phergie/phergie-irc-client-react

<?php
/**
 * Phergie (http://phergie.org)
 *
 * @link http://github.com/phergie/phergie-irc-client-react for the canonical source repository
 * @copyright Copyright (c) 2008-2014 Phergie Development Team (http://phergie.org)
 * @license http://phergie.org/license Simplified BSD License
 * @package Phergie\Irc\Client\React
 */

namespace Phergie\Irc\Client\React;

use Evenement\EventEmitter;
use Phergie\Irc\GeneratorInterface;
use React\Stream\ReadableStreamInterface;
use React\Stream\Util;
use React\Stream\WritableStreamInterface;

/**
 * Stream that sends IRC messages to a server.
 *
 * @category Phergie
 * @package Phergie\Irc\Client\React
 */
class WriteStream extends EventEmitter implements ReadableStreamInterface, GeneratorInterface
{
    /**
     * Generator composed to write IRC messages to the stream
     *
     * @var \Phergie\Irc\GeneratorInterface
     */
    protected $generator;

    /**
     * @var bool
     */
    protected $closed = false;

    /**
     * Returns the IRC message generator in use.
     *
     * @return \Phergie\Irc\GeneratorInterface
     */
    public function getGenerator()
    {
        if (!$this->generator) {
            $this->generator = new \Phergie\Irc\Generator;
        }
        return $this->generator;
    }

    /**
     * Sets the IRC message generator to use.
     *
     * @param \Phergie\Irc\GeneratorInterface $generator
     */
    public function setGenerator(GeneratorInterface $generator)
    {
        $this->generator = $generator;
    }

    public function isReadable()
    {
        return !$this->closed;
    }

    public function pause()
    {
    }

    public function resume()
    {
    }

    public function pipe(WritableStreamInterface $dest, array $options = array())
    {
        Util::pipe($this, $dest, $options);

        return $dest;
    }

    public function close()
    {
        if ($this->closed) {
            return;
        }

        $this->closed = true;
        $this->emit('end', array($this));
        $this->emit('close', array($this));
        $this->removeAllListeners();
    }

    /**
     * Implements \Phergie\Irc\GeneratorInterface->setPrefix().
     *
     * @param string $prefix
     */
    public function setPrefix($prefix)
    {
        $this->getGenerator()->setPrefix($prefix);
    }

    /**
     * Implements \Phergie\Irc\GeneratorInterface->ircPass().
     *
     * @param string $password
     * @return string
     */
    public function ircPass($password)
    {
        $msg = $this->getGenerator()->ircPass($password);
        $this->emit('data', array($msg));
        return $msg;
    }

    /**
     * Implements \Phergie\Irc\GeneratorInterface->ircNick().
     *
     * @param string $nickname
     * @param int $hopcount
     * @return string
     */
    public function ircNick($nickname, $hopcount = null)
    {
        $msg = $this->getGenerator()->ircNick($nickname, $hopcount);
        $this->emit('data', array($msg));
        return $msg;
    }

    /**
     * Implements \Phergie\Irc\GeneratorInterface->ircUser().
     *
     * @param string $username
     * @param string $hostname
     * @param string $servername
     * @param string $realname
     * @return string
     */
    public function ircUser($username, $hostname, $servername, $realname)
    {
        $msg = $this->getGenerator()->ircUser($username, $hostname, $servername, $realname);
        $this->emit('data', array($msg));
        return $msg;
    }

    /**
     * Implements \Phergie\Irc\GeneratorInterface->ircServer().
     *
     * @param string $servername
     * @param int $hopcount
     * @param string $info
     * @return string
     */
    public function ircServer($servername, $hopcount, $info)
    {
        $msg = $this->getGenerator()->ircServer($servername, $hopcount, $info);
        $this->emit('data', array($msg));
        return $msg;
    }

