Changeset 106

Timestamp:

03/03/08 01:36:28 (9 months ago)

Author:

tobias382

Message:

* Modified all declarations and uses of checkDependencies to include the current client instance
* Modified the Weather plugin to check for authentication-related configuration settings as part of its dependencies check

Files:

• trunk/Phergie/Bot.php (modified) (1 diff)
• trunk/Phergie/Plugin/Abstract/AdminCommand.php (modified) (1 diff)
• trunk/Phergie/Plugin/Abstract/Base.php (modified) (1 diff)
• trunk/Phergie/Plugin/Acronym.php (modified) (1 diff)
• trunk/Phergie/Plugin/Drink.php (modified) (1 diff)
• trunk/Phergie/Plugin/Karma.php (modified) (1 diff)
• trunk/Phergie/Plugin/Lart.php (modified) (1 diff)
• trunk/Phergie/Plugin/Logging.php (modified) (6 diffs)
• trunk/Phergie/Plugin/Nickserv.php (modified) (1 diff)
• trunk/Phergie/Plugin/Weather.php (modified) (3 diffs)

trunk/Phergie/Bot.php

@@ -154 +154 @@
-            require_once 'Phergie/Plugin/' . $plugin . '.php';
-            $class = 'Phergie_Plugin_' . $plugin;
-
+client, $
-                $instance = new $class($client);
-                $instance->enabled = $enabled;

trunk/Phergie/Plugin/Abstract/AdminCommand.php

