Changeset 24

Timestamp:

02/09/08 13:53:00 (5 years ago)

Author:

tobias382

Message:

Fixes #14
* Added plugin short name retrieval and configuration namespacing methods to the base event handler class
* Added Command class, modified AdminCommand? to extend it, and modified Quit and JoinPart? to use it
* Updated Cron, Nickserv, RSSParser, and Autojoin to use the new configuration namespacing features
* Removed a debugging echo left in the Users::onResponse method

Location:

trunk/Phergie/Event

Files:

• Handler.php (modified) (2 diffs)
• Handler/AdminCommand.php (modified) (2 diffs)
• Handler/Autojoin.php (modified) (1 diff)
• Handler/Command.php (added)
• Handler/Cron.php (modified) (1 diff)
• Handler/JoinPart.php (modified) (1 diff)
• Handler/Nickserv.php (modified) (1 diff)
• Handler/Quit.php (modified) (1 diff)
• Handler/RSSParser.php (modified) (1 diff)
• Handler/Users.php (modified) (1 diff)

trunk/Phergie/Event/Handler.php

@@ -30 +30 @@
 
     /**
-    * Sets a reference to the client used to initiate commands
+    * Sets a reference to the client used to initiate commands.
     *
     * @param Phergie_Client $client
@@ -40 +40 @@
 
     /**
-     * Initializes the plugin
-     *
-     * Should it require initialization, just extend this method
-     */
+    * Returns the short name of the current plugin.
+    *
+    * @return string
+    */
+    public function getName()
+    {
+        return substr(get_class($this), 22);
+    }
+
+    /**
+    * Returns the value of a configuration setting for a plugin.
+    *
+    * @param string $setting Name of the setting
+    * @param string $plugin Name of the plugin, defaults to the current 
+    *                       plugin (optional)
+    * @return string Value of the setting
+    */
+    public function getIni($setting, $plugin = null)
+    {
+        if ($plugin === null) {
+            $plugin = $this->getName(); 
+        }
+        return $this->_client->getIni($plugin . '.' . $setting);
+    }
+
+    /**
+    * Sets the value of a configuration setting for a plugin.
+    *
+    * @param string $setting Name of the setting
+    * @param string $value New value for the setting
+    * @param string $plugin Name of the plugin, defaults to the current 
+    *                       plugin (optional)
+    */
+    public function setIni($setting, $value, $plugin = null)
+    {
+        if ($plugin === null) {
+            $plugin = $this->getName();
+        }
+        $this->_client->setIni($plugin . '.' . $setting, $value);
+    }
+
+    /**
+    * Initializes the plugin. Should it require initialization, just 
+    * override this method.
+    */
     public function init() { }
 

trunk/Phergie/Event/Handler/AdminCommand.php

@@ -2 +2 @@
 
 /**
-* @see Phergie_Event_Handler
+* @see Phergie_Event_Handler_Command
 */
-require_once 'Phergie/Event/Handler.php';
+require_once 'Phergie/Event/Handler/Command.php';
 
 /**
@@ -31 +31 @@
  * </code>
  */