    /**
     * Implements \Phergie\Irc\GeneratorInterface->ircOper().
     *
     * @param string $user
     * @param string $password
     * @return string
     */
    public function ircOper($user, $password)
    {
        $msg = $this->getGenerator()->ircOper($user, $password);
        $this->emit('data', array($msg));
        return $msg;
    }

    /**
     * Implements \Phergie\Irc\GeneratorInterface->ircQuit().
     *
     * @param string $message
     * @return string
     */
    public function ircQuit($message = null)
    {
        $msg = $this->getGenerator()->ircQuit($message);
        $this->emit('data', array($msg));
        $this->close();
        return $msg;
    }

    /**
     * Implements \Phergie\Irc\GeneratorInterface->ircSquit().
     *
     * @param string $server
     * @param string $comment
     * @return string
     */
    public function ircSquit($server, $comment)
    {
        $msg = $this->getGenerator()->ircSquit($server, $comment);
        $this->emit('data', array($msg));
        return $msg;
    }

    /**
     * Implements \Phergie\Irc\GeneratorInterface->ircJoin().
     *
     * @param string $channels
     * @param string $keys
     * @return string
     */
    public function ircJoin($channels, $keys = null)
    {
        $msg = $this->getGenerator()->ircJoin($channels, $keys);
        $this->emit('data', array($msg));
        return $msg;
    }

    /**
     * Implements \Phergie\Irc\GeneratorInterface->ircPart().
     *
     * @param string $channels
     * @param string|null $message
     * @return string
     */
    public function ircPart($channels, $message = null)
    {
        $msg = $this->getGenerator()->ircPart($channels, $message);
        $this->emit('data', array($msg));
        return $msg;
    }

    /**
     * Implements \Phergie\Irc\GeneratorInterface->ircMode().
     *
     * @param string $target
     * @param string|null $mode
     * @param string|null $param
     * @return string
     */
    public function ircMode($target, $mode = null, $param = null)
    {
        $msg = $this->getGenerator()->ircMode($target, $mode, $param);
        $this->emit('data', array($msg));
        return $msg;
    }

    /**
     * Implements \Phergie\Irc\GeneratorInterface->ircTopic().
     *
     * @param string $channel
     * @param string $topic
     * @return string
     */
    public function ircTopic($channel, $topic = null)
    {
        $msg = $this->getGenerator()->ircTopic($channel, $topic);
        $this->emit('data', array($msg));
        return $msg;
    }

    /**
     * Implements \Phergie\Irc\GeneratorInterface->ircNames().
     *
     * @param string $channels
     * @return string
     */
    public function ircNames($channels)
    {
        $msg = $this->getGenerator()->ircNames($channels);
        $this->emit('data', array($msg));
        return $msg;
    }

    /**
     * Implements \Phergie\Irc\GeneratorInterface->ircList().
     *
     * @param string $channels
     * @param string $server
     * @return string
     */
    public function ircList($channels = null, $server = null)
    {
        $msg = $this->getGenerator()->ircList($channels, $server);
        $this->emit('data', array($msg));
        return $msg;
    }

    /**
     * Implements \Phergie\Irc\GeneratorInterface->ircInvite().
     *
     * @param string $nickname
     * @param string $channel
     * @return string
     */
    public function ircInvite($nickname, $channel)
    {
        $msg = $this->getGenerator()->ircInvite($nickname, $channel);
        $this->emit('data', array($msg));
        return $msg;
    }

    /**
     * Implements \Phergie\Irc\GeneratorInterface->ircKick().
     *
     * @param string $channel
     * @param string $user
     * @param string $comment
     * @return string
     */
    public function ircKick($channel, $user, $comment = null)
    {
        $msg = $this->getGenerator()->ircKick($channel, $user, $comment);
        $this->emit('data', array($msg));
        return $msg;
    }

    /**
     * Implements \Phergie\Irc\GeneratorInterface->ircVersion().
     *
     * @param string $server
     * @return string
     */
    public function ircVersion($server = null)
    {
        $msg = $this->getGenerator()->ircVersion($server);
        $this->emit('data', array($msg));
        return $msg;
    }

