Changeset 166

Timestamp:

03/11/08 21:58:10 (8 months 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.

Files:

• trunk/Phergie/Driver/Streams.php (modified) (10 diffs)
• trunk/Phergie/Event/Request.php (modified) (8 diffs)
• trunk/Phergie/Event/Response.php (modified) (2 diffs)
• trunk/Phergie/Plugin/Abstract/Base.php (modified) (4 diffs)
• trunk/Phergie/Plugin/Abstract/Cron.php (modified) (1 diff)
• trunk/Phergie/Plugin/Ctcp.php (added)
• trunk/Phergie/Plugin/Debug.php (modified) (2 diffs)
• trunk/Phergie/Plugin/FeedTicker.php (modified) (2 diffs)
• trunk/Phergie/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':
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-                    break;
-                case 'oper':
@@ -240 +279 @@
-                    break;
-                case 'privmsg':
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-                    } else {
-explode(' :
+preg_split('/ :?/
-                    }
-                    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)
-    */
-
-
-
+
+
+
+
+
+
-    }
-
@@ -547 +609 @@
-    public function doAction($target, $text)
-    {
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-    }
-}

trunk/Phergie/Event/Request.php

@@ -86 +86 @@
-
-    /**
- 
+
-    *
-    * @var array
@@ -99 +99 @@
-            'channel' => 0
-        ),
-
+
-        self::TYPE_KICK => array(
-            'channel' => 0,
@@ -115 +115 @@
-            'limit'    => 2,
-            'user'     => 3,
- 
+
-        ),
-
@@ -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
- 
+
-    *                         be empty)
-    * @return mixed
@@ -369 +397 @@
-        if (count($arguments) == 0
-            && substr($name, 0, 3) == 'get') {
- 
+
-        }
-    }

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 @@
-
-    /**
-checks the client connection to ensure
-
+or a userchecks the client connection to
+ensure 
-    *
-    * @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 @@
-
-    /**
-PING
+raw
-    * occurs.
-    *
-    * @return void
-    */
-
-
-
-
-
-
-
-
-
-
-
-
+
-    {
-        $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()
-    {
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
-
-        $this->doPrivmsg($this->event->getSource(), $uptime);

trunk/Phergie/Plugin/FeedTicker.php

@@ -122 +122 @@
-
-    /**
-
-
-
-
-
+
+
+
+
-    *
-    * @return void
@@ -132 +131 @@
-    public function onPrivmsg()
-    {
-        parent::onPrivmsg();
-
-        $this->checkQueue();
-    }

trunk/Phergie/Plugin/Pong.php

@@ -20 +20 @@
-    public function onPing()
-    {
-
+
+
+
+
-    }
-}