Changeset 82

Timestamp:

02/27/08 05:40:00 (5 years ago)

Author:

Seldaek

Message:

+ Adds Toggle module that allows to mute and or disable other plugins (excepted itself for disable)
- Base: Removed the static $instance and getInstance functions as they did not work (you can't have a single var for all classes, they just override each other's static var and we ended up with getInstance always returning the Users instance)
+ Streams/Abstract?: Added a getInstance($plugin) method so plugins can do $this->getInstance('MyBuddyPlugin?') to reach them
* Bot: All plugins are loaded now but those that are disabled in the .ini are marked as disabled - That way they can be enabled during runtime
* Nickserv: Fix to use the new getInstance model

Location:

trunk/Phergie

Files:

• Bot.php (modified) (1 diff)
• Driver/Abstract.php (modified) (1 diff)
• Driver/Streams.php (modified) (2 diffs)
• Plugin/Abstract/Base.php (modified) (5 diffs)
• Plugin/Nickserv.php (modified) (2 diffs)
• Plugin/Toggle.php (added)

trunk/Phergie/Bot.php

@@ -133 +133 @@
         $name = substr($entry, 0, -4);
         if ($all xor in_array(strtolower($name), $include)) {
-            $plugins[] = $name;
+            $plugins[$name] = true;
+        } else {
+                $plugins[$name] = false;
         }
     }
 }
-sort($plugins);
+
+ksort($plugins);
 
 unset ($iterator, $entry, $name, $all, $include);
 
-foreach ($plugins as $plugin) {
+foreach ($plugins as $plugin=>$enabled) {
     require_once 'Phergie/Plugin/' . $plugin . '.php';
-    $class = 'Phergie_Plugin_' . $plugin; 
+    $class = 'Phergie_Plugin_' . $plugin;
     if (call_user_func(array($class, 'checkDependencies'), $plugins)) {
         $instance = new $class($client);
+        $instance->enabled = $enabled;
         $client->addPlugin($instance);
-        $client->debug('Loaded ' . $plugin); 
+        $client->debug('Loaded ' . $plugin . ($enabled ? '':' [Disabled]'));
     } else {
         $client->debug('Unable to load ' . $plugin);

trunk/Phergie/Driver/Abstract.php

@@ -88 +88 @@
     public abstract function addPlugin(Phergie_Plugin_Abstract_Base $plugin);
 
+        /**
+         * Returns a plugin instance
+         *
+         * @param $plugin The plugin class name (without the Phergie_Plugin_ prefix)
+         * @return Phergie_Plugin_Abstract_Base
+         */
+        public abstract function getInstance($plugin);
+
     /**
     * Executes a continuous loop in which the client listens for events from

trunk/Phergie/Driver/Streams.php

@@ -93 +93 @@
         $plugin->init();
 
-        $this->plugins[] = $plugin;
-    }
+        $this->plugins[strtolower($plugin->getName())] = $plugin;
+    }
+
+        /**
+         * Returns a plugin instance
+         *
+         * @param $plugin The plugin class name (without the Phergie_Plugin_ prefix)
+         * @return Phergie_Plugin_Abstract_Base
+         */
+        public function getInstance($plugin)
+        {
+                if (isset($this->plugins[strtolower($plugin)]))
+                        return $this->plugins[strtolower($plugin)];
+                return false;
+        }
 
     /**
@@ -220 +233 @@
 
             foreach ($this->plugins as $plugin) {
+                if ($plugin->enabled === false) { // Skip disabled plugins
+                        continue;
+                }
                 $plugin->setEvent($event);
                 if ($event instanceof Phergie_Event_Response) {

trunk/Phergie/Plugin/Abstract/Base.php

@@ -46 +46 @@
 
     /**
-    * Reference to the current instance of the plugin, used to make its
-    * non-static methods accessible to other plugins
-    *
-    * @var Phergie_Plugin_Abstract_Base
-    */
-    protected static $instance;
-
-    /**
     * Short class name
     *
@@ -68 +60 @@
 
     /**
+     * Flag indicating whether or not the plugin is enabled and receives events
+     *
+     * @var bool
+     */
+    public $enabled = true;
+
+    /**
+     * Flag indicating whether or not the plugin is muted and can output events
+     *
+     * @var bool
+     */
+    public $muted = false;
+
+    /**
     * Sets a reference to the client used to initiate commands.
     *
@@ -75 +81 @@
     final public function __construct(Phergie_Driver_Abstract $client)
     {
-        self::$instance = $this;
-
         $this->client = $client;
 
@@ -210 +214 @@
 
     /**
-    * Returns a reference to the instance of the current plugin.
-    *
-    * @return Phergie_Plugin_Abstract_Base
-    */
-    public static function getInstance()
-    {
-        return self::$instance;
-    }
-
-    /**
     * Returns whether or not the current environment meets the requirements
     * of the plugin in order for it to be run, including the PHP version,
@@ -354 +348 @@
     public function __call($method, $arguments)
     {
+        if ($this->muted && substr($method, 0, 2) === 'do') { // Silence output calls if the plugin is muted
+                return false;
+        }
         return call_user_func_array(array($this->client, $method), $arguments);
     }

trunk/Phergie/Plugin/Nickserv.php

@@ -42 +42 @@
     * Returns whether or not the plugin's dependencies are met.
     *
-    * @param array $plugins List of short names for plugins that the 
+    * @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
@@ -95 +95 @@
     public function onDoGhostbust()
     {
-        if (Phergie_Plugin_Users::getInstance() === null) {
+        if ($this->getInstance('Users') === null) {
             $password = $this->getPluginIni('password');
             $this->debug('password = ' . $password);