Changeset 2048 for trunk/modules/kirc/libraries/Kirc.php

Timestamp:

02/14/2008 07:14:13 PM (11 months ago)

Author:

Shadowhand

Message:

Preparing to rename Kirc... again.

Files:

• trunk/modules/kirc/libraries/Kirc.php (modified) (11 diffs)

trunk/modules/kirc/libraries/Kirc.php

@@ -5 +5 @@
  * $Id$
  *
- * @package    Kirc
+ * @package    Kobot
  * @author     Woody Gilk
  * @copyright  (c) 2007-2008 Kohana Team
  * @license    http://kohanaphp.com/license.html
  */
-class Kirc_Core {
+class Kobot_Core {
 
         // The characters that represent a newline
@@ -17 +17 @@
         // Log level: 1 = errors, 2 = debug
         public $log_level = 1;
+
+        // Command responses
+        protected $responses = array();
 
         // IRC socket, MOTD, and stats
@@ -36 +39 @@
         public function __construct($server, $port = NULL, $timeout = NULL)
         {
+                echo Kohana::debug($this->parse(':anthony.freenode.net 353 koboto @ #koboto :koboto @Shadowhand'));exit;
+                
                 if (PHP_SAPI !== 'cli')
-                        throw new Kirc_Exception('kirc.command_line_only');
+                        throw new Kohana_Exception('kobot.command_line_only');
 
                 // Close all output buffers
@@ -73 +78 @@
 
                         // Automatically reply to PING comamnds
-                        Event::add('kirc.ping', array($this, 'pong'));
+                        $this->set_response('ping', array($this, 'pong'));
                 }
                 else
@@ -109 +114 @@
         }
 
+        public function set_response($command, $callback)
+        {
+                if ( ! is_callable($callback))
+                        throw new Kohana_Exception('kobot.invalid_callback');
+
+                // Set the response callback
+                $this->responses[$command] = $callback;
+
+                return $this;
+        }
+
         public function login($username, $password = NULL, $realname = 'Kohana PHP Bot')
         {
@@ -118 +134 @@
                 $this->stats['last_ping'] = microtime(TRUE);
 
-                // Read the MOTD before continuing
-                Event::add('kirc.375', array($this, 'read_motd'));
-                Event::add('kirc.372', array($this, 'read_motd'));
-                Event::add('kirc.376', array($this, 'read_motd'));
-        }
-
-        public function read_motd()
-        {
-                switch (Event::$data['command'])
+                // Set the MOTD response
+                $this->set_response('375', array($this, 'read_motd'));
+                $this->set_response('372', array($this, 'read_motd'));
+                $this->set_response('376', array($this, 'read_motd'));
+        }
+
+        public function read_motd($data)
+        {
+                switch ($data['command'])
                 {
                         case '375':
@@ -134 +150 @@
                         case '372':
                                 // Read the MOTD
-                                $this->motd[] = substr(Event::$data['message'], 2);
+                                $this->motd[] = substr($data['message'], 2);
                         break;
                         case '376':
@@ -157 +173 @@
 
                         // Read the USERS command
-                        Event::add('kirc.353', array($this, 'read_userlist'));
-                }
-        }
-
-        public function read_userlist()
-        {
-                if (strpos(Event::$data['target'], ' @ ') !== FALSE)
-                {
-                        // Get the channel name from the target
-                        list ($bot, $channel) = explode(' @ ', Event::$data['target'], 2);
-
-                        // Set the current users
-                        $this->channels[$channel] = explode(' ', Event::$data['message']);
-
-                        // Log the user count
-                        $this->log(1, 'Read '.count($this->channels[$channel]).' users');
+                        $this->set_response('353', array($this, 'read_userlist'));
                 }
         }
@@ -220 +221 @@
         }
 
