plugins/Irc/extlib/phergie/Phergie/Driver/Streams.php

   1 <?php
   2 /**
   3  * Phergie
   4  *
   5  * PHP version 5
   6  *
   7  * LICENSE
   8  *
   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
  13  *
  14  * @category  Phergie
  15  * @package   Phergie
  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
  20  */
  21
  22 /**
  23  * Driver that uses the sockets wrapper of the streams extension for
  24  * communicating with the server and handles formatting and parsing of
  25  * events using PHP.
  26  *
  27  * @category Phergie
  28  * @package  Phergie
  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
  32  */
  33 class Phergie_Driver_Streams extends Phergie_Driver_Abstract
  34 {
  35     /**
  36      * Socket handlers
  37      *
  38      * @var array
  39      */
  40     protected $sockets = array();
  41
  42     /**
  43      * Reference to the currently active socket handler
  44      *
  45      * @var resource
  46      */
  47     protected $socket;
  48
  49     /**
  50      * Amount of time in seconds to wait to receive an event each time the
  51      * socket is polled
  52      *
  53      * @var float
  54      */
  55     protected $timeout = 0.1;
  56
  57     /**
  58      * Handles construction of command strings and their transmission to the
  59      * server.
  60      *
  61      * @param string       $command Command to send
  62      * @param string|array $args    Optional string or array of sequential
  63      *        arguments
  64      *
  65      * @return string Command string that was sent
  66      * @throws Phergie_Driver_Exception
  67      */
  68     protected function send($command, $args = '')
  69     {
  70         $connection = $this->getConnection();
  71         $encoding = $connection->getEncoding();
  72
  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
  78             );
  79         }
  80
  81         // Add the command
  82         $buffer = strtoupper($command);
  83
  84         // Add arguments
  85         if (!empty($args)) {
  86
  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);
  92             } else {
  93                 $args = ':' . $args;
  94             }
  95
  96             $buffer .= ' ' . $args;
  97         }
  98
  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);
 104         while (true) {
 105             $written += (int) fwrite($this->socket, $temp);
 106             if ($written < $length) {
 107                 $temp = substr($temp, $written);
 108                 $attempts++;
 109                 if ($attempts == 3) {
 110                     throw new Phergie_Driver_Exception(
 111                         'Unable to write to socket',
 112                         Phergie_Driver_Exception::ERR_CONNECTION_WRITE_FAILED
 113                     );
 114                 }
 115             } else {
 116                 break;
 117             }
 118         }
 119
 120         // Return the command string that was transmitted
 121         return $buffer;
 122     }
 123
 124     /**
 125      * Overrides the parent class to set the currently active socket handler
 126      * when the active connection is changed.
 127      *
 128      * @param Phergie_Connection $connection Active connection
 129      *
 130      * @return Phergie_Driver_Streams Provides a fluent interface
 131      */
 132     public function setConnection(Phergie_Connection $connection)
 133     {
 134         // Set the active socket handler
 135         $hostmask = (string) $connection->getHostmask();
 136         if (!empty($this->sockets[$hostmask])) {
 137             $this->socket = $this->sockets[$hostmask];
 138         }
 139
 140         // Set the active connection
 141         return parent::setConnection($connection);
 142     }
 143
 144     /**
 145      * Returns a list of hostmasks corresponding to sockets with data to read.
 146      *
 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)
 149      *
 150      * @return array List of hostmasks or an empty array if none were found
 151      *         to have data to read
 152      */
 153     public function getActiveReadSockets($sec = 0, $usec = 200000)
 154     {
 155         $read = $this->sockets;
 156         $write = null;
 157         $error = null;
 158         $active = array();
 159
 160         if (count($this->sockets) > 0) {
 161             $number = stream_select($read, $write, $error, $sec, $usec);
 162             if ($number > 0) {
 163                 foreach ($read as $item) {
 164                     $active[] = array_search($item, $this->sockets);
 165                 }
 166             }
 167         }
 168
 169         return $active;
 170     }
 171
 172     /**
 173      * Sets the amount of time to wait for a new event each time the socket
 174      * is polled.
 175      *
 176      * @param float $timeout Amount of time in seconds
 177      *
 178      * @return Phergie_Driver_Streams Provides a fluent interface
 179      */
 180     public function setTimeout($timeout)
 181     {
 182         $timeout = (float) $timeout;
 183         if ($timeout) {
 184             $this->timeout = $timeout;
 185         }
 186         return $this;
 187     }
 188
 189     /**
 190      * Returns the amount of time to wait for a new event each time the
 191      * socket is polled.
 192      *
 193      * @return float Amount of time in seconds
 194      */
 195     public function getTimeout()
 196     {
 197         return $this->timeout;
 198     }
 199
 200     /**
 201      * Supporting method to parse event argument strings where the last
 202      * argument may contain a colon.
 203      *
 204      * @param string $args  Argument string to parse
 205      * @param int    $count Optional maximum number of arguments
 206      *
 207      * @return array Array of argument values
 208      */
 209     protected function parseArguments($args, $count = -1)
 210     {
 211         return preg_split('/ :?/S', $args, $count);
 212     }
 213
 214     /**
 215      * Listens for an event on the current connection.
 216      *
 217      * @return Phergie_Event_Interface|null Event instance if an event was
 218      *         received, NULL otherwise
 219      */
 220     public function getEvent()
 221     {
 222         // Check for a new event on the current connection
 223         $buffer = fgets($this->socket, 512);
 224
 225         // If no new event was found, return NULL
 226         if (empty($buffer)) {
 227             return null;
 228         }
 229
 230         // Strip the trailing newline from the buffer
 231         $buffer = rtrim($buffer);
 232
 233         // If the event is from the server...
 234         if (substr($buffer, 0, 1) != ':') {
 235
 236             // Parse the command and arguments
 237             list($cmd, $args) = array_pad(explode(' ', $buffer, 2), 2, null);
 238
 239         } else {
 240             // If the event could be from the server or a user...
 241
 242             // Parse the server hostname or user hostmask, command, and arguments
 243             list($prefix, $cmd, $args)
 244                 = array_pad(explode(' ', ltrim($buffer, ':'), 3), 3, null);
 245             if (strpos($prefix, '@') !== false) {
 246                 $hostmask = Phergie_Hostmask::fromString($prefix);
 247             }
 248         }
 249
 250         // Parse the event arguments depending on the event type
 251         $cmd = strtolower($cmd);
 252         switch ($cmd) {
 253         case 'names':
 254         case 'nick':
 255         case 'quit':
 256         case 'ping':
 257         case 'join':
 258         case 'error':
 259             $args = array(ltrim($args, ':'));
 260             break;
 261
 262         case 'privmsg':
 263         case 'notice':
 264             $ctcp = substr(strstr($args, ':'), 1);
 265             if (substr($ctcp, 0, 1) === "\x01" && substr($ctcp, -1) === "\x01") {
 266                 $ctcp = substr($ctcp, 1, -1);
 267                 $reply = ($cmd == 'notice');
 268                 list($cmd, $args) = array_pad(explode(' ', $ctcp, 2), 2, null);
 269                 $cmd = strtolower($cmd);
 270                 switch ($cmd) {
 271                 case 'version':
 272                 case 'time':
 273                 case 'finger':
 274                     if ($reply) {
 275                         $args = $ctcp;
 276                     }
 277                     break;
 278                 case 'ping':
 279                     if ($reply) {
 280                         $cmd .= 'Response';
 281                     } else {
 282                         $cmd = 'ctcpPing';
 283                     }
 284                     break;
 285                 case 'action':
 286                     $args = array($this->getConnection()->getNick(), $args);
 287                     break;
 288
 289                 default:
 290                     $cmd = 'ctcp';
 291                     if ($reply) {
 292                         $cmd .= 'Response';
 293                     }
 294                     $args = array($this->getConnection()->getNick(), $ctcp);
 295                     break;
 296                 }
 297             } else {
 298                 $args = $this->parseArguments($args, 2);
 299             }
 300             break;
 301
 302         case 'oper':
 303         case 'topic':
 304         case 'mode':
 305             $args = $this->parseArguments($args);
 306             break;
 307
 308         case 'part':
 309         case 'kill':
 310         case 'invite':
 311             $args = $this->parseArguments($args, 2);
 312             break;
 313
 314         case 'kick':
 315             $args = $this->parseArguments($args, 3);
 316             break;
 317
 318         // Remove the target from responses
 319         default:
 320             $args = substr($args, strpos($args, ' ') + 1);
 321             break;
 322         }
 323
 324         // Create, populate, and return an event object
 325         if (ctype_digit($cmd)) {
 326             $event = new Phergie_Event_Response;
 327             $event
 328                 ->setCode($cmd)
 329                 ->setDescription($args);
 330         } else {
 331             $event = new Phergie_Event_Request;
 332             $event
 333                 ->setType($cmd)
 334                 ->setArguments($args);
 335             if (isset($hostmask)) {
 336                 $event->setHostmask($hostmask);
 337             }
 338         }
 339         $event->setRawData($buffer);
 340         return $event;
 341     }
 342
 343     /**
 344      * Initiates a connection with the server.
 345      *
 346      * @return void
 347      */
 348     public function doConnect()
 349     {
 350         // Listen for input indefinitely
 351         set_time_limit(0);
 352
 353         // Get connection information
 354         $connection = $this->getConnection();
 355         $hostname = $connection->getHost();
 356         $port = $connection->getPort();
 357         $password = $connection->getPassword();
 358         $username = $connection->getUsername();
 359         $nick = $connection->getNick();
 360         $realname = $connection->getRealname();
 361         $transport = $connection->getTransport();
 362
 363         // Establish and configure the socket connection
 364         $remote = $transport . '://' . $hostname . ':' . $port;
 365         $this->socket = @stream_socket_client($remote, $errno, $errstr);
 366         if (!$this->socket) {
 367             throw new Phergie_Driver_Exception(
 368                 'Unable to connect: socket error ' . $errno . ' ' . $errstr,
 369                 Phergie_Driver_Exception::ERR_CONNECTION_ATTEMPT_FAILED
 370             );
 371         }
 372
 373         $seconds = (int) $this->timeout;
 374         $microseconds = ($this->timeout - $seconds) * 1000000;
 375         stream_set_timeout($this->socket, $seconds, $microseconds);
 376
 377         // Send the password if one is specified
 378         if (!empty($password)) {
 379             $this->send('PASS', $password);
 380         }
 381
 382         // Send user information
 383         $this->send(
 384             'USER',
 385             array(
 386                 $username,
 387                 $hostname,
 388                 $hostname,
 389                 $realname
 390             )
 391         );
 392
 393         $this->send('NICK', $nick);
 394
 395         // Add the socket handler to the internal array for socket handlers
 396         $this->sockets[(string) $connection->getHostmask()] = $this->socket;
 397     }
 398
 399     /**
 400      * Terminates the connection with the server.
 401      *
 402      * @param string $reason Reason for connection termination (optional)
 403      *
 404      * @return void
 405      */
 406     public function doQuit($reason = null)
 407     {
 408         // Send a QUIT command to the server
 409         $this->send('QUIT', $reason);
 410
 411         // Terminate the socket connection
 412         fclose($this->socket);
 413
 414         // Remove the socket from the internal socket list
 415         unset($this->sockets[(string) $this->getConnection()->getHostmask()]);
 416     }
 417
 418     /**
 419      * Joins a channel.
 420      *
 421      * @param string $channels Comma-delimited list of channels to join
 422      * @param string $keys     Optional comma-delimited list of channel keys
 423      *
 424      * @return void
 425      */
 426     public function doJoin($channels, $keys = null)
 427     {
 428         $args = array($channels);
 429
 430         if (!empty($keys)) {
 431             $args[] = $keys;
 432         }
 433
 434         $this->send('JOIN', $args);
 435     }
 436
 437     /**
 438      * Leaves a channel.
 439      *
 440      * @param string $channels Comma-delimited list of channels to leave
 441      *
 442      * @return void
 443      */
 444     public function doPart($channels)
 445     {
 446         $this->send('PART', $channels);
 447     }
 448
 449     /**
 450      * Invites a user to an invite-only channel.
 451      *
 452      * @param string $nick    Nick of the user to invite
 453      * @param string $channel Name of the channel
 454      *
 455      * @return void
 456      */
 457     public function doInvite($nick, $channel)
 458     {
 459         $this->send('INVITE', array($nick, $channel));
 460     }
 461
 462     /**
 463      * Obtains a list of nicks of usrs in currently joined channels.
 464      *
 465      * @param string $channels Comma-delimited list of one or more channels
 466      *
 467      * @return void
 468      */
 469     public function doNames($channels)
 470     {
 471         $this->send('NAMES', $channels);
 472     }
 473
 474     /**
 475      * Obtains a list of channel names and topics.
 476      *
 477      * @param string $channels Comma-delimited list of one or more channels
 478      *                         to which the response should be restricted
 479      *                         (optional)
 480      *
 481      * @return void
 482      */
 483     public function doList($channels = null)
 484     {
 485         $this->send('LIST', $channels);
 486     }
 487
 488     /**
 489      * Retrieves or changes a channel topic.
 490      *
 491      * @param string $channel Name of the channel
 492      * @param string $topic   New topic to assign (optional)
 493      *
 494      * @return void
 495      */
 496     public function doTopic($channel, $topic = null)
 497     {
 498         $args = array($channel);
 499
 500         if (!empty($topic)) {
 501             $args[] = $topic;
 502         }
 503
 504         $this->send('TOPIC', $args);
 505     }
 506
 507     /**
 508      * Retrieves or changes a channel or user mode.
 509      *
 510      * @param string $target Channel name or user nick
 511      * @param string $mode   New mode to assign (optional)
 512      *
 513      * @return void
 514      */
 515     public function doMode($target, $mode = null)
 516     {
 517         $args = array($target);
 518
 519         if (!empty($mode)) {
 520             $args[] = $mode;
 521         }
 522
 523         $this->send('MODE', $args);
 524     }
 525
 526     /**
 527      * Changes the client nick.
 528      *
 529      * @param string $nick New nick to assign
 530      *
 531      * @return void
 532      */
 533     public function doNick($nick)
 534     {
 535         $this->send('NICK', $nick);
 536     }
 537
 538     /**
 539      * Retrieves information about a nick.
 540      *
 541      * @param string $nick Nick
 542      *
 543      * @return void
 544      */
 545     public function doWhois($nick)
 546     {
 547         $this->send('WHOIS', $nick);
 548     }
 549
 550     /**
 551      * Sends a message to a nick or channel.
 552      *
 553      * @param string $target Channel name or user nick
 554      * @param string $text   Text of the message to send
 555      *
 556      * @return void
 557      */
 558     public function doPrivmsg($target, $text)
 559     {
 560         $this->send('PRIVMSG', array($target, $text));
 561     }
 562
 563     /**
 564      * Sends a notice to a nick or channel.
 565      *
 566      * @param string $target Channel name or user nick
 567      * @param string $text   Text of the notice to send
 568      *
 569      * @return void
 570      */
 571     public function doNotice($target, $text)
 572     {
 573         $this->send('NOTICE', array($target, $text));
 574     }
 575
 576     /**
 577      * Kicks a user from a channel.
 578      *
 579      * @param string $nick    Nick of the user
 580      * @param string $channel Channel name
 581      * @param string $reason  Reason for the kick (optional)
 582      *
 583      * @return void
 584      */
 585     public function doKick($nick, $channel, $reason = null)
 586     {
 587         $args = array($nick, $channel);
 588
 589         if (!empty($reason)) {
 590             $args[] = $response;
 591         }
 592
 593         $this->send('KICK', $args);
 594     }
 595
 596     /**
 597      * Responds to a server test of client responsiveness.
 598      *
 599      * @param string $daemon Daemon from which the original request originates
 600      *
 601      * @return void
 602      */
 603     public function doPong($daemon)
 604     {
 605         $this->send('PONG', $daemon);
 606     }
 607
 608     /**
 609      * Sends a CTCP ACTION (/me) command to a nick or channel.
 610      *
 611      * @param string $target Channel name or user nick
 612      * @param string $text   Text of the action to perform
 613      *
 614      * @return void
 615      */
 616     public function doAction($target, $text)
 617     {
 618         $buffer = rtrim('ACTION ' . $text);
 619
 620         $this->doPrivmsg($target, chr(1) . $buffer . chr(1));
 621     }
 622
 623     /**
 624      * Sends a CTCP response to a user.
 625      *
 626      * @param string       $nick    User nick
 627      * @param string       $command Command to send
 628      * @param string|array $args    String or array of sequential arguments
 629      *        (optional)
 630      *
 631      * @return void
 632      */
 633     protected function doCtcp($nick, $command, $args = null)
 634     {
 635         if (is_array($args)) {
 636             $args = implode(' ', $args);
 637         }
 638
 639         $buffer = rtrim(strtoupper($command) . ' ' . $args);
 640
 641         $this->doNotice($nick, chr(1) . $buffer . chr(1));
 642     }
 643
 644     /**
 645      * Sends a CTCP PING request or response (they are identical) to a user.
 646      *
 647      * @param string $nick User nick
 648      * @param string $hash Hash to use in the handshake
 649      *
 650      * @return void
 651      */
 652     public function doPing($nick, $hash)
 653     {
 654         $this->doCtcp($nick, 'PING', $hash);
 655     }
 656
 657     /**
 658      * Sends a CTCP VERSION request or response to a user.
 659      *
 660      * @param string $nick    User nick
 661      * @param string $version Version string to send for a response
 662      *
 663      * @return void
 664      */
 665     public function doVersion($nick, $version = null)
 666     {
 667         if ($version) {
 668             $this->doCtcp($nick, 'VERSION', $version);
 669         } else {
 670             $this->doCtcp($nick, 'VERSION');
 671         }
 672     }
 673
 674     /**
 675      * Sends a CTCP TIME request to a user.
 676      *
 677      * @param string $nick User nick
 678      * @param string $time Time string to send for a response
 679      *
 680      * @return void
 681      */
 682     public function doTime($nick, $time = null)
 683     {
 684         if ($time) {
 685             $this->doCtcp($nick, 'TIME', $time);
 686         } else {
 687             $this->doCtcp($nick, 'TIME');
 688         }
 689     }
 690
 691     /**
 692      * Sends a CTCP FINGER request to a user.
 693      *
 694      * @param string $nick   User nick
 695      * @param string $finger Finger string to send for a response
 696      *
 697      * @return void
 698      */
 699     public function doFinger($nick, $finger = null)
 700     {
 701         if ($finger) {
 702             $this->doCtcp($nick, 'FINGER', $finger);
 703         } else {
 704             $this->doCtcp($nick, 'FINGER');
 705         }
 706     }
 707
 708     /**
 709      * Sends a raw command to the server.
 710      *
 711      * @param string $command Command string to send
 712      *
 713      * @return void
 714      */
 715     public function doRaw($command)
 716     {
 717         $this->send('RAW', $command);
 718     }
 719 }