    /**
     * Implements \Phergie\Irc\GeneratorInterface->ircStats().
     *
     * @param string $query
     * @param string $server
     * @return string
     */
    public function ircStats($query, $server = null)
    {
        $msg = $this->getGenerator()->ircStats($query, $server);
        $this->emit('data', array($msg));
        return $msg;
    }

    /**
     * Implements \Phergie\Irc\GeneratorInterface->ircLinks().
     *
     * @param string $servermask
     * @param string $remoteserver
     * @return string
     */
    public function ircLinks($servermask = null, $remoteserver = null)
    {
        $msg = $this->getGenerator()->ircLinks($servermask, $remoteserver);
        $this->emit('data', array($msg));
        return $msg;
    }

    /**
     * Implements \Phergie\Irc\GeneratorInterface->ircTime().
     *
     * @param string $server
     * @return string
     */
    public function ircTime($server = null)
    {
        $msg = $this->getGenerator()->ircTime($server);
        $this->emit('data', array($msg));
        return $msg;
    }

    /**
     * Implements \Phergie\Irc\GeneratorInterface->ircConnect().
     *
     * @param string $targetserver
     * @param int $port
     * @param string $remoteserver
     * @return string
     */
    public function ircConnect($targetserver, $port = null, $remoteserver = null)
    {
        $msg = $this->getGenerator()->ircConnect($targetserver, $port, $remoteserver);
        $this->emit('data', array($msg));
        return $msg;
    }

    /**
     * Implements \Phergie\Irc\GeneratorInterface->ircTrace().
     *
     * @param string $server
     * @return string
     */
    public function ircTrace($server = null)
    {
        $msg = $this->getGenerator()->ircTrace($server);
        $this->emit('data', array($msg));
        return $msg;
    }

    /**
     * Implements \Phergie\Irc\GeneratorInterface->ircAdmin().
     *
     * @param string $server
     * @return string
     */
    public function ircAdmin($server = null)
    {
        $msg = $this->getGenerator()->ircAdmin($server);
        $this->emit('data', array($msg));
        return $msg;
    }

    /**
     * Implements \Phergie\Irc\GeneratorInterface->ircInfo().
     *
     * @param string $server
     * @return string
     */
    public function ircInfo($server = null)
    {
        $msg = $this->getGenerator()->ircInfo($server);
        $this->emit('data', array($msg));
        return $msg;
    }

    /**
     * Implements \Phergie\Irc\GeneratorInterface->ircPrivmsg().
     *
     * @param string $receivers
     * @param string $text
     * @return string
     */
    public function ircPrivmsg($receivers, $text)
    {
        $msg = $this->getGenerator()->ircPrivmsg($receivers, $text);
        $this->emit('data', array($msg));
        return $msg;
    }

    /**
     * Implements \Phergie\Irc\GeneratorInterface->ircNotice().
     *
     * @param string $nickname
     * @param string $text
     * @return string
     */
    public function ircNotice($nickname, $text)
    {
        $msg = $this->getGenerator()->ircNotice($nickname, $text);
        $this->emit('data', array($msg));
        return $msg;
    }

    /**
     * Implements \Phergie\Irc\GeneratorInterface->ircWho().
     *
     * @param string $name
     * @param string $o
     * @return string
     */
    public function ircWho($name, $o = null)
    {
        $msg = $this->getGenerator()->ircWho($name, $o);
        $this->emit('data', array($msg));
        return $msg;
    }

    /**
     * Implements \Phergie\Irc\GeneratorInterface->ircWhois().
     *
     * @param string $nickmasks
     * @param string $server Optional
     * @return string
     */
    public function ircWhois($nickmasks, $server = null)
    {
        $msg = $this->getGenerator()->ircWhois($nickmasks, $server);
        $this->emit('data', array($msg));
        return $msg;
    }

