root/trunk/Phergie/Plugin/ModuleList.php @ 161

<?php

/**
* @see Phergie_Plugin_AdminCommand
*/
require_once 'Phergie/Plugin/Abstract/AdminCommand.php';

/**
* Handles requests from administrators to list currently running plugins.
* By default, plugins returns a list of all the plugins running.
* Optionally, you can pass arguments such as plugins -m to list all the
* muted. Multiple arguments can bepassed such as plugins -m -d to get a
* list of all the muted and disabled plugins.
*/
class Phergie_Plugin_ModuleList extends Phergie_Plugin_Abstract_AdminCommand
{

    /**
    * An array containing a list of arguments as the array's keys that are
    * available and the value is what the argurment is mapped to.
    *
    * @var array
    */
    protected $argList = array(
        'v' => 'Verbose',      // Extended/Verbose All Plugins List
        'e' => 'Enabled',      // Enabled Plugins List
        'd' => 'Disabled',     // Disabled Plugins List
        'm' => 'Muted',        // Muted Plugins list
        'g' => 'Global_Muted', // Global Muted Plugins List
        'l' => 'Local_Muted',  // Local/Current Channel Muted plugins list
        'u' => 'Unmuted',      // Unmuted Plugins List
        'a' => 'Admin',        // Admin Plugins List
        'b' => 'Base',         // Base/Core Plugins List
    );

    public function onDoPlugins($rawArgs='') {
        $source = $this->event->getSource();
        $rawArgs = $this->parseArguments($rawArgs);
        $pluginData = array();

        // Loop through the parsed args and formats them
        $args = array();
        foreach($rawArgs['flags'] as $arg => $value) {
            if ($arg == 'mg' || $arg == 'mutedglobal') $arg = 'g';
            else if ($arg == 'ml' || $arg == 'mutedlocal') $arg = 'l';
            $args[substr(strtolower($arg), 0, 1)] = $value;
        }
        unset($rawArgs);

        // Help command, return a list of all supprted commands
        if ($args['h']) {
            $message = 'Help Info: ';
            foreach($this->argList as $arg => $info) {
                // Get the commands. Format: -c, -command = Info
                $message .= '-'.$arg.', -'.str_replace('_','',strtolower($info)).' = '.
                            str_replace('_',' ',ucfirst($info)).' '.($arg == 'v'?'mode':'plugins').' | ';
            }
            $this->doPrivmsg($source, trim($message, "| \t\n\r\0\v\0xa0"));
            return;
        }

        // Retrieve and loop through th plugins to gather a list of information about them.
        $plugins = $this->getPlugins();
        foreach($plugins as $plugin => $data) {
            $plugin = ucfirst(trim($plugin));
            if (!empty($plugin)) {
                // Checks to see if the plugins are enabled or not
                if ($data->enabled) {
                    $pluginData['Enabled'][] = $plugin;
                } else {
                    $pluginData['Disabled'][] = $plugin;
                }
                // Checks to see if the plugins are muted or not
                if ($data->muted[$source] || $data->muted['global']) {
                    $pluginData['Muted'][] = $plugin . ($data->muted['global']?'*':'');
                    if ($data->muted['global']) {
                        $pluginData['Global_Muted'][] = $plugin;
                    }
                    if ($data->muted[$source]) {
                        $pluginData['Local_Muted'][] = $plugin;
                    }
                } else {
                    $pluginData['Unmuted'][] = $plugin;
                }
                // Checks to see if the plugins are admin plugins or not
                if ($data instanceof Phergie_Plugin_Abstract_AdminCommand) {
                    $pluginData['Admin'][] = $plugin;
                } else {
                    $pluginData['Base'][] = $plugin;
                }
                // Extended/Verbose plugins list that shows every plugin and their state
                $state = $prepend = $append = null;
                if ($args['v'] && is_array($pluginData)) {
                    // Check to see if admin
                    if (is_array($pluginData['Admin']) && in_array($plugin, $pluginData['Admin']))
                        $state .= 'A';
                    // Check if disabled
                    if (is_array($pluginData['Disabled']) && in_array($plugin, $pluginData['Disabled']))
                        $state .= 'D';
                    // Check if locally muted
                    if (is_array($pluginData['Local_Muted']) && in_array($plugin, $pluginData['Local_Muted']))
                        $state .= 'L';
                    // Check to see if globally muted
                    if (is_array($pluginData['Global_Muted']) && in_array($plugin, $pluginData['Global_Muted']))
                        $state .= 'G';
                    // Format the append data if its set
                    $state = (!empty($state) ? '('.trim($state).')' : '');
                }
                // All plugins list
                $pluginData['all'][] = $prepend . $plugin . $append . $state;
            }
        }
        unset($plugins);

        // Go through the list of any passed arugments and generate the plugin list for them
        $message = null;
        if (!$args['v']) {
            foreach($args as $arg => $value) {
                $plugin = $this->argList[$arg];
                if (isset($plugin)) {
                    if (is_array($pluginData[$plugin]) && count($pluginData[$plugin]) > 0) {
                        sort($pluginData[$plugin]);
                    }
                    $plugins = trim(count($pluginData[$plugin]) > 0 ? implode(', ', $pluginData[$plugin]) : '');
                    $message .= ucfirst(str_replace('_',' ',$plugin)).': '.($plugins ? $plugins : 'No Plugins').' :: ';
                }
            }
            unset($plugins);
        }

        // Cleans the message and stips out useless characters
        $message = trim($message, ": \t\n\r\0\v\0xa0");
        // If the message is empty, aka no args were passed, return the full plugin list
        if (empty($message)) {
            sort($pluginData['all']);
            $message = ($args['v'] ? 'Verbose' : 'Plugins') . ': '.implode(', ', $pluginData['all']);
        }

        $this->doPrivmsg($source, $message);
        unset($message);
    }
}