-abstract class Phergie_Event_Handler_AdminCommand extends Phergie_Event_Handler
+abstract class Phergie_Event_Handler_AdminCommand extends Phergie_Event_Handler_Command
 {
         protected $_admins = array();
-        protected $_adminOps = array();
+        protected $_ops = array();
 
-    public function isAdmin(Phergie_Event_Request $event)
+    public function fromAdmin(Phergie_Event_Request $event)
     {
-        $class = substr(get_class($this), 22);
-        if (!isset($this->_admins[$class])) {
-                $this->initialize($class);
-        }
+        $class = $this->getName();
         $mask = $event->getNick() .'!'. $event->getUsername() .'@'. $event->getHost();
                 // Check if is op and ops are admins
-                if($this->_adminOps[$class] === true && Phergie_Event_Handler_Users::isOp($event->getNick(), $event->getArgument(0)) === true) {
+                if($this->_ops[$class] === true 
+            && Phergie_Event_Handler_Users::isOp($event->getNick(), $event->getArgument(0)) === true) {
                         return true;
                 }
         // Try to match mask against admin masks
-        foreach ($this->_admins[$class] as $admin) {
-                if (preg_match('{^'.$admin.'$}', $mask)) {
-                        return true;
-                }
-        }
+        if (isset($this->_admins[$class])) {
+            foreach ($this->_admins[$class] as $admin) {
+                if (preg_match('{^'.$admin.'$}', $mask)) {
+                    return true;
+                }
+            }
+        }
         return false;
     }
 
-    protected function initialize($class)
+    public function onPrivmsg(Phergie_Event_Request $event)
     {
-        // Set adminOps values
-        $ini = $this->getIni($class.'.admin_ops');
+        if ($this->fromAdmin($event) 
+            && preg_match('/^' . $this->getConnection()->getNick() . ':?\s+(.*)$/', $event->getArgument(1), $m)) {
+            $this->processCommand($m[1], $event);
+        }
+    }
+
+    public function init()
+    {
+        $class = $this->getName();
+
+        // Set ops values
+        $ini = $this->getIni('ops');
         if ($ini===null) {
-                $ini = $this->getIni('admincommand.admin_ops');
+                $ini = $this->getIni('ops', 'admincommand');
         }
         if ($ini==='true' || $ini==='1') {
-                $this->_adminOps[$class] = true;
+                $this->_ops[$class] = true;
         } else {
-                $this->_adminOps[$class] = false;
+                $this->_ops[$class] = false;
         }
 
         // Set admins values
-        $ini = $this->getIni($class.'.admins');
+        $ini = $this->getIni('admins');
         if ($ini===null) {
-                $ini = $this->getIni('admincommand.admins');
+                $ini = $this->getIni('admins', 'admincommand');
         }
         $admins = preg_split('#[\s\r\n,]+#', $ini);

trunk/Phergie/Event/Handler/Autojoin.php

@@ -7 +7 @@
     public function onResponse(Phergie_Event_Response $response)
     {
-        $channels = $this->getIni('autojoin.channels');
+        $channels = $this->getIni('channels');
         if (!empty($channels)
             && $response->getCode() == Phergie_Event_Response::RPL_ENDOFMOTD) {

trunk/Phergie/Event/Handler/Cron.php

@@ -36 +36 @@
     {
                 if($this->ttl === null) {
-                        $class = substr(get_class($this), 22);
-                        if ((($time = $this->getIni($class.'.time_to_live')) !== null) || $time = $this->defaultTTL) {
+                        if ((($time = $this->getIni('time_to_live')) !== null) || $time = $this->defaultTTL) {
                                 $this->ttl = $time;
                         }

trunk/Phergie/Event/Handler/JoinPart.php

@@ -8 +8 @@
 class Phergie_Event_Handler_JoinPart extends Phergie_Event_Handler_AdminCommand
 {
-    public function onPrivmsg(Phergie_Event_Request $event)
+    /**
+    * Joins the specified channel.
+    *
+    * @param string $channel Name of the channel to join
+    */
+    public function onDoJoin($channel)
     {
-                // Tries to match join #chan or part [#chan] (parts the chan where the command is called if no chan provided)
-        if (preg_match('{^(join|part)\s*(#.*)?$}i', $event->getArgument(1), $m)) {
-                // Checks admin
-                if ($this->isAdmin($event, __CLASS__)) {
-                        if ($m[1] === 'join' && $m[2] != null) {
-                                $this->doJoin($m[2]);
-                        } elseif ($m[1] === 'part' && ($m[2] != null || substr($event->getArgument(0), 0, 1) === '#')) {
-                                $this->doPart($m[2] == null ? $event->getArgument(0) : $m[2]);
-                        }
-                }
-        }
+        $this->doJoin($channel);
+    }
+
+    /**
+    * Parts either the specified channel or the current channel if none is 
+    * specified.
+    *
+    * @param mixed $spec A string containing the name of the channel to part
+    *                    or an instance of Phergie_Event_Request for the 
+    *                    original event that occurred
+    */
+    public function onDoPart($spec)
+    {
+        if ($spec instanceof Phergie_Event_Request) {
+            $this->doPart($spec->getArgument(0));
+        } else {
+            $this->doPart($spec);
+        }
     }
 }

trunk/Phergie/Event/Handler/Nickserv.php

@@ -9 +9 @@
         if ($event->getNick() == 'NickServ'
             && $event->getArgument(1) == 'This nickname is owned by someone else') {
-            $password = $this->getIni('nickserv.password');
+            $password = $this->getIni('password');
             if (!empty($password)) {
                 $this->doPrivmsg('NickServ', 'IDENTIFY ' . $password); 

trunk/Phergie/Event/Handler/Quit.php

@@ -8 +8 @@
 class Phergie_Event_Handler_Quit extends Phergie_Event_Handler_AdminCommand
 {
-    public function onPrivmsg(Phergie_Event_Request $event)
+    public function onDoQuit(Phergie_Event_Request $event)
     {
-        if($event->getArgument(1)=='quit' && $this->isAdmin($event)) {
-                $this->doQuit('by request of ' . $event->getNick());
-        }
+        $this->doQuit('by request of ' . $event->getNick());
     }
 }

trunk/Phergie/Event/Handler/RSSParser.php

@@ -19 +19 @@
                 $i = 0;
                 $this->feeds = array();
-                while ($i < 10 || ($this->getIni('rssparser.feed'.$i) !== null && $this->getIni('rssparser.chans'.$i) !== null)) {
-                        $this->feeds[] = array($this->getIni('rssparser.feed'.$i), preg_split('#[\s\r\n,]+#', $this->getIni('rssparser.chans'.$i)));
+                while ($i < 10 || ($this->getIni('feed'.$i) !== null && $this->getIni('chans'.$i) !== null)) {
+                        $this->feeds[] = array($this->getIni('feed'.$i), preg_split('#[\s\r\n,]+#', $this->getIni('chans'.$i)));
                         $i++;
                 }

trunk/Phergie/Event/Handler/Users.php

@@ -66 +66 @@
     {
                 if ($event->getCode() == Phergie_Event_Response::RPL_NAMREPLY) {
-        echo $event->getDescription()."\n";
                         $desc = $event->getDescription();
                         $desc = substr($desc, strpos($desc, '=')+2);