Changeset 2055

Timestamp:

02/15/2008 08:53:29 AM (11 months ago)

Author:

Shadowhand

Message:

Kobot can haz set_timer()!

Location:

trunk/modules/kobot

Files:

• controllers/kobot.php (modified) (2 diffs)
• i18n/en_US/kobot.php (modified) (1 diff)
• libraries/Kobot.php (modified) (7 diffs)

trunk/modules/kobot/controllers/kobot.php

@@ -12 +12 @@
 
                 // Add triggers
-                $bot->add_trigger('^goodnight, bot$', array($this, 'trigger_quit'))
-                    ->add_trigger('^tell (.+?) about (.+)$', array($this, 'trigger_say'))
-                    ->add_trigger('^([r|#])(\d+)$', array($this, 'trigger_trac'))
-                    ->add_trigger('^[a-z_]+$', array($this, 'trigger_default'));
+                $bot->set_trigger('^goodnight, bot$', array($this, 'trigger_quit'))
+                    ->set_trigger('^tell (.+?) about (.+)$', array($this, 'trigger_say'))
+                    ->set_trigger('^([r|#])(\d+)$', array($this, 'trigger_trac'))
+                    ->set_trigger('^[a-z_]+$', array($this, 'trigger_default'));
+
+                // Add timers
+                $bot->set_timer(5, array($this, 'say_hi'));
 
                 // Login and join the default channel
                 $bot->login('koboto');
                 $bot->join('#koboto');
+                $bot->read();
+        }
 
-                $bot->read();
+        public function say_hi(Kobot $bot)
+        {
+                // Say hello!
+                $bot->log(1, 'Just saying a timed hello!');
 
-                // $bot->send('PRIVMSG #koboto :Go away, Shadowhand!');
-                // $bot->quit('hahahaha');
+                // Only execute the timer once
+                $bot->remove_timer(array($this, __FUNCTION__));
         }
 
@@ -55 +63 @@
                 {
                         case '#':
-                                $bot->send('PRIVMSG '.$data['target'].' :Ticket #'.$params[2].' is http://trac.kohanaphp.com/ticket/'.$params[2]);
+                                $bot->send('PRIVMSG '.$data['target'].' :Ticket '.$params[2].', http://trac.kohanaphp.com/ticket/'.$params[2]);
                         break;
                         case 'r':
-                                $bot->send('PRIVMSG '.$data['target'].' :Revision r'.$params[2].' is http://trac.kohanaphp.com/changeset/'.$params[2]);
+                                $bot->send('PRIVMSG '.$data['target'].' :Revision '.$params[2].', http://trac.kohanaphp.com/changeset/'.$params[2]);
                         break;
                 }

trunk/modules/kobot/i18n/en_US/kobot.php

@@ -5 +5 @@
         'command_line_only' => 'Kobot can only be run in command line mode: <tt>php index.php "kobot"</tt>',
         'invalid_callback'  => 'Invalid response for %s. See <a href="http://php.net/callback#language.types.callback">php.net/callback</a>.',
+        'invalid_timer'     => 'All timers must be valid callbacks. See <a href="http://php.net/callback#language.types.callback">php.net/callback</a>.',
 );

trunk/modules/kobot/libraries/Kobot.php

@@ -18 +18 @@
         public $log_level = 1;
 
-        // Command responses
+        // Command responses and timers
         protected $responses = array();
+        protected $timers = array();
 
         // Responses to drop by default
@@ -119 +120 @@
                         // Read the PRIVMSG command
                         $this->set_response('PRIVMSG', array($this, 'response_privmsg'));
-
-                        // Reply to VERSION commands
-                        $this->add_trigger('^VERSION$', array($this, 'trigger_version'));
                 }
                 else
@@ -202 +200 @@
                 while ( ! feof($this->socket))
                 {
+                        // Start a new read loop
+                        $loop_time = microtime(TRUE);
+
                         // Read the raw server stream, up to 512 characters
                         while ($raw = fgets($this->socket, 512))
@@ -222 +223 @@
                                 }
                         }
-                        // One half-second is high enough interactivity
-                        usleep(500000);
+
+                        // Check the timers
+                        $this->check_timers();
+
+                        // Detemine the amount of time spent in this loop, in microseconds
+                        $loop_time = (microtime(TRUE) - $loop_time) * 1000000;
+
+                        // Every loop should take one-half second
+                        ($loop_time < 500000) and usleep(500000 - $loop_time);
                 }
 
@@ -332 +340 @@
         }
 
-        public function add_trigger($pattern, $callback)
+        protected function check_timers()
+        {
+                foreach ($this->timers as $key => $data)
+                {
+                        if (microtime(TRUE) >= $data['timeout'])
+                        {
+                                // Run the callback, passing the bot as the only parameter
+                                call_user_func($data['callback'], $this);
+
+                                // Restart the timer, if it was not removed
+                                isset($this->timers[$key]) and $this->timers[$key]['timeout'] = microtime(TRUE) + $data['interval'];
+                        }
+                }
+        }
+
+        public function set_timer($interval, $callback)
+        {
+                if ( ! is_callable($callback))
+                        throw new Kohana_Exception('kobot.invalid_timer');
+
+                // Add the timer to the timers, forcing the callback to be unique
+                $this->timers[$this->callback_hash($callback)] = array
+                (
+                        'callback' => $callback,
+                        'interval' => $interval,
+                        'timeout'  => microtime(TRUE) + $interval,
+                );
+
+                return $this;
+        }
+
+        public function remove_timer($callback)
+        {
+                // Remove the timer
+                unset($this->timers[$this->callback_hash($callback)]);
+
+                return $this;
+        }
+
+        public function set_trigger($pattern, $callback)
         {
                 // Store the trigger and it's callback
@@ -349 +396 @@
 
                 return $this;
+        }
+
+        protected function callback_hash($callback)
+        {
+                $hash = NULL;
+                if (is_array($callback))
+                {
+                        if (is_string($callback[0]))
+                        {
+                                // Static method callback
+                                $hash = sha1($callback[0].'::'.$callback[1]);
+                        }
+                        else
+                        {
+                                // Object method callback
+                                $hash = sha1(get_class($callback[0]).'->'.$callback[1]);
+                        }
+                }
+                else
+                {
+                        // Hash the name
+                        $hash = sha1($callback);
+                }
+
+                return $hash;
         }
 
@@ -423 +495 @@
                                 $this->channels[$data['target']][] = $data['sender'];
 
+                                // This prevents the userlist key from growing too large, causing a buffer overflow
+                                $this->channels[$data['target']] = array_values($this->channels[$data['target']]);
+
                                 // Debug the join
                                 $this->log(2, '> '.$data['sender'].' ('.$data['target'].')');