9 * This source file is subject to the new BSD license that is bundled
10 * with this package in the file LICENSE.
11 * It is also available through the world-wide-web at this URL:
12 * http://phergie.org/license
16 * @author Phergie Development Team <team@phergie.org>
17 * @copyright 2008-2010 Phergie Development Team (http://phergie.org)
18 * @license http://phergie.org/license New BSD License
19 * @link http://pear.phergie.org/package/Phergie
23 * Driver that uses the sockets wrapper of the streams extension for
24 * communicating with the server and handles formatting and parsing of
29 * @author Phergie Development Team <team@phergie.org>
30 * @license http://phergie.org/license New BSD License
31 * @link http://pear.phergie.org/package/Phergie
33 class Phergie_Driver_Streams extends Phergie_Driver_Abstract
40 protected $sockets = array();
43 * Reference to the currently active socket handler
50 * Amount of time in seconds to wait to receive an event each time the
55 protected $timeout = 0.1;
58 * Handles construction of command strings and their transmission to the
61 * @param string $command Command to send
62 * @param string|array $args Optional string or array of sequential
65 * @return string Command string that was sent
66 * @throws Phergie_Driver_Exception
68 protected function send($command, $args = '')
70 $connection = $this->getConnection();
71 $encoding = $connection->getEncoding();
73 // Require an open socket connection to continue
74 if (empty($this->socket)) {
75 throw new Phergie_Driver_Exception(
76 'doConnect() must be called first',
77 Phergie_Driver_Exception::ERR_NO_INITIATED_CONNECTION
82 $buffer = strtoupper($command);
87 // Apply formatting if arguments are passed in as an array
88 if (is_array($args)) {
89 $end = count($args) - 1;
90 $args[$end] = ':' . $args[$end];
91 $args = implode(' ', $args);
96 $buffer .= ' ' . $args;
99 // Transmit the command over the socket connection
100 $attempts = $written = 0;
101 $temp = $buffer . "\r\n";
102 $is_multibyte = !substr($encoding, 0, 8) === 'ISO-8859' && $encoding !== 'ASCII' && $encoding !== 'CP1252';
103 $length = ($is_multibyte) ? mb_strlen($buffer, '8bit') : strlen($buffer);
105 $written += (int) fwrite($this->socket, $temp);
106 if ($written < $length) {
107 $temp = substr($temp, $written);
109 if ($attempts == 3) {
110 throw new Phergie_Driver_Exception(
111 'Unable to write to socket',
112 Phergie_Driver_Exception::ERR_CONNECTION_WRITE_FAILED
120 // Return the command string that was transmitted
125 * Overrides the parent class to set the currently active socket handler
126 * when the active connection is changed.
128 * @param Phergie_Connection $connection Active connection
130 * @return Phergie_Driver_Streams Provides a fluent interface
132 public function setConnection(Phergie_Connection $connection)
134 // Set the active socket handler
135 $hostmask = (string) $connection->getHostmask();
136 if (!empty($this->sockets[$hostmask])) {
137 $this->socket = $this->sockets[$hostmask];
140 // Set the active connection
141 return parent::setConnection($connection);
145 * Returns a list of hostmasks corresponding to sockets with data to read.
147 * @param int $sec Length of time to wait for new data (seconds)
148 * @param int $usec Length of time to wait for new data (microseconds)
150 * @return array List of hostmasks or an empty array if none were found
151 * to have data to read
153 public function getActiveReadSockets($sec = 0, $usec = 200000)
155 $read = $this->sockets;
160 if (count($this->sockets) > 0) {
161 $number = stream_select($read, $write, $error, $sec, $usec);
163 foreach ($read as $item) {
164 $active[] = array_search($item, $this->sockets);
173 * Sets the amount of time to wait for a new event each time the socket
176 * @param float $timeout Amount of time in seconds
178 * @return Phergie_Driver_Streams Provides a fluent interface
180 public function setTimeout($timeout)
182 $timeout = (float) $timeout;
184 $this->timeout = $timeout;
190 * Returns the amount of time to wait for a new event each time the
193 * @return float Amount of time in seconds
195 public function getTimeout()
197 return $this->timeout;
201 * Supporting method to parse event argument strings where the last
202 * argument may contain a colon.
204 * @param string $args Argument string to parse
205 * @param int $count Optional maximum number of arguments
207 * @return array Array of argument values
209 protected function parseArguments($args, $count = -1)
211 return preg_split('/ :?/S', $args, $count);
215 * Listens for an event on the current connection.
217 * @return Phergie_Event_Interface|null Event instance if an event was
218 * received, NULL otherwise
220 public function getEvent()
222 // Check the socket is still active
223 if (feof($this->socket)) {
224 throw new Phergie_Driver_Exception(
225 'EOF detected on socket',
226 Phergie_Driver_Exception::ERR_CONNECTION_READ_FAILED
230 // Check for a new event on the current connection
231 $buffer = fgets($this->socket, 512);
233 // If no new event was found, return NULL
234 if (empty($buffer)) {
238 // Strip the trailing newline from the buffer
239 $buffer = rtrim($buffer);
241 // If the event is from the server...
242 if (substr($buffer, 0, 1) != ':') {
244 // Parse the command and arguments
245 list($cmd, $args) = array_pad(explode(' ', $buffer, 2), 2, null);
248 // If the event could be from the server or a user...
250 // Parse the server hostname or user hostmask, command, and arguments
251 list($prefix, $cmd, $args)
252 = array_pad(explode(' ', ltrim($buffer, ':'), 3), 3, null);
253 if (strpos($prefix, '@') !== false) {
254 $hostmask = Phergie_Hostmask::fromString($prefix);
256 $hostmask = new Phergie_Hostmask(null, null, $prefix);
260 // Parse the event arguments depending on the event type
261 $cmd = strtolower($cmd);
269 $args = array(ltrim($args, ':'));
274 $args = $this->parseArguments($args, 2);
275 list($source, $ctcp) = $args;
276 if (substr($ctcp, 0, 1) === "\001" && substr($ctcp, -1) === "\001") {
277 $ctcp = substr($ctcp, 1, -1);
278 $reply = ($cmd == 'notice');
279 list($cmd, $args) = array_pad(explode(' ', $ctcp, 2), 2, null);
280 $cmd = strtolower($cmd);
297 $args = array($source, $args);
305 $args = array($source, $args);
314 $args = $this->parseArguments($args);
320 $args = $this->parseArguments($args, 2);
324 $args = $this->parseArguments($args, 3);
327 // Remove the target from responses
329 $args = substr($args, strpos($args, ' ') + 1);
333 // Create, populate, and return an event object
334 if (ctype_digit($cmd)) {
335 $event = new Phergie_Event_Response;
338 ->setDescription($args);
340 $event = new Phergie_Event_Request;
343 ->setArguments($args);
344 if (isset($hostmask)) {
345 $event->setHostmask($hostmask);
348 $event->setRawData($buffer);
353 * Initiates a connection with the server.
357 public function doConnect()
359 // Listen for input indefinitely
362 // Get connection information
363 $connection = $this->getConnection();
364 $hostname = $connection->getHost();
365 $port = $connection->getPort();
366 $password = $connection->getPassword();
367 $username = $connection->getUsername();
368 $nick = $connection->getNick();
369 $realname = $connection->getRealname();
370 $transport = $connection->getTransport();
372 // Establish and configure the socket connection
373 $remote = $transport . '://' . $hostname . ':' . $port;
374 $this->socket = @stream_socket_client($remote, $errno, $errstr);
375 if (!$this->socket) {
376 throw new Phergie_Driver_Exception(
377 'Unable to connect: socket error ' . $errno . ' ' . $errstr,
378 Phergie_Driver_Exception::ERR_CONNECTION_ATTEMPT_FAILED
382 $seconds = (int) $this->timeout;
383 $microseconds = ($this->timeout - $seconds) * 1000000;
384 stream_set_timeout($this->socket, $seconds, $microseconds);
386 // Send the password if one is specified
387 if (!empty($password)) {
388 $this->send('PASS', $password);
391 // Send user information
402 $this->send('NICK', $nick);
404 // Add the socket handler to the internal array for socket handlers
405 $this->sockets[(string) $connection->getHostmask()] = $this->socket;
409 * Terminates the connection with the server.
411 * @param string $reason Reason for connection termination (optional)
415 public function doQuit($reason = null)
417 // Send a QUIT command to the server
418 $this->send('QUIT', $reason);
420 // Terminate the socket connection
421 fclose($this->socket);
423 // Remove the socket from the internal socket list
424 unset($this->sockets[(string) $this->getConnection()->getHostmask()]);
430 * @param string $channels Comma-delimited list of channels to join
431 * @param string $keys Optional comma-delimited list of channel keys
435 public function doJoin($channels, $keys = null)
437 $args = array($channels);
443 $this->send('JOIN', $args);
449 * @param string $channels Comma-delimited list of channels to leave
453 public function doPart($channels)
455 $this->send('PART', $channels);
459 * Invites a user to an invite-only channel.
461 * @param string $nick Nick of the user to invite
462 * @param string $channel Name of the channel
466 public function doInvite($nick, $channel)
468 $this->send('INVITE', array($nick, $channel));
472 * Obtains a list of nicks of usrs in currently joined channels.
474 * @param string $channels Comma-delimited list of one or more channels
478 public function doNames($channels)
480 $this->send('NAMES', $channels);
484 * Obtains a list of channel names and topics.
486 * @param string $channels Comma-delimited list of one or more channels
487 * to which the response should be restricted
492 public function doList($channels = null)
494 $this->send('LIST', $channels);
498 * Retrieves or changes a channel topic.
500 * @param string $channel Name of the channel
501 * @param string $topic New topic to assign (optional)
505 public function doTopic($channel, $topic = null)
507 $args = array($channel);
509 if (!empty($topic)) {
513 $this->send('TOPIC', $args);
517 * Retrieves or changes a channel or user mode.
519 * @param string $target Channel name or user nick
520 * @param string $mode New mode to assign (optional)
524 public function doMode($target, $mode = null)
526 $args = array($target);
532 $this->send('MODE', $args);
536 * Changes the client nick.
538 * @param string $nick New nick to assign
542 public function doNick($nick)
544 $this->send('NICK', $nick);
548 * Retrieves information about a nick.
550 * @param string $nick Nick
554 public function doWhois($nick)
556 $this->send('WHOIS', $nick);
560 * Sends a message to a nick or channel.
562 * @param string $target Channel name or user nick
563 * @param string $text Text of the message to send
567 public function doPrivmsg($target, $text)
569 $this->send('PRIVMSG', array($target, $text));
573 * Sends a notice to a nick or channel.
575 * @param string $target Channel name or user nick
576 * @param string $text Text of the notice to send
580 public function doNotice($target, $text)
582 $this->send('NOTICE', array($target, $text));
586 * Kicks a user from a channel.
588 * @param string $nick Nick of the user
589 * @param string $channel Channel name
590 * @param string $reason Reason for the kick (optional)
594 public function doKick($nick, $channel, $reason = null)
596 $args = array($nick, $channel);
598 if (!empty($reason)) {
602 $this->send('KICK', $args);
606 * Responds to a server test of client responsiveness.
608 * @param string $daemon Daemon from which the original request originates
612 public function doPong($daemon)
614 $this->send('PONG', $daemon);
618 * Sends a CTCP ACTION (/me) command to a nick or channel.
620 * @param string $target Channel name or user nick
621 * @param string $text Text of the action to perform
625 public function doAction($target, $text)
627 $buffer = rtrim('ACTION ' . $text);
629 $this->doPrivmsg($target, chr(1) . $buffer . chr(1));
633 * Sends a CTCP response to a user.
635 * @param string $nick User nick
636 * @param string $command Command to send
637 * @param string|array $args String or array of sequential arguments
642 protected function doCtcp($nick, $command, $args = null)
644 if (is_array($args)) {
645 $args = implode(' ', $args);
648 $buffer = rtrim(strtoupper($command) . ' ' . $args);
650 $this->doNotice($nick, chr(1) . $buffer . chr(1));
654 * Sends a CTCP PING request or response (they are identical) to a user.
656 * @param string $nick User nick
657 * @param string $hash Hash to use in the handshake
661 public function doPing($nick, $hash)
663 $this->doCtcp($nick, 'PING', $hash);
667 * Sends a CTCP VERSION request or response to a user.
669 * @param string $nick User nick
670 * @param string $version Version string to send for a response
674 public function doVersion($nick, $version = null)
677 $this->doCtcp($nick, 'VERSION', $version);
679 $this->doCtcp($nick, 'VERSION');
684 * Sends a CTCP TIME request to a user.
686 * @param string $nick User nick
687 * @param string $time Time string to send for a response
691 public function doTime($nick, $time = null)
694 $this->doCtcp($nick, 'TIME', $time);
696 $this->doCtcp($nick, 'TIME');
701 * Sends a CTCP FINGER request to a user.
703 * @param string $nick User nick
704 * @param string $finger Finger string to send for a response
708 public function doFinger($nick, $finger = null)
711 $this->doCtcp($nick, 'FINGER', $finger);
713 $this->doCtcp($nick, 'FINGER');
718 * Sends a raw command to the server.
720 * @param string $command Command string to send
724 public function doRaw($command)
726 $this->send('RAW', $command);