Handle TCP Filetransfers

.env.testing.example

@@ -9,4 +9,6 @@ DEV_LIVE_SERVER_UNIT_TEST_CHANNEL=UnitTest
 DEV_LIVE_SERVER_UNIT_TEST_USER_ACTIVE=false
 DEV_LIVE_SERVER_UNIT_TEST_USER=UnitTestUser
 DEV_LIVE_SERVER_UNIT_TEST_SIGNALS=false
-DEV_LIVE_SERVER_UNIT_TEST_USER_EXTEND=
+DEV_LIVE_SERVER_UNIT_TEST_USER_EXTEND=UnitTestUser2
+DEV_LIVE_SERVER_UNIT_TEST_SERVER_PORT=9987
+DEV_LIVE_SERVER_UNIT_TEST_SERVER_QUERY_LOGIN_NAME=ts3-bot-dev

src/Adapter/FileTransfer.php

@@ -7,6 +7,7 @@
 use PlanetTeamSpeak\TeamSpeak3Framework\Helper\Profiler;
 use PlanetTeamSpeak\TeamSpeak3Framework\Helper\Signal;
 use PlanetTeamSpeak\TeamSpeak3Framework\Helper\StringHelper;
+use PlanetTeamSpeak\TeamSpeak3Framework\Transport\TCP;
 use PlanetTeamSpeak\TeamSpeak3Framework\Transport\Transport;
 
 /**
@@ -21,7 +22,7 @@ class FileTransfer extends Adapter
      */
     public function syn(): void
     {
-        $this->initTransport($this->options);
+        $this->initTransport($this->options, TCP::class);
         $this->transport->setAdapter($this);
 
         Profiler::init(spl_object_hash($this));
@@ -42,14 +43,14 @@ public function __destruct()
     /**
      * Sends a valid file transfer key to the server to initialize the file transfer.
      *
-     * @param  string  $ftkey
+     * @param string $ftkey
      * @return void
      * @throws FileTransferException
      * @throws TransportException
      */
     protected function init(string $ftkey): void
     {
-        if (strlen($ftkey) != 32 && strlen($ftkey) != 16) {
+        if (strlen($ftkey) !== 32 && strlen($ftkey) !== 16) {
             throw new FileTransferException('invalid file transfer key format');
         }
 
@@ -62,9 +63,9 @@ protected function init(string $ftkey): void
     /**
      * Sends the content of a file to the server.
      *
-     * @param  string  $ftkey
-     * @param  int  $seek
-     * @param  string  $data
+     * @param string $ftkey
+     * @param int $seek
+     * @param string $data
      * @return void
      * @throws FileTransferException
      * @throws TransportException
@@ -78,14 +79,15 @@ public function upload(string $ftkey, int $seek, string $data): void
 
         Signal::getInstance()->emit('filetransferUploadStarted', $ftkey, $seek, $size);
 
-        for (; $seek < $size;) {
+        while ($seek < $size) {
             $rest = $size - $seek;
-            $pack = min($rest, $pack);
-            $buff = substr($data, $seek, $pack);
-            $seek = $seek + $pack;
+            $chunkSize = min($rest, $pack);
+            $buff = substr($data, $seek, $chunkSize);
 
             $this->getTransport()->send($buff);
 
+            $seek += $chunkSize;
+
             Signal::getInstance()->emit('filetransferUploadProgress', $ftkey, $seek, $size);
         }
 
@@ -97,9 +99,9 @@ public function upload(string $ftkey, int $seek, string $data): void
     /**
      * Returns the content of a downloaded file as a PlanetTeamSpeak\TeamSpeak3Framework\Helper\StringHelper object.
      *
-     * @param  string  $ftkey
-     * @param  int  $size
-     * @param  bool  $passthru
+     * @param string $ftkey
+     * @param int $size
+     * @param bool $passthru
      * @return StringHelper|void
      * @throws FileTransferException
      * @throws TransportException
@@ -119,13 +121,16 @@ public function download(string $ftkey, int $size, bool $passthru = false)
 
         Signal::getInstance()->emit('filetransferDownloadStarted', $ftkey, count($buff), $size);
 
-        for ($seek = 0; $seek < $size;) {
-            $rest = $size - $seek;
-            $pack = min($rest, $pack);
-            $data = $this->getTransport()->read(min($rest, $pack));
-            $seek = $seek + $pack;
+        while (count($buff) < $size) {
+            $rest = $size - count($buff);
+            $chunkSize = min($rest, $pack);
+            $data = $this->getTransport()->read($chunkSize);
+
+            if (count($data) === 0) {
+                break;
+            }
 
-            $buff->append($data);
+            $buff->append($data->toString());
 
             Signal::getInstance()->emit('filetransferDownloadProgress', $ftkey, count($buff), $size);
         }
@@ -134,7 +139,7 @@ public function download(string $ftkey, int $size, bool $passthru = false)
 
         Signal::getInstance()->emit('filetransferDownloadFinished', $ftkey, count($buff), $size);
 
-        if (strlen($buff) != $size) {
+        if (count($buff) !== $size) {
             throw new FileTransferException('incomplete file download ('.count($buff).' of '.$size.' bytes)');
         }
 
@@ -151,10 +156,16 @@ public function download(string $ftkey, int $size, bool $passthru = false)
      */
     protected function passthru(int $size): void
     {
-        $buff_size = fpassthru($this->getTransport()->getStream());
+        $stream = $this->getTransport()->getStream();
+
+        if (! is_resource($stream)) {
+            throw new FileTransferException('invalid file transfer stream');
+        }
+
+        $buffSize = fpassthru($stream);
 
-        if ($buff_size != $size) {
-            throw new FileTransferException('incomplete file download ('.$buff_size.' of '.$size.' bytes)');
+        if ($buffSize !== $size) {
+            throw new FileTransferException('incomplete file download ('.$buffSize.' of '.$size.' bytes)');
         }
     }
 }

src/Node/Channel.php

@@ -332,6 +332,44 @@ public function dirCreate(string $cpw = '', string $dirname = '/'): void
         $this->getParent()->channelDirCreate($this->getId(), $cpw, $dirname);
     }
 
+    /**
+     * Downloads a file from this channel file repository.
+     *
+     * @param string $name
+     * @param string $cpw
+     * @param int $seekpos
+     * @return StringHelper
+     * @throws AdapterException
+     * @throws FileTransferException
+     * @throws ServerQueryException
+     * @throws TransportException
+     * @throws \Exception
+     */
+    public function fileDownload(string $name, string $cpw = '', int $seekpos = 0): StringHelper
+    {
+        return $this->getParent()->channelFileDownload($this->getId(), $name, $cpw, $seekpos);
+    }
+
+    /**
+     * Uploads a file into this channel file repository.
+     *
+     * @param string $name
+     * @param string $data
+     * @param string $cpw
+     * @param bool $overwrite
+     * @param bool $resume
+     * @return void
+     * @throws AdapterException
+     * @throws FileTransferException
+     * @throws ServerQueryException
+     * @throws TransportException
+     * @throws \Exception
+     */
+    public function fileUpload(string $name, string $data, string $cpw = '', bool $overwrite = false, bool $resume = false) :void
+    {
+        $this->getParent()->channelFileUpload($this->getId(), $name, $data, $cpw, $overwrite, $resume);
+    }
+
     /**
      * Returns the level of the channel.
      *
@@ -417,9 +455,10 @@ public function iconDownload()
         }
 
         $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']);
+        $ftkey = str_replace('\\/', '/', (string) $download['ftkey']);
+        $transfer = TeamSpeak3::factory($this->getParent()->buildFileTransferUri($download));
 
-        return $transfer->download($download['ftkey'], $download['size']);
+        return $transfer->download($ftkey, (int) $download['size']);
     }
 
     /**

src/Node/Client.php

@@ -374,9 +374,10 @@ public function avatarDownload()
         }
 
         $download = $this->getParent()->transferInitDownload(rand(0x0000, 0xFFFF), 0, $this->avatarGetName());
-        $transfer = TeamSpeak3::factory('filetransfer://'.(str_contains($download['host'], ':') ? '['.$download['host'].']' : $download['host']).':'.$download['port']);
+        $ftkey = str_replace('\\/', '/', (string) $download['ftkey']);
+        $transfer = TeamSpeak3::factory($this->getParent()->buildFileTransferUri($download));
 
-        return $transfer->download($download['ftkey'], $download['size']);
+        return $transfer->download($ftkey, (int) $download['size']);
     }
 
     /**
@@ -476,9 +477,10 @@ public function iconDownload()
         }
 
         $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']);
+        $ftkey = str_replace('\\/', '/', (string) $download['ftkey']);
+        $transfer = TeamSpeak3::factory($this->getParent()->buildFileTransferUri($download));
 
-        return $transfer->download($download['ftkey'], $download['size']);
+        return $transfer->download($ftkey, (int) $download['size']);
     }
 
     /**

src/Node/Group.php

@@ -63,9 +63,10 @@ public function iconDownload()
         }
 
         $download = $this->getParent()->transferInitDownload(rand(0x0000, 0xFFFF), 0, $this->iconGetName('iconid'));
-        $transfer = TeamSpeak3::factory('filetransfer://'.(str_contains($download['host'], ':') ? '['.$download['host'].']' : $download['host']).':'.$download['port']);
+        $ftkey = str_replace('\\/', '/', (string) $download['ftkey']);
+        $transfer = TeamSpeak3::factory($this->getParent()->buildFileTransferUri($download));
 
-        return $transfer->download($download['ftkey'], $download['size']);
+        return $transfer->download($ftkey, (int) $download['size']);
     }
 
     /**