<?php

/**
 * @file
 * TeamSpeak 3 PHP Framework
 * $Id: FileTransfer.php 06/06/2016 22:27:13 scp@Svens-iMac $
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 * You should have received a copy of the GNU General Public License
 * along with this program. If not, see <http://www.gnu.org/licenses/>.
 * @package   TeamSpeak3
 * @version   1.1.24
 * @author    Sven 'ScP' Paulsen
 * @copyright Copyright (c) 2010 by Planet TeamSpeak. All rights reserved.
 */

/**
 * @class TeamSpeak3_Adapter_FileTransfer
 * @brief Provides low-level methods for file transfer communication with a TeamSpeak 3 Server.
 */
class TeamSpeak3_Adapter_FileTransfer extends TeamSpeak3_Adapter_Abstract
{
    /**
     * Connects the TeamSpeak3_Transport_Abstract object and performs initial actions on the remote
     * server.
     *
     * @throws TeamSpeak3_Adapter_Exception
     * @return void
     */
    public function syn()
    {
        $this->initTransport($this->options);
        $this->transport->setAdapter($this);

        TeamSpeak3_Helper_Profiler::init(spl_object_hash($this));

        TeamSpeak3_Helper_Signal::getInstance()->emit('filetransferConnected', $this);
    }

    /**
     * The TeamSpeak3_Adapter_FileTransfer destructor.
     *
     * @return void
     */
    public function __destruct()
    {
        if ($this->getTransport() instanceof TeamSpeak3_Transport_Abstract && $this->getTransport()->isConnected()) {
            $this->getTransport()->disconnect();
        }
    }

    /**
     * Sends a valid file transfer key to the server to initialize the file transfer.
     *
     * @param  string $ftkey
     * @throws TeamSpeak3_Adapter_FileTransfer_Exception
     * @return void
     */
    protected function init($ftkey)
    {
        if (strlen($ftkey) != 32) {
            throw new TeamSpeak3_Adapter_FileTransfer_Exception('invalid file transfer key format');
        }

        $this->getProfiler()->start();
        $this->getTransport()->send($ftkey);

        TeamSpeak3_Helper_Signal::getInstance()->emit('filetransferHandshake', $this);
    }

    /**
     * Sends the content of a file to the server.
     *
     * @param  string $ftkey
     * @param  int    $seek
     * @param  string $data
     * @throws TeamSpeak3_Adapter_FileTransfer_Exception
     * @return void
     */
    public function upload($ftkey, $seek, $data)
    {
        $this->init($ftkey);

        $size = strlen($data);
        $seek = (int) $seek;
        $pack = 4096;

        TeamSpeak3_Helper_Signal::getInstance()->emit('filetransferUploadStarted', $ftkey, $seek, $size);

        for (; $seek < $size;) {
            $rest = $size - $seek;
            $pack = $rest < $pack ? $rest : $pack;
            $buff = substr($data, $seek, $pack);
            $seek = $seek + $pack;

            $this->getTransport()->send($buff);

            TeamSpeak3_Helper_Signal::getInstance()->emit('filetransferUploadProgress', $ftkey, $seek, $size);
        }

        $this->getProfiler()->stop();

        TeamSpeak3_Helper_Signal::getInstance()->emit('filetransferUploadFinished', $ftkey, $seek, $size);

        if ($seek < $size) {
            throw new TeamSpeak3_Adapter_FileTransfer_Exception('incomplete file upload (' . $seek . ' of ' . $size . ' bytes)');
        }
    }

    /**
     * Returns the content of a downloaded file as a TeamSpeak3_Helper_String object.
     *
     * @param  string $ftkey
     * @param  int    $size
     * @param  bool   $passthru
     * @throws TeamSpeak3_Adapter_FileTransfer_Exception
     * @return TeamSpeak3_Helper_String
     */
    public function download($ftkey, $size, $passthru = false)
    {
        $this->init($ftkey);

        if ($passthru) {
            return $this->passthru($size);
        }

        $buff = new TeamSpeak3_Helper_String('');
        $size = (int) $size;
        $pack = 4096;

        TeamSpeak3_Helper_Signal::getInstance()->emit('filetransferDownloadStarted', $ftkey, count($buff), $size);

        for ($seek = 0; $seek < $size;) {
            $rest = $size - $seek;
            $pack = $rest < $pack ? $rest : $pack;
            $data = $this->getTransport()->read($rest < $pack ? $rest : $pack);
            $seek = $seek + $pack;

            $buff->append($data);

            TeamSpeak3_Helper_Signal::getInstance()->emit('filetransferDownloadProgress', $ftkey, count($buff), $size);
        }

        $this->getProfiler()->stop();

        TeamSpeak3_Helper_Signal::getInstance()->emit('filetransferDownloadFinished', $ftkey, count($buff), $size);

        if (strlen($buff) != $size) {
            throw new TeamSpeak3_Adapter_FileTransfer_Exception('incomplete file download (' . count($buff) . ' of ' . $size . ' bytes)');
        }

        return $buff;
    }

    /**
     * Outputs all remaining data on a TeamSpeak 3 file transfer stream using PHP's fpassthru()
     * function.
     *
     * @param  int $size
     * @throws TeamSpeak3_Adapter_FileTransfer_Exception
     * @return void
     */
    protected function passthru($size)
    {
        $buff_size = fpassthru($this->getTransport()->getStream());

        if ($buff_size != $size) {
            throw new TeamSpeak3_Adapter_FileTransfer_Exception('incomplete file download (' . (int) $buff_size . ' of ' . $size . ' bytes)');
        }
    }
}