-        public function pong()
-        {
-                // Reply with a PONG
-                $this->send('PONG '.substr(Event::$data['message'], 1));
-        }
-
         public function read()
         {
@@ -248 +243 @@
         protected function parse($raw)
         {
-                // These will always be returned
-                $sender   = NULL;
-                $sendhost = NULL;
-                $command  = NULL;
-                $target   = NULL;
-                $message  = NULL;
-
-                // Split the message
-                $message = explode(' ', trim($raw), 2);
-
-                if ( ! empty($message[0]) AND $message[0]{0} === ':')
-                {
-                        // Is a receivable command
-                        $prefix = substr($message[0], 1);
+                // Remove the whitespace garbage
+                $raw = trim($raw);
+
+                // These values are always returned
+                $data = array
+                (
+                        'sender'   => NULL,
+                        'sendhost' => NULL,
+                        'command'  => NULL,
+                        'target'   => NULL,
+                        'message'  => NULL,
+                );
+
+                // Extract the prefix from the string
+                list ($prefix, $str) = explode(' ', $raw, 2);
+
+                if ( ! empty($prefix) AND $prefix{0} === ':')
+                {
+                        // A user-level command, like PRIVMSG or NOTICE
+                        $prefix = substr($prefix, 1);
 
                         if (strpos($prefix, '!') !== FALSE)
                         {
-                                // sender!sendhost
-                                list ($sender, $sendhost) = explode('!', $prefix, 2);
+                                // sender@host, typically a user
+                                list ($data['sender'], $data['sendhost']) = explode('!', $prefix, 2);
                         }
                         else
                         {
-                                // sender
-                                $sender = $prefix;
-                        }
-
-                        // Separate the command and message
-                        list ($command, $params) = explode(' ', $message[1], 2);
-
-                        if (strpos($params, ' :') !== FALSE)
-                        {
-                                // target :message
-                                list ($target, $message) = explode(' :', $params, 2);
-                        }
-                        elseif ($params{0} === ':')
-                        {
-                                // :target
-                                $target = substr($params, 1);
-                                $message = NULL;
+                                // sender, Typically a server
+                                $data['sender'] = $prefix;
+                        }
+
+                        // CMD str, Extract the command from the remaining string
+                        list ($data['command'], $str) = explode(' ', $str, 2);
+
+                        if (strpos($str, ' :') !== FALSE)
+                        {
+                                // target :message, some kind of communication
+                                list ($data['target'], $data['message']) = explode(' :', $params, 2);
+                        }
+                        elseif ($str{0} === ':')
+                        {
+                                // :target, without a message
+                                $data['target'] = substr($str, 1);
                         }
                         else
                         {
-                                // target
-                                $target = $params;
-                                $message = NULL;
+                                $data['target'] = $str;
                         }
                 }
                 else
                 {
-                        // Is a raw command, like PING
-                        $command = $message[0];
-                        $message = empty($message[1]) ? NULL : trim($message[1]);
-                }
-
-                return array($sender, $sendhost, $command, $target, $message);
+                        // A server-level command, like PING
+                        $data['command'] = $prefix;
+                        $data['message'] = empty($str) ? NULL : $str;
+                }
+
+                return $data;
         }
 
@@ -404 +402 @@
         }
 
-        protected function url_status($url)
-        {
-                if (($status = $this->db_url_status($url)) === NULL)
-                {
-                        // Extract the URL params
-                        extract(parse_url($url), EXTR_PREFIX_ALL, 'url');
-
-                        // Invalid URL by default
-                        $status = FALSE;
-                        if ($socket = fsockopen($url_host, 80, $errno, $errstr, 6))
-                        {
-                                // Fetch the HTTP HEAD
-                                fwrite($socket, "HEAD $url_path HTTP/1.0\r\nHost: $url_host\r\n\r\n");
-
-                                // Read the response
-                                $status = fgets($socket, 22);
-
-                                // Set the response
-                                $status = (strpos($status, '200 OK') !== FALSE);
-
-                                // Close the connection
-                                fclose($socket);
-                        }
-
-                        // Save the URL to the database
-                        $this->db->insert('urls', array('url' => $url, 'status' => (int) $status));
-                }
-
-                return $status;
-        }
-
-        protected function db_url_status($url)
-        {
-                // Fetch the status of the URL
-                $status = $this->db->select('status')->where('url', $url)->limit(1)->get('urls');
-
-                return $status->count() ? (bool) $status->current()->status : NULL;
-        }
-
-}
+        /**
+         * Kobot default responses. You can overload these in your own extension class,
+         * or attach your own event handlers
+         */
+
+        public function response_drop($data)
+        {
+                // Log dropped responses
+                $this->log(2, $data);
+        }
+
+        public function response_ping($data)
+        {
+                // Reply with a PONG
+                $this->send('PONG '.substr($data['message'], 1));
+        }
+
+        // 353
+        public function response_userlist($data)
+        {
+                if (strpos($data['target'], ' @ ') !== FALSE)
+                {
+                        // Get the channel name from the target
+                        list ($bot, $channel) = explode(' @ ', $data['target'], 2);
+
+                        // Set the current users
+                        $this->channels[$channel] = explode(' ', $data['message']);
+
+                        // Log the user count
+                        $this->log(1, 'Read '.count($this->channels[$channel]).' users');
+                }
+        }
+
+} // End Kobot