Changeset 166

Timestamp:

03/11/08 21:58:10 (5 years ago)

Author:

Slynderdale

Message:

Added full CTCP as well as raw handlers. onRaw is called every time Phergie gets a response from the server and $this->event->getRawBuffer(); can be used to get the raw buffer from the server. On the CTCP support end, I added onVersion, onTime, onCtcp and also made it so both server pings and CTCP pings get handled by onPing. If the first argument is set in onPing, then its a CTCP ping. I also added onVersionreply, onTimereply, onPingreply and onCtcpreply as well.

Location:

trunk/Phergie

Files:

• Driver/Streams.php (modified) (10 diffs)
• Event/Request.php (modified) (8 diffs)
• Event/Response.php (modified) (2 diffs)
• Plugin/Abstract/Base.php (modified) (4 diffs)
• Plugin/Abstract/Cron.php (modified) (1 diff)
• Plugin/Ctcp.php (added)
• Plugin/Debug.php (modified) (2 diffs)
• Plugin/FeedTicker.php (modified) (2 diffs)
• Plugin/Pong.php (modified) (1 diff)

trunk/Phergie/Driver/Streams.php

@@ -75 +75 @@
 
     /**
+    * The time the bot started
+    *
+    * @var int
+    */
+    protected $startTime;
+
+    /**
     * Constructor to initialize instance properties.
     */
@@ -120 +127 @@
 
     /**
+    * Returns the start time.
+    *
+    * @return int
+    */
+    public function getStartTime()
+    {
+        return $this->startTime;
+    }
+
+    /**
     * Executes a continuous loop in which the client listens for events from
     * the server and processes them until the connection is terminated.
@@ -127 +144 @@
     public function run()
     {
+        $this->startTime = time();
         $returnCode = $this->getIni('keepalive') ? self::RETURN_KEEPALIVE : self::RETURN_END;
         $server = $this->getIni('server');
@@ -226 +244 @@
                     break;
                 case 'notice':
-                    $args = explode(' :', $args);
+                    $temp = preg_split('/ :?/', trim($args), 2);
+                    if(substr($temp[1], 0, 1) === chr(1) && substr($temp[1], -1) === chr(1)) {
+                        $ctcp = trim(substr($temp[1], 1, -1));
+                            list ($cmd, $args) = explode(' ', $ctcp.' ', 2);
+                        $cmd = strtolower($cmd);
+
+                       // Check for the type of Notice message and handle it accordingly
+                       if ($cmd == 'action') {
+                           // Return sender as source and the action as its first argument
+                           $args = array($nick, trim($args));
+                       } elseif ($cmd == 'ping' || $cmd == 'version' || $cmd == 'time') {
+                           // Return sender as source and the rest of the args as its first argument
+                           $cmd = $cmd.'reply';
+                           $args = array($nick, trim($args));
+                       } else {
+                           // Return sender as source and the ctcp as its first argument
+                           $cmd = 'ctcpreply';
+                           $args = array($nick, $ctcp);
+                       }
+                    } else {
+                        $args = preg_split('/ :?/', $args, 2);
+                    }
                     break;
                 case 'oper':
@@ -240 +279 @@
                     break;
                 case 'privmsg':
-                    if ($args[0] == chr(1)) {
-                        /**
-                        * This will likely need to be changed if support is added
-                        * for CTCP commands other than ACTION.
-                        */
-                        list ($target, $args) = explode(' ', $args, 2);
-                        $args = explode(' ', substr($args, 1, -1), 2);
-                        $cmd = strtolower(array_shift($args));
-                        array_unshift($args, $target);
+                    $temp = preg_split('/ :?/', trim($args), 2);
+                    // Check to see if its a CTCP request, if so, handle it accordingly
+                    if(substr($temp[1], 0, 1) === chr(1) && substr($temp[1], -1) === chr(1)) {
+                        $ctcp = trim(substr($temp[1], 1, -1));
+                            list ($cmd, $args) = explode(' ', $ctcp.' ', 2);
+                        $cmd = strtolower($cmd);
+
+                       // Check for the type of CTCP message and handle it accordingly
+                       if ($cmd == 'action') {
+                           $botnick = $this->getIni('nick');
+                           // If sent within a channel, use the chanel as the source, else use the sender
+                           $source = (strtolower($temp[0]) == strtolower($botnick) ? $nick : $temp[0]);
+                           // Return channel/sender as source and the action as its first argument
+                           $args = array($source, trim($args));
+                       } elseif ($cmd == 'ping' && !empty($args)) {
+                           // Return nick of sender as source and the handshake as its first argument
+                           $args = array($nick, trim($args));
+                       } elseif (($cmd == 'version' || $cmd == 'time') && empty($args)) {
+                           // Return nick of sender as source and the ctcp as its first argument
+                           $args = array($nick, $ctcp);
+                       } else {
+                           // Return nick of sender as source and the ctcp as its first argument
+                           $cmd = 'ctcp';
+                           $args = array($nick, $ctcp);
+                       }
                     } else {
-                        $args = explode(' :', $args, 2);
+                        $args = preg_split('/ :?/', $args, 2);
                     }
                     break;
