Changeset 71

Timestamp:

02/25/08 01:38:31 (5 years ago)

Author:

tobias382

Message:

* Added support to the Acronym plugin for filtering responses to certain acronyms
* Modified the Acronym plugin to restrict lookups to instances where the acronym takes up the entire post
* Modified the Acronym and Url plugins to add a lookup timeout
* Modified the Nickserv plugin to extend AdminCommand? instead of Command
* Fixed an issue in the tinyUrl method of the base plugin class where lack of URL encoding of the passed URL resulted in truncation of the original URL when computing its TinyURL equivalent
* Modified getIni and setIni methods in and added getPluginIni and setPluginIni to the base plugin case to allow for easier access to both core and plugin-specific settings and modified existing plugins to use the new methods where appropriate

Location:

trunk/Phergie

Files:

• Bot.php (modified) (1 diff)
• Driver/Streams.php (modified) (3 diffs)
• Plugin/Abstract/AdminCommand.php (modified) (2 diffs)
• Plugin/Abstract/Base.php (modified) (2 diffs)
• Plugin/Abstract/Cron.php (modified) (1 diff)
• Plugin/Acronym.php (modified) (6 diffs)
• Plugin/Altnick.php (modified) (2 diffs)
• Plugin/Autojoin.php (modified) (1 diff)
• Plugin/FeedTicker.php (modified) (1 diff)
• Plugin/Karma.php (modified) (2 diffs)
• Plugin/Nickserv.php (modified) (5 diffs)
• Plugin/Tld.php (modified) (1 diff)
• Plugin/Url.php (modified) (3 diffs)
• phergie.ini (modified) (1 diff)

trunk/Phergie/Bot.php

@@ -51 +51 @@
     trigger_error('Phergie is intended to be run using the CLI SAPI for PHP', E_USER_ERROR);
 }
