Changeset 193

Timestamp:

03/29/08 12:59:29 (8 months ago)

Author:

Slynderdale

Message:

Added several bug fixes and also made AdminFunctions obsolete. Moved the fromAdmin function to Base.php and made the Users op check an optional check so Users can be disabled and the admin check will still work. Also added onPHPError, A custom error handler for plugins to capture PHP errors. Also added a pluginLoaded and a static pluginLoaded function to easily check to see if a plugin is loaded.

Now that AdminFunctions is obselete, Admin plugins now need to extend Command and specify the $this->needsAdmin flag to differate itself from normal plugins.

Files:

• trunk/Phergie/Plugin/Abstract/AdminCommand.php (deleted)
• trunk/Phergie/Plugin/Abstract/Base.php (modified) (13 diffs)
• trunk/Phergie/Plugin/Abstract/Command.php (modified) (4 diffs)

trunk/Phergie/Plugin/Abstract/Base.php

@@ -4 +4 @@
-* @see Phergie_Driver_Abstract
-*/
-'Phergie/Driver/
+PHERGIE_DRIVER_DIR.'
-
-/**
-* @see Phergie_Event_Request
-*/
-'Phergie/Event/
+PHERGIE_EVENT_DIR.'
-
-/**
-* @see Phergie_Event_Response
-*/
-'Phergie/Event/
+PHERGIE_EVENT_DIR.'
-
-/**
@@ -60 +60 @@
-
-    /**
+    * List of administrator hostmasks
+    *
+    * @var array
+    */
+    protected $adminList = array();
+
+    /**
+    * List of channel ops
+    *
+    * @var array
+    */
+    protected $opList = array();
+
+    /**
-     * Flag indicating whether or not the plugin is enabled and receives events
-     *
@@ -74 +88 @@
-
-    /**
+     * Flag indicating whether or not the plugin is a passive plugin or not
+     *
+     * @var bool
+     */
+    public $passive = false;
+
+    /**
-    * Sets a reference to the client used to initiate commands.
-    *
@@ -81 +102 @@
-    final public function __construct(Phergie_Driver_Abstract $client)
-    {
+        set_error_handler(array(__CLASS__, 'onBaseError'));
-        $this->client = $client;
-
@@ -88 +110 @@
-        if ($this->needsDir) {
-            $class = new ReflectionClass($name);
-
-
-
-
-
+
-            if (!file_exists($dir)) {
-                mkdir($dir);
@@ -101 +119 @@
-
-    /**
+    * Base error handler for PHP errors. This functions called onPHPError for
+    * any clas extending it to give each plugin its own error handler.
+    *
+    * @return bool
+    */
+    public final function onBaseError($errno, $errstr, $errfile, $errline) {
+        if (!isset($this)) {
+                return false;
+        }
+        return call_user_func_array(array($this, 'onPHPError'), array($errno, $errstr, $errfile, $errline));
+    }
+
+    /**
-    * Returns the short name of the current plugin.
-    *
@@ -181 +212 @@
-    public function debug($message)
-    {
-strtolower($this->name) . ' -
+'<' . strtolower($this->name) . '
-    }
-
@@ -224 +255 @@
-    public function decodeTranslit($text, $charSetFrom = 'UTF-8', $charSetTo = 'ISO-8859-1') {
-        $text = html_entity_decode($text, ENT_QUOTES, $charSetFrom);
-
-
+
+
+
+
-
-        // Use the translit extension if installed else fallback on to basic transliteration
@@ -234 +267 @@
-            $text = transliterate($text, array('han_transliterate', 'diacritical_remove'), $charSetFrom, $charSetTo);
-        } else {
-��������������������������������������������������������������
+ÀÁÂÃÄÅÆÇÈÉÊËÌÍÎÏÐÑÒÓÔÕÖØÙÚÛÜÝÞßàáâãäåæçèéêëìíîïðñòóôõöøùúûüýþÿ
-                                 'AAAAAAACEEEEIIIIDNOOOOOOUUUUYPYaaaaaaaceeeeiiiidnoooooouuuuypy');
-�^!�\[\]$*���%�
+§^!°\[\]$*¨µ£%´
-            $text = utf8_decode($text);
-        }
@@ -405 +438 @@
-
-    /**
+    * Checks if a specified plugin is loaded
+    *
+    * @param string $plugin Plugin to check
+    * @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
+    */
+    public function pluginLoaded($plugin, $plugins = null, $client = null) {
+        $plugin = trim($plugin);
+        if (!empty($plugin)) {
+            if (!$client) {
+                $client = $this->client;
+            }
+            if (!is_array($plugins) || count($plugins) <= 0) {
+                $plugins = $this->getPluginList();
+            }
+            $plugins = array_map('strtolower', $plugins);
+            if (in_array(strtolower($plugin), $plugins) && class_exists('Phergie_Plugin_' . $plugin) &&
+                call_user_func(array('Phergie_Plugin_' . $plugin, 'checkDependencies'), $client, $plugins)) {
+                return true;
+            }
+        }
+        return false;
+    }
+
+    /**
+    * Static call to check if a specified plugin is loaded
+    *
+    * @param string $plugin Plugin to check
+    * @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
+    */
+    public static function staticPluginLoaded($plugin, $plugins, $client) {
+        $plugin = trim($plugin);
+        if (!empty($plugin) && is_array($plugins)) {
+            $plugins = array_map('strtolower', $plugins);
+            if (in_array(strtolower($plugin), $plugins) && class_exists('Phergie_Plugin_' . $plugin) &&
+                call_user_func(array('Phergie_Plugin_' . $plugin, 'checkDependencies'), $client, $plugins)) {
+                return true;
+            }
+        }
+        return false;
+    }
+
+    /**
+    * Returns whether or not a message originated from an authorized admin or
+    * op.
+    *
+    * @param bool $includeOps Include ops in the admin check
+    * @return bool TRUE if the message originated from an authorized
+    *              individual, FALSE otherwise
+    */
+    public function fromAdmin($includeOps = true)
+    {
+        $class = $this->getName();
+        // Check to see if the current class has any admin or ops settings specified
+        if (!isset($this->adminList[$class]) || !isset($this->opList[$class])) {
+                // Handle the op settings
+                $ini = $this->getPluginIni('ops');
+                if ($ini === null) {
+                $ini = $this->getIni('admincommand.ops');
+            }
+            $this->opList[$class] = ((strtolower($ini) === 'true' || $ini === '1'));
+
+            // Handle the admin settings
+            $ini = trim($this->getPluginIni('admins') . ' ' . $this->getIni('admincommand.admins'));
+            $this->adminList[$class] = (!empty($ini) ? $this->hostmasksToRegex($ini) : null);
+            unset($ini);
+        }
+
+        // Try to match mask against admin masks
+        if (isset($this->adminList[$class])
+            && preg_match($this->adminList[$class], $this->event->getHostmask())) {
+            return true;
+        }
+
+        // Check if is op and ops are admins
+        if ($includeOps && isset($this->opList[$class]) && $this->pluginLoaded('Users')) {
+            $nick = $this->event->getNick();
+            $source = $this->event->getSource();
+            if (Phergie_Plugin_Users::isOp($nick, $source)) {
+                return true;
+            }
+        }
+        return false;
+    }
+
+    /**
-    * Returns whether or not the current environment meets the requirements
-    * of the plugin in order for it to be run, including the PHP version,
@@ -586 +710 @@
-
-    /**
+    * Handler for when the server sends a kill request.
+    *
+    * @return void
+    */
+    public function onKill() { }
+
+    /**
-    * Handler for when a server response is received to a client-issued
-    * command.
@@ -592 +723 @@
-    */
-    public function onResponse() { }
+
+    /**
+    * Handler for when PHP throws an error
+    *
+    * @return void
+    */
+    public function onPHPError($errno, $errstr, $errfile, $errline) { return false; }
-
-    /**
@@ -605 +743 @@
-    {
-        // Silence output calls if the plugin is muted for that source or globally
-
-
+
+
+
+
+
-                (isset($this->muted['global']) && $this->muted['global'])) &&
-                substr($method, 0, 2) === 'do') {

trunk/Phergie/Plugin/Abstract/Command.php

@@ -4 +4 @@
-* @see Phergie_Plugin_Abstract_Base
-*/
-'Phergie/Plugin/Abstract/
+PHERGIE_PLUGIN_DIR.'Abstract'.DS.'
-
-/**
@@ -19 +19 @@
-    */
-    private $methods;
+
+    /**
+     * Flag indicating whether or not the plugin is an admin plugin or not
+     *
+     * @var bool
+     */
+    public $needsAdmin = false;
-
-    /**
@@ -36 +43 @@
-    *
-    * @param string $message Message to analyze
+    * @param bool $ignorePrefix Whether or not to ignore the command prefix
+    * @param bool $forceBotPrefix Whether or not to require the bot's name as a
+    *                             prefix
-    * @return void
-    */
@@ -52 +62 @@
-                }
-            }
+        }
+
+        // Checks to see if the plugin is an admin plugin and run the checks
+        if ($this->needsAdmin) {
+                if (!$this->fromAdmin()) {
+                        return;
+                }
+                $ignorePrefix = $forceBotPrefix = true;
-        }
-