@@ -259 +314 @@
                 $event->setCode($cmd);
                 $event->setDescription($args);
+                $event->setRawBuffer($buffer);
             } else {
                 $event = new Phergie_Event_Request();
@@ -268 +324 @@
                     $event->setNick($nick);
                 }
+                $event->setRawBuffer($buffer);
             }
 
@@ -282 +339 @@
                     call_user_func(array($plugin, 'on' . ucfirst($event->getType())));
                 }
+                // onRaw Handler
+                $plugin->onRaw();
             }
             $this->queueing = false;
@@ -534 +593 @@
     *                         (optional)
     */
-    protected function sendCtcp($target, $command, array $arguments = array())
-    {
-        $this->doPrivmsg($target, chr(1) . strtoupper($command) . ' ' . implode(' ', $arguments) . chr(1));
+    public function doCtcp($target, $command, $arguments = '')
+    {
+        if (is_array($arguments)) {
+            $arguments = implode(' ', $arguments);
+        }
+        $this->doPrivmsg($target, chr(1) . trim(strtoupper($command) . ' ' . $arguments) . chr(1));
     }
 
@@ -547 +609 @@
     public function doAction($target, $text)
     {
-        $this->sendCtcp($target, Phergie_Event_Request::TYPE_ACTION, array($text));
+        $this->doCtcp($target, Phergie_Event_Request::TYPE_ACTION, array($text));
+    }
+
+    /**
+    * Sends a ping reply to a nick.
+    *
+    * @param string $target User nickname
+    * @param string $hash The ping hash to use in the handshake
+    */
+    public function doPingReply($target, $hash)
+    {
+        $this->doCtcpReply($target, 'ping', $hash);
+    }
+
+    /**
+    * Sends a version reply to a nick.
+    *
+    * @param string $target User nickname
+    * @param string $version The version to send
+    */
+    public function doVersionReply($target, $version='')
+    {
+        $version = trim($version);
+        if (empty($version)) {
+                $version = 'Phergie '.PHERGIE_VERSION.' - An IRC bot written in PHP (http://www.phergie.com)';
+        }
+        $this->doCtcpReply($target, 'version', $version);
+    }
+
+    /**
+    * Sends a time reply to a nick
+    *
+    * @param string $target User nickname
+    * @param string $time The time to send
+    */
+    public function doTimeReply($target, $time='')
+    {
+        $time = trim($time);
+        if (empty($time) || ctype_digit($time)) {
+            if (empty($time)) $time = time();
+            $time = date('D M d H:i:s o', $time);
+        }
+        $this->doCtcpReply($target, 'time', $time);
+    }
+
+    /**
+    * Sends a ctcp reply to a nick
+    *
+    * @param string $target User nickname
+    * @param string $reply The CTCP reply to send
+    */
+    public function doCtcpReply($target, $command, $reply='')
+    {
+        $command = trim($command);
+        if (empty($command))
+            return;
+        $this->send(Phergie_Event_Request::TYPE_NOTICE, array($target, chr(1).trim(strtoupper($command).' '.$reply).chr(1)));
     }
 }

trunk/Phergie/Event/Request.php