+
+/**
+* Allow the bot to run indefinitely
+*/
+set_time_limit(0);
 
 /**

trunk/Phergie/Driver/Streams.php

@@ -116 +116 @@
         );
 
+        unset($port);
+
         if (!$this->socket) {
             $this->debug(rtrim('Unable to connect to server: socket error ' . $errno . ' ' . $errstr));
@@ -121 +123 @@
         }
 
+        unset($errno, $errstr);
+
         $password = $this->getIni('password');
         if ($password) {
@@ -126 +130 @@
         }
 
-        $this->send('USER', array($this->getIni('username'), $server, $server, $this->getIni('realname')));
+        unset($password);
+
+        $params = array(
+            $this->getIni('username'),
+            $server,
+            $server,
+            $this->getIni('realname')
+        );
+
+        unset($server);
+
+        $this->send('USER', $params);
         $this->doNick($this->getIni('nick'));
 
-        unset($server, $port, $password, $errno, $errstr);
+        unset($params);
 
         while(true) {

trunk/Phergie/Plugin/Abstract/AdminCommand.php

@@ -67 +67 @@
 
         // Set ops values
-        $ini = $this->getIni('ops');
+        $ini = $this->getPluginIni('ops');
         if ($ini===null) {
-            $ini = $this->getIni('ops', 'admincommand');
+            $ini = $this->getIni('admincommand.ops');
         }
         if ($ini==='true' || $ini==='1') {
@@ -78 +78 @@
 
         // Set admins values
-        $ini = $this->getIni('admins');
+        $ini = $this->getPluginIni('admins');
         if ($ini===null) {
-            $ini = $this->getIni('admins', 'admincommand');
+            $ini = $this->getIni('admincommand.admins');
         }
         if (!empty ($ini)) {

trunk/Phergie/Plugin/Abstract/Base.php

@@ -97 +97 @@
 
     /**
-    * 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
-    */
-    public function getIni($setting, $plugin = null)
-    {
-        if ($plugin === null) {
-            $plugin = $this->getName();
-        }
-        $value = $this->client->getIni($plugin . '.' . $setting);
-        if (!$value) {
-            $value = $this->client->getIni($setting);
-        }
-        return $value;
-    }
-
-    /**
-    * 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)
-    * @return void
-    */
-    public function setIni($setting, $value, $plugin = null)
-    {
-        if ($plugin === null) {
-            $plugin = $this->getName();
-        }
-        $this->client->setIni($plugin . '.' . $setting, $value);
+    * Returns the value of a specified configuration setting.
+    *
+    * @param string $setting Full name of the setting including the plugin
+    *                        name prefix (ex: pluginname.settingname)
+    * @return mixed
+    */
+    public function getIni($setting)
+    {
+        return $this->client->getIni($setting);
+    }
+
+    /**
+    * Returns the value of a specified configuration setting for the current
+    * plugin.
+    *
+    * @param string $setting Name of the setting without the plugin name
+    *                        prefix
+    * @return mixed
+    */
+    public function getPluginIni($setting)
+    {
+        return $this->client->getIni($this->getName() . '.' . $setting);
+    }
+
+    /**
+    * Sets the value of a specified configuration setting.
+    *
+    * @param string $setting Full name of the setting including the plugin
+    *                        name prefix (ex: pluginname.settingname)
+    * @param mixed $value New value for the setting
+    * @return void
+    */
+    public function setIni($setting, $value)
+    {
+        $this->client->setIni($setting, $value);
+    }
+
+    /**
+    * Sets the value of a specified configuration setting for the current
+    * plugin.
+    *
+    * @param string $setting Name of the setting without the plugin name
+    *                        prefix
+    * @param mixed $value New value for the setting
+    * @return void
+    */
+    public function setPluginIni($setting, $value)
+    {
+        $this->client->setIni($this->getName() . '.' . $setting, $value);
     }
 
@@ -164 +179 @@
     {
         if (strlen($url) > 30) {
-            $tiny = @file_get_contents('http://tinyurl.com/api-create.php?url=' . $url);
+            $tiny = @file_get_contents('http://tinyurl.com/api-create.php?url=' . urlencode($url));
             if (empty($tiny)) {
                 $tiny = $url;

trunk/Phergie/Plugin/Abstract/Cron.php

@@ -53 +53 @@
     {
         if($this->delay === null) {
-            if ((($time = $this->getIni('delay')) !== null) || $time = $this->defaultDelay) {
+            if ((($time = $this->getPluginIni('delay')) !== null) || $time = $this->defaultDelay) {
                 $this->delay = $time;
             }

trunk/Phergie/Plugin/Acronym.php

@@ -14 +14 @@
 * The limit configuration setting should be set to the maximum number of
 * potential meanings to return for any single given acronym.
+*
+* @todo Add a cache to avoid exceeding the acronymfinder.com daily lookup
+*       limit. Cache should be flushed daily.
 */
 class Phergie_Plugin_Acronym extends Phergie_Plugin_Abstract_Base
@@ -23 +26 @@
     */
     protected $limit;
+
+    /**
+    * List of acronyms for which responses should not be sent
+    *
+    * @var array
+    */
+    protected $filter;
 
     /**
@@ -45 +55 @@
     public function init()
     {
-        $limit = $this->getIni('limit');
+        $limit = $this->getPluginIni('limit');
         if ($limit < 0 || $limit === null) {
             $this->limit = 5;
@@ -51 +61 @@
             $this->limit = (int) $limit;
         }
+
+        $this->filter = array_filter(preg_split('/[ ,]/', $this->getPluginIni('filter')), 'strlen');
     }
 
@@ -87 +99 @@
         $message = $this->event->getArgument(1);
 
-        if (!preg_match('/((?:[A-Z]\.?){2,})\?/', $message, $acronym)) {
+        if (!preg_match('/((?:[A-Z]\.?){2,})\?/AD', $message, $acronym)) {
             return;
         }
 
         $acronym = str_replace('.', '', $acronym[1]);
+
+        if (in_array($acronym, $this->filter)) {
+            return;
+        }
 
         if (in_array($acronym, array('WHO', 'WHAT', 'WHERE', 'WHEN', 'WHY', 'HOW'))) {
@@ -100 +116 @@
         $opts = array('http' =>
             array(
+                'timeout' => 5,
                 'method' => 'GET',
                 'header' => 'Content-type: application/x-www-form-urlencoded',

trunk/Phergie/Plugin/Altnick.php

@@ -38 +38 @@
         if ($this->event->getCode() == Phergie_Event_Response::ERR_NICKNAMEINUSE) {
             $this->index++;
-            $altnick = $this->getIni('altnick' . $this->index);
+            $altnick = $this->getPluginIni('altnick' . $this->index);
             if ($altnick) {
                 $this->doNick($altnick);
+                $this->setIni('nick', $altnick);
             } else {
                 $this->doQuit('All specified nicks are in use');
@@ -46 +47 @@
         }
     }
-
-    /**
-    * Changes the in-memory configuration setting for the bot nick if it is
-    * successfully changed.
-    *
-    * @return void
-    */
-    public function onNick()
-    {
-        if ($this->event->getSource() == $this->getIni('nick')) {
-            $this->setIni('nick', $this->event->getArgument(0));
-        }
-    }
 }

trunk/Phergie/Plugin/Autojoin.php

@@ -26 +26 @@
             case Phergie_Event_Response::RPL_ENDOFMOTD:
             case Phergie_Event_Response::ERR_NOMOTD:
-                $channels = $this->getIni('channels');
+                $channels = $this->getPluginIni('channels');
                 if (!empty ($channels)) {
                     $this->doJoin(implode(' ', preg_split('#[, ]+#', $channels)));

trunk/Phergie/Plugin/FeedTicker.php

@@ -70 +70 @@
         $this->feeds = array();
         do {
-            $feed = $this->getIni('feed' . $i);
-            $chans = $this->getIni('chans' . $i);
+            $feed = $this->getPluginIni('feed' . $i);
+            $chans = $this->getPluginIni('chans' . $i);
             if (!empty($feed) && !empty($chans)) {
                 $this->feeds[] = array($feed, preg_split('#[\s\r\n,]+#', $chans));
             }
         } while (++$i < 10);
-        if($this->getIni('format') != null) {
-            $this->format = $this->getIni('format');
+        if($this->getPluginIni('format') != null) {
+            $this->format = $this->getPluginIni('format');
         }
     }

trunk/Phergie/Plugin/Karma.php

@@ -76 +76 @@
         );
 
-        $static = $this->getIni('static');
+        $static = $this->getPluginIni('static');
         if ($static) {
             $this->fixedKarma[strtolower($this->getIni('nick'))] = $static;
@@ -146 +146 @@
             // Antithrottling check
             $host = $this->event->getHost();
-            $limit = $this->getIni('limit');
+            $limit = $this->getPluginIni('limit');
             if (isset ($this->log[$host][$word])
                 && $limit

trunk/Phergie/Plugin/Nickserv.php

@@ -4 +4 @@
 * @see Phergie_Plugin_Abstract_AdminCommand
 */
-require_once 'Phergie/Plugin/Abstract/Command.php';
+require_once 'Phergie/Plugin/Abstract/AdminCommand.php';
 
 /**
@@ -13 +13 @@
 * with NickServ for the nick used by the bot.
 */
-class Phergie_Plugin_Nickserv extends Phergie_Plugin_Abstract_Command
+class Phergie_Plugin_Nickserv extends Phergie_Plugin_Abstract_AdminCommand
 {
     /**
@@ -29 +29 @@
     public function init()
     {
+        parent::init();
+
         $this->nick = $this->getIni('nick');
     }
@@ -44 +46 @@
             $message = $this->event->getArgument(1);
             if ($message == 'This nickname is owned by someone else') {
-                $password = $this->getIni('password');
+                $password = $this->getPluginIni('password');
                 if (! empty($password)) {
                     $this->doPrivmsg('NickServ', 'IDENTIFY ' . $password);
@@ -74 +76 @@
     public function onDoGhostbust()
     {
-        $password = $this->getIni('password');
+        $password = $this->getPluginIni('password');
+        $this->debug('password = ' . $password);
 
-        if (!empty ($password) && $this->index != -1) {
+        if (!empty ($password)) {
             $this->doPrivmsg(
                 'NickServ',

trunk/Phergie/Plugin/Tld.php

@@ -9 +9 @@
 * Responds to a request for a TLD (formatted as .tld where tld is the TLD to
 * be looked up) with its corresponding description.
+*
+* @todo Move TLD lookup table to SQLite database created and populated in
+*       init() when needed. Add caching of lookup results, flush it daily.
 */
 class Phergie_Plugin_Tld extends Phergie_Plugin_Abstract_Base

trunk/Phergie/Plugin/Url.php

@@ -38 +38 @@
     public function init()
     {
-        $format = $this->getIni('format');
+        $format = $this->getPluginIni('format');
         if ($format) {
             $this->format = $format;
@@ -59 +59 @@
                         if(array_search($url, $this->lastUrl) !== false)
                                 return;
-            // @todo if image or something, output content type
             // Convert url
             $tinyUrl = $this->tinyUrl($url);
@@ -66 +65 @@
                                 return;
 
-            $titleLength = $this->getIni('title_length');
+            $titleLength = $this->getPluginIni('title_length');
 
             $opts = array('http' =>
                 array(
+                    'timeout' => 5,
                     'method' => 'GET',
                     'header' => 'Content-type: application/x-www-form-urlencoded',

trunk/Phergie/phergie.ini

@@ -59 +59 @@
 ;    an acronym that should be displayed in a given instance (defaults to 5)
 acronym.limit =
+
+; acronym.filter :
+;    comma- or space-delimited list of acronyms for which meanings should not
+;    be returned
+acronym.filter =
 
 ;-----------------------------------------------------------------------------