    /**
     * Implements \Phergie\Irc\GeneratorInterface->ircWhowas().
     *
     * @param string $nickname
     * @param int $count
     * @param string $server
     * @return string
     */
    public function ircWhowas($nickname, $count = null, $server = null)
    {
        $msg = $this->getGenerator()->ircWhowas($nickname, $count, $server);
        $this->emit('data', array($msg));
        return $msg;
    }

    /**
     * Implements \Phergie\Irc\GeneratorInterface->ircKill().
     *
     * @param string $nickname
     * @param string $comment
     * @return string
     */
    public function ircKill($nickname, $comment)
    {
        $msg = $this->getGenerator()->ircKill($nickname, $comment);
        $this->emit('data', array($msg));
        return $msg;
    }

    /**
     * Implements \Phergie\Irc\GeneratorInterface->ircPing().
     *
     * @param string $server1
     * @param string $server2
     * @return string
     */
    public function ircPing($server1, $server2 = null)
    {
        $msg = $this->getGenerator()->ircPing($server1, $server2);
        $this->emit('data', array($msg));
        return $msg;
    }

    /**
     * Implements \Phergie\Irc\GeneratorInterface->ircPong().
     *
     * @param string $daemon
     * @param string $daemon2
     * @return string
     */
    public function ircPong($daemon, $daemon2 = null)
    {
        $msg = $this->getGenerator()->ircPong($daemon, $daemon2);
        $this->emit('data', array($msg));
        return $msg;
    }

    /**
     * Implements \Phergie\Irc\GeneratorInterface->ircError().
     *
     * @param string $message
     * @return string
     */
    public function ircError($message)
    {
        $msg = $this->getGenerator()->ircError($message);
        $this->emit('data', array($msg));
        return $msg;
    }

    /**
     * Implements \Phergie\Irc\GeneratorInterface->ircAway().
     *
     * @param string $message
     * @return string
     */
    public function ircAway($message = null)
    {
        $msg = $this->getGenerator()->ircAway($message);
        $this->emit('data', array($msg));
        return $msg;
    }

    /**
     * Implements \Phergie\Irc\GeneratorInterface->ircRehash().
     *
     * @return string
     */
    public function ircRehash()
    {
        $msg = $this->getGenerator()->ircRehash();
        $this->emit('data', array($msg));
        return $msg;
    }

    /**
     * Implements \Phergie\Irc\GeneratorInterface->ircRestart().
     *
     * @return string
     */
    public function ircRestart()
    {
        $msg = $this->getGenerator()->ircRestart();
        $this->emit('data', array($msg));
        return $msg;
    }

    /**
     * Implements \Phergie\Irc\GeneratorInterface->ircSummon().
     *
     * @param string $user
     * @param string $server
     * @return string
     */
    public function ircSummon($user, $server = null)
    {
        $msg = $this->getGenerator()->ircSummon($user, $server);
        $this->emit('data', array($msg));
        return $msg;
    }

    /**
     * Implements \Phergie\Irc\GeneratorInterface->ircUsers().
     *
     * @param string $server
     * @return string
     */
    public function ircUsers($server = null)
    {
        $msg = $this->getGenerator()->ircUsers($server);
        $this->emit('data', array($msg));
        return $msg;
    }

    /**
     * Implements \Phergie\Irc\GeneratorInterface->ircWallops().
     *
     * @param string $text
     * @return string
     */
    public function ircWallops($text)
    {
        $msg = $this->getGenerator()->ircWallops($text);
        $this->emit('data', array($msg));
        return $msg;
    }

    /**
     * Implements \Phergie\Irc\GeneratorInterface->ircUserhost().
     *
     * @param string $nickname1
     * @param string $nickname2
     * @param string $nickname3
     * @param string $nickname4
     * @param string $nickname5
     * @return string
     */
    public function ircUserhost($nickname1, $nickname2 = null, $nickname3 = null, $nickname4 = null, $nickname5 = null)
    {
        $msg = $this->getGenerator()->ircUserhost($nickname1, $nickname2, $nickname3, $nickname4, $nickname5);
        $this->emit('data', array($msg));
        return $msg;
    }