@@ -86 +86 @@
 
     /**
-    * Mapping of event types to their named parameters 
+    * Mapping of event types to their named parameters
     *
     * @var array
@@ -99 +99 @@
             'channel' => 0
         ),
-        
+
         self::TYPE_KICK => array(
             'channel' => 0,
@@ -115 +115 @@
             'limit'    => 2,
             'user'     => 3,
-            'banmask' => 4 
+            'banmask' => 4
         ),
 
@@ -132 +132 @@
             'text'     => 1
         ),
-            
+
         self::TYPE_ACTION => array(
             'target' => 0,
@@ -173 +173 @@
     */
     protected $arguments;
+
+    /**
+    * The raw buffer that was sent by the server
+    *
+    * @var string
+    */
+    protected $rawBuffer;
 
     /**
@@ -314 +321 @@
 
     /**
+    * Sets the raw buffer for the given event
+    *
+    * @param string $buffer
+    * @return void
+    */
+    public function setRawBuffer($buffer)
+    {
+        $this->rawBuffer = $buffer;
+    }
+
+    /**
+    * Returns the raw buffer that was sent from the server for that event
+    *
+    * @return string
+    */
+    public function getRawBuffer()
+    {
+        return $this->rawBuffer;
+    }
+
+    /**
     * Returns the channel name or user nick representing the source of the
     * event.
@@ -361 +389 @@
     *
     * @param string $name Name of the method called
-    * @param array $arguments Arguments passed to the method (should always 
+    * @param array $arguments Arguments passed to the method (should always
     *                         be empty)
     * @return mixed
@@ -369 +397 @@
         if (count($arguments) == 0
             && substr($name, 0, 3) == 'get') {
-            return $this->getArgument(substr($name, 3)); 
+            return $this->getArgument(substr($name, 3));
         }
     }

trunk/Phergie/Event/Response.php

@@ -846 +846 @@
 
     /**
+    * The raw buffer that was sent by the server
+    *
+    * @var string
+    */
+    protected $rawBuffer;
+
+    /**
     * Sets the reply code sent by the server.
     *
@@ -884 +891 @@
         return $this->description;
     }
+
+    /**
+    * Sets the raw buffer for the given event
+    *
+    * @param string $buffer
+    * @return void
+    */
+    public function setRawBuffer($buffer)
+    {
+        $this->rawBuffer = $buffer;
+    }
+
+    /**
+    * Returns the raw buffer that was sent from the server for that event
+    *
+    * @return string
+    */
+    public function getRawBuffer()
+    {
+        return $this->rawBuffer;
+    }
 }

trunk/Phergie/Plugin/Abstract/Base.php

@@ -370 +370 @@
 
     /**
+    * Converts a given integer/timestamp into days, minutes and seconds
+    *
+    * @param int $time The time/integer to calulate the values from
+    * @return string
+    */
+    public function getCountdown($time)
+    {
+        $return = array();
+
+        $days = floor($time / 86400);
+        if ($days > 0) {
+            $return[] = $days . 'd';
+            $time = $time % 86400;
+        }
+
+        $hours = floor($time / 3600);
+        if ($hours > 0) {
+            $return[] = $hours . 'h';
+            $time = $time % 3600;
+        }
+
+        $minutes = floor($time / 60);
+        if ($minutes > 0) {
+            $return[] = $minutes . 'm';
+            $time = $time % 60;
+        }
+
+        $return[] = $time . 's';
+
+        return implode(' ', $return);
+    }
+
+    /**
     * Returns whether or not the current environment meets the requirements
     * of the plugin in order for it to be run, including the PHP version,
@@ -458 +491 @@
 
     /**
+    * Handler for when an action is received from a channel or user
+    *
+    * @return void
+    */
+    public function onAction() { }
+
+    /**
     * Handler for when a notice is received.
     *
@@ -472 +512 @@
 
     /**
-    * Handler for when the server checks the client connection to ensure
-    * activity.
+    * Handler for when the server or a userchecks the client connection to
+    * ensure activity.
     *
     * @return void
     */
     public function onPing() { }