@@ -90 +90 @@
-    * Returns whether or not the plugin's dependencies are met.
-    *
+    * @param Phergie_Driver_Abstract $client Client instance
-    * @param array $plugins List of short names for plugins that the
-    *                       bootstrap file intends to instantiate
-    * @return bool TRUE if the plugins dependencies are met, FALSE otherwise
-    * @see Phergie_Plugin_Abstract_Base::checkDependencies()
-    * @return bool TRUE if dependencies are met, FALSE otherwise
-    */
-
+Phergie_Driver_Abstract $client, 
-    {
-        if (! in_array('Users', $plugins)
-
+client, $
-            return false;
-        }

trunk/Phergie/Plugin/Abstract/Base.php

@@ -219 +219 @@
-    * Plugins with such requirements should override this method.
-    *
+    * @param Phergie_Driver_Abstract $client Client instance
-    * @param array $plugins List of short names for plugins that the
-    *                       bootstrap file intends to instantiate
-    * @return bool TRUE if dependencies are met, FALSE otherwise
-    */
-
+Phergie_Driver_Abstract $client, 
-    {
-        return true;

trunk/Phergie/Plugin/Acronym.php

@@ -73 +73 @@
-    * Returns whether or not the plugin's dependencies are met.
-    *
-
+
+
-    *                       bootstrap file intends to instantiate
-    * @return bool TRUE if the plugins dependencies are met, FALSE otherwise
-    * @see Phergie_Plugin_Abstract_Base::checkDependencies()
-    * @return bool TRUE if dependencies are met, FALSE otherwise
-    */
-
+Phergie_Driver_Abstract $client, 
-    {
-        if (! in_array('Users', $plugins)
-
+client, $
-            return false;
-        }

trunk/Phergie/Plugin/Drink.php

@@ -186 +186 @@
-    * Returns whether or not the plugin's dependencies are met.
-    *
-
+
+
-    *                       bootstrap file intends to instantiate
-    * @return bool TRUE if the plugins dependencies are met, FALSE otherwise
-    * @see Phergie_Plugin_Abstract_Base::checkDependencies()
-    * @return bool TRUE if dependencies are met, FALSE otherwise
-    */
-
+Phergie_Driver_Abstract $client, 
-    {
-        if (!extension_loaded('PDO') 

trunk/Phergie/Plugin/Karma.php

@@ -147 +147 @@
-    * Returns whether or not the plugin's dependencies are met.
-    *
+    * @param Phergie_Driver_Abstract $client Client instance
-    * @param array $plugins List of short names for plugins that the
-    *                       bootstrap file intends to instantiate
-    * @return bool TRUE if the plugins dependencies are met, FALSE otherwise
-    * @see Phergie_Plugin_Abstract_Base::checkDependencies()
-    * @return bool TRUE if dependencies are met, FALSE otherwise
-    */
-
+Phergie_Driver_Abstract $client, 
-    {
-        if (!extension_loaded('PDO')

trunk/Phergie/Plugin/Lart.php

@@ -101 +101 @@
-    * Returns whether or not the plugin's dependencies are met.
-    *
-
+
+
-    *                       bootstrap file intends to instantiate
-    * @return bool TRUE if the plugins dependencies are met, FALSE otherwise
-    * @see Phergie_Plugin_Abstract_Base::checkDependencies()
-    * @return bool TRUE if dependencies are met, FALSE otherwise
-    */
-
+Phergie_Driver_Abstract $client, 
-    {
-        if (!extension_loaded('PDO') 

trunk/Phergie/Plugin/Logging.php

@@ -118 +118 @@
-    */
-    protected $heard;
+
+    /**
+    * PRepared statement for searching for one or more time ranges during 
+    * which a particular user is most likely to be present in a particular 
+    * channel 
+    *
+    * @var PDOStatement
+    */
+    protected $willsee;
-
-    /**
@@ -185 +194 @@
-                $result = $this->db->exec('
-                    CREATE TABLE logs (
-4
+9
-                        type SHORTINT,
-                        chan VARCHAR(45),
@@ -222 +231 @@
-                AND chan = :chan
-                ORDER BY tstamp DESC
+                LIMIT 1
+            ');
+
+            $this->willsee = $this->db->prepare('
+                SELECT strftime("%H", tstamp) post_hour, COUNT(*) post_count
+                FROM logs
+                WHERE type IN (' . self::PRIVMSG . ', ' . self::ACTION . ')
+                AND nick = :nick
+                AND chan = :chan
+                GROUP BY strftime("%H", tstamp)
+                ORDER BY 2 DESC, 1
-                LIMIT 1
-            ');
@@ -247 +267 @@
-    * Returns whether or not the plugin's dependencies are met.
-    *
-
+
+
-    *                       bootstrap file intends to instantiate
-    * @return bool TRUE if the plugins dependencies are met, FALSE otherwise
-    * @see Phergie_Plugin_Abstract_Base::checkDependencies()
-    * @return bool TRUE if dependencies are met, FALSE otherwise
-    */
-
+Phergie_Driver_Abstract $client, 
-    {
-        if (! in_array('Users', $plugins)
-
+client, $
-            return false;
-        }
@@ -320 +340 @@
-
-        $params = array(
-mdHi
+-m-d H:i:
-            ':type' => $type,
-            ':chan' => $chan,
@@ -642 +662 @@
-        }
-    }
+
+    /**
+    * Responds to requests for a time range during which a particular user 
+    * is most likely to be present in the channel from which the request 
+    * originates.
+    *
+    * @param string $user Nick of the user to search for
+    * @return void
+    */
+    public function onDoWillsee($user)
+    {
+        if (!$this->db) {
+            return;
+        }
+        
+        // Check to make sure the request came from a channel
+        $source = $this->event->getSource();
+        if ($source[0] != '#') {
+            return;
+        }
+
+        // Handle cases where the bot is the subject
+        if ($user == $this->getIni('nick')) {
+            $this->doPrivmsg($source, 'What are you talking about? I\'m always here!');
+            return;
+        }
+
+        // Handle 'me' alias
+        if ($user == 'me') {
+            $user = $this->event->getNick();
+        }
+
+        // Perform the search
+        $params = array(
+            ':nick' => $user,
+            ':chan' => $source
+        );
+
+        $this->willsee->execute($params);
+        $prediction = $this->willsee->fetchColumn();
+
+        // Return if no results are found
+        if ($prediction === false) {
+            $this->doPrivmsg($source, $user . ' ' . $this->randomMissing());
+            return;
+        }
+
+        // Calculate a predicted time of arrival 
+        $hour = date('H');
+        if ($hour > $prediction) {
+            $prediction = 24 - ($hour - $prediction);
+        } else {
+            $prediction = $prediction - $hour;
+        }
+
+        // Return with a message including the prediction
+        $message = $user . ' is most likely to be online ';
+        if ($prediction == 0) {
+            $message .= 'now!';
+        } elseif ($prediction == 1) {
+            $message .= 'in 1 hour.';
+        } else {
+            $message .= 'in ' . $prediction . ' hours.';
+        }
+        $this->doPrivmsg($source, $message);
+    }
-}

trunk/Phergie/Plugin/Nickserv.php

@@ -42 +42 @@
-    * Returns whether or not the plugin's dependencies are met.
-    *
+    * @param Phergie_Driver_Abstract $client Client instance
-    * @param array $plugins List of short names for plugins that the
-    *                       bootstrap file intends to instantiate
-    * @return bool TRUE if the plugins dependencies are met, FALSE otherwise
-    * @see Phergie_Plugin_Abstract_Base::checkDependencies()
-    * @return bool TRUE if dependencies are met, FALSE otherwise
-    */
-
+Phergie_Driver_Abstract $client, 
-    {
+        // Only the ghostbust command requires being an admin
-        return true;
-    }

trunk/Phergie/Plugin/Weather.php

@@ -9 +9 @@
-* Detects and responds to requests for current weather conditions in a 
-* particular location using data from a web service. Requires registering 
-
+
+
+
-*
-* @see http://www.weather.com/services/xmloap.html
@@ -15 +17 @@
-class Phergie_Plugin_Weather extends Phergie_Plugin_Abstract_Command
-{
+    /**
+    * Partner ID for web service authentication
+    *
+    * @var string
+    */
+    protected $partnerId;
+
+    /**
+    * License Key for web service authentication
+    *
+    * @var string
+    */
+    protected $licenseKey;
+
+    /**
+    * Obtains configuration settings used for web service authentication.
+    *
+    * @return void
+    */
+    public function init()
+    {
+        $this->partnerId = $this->getPluginIni('partner_id');
+        $this->licenseKey = $this->getPluginIni('license_key');
+    }
+
+    /**
+    * Returns whether or not the plugin's dependencies are met.
+    *
+    * @param Phergie_Driver_Abstract $client Client instance
+    * @param array $plugins List of short names for plugins that the
+    *                       bootstrap file intends to instantiate
+    * @see Phergie_Plugin_Abstract_Base::checkDependencies()
+    * @return bool TRUE if dependencies are met, FALSE otherwise
+    */
+    public static function checkDependencies(Phergie_Driver_Abstract $client, array $plugins)
+    {
+        $partnerId = $client->getIni('weather.partner_id');
+        $licenseKey = $client->getIni('weather.license_key');
+
+        if (!$partnerId || !$licenseKey) {
+            return false;
+        }
+        
+        return true;
+    }
+
-        public function onDoWeather($where)
-        {
-        $partnerId = $this->getPluginIni('partner_id');
-        $licenseKey = $this->getPluginIni('license_key');
-
-        if (!$partnerId || !$licenseKey) {
-            return;
-        }
-
-        $context = stream_context_create(array('http' => array('timeout' => 3)));
-
@@ -35 +76 @@
-                if(count($xml->loc) != 0) {
-                        $where = $xml->loc[0]['id'];
-partnerId . '&key=' . $
+this->partnerId . '&key=' . $this->
-            $contents = @file_get_contents($feed, null, $context);
-            if (!$contents) {