    /**
     * Implements \Phergie\Irc\GeneratorInterface->ircIson().
     *
     * @param string $nicknames
     * @return string
     */
    public function ircIson($nicknames)
    {
        $msg = $this->getGenerator()->ircIson($nicknames);
        $this->emit('data', array($msg));
        return $msg;
    }

    /**
     * Implements \Phergie\Irc\GeneratorInterface->ircProtoctl().
     *
     * @param string $proto
     * @return string
     */
    public function ircProtoctl($proto)
    {
        $msg = $this->getGenerator()->ircProtoctl($proto);
        $this->emit('data', array($msg));
        return $msg;
    }
    
    /**
     * Implements \Phergie\Irc\GeneratorInterface->ctcpAction().
     *
     * @param string $receivers 
     * @param string $action
     * @return string
     */
    public function ctcpAction($receivers, $action)
    {
        $msg = $this->getGenerator()->ctcpAction($receivers, $action);
        $this->emit('data', array($msg));
        return $msg;
    }

    /**
     * Implements \Phergie\Irc\GeneratorInterface->ctcpActionResponse().
     *
     * @param string $nickname
     * @param string $action
     * @return string
     */
    public function ctcpActionResponse($nickname, $action)
    {
        $msg = $this->getGenerator()->ctcpActionResponse($nickname, $action);
        $this->emit('data', array($msg));
        return $msg;
    }

    /**
     * Implements \Phergie\Irc\GeneratorInterface->ctcpFinger().
     *
     * @param string $receivers
     * @return string
     */
    public function ctcpFinger($receivers)
    {
        $msg = $this->getGenerator()->ctcpFinger($receivers);
        $this->emit('data', array($msg));
        return $msg;
    }

    /**
     * Implements \Phergie\Irc\GeneratorInterface->ctcpFingerResponse().
     *
     * @param string $nickname
     * @param string $text
     * @return string
     */
    public function ctcpFingerResponse($nickname, $text)
    {
        $msg = $this->getGenerator()->ctcpFingerResponse($nickname, $text);
        $this->emit('data', array($msg));
        return $msg;
    }

    /**
     * Implements \Phergie\Irc\GeneratorInterface->ctcpVersion().
     *
     * @param string $receivers
     * @return string
     */
    public function ctcpVersion($receivers)
    {
        $msg = $this->getGenerator()->ctcpVersion($receivers);
        $this->emit('data', array($msg));
        return $msg;
    }

    /**
     * Implements \Phergie\Irc\GeneratorInterface->ctcpVersionResponse().
     *
     * @param string $nickname
     * @param string $name
     * @param string $version
     * @param string $environment
     * @return string
     */
    public function ctcpVersionResponse($nickname, $name, $version, $environment)
    {
        $msg = $this->getGenerator()->ctcpVersionResponse($nickname, $name, $version, $environment);
        $this->emit('data', array($msg));
        return $msg;
    }

    /**
     * Implements \Phergie\Irc\GeneratorInterface->ctcpSource().
     *
     * @param string $receivers
     * @return string
     */
    public function ctcpSource($receivers)
    {
        $msg = $this->getGenerator()->ctcpSource($receivers);
        $this->emit('data', array($msg));
        return $msg;
    }

    /**
     * Implements \Phergie\Irc\GeneratorInterface->ctcpSourceResponse().
     *
     * @param string $nickname
     * @param string $host
     * @param string $directories
     * @param string $files
     * @return string
     */
    public function ctcpSourceResponse($nickname, $host, $directories, $files)
    {
        $msg = $this->getGenerator()->ctcpSourceResponse($nickname, $host, $directories, $files);
        $this->emit('data', array($msg));
        return $msg;
    }

    /**
     * Implements \Phergie\Irc\GeneratorInterface->ctcpUserinfo().
     *
     * @param string $receivers
     * @return string
     */
    public function ctcpUserinfo($receivers)
    {
        $msg = $this->getGenerator()->ctcpUserinfo($receivers);
        $this->emit('data', array($msg));
        return $msg;
    }

    /**
     * Implements \Phergie\Irc\GeneratorInterface->ctcpUserinfoResponse().
     *
     * @param string $nickname
     * @param string $text
     * @return string
     */
    public function ctcpUserinfoResponse($nickname, $text)
    {
        $msg = $this->getGenerator()->ctcpUserinfoResponse($nickname, $text);
        $this->emit('data', array($msg));
        return $msg;
    }

    /**
     * Implements \Phergie\Irc\GeneratorInterface->ctcpCientinfo().
     *
     * @param string $receivers
     * @return string
     */
    public function ctcpClientinfo($receivers)
    {
        $msg = $this->getGenerator()->ctcpClientInfo($receivers);
        $this->emit('data', array($msg));
        return $msg;
    }

    /**
     * Implements \Phergie\Irc\GeneratorInterface->ctcpClientinfoResponse().
     *
     * @param string $nickname
     * @param string $client
     * @return string
     */
    public function ctcpClientinfoResponse($nickname, $client)
    {
        $msg = $this->getGenerator()->ctcpClientinfoResponse($nickname, $client);
        $this->emit('data', array($msg));
        return $msg;
    }

    /**
     * Implements \Phergie\Irc\GeneratorInterface->ctcpErrmsg().
     *
     * @param string $receivers
     * @param string $query
     * @return string
     */
    public function ctcpErrmsg($receivers, $query)
    {
        $msg = $this->getGenerator()->ctcpErrmsg($receivers, $query);
        $this->emit('data', array($msg));
        return $msg;
    }

    /**
     * Implements \Phergie\Irc\GeneratorInterface->ctcpErrmsgResponse().
     *
     * @param string $nickname
     * @param string $query
     * @param string $message
     * @return string
     */
    public function ctcpErrmsgResponse($nickname, $query, $message)
    {
        $msg = $this->getGenerator()->ctcpErrmsgResponse($nickname, $query, $message);
        $this->emit('data', array($msg));
        return $msg;
    }

    /**
     * Implements \Phergie\Irc\GeneratorInterface->ctcpPing().
     *
     * @param string $receivers
     * @param int $timestamp
     * @return string
     */
    public function ctcpPing($receivers, $timestamp)
    {
        $msg = $this->getGenerator()->ctcpPing($receivers, $timestamp);
        $this->emit('data', array($msg));
        return $msg;
    }

    /**
     * Implements \Phergie\Irc\GeneratorInterface->ctcpPingResponse().
     *
     * @param string $nickname
     * @param int $timestamp
     * @return string
     */
    public function ctcpPingResponse($nickname, $timestamp)
    {
        $msg = $this->getGenerator()->ctcpPingResponse($nickname, $timestamp);
        $this->emit('data', array($msg));
        return $msg;
    }

    /**
     * Implements \Phergie\Irc\GeneratorInterface->ctcpTime().
     *
     * @param string $receivers
     * @return string
     */
    public function ctcpTime($receivers)
    {
        $msg = $this->getGenerator()->ctcpTime($receivers);
        $this->emit('data', array($msg));
        return $msg;
    }

    /**
     * Implements \Phergie\Irc\GeneratorInterface->ctcpTimeResponse().
     *
     * @param string $nickname
     * @param string $time
     * @return string
     */
    public function ctcpTimeResponse($nickname, $time)
    {
        $msg = $this->getGenerator()->ctcpTimeResponse($nickname, $time);
        $this->emit('data', array($msg));
        return $msg;
    }
}