+
+    /**
+    * Handler for when the server sends a CTCP Time request
+    *
+    * @return void
+    */
+    public function onTime() { }
+
+    /**
+    * Handler for when the server sends a CTCP Version request
+    *
+    * @return void
+    */
+    public function onVersion() { }
+
+    /**
+    * Handler for when the server sends a CTCP request
+    *
+    * @return void
+    */
+    public function onCtcp() { }
+
+    /**
+    * Handler for the reply received when a ping CTCP is sent
+    *
+    *
+    * @return void
+    */
+    public function onPingreply() { }
+
+    /**
+    * Handler for the reply received when a time CTCP is sent
+    *
+    * @return void
+    */
+    public function onTimereply() { }
+
+    /**
+    * Handler for the reply received when a version CTCP is sent
+    *
+    * @return void
+    */
+    public function onVersionreply() { }
+
+    /**
+    * Handler for the reply received when a CTCP is sent
+    *
+    * @return void
+    */
+    public function onCtcpreply() { }
+
+    /**
+    * Handler for raw requests from the server
+    *
+    * @return void
+    */
+    public function onRaw() { }
 
     /**
@@ -512 +609 @@
                 return false;
         }
+
         return call_user_func_array(array($this->client, $method), $arguments);
     }

trunk/Phergie/Plugin/Abstract/Cron.php

@@ -64 +64 @@
 
     /**
-    * Checks to see if the run method should be called when a PING event
+    * Checks to see if the run method should be called when a raw event
     * occurs.
     *
     * @return void
     */
-    public function onPing()
-    {
-        $this->check();
-    }
-
-    /**
-    * Checks to see if the run method should be called when a message is
-    * received.
-    *
-    * @return void
-    */
-    public function onPrivmsg()
+    public function onRaw()
     {
         $this->check();

trunk/Phergie/Plugin/Debug.php

@@ -12 +12 @@
 class Phergie_Plugin_Debug extends Phergie_Plugin_Abstract_AdminCommand
 {
-    /**
-    * Timestamp used to calculate uptime
-    *
-    * @var int
-    */
-    protected $uptime;
-
-    /**
-    * Initializes a local timestamp used to calculate uptime.
-    *
-    * @return void
-    */
-    public function init()
-    {
-        parent::init();
-
-        $this->uptime = time();
-    }
-
     /**
     * Responds to requests for statistics related to the bot's memory
@@ -52 +33 @@
     public function onDoUptime()
     {
-        $diff = time() - $this->uptime;
-        $uptime = array();
-
-        $days = floor($diff / 86400);
-        if ($days > 0) {
-            $uptime[] = $days . 'd';
-            $diff = $diff % 86400;
-        }
-
-        $hours = floor($diff / 3600);
-        if ($hours > 0) {
-            $uptime[] = $hours . 'h';
-            $diff = $diff % 3600;
-        }
-
-        $minutes = floor($diff / 60);
-        if ($minutes > 0) {
-            $uptime[] = $minutes . 'm';
-            $diff = $diff % 60;
-        }
-
-        $uptime[] = $diff . 's';
-
-        $uptime = 'uptime : ' . implode(' ', $uptime);
+        $uptime = 'Uptime: ' . $this->getCountdown(time() - $this->getStartTime());
 
         $this->doPrivmsg($this->event->getSource(), $uptime);

trunk/Phergie/Plugin/FeedTicker.php

@@ -122 +122 @@
 
     /**
-    * Overrides Cron method to add checkQueue to this, so that whenever a user
-    * sends a message to a channel in which the bot is present, the queue is
-    * checked. This behavior attempts to prevent the bot from spamming the
-    * channel if no users are conversing and everything is retained in the
-    * queue until channel activity is detected.
+    * Whenever a user sends a message to a channel in which the bot is present,
+    * the queue is checked. This behavior attempts to prevent the bot from
+    * spamming the channel if no users are conversing and everything is retained
+    * in the queue until channel activity is detected.
     *
     * @return void
@@ -132 +131 @@
     public function onPrivmsg()
     {
-        parent::onPrivmsg();
-
         $this->checkQueue();
     }

trunk/Phergie/Plugin/Pong.php

@@ -20 +20 @@
     public function onPing()
     {
-        $this->doPong($this->event->getArgument(0));
+        // Check for a handshake hash, otherwise its a server ping request
+        if (!$this->event->getArgument(1)) {
+            $this->doPong($this->event->getArgument(0));
+        }
     }
 }