Stub plugins administration panel, allows for disabling/re-enabling plugins from...

[quix0rs-gnu-social.git] / lib / pluginlist.php

diff --git a/lib/pluginlist.php b/lib/pluginlist.php
new file mode 100644 (file)
index 0000000..07a17ba
--- /dev/null
+++ b/lib/pluginlist.php
@@ -0,0 +1,213 @@
+<?php
+/**
+ * StatusNet, the distributed open-source microblogging tool
+ *
+ * Plugins administration panel
+ *
+ * PHP version 5
+ *
+ * LICENCE: This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ * @category  Settings
+ * @package   StatusNet
+ * @author    Brion Vibber <brion@status.net>
+ * @copyright 2010 StatusNet, Inc.
+ * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
+ * @link      http://status.net/
+ */
+
+if (!defined('STATUSNET')) {
+    exit(1);
+}
+
+require INSTALLDIR . "/lib/pluginenableform.php";
+require INSTALLDIR . "/lib/plugindisableform.php";
+
+/**
+ * Plugin list
+ *
+ * @category Admin
+ * @package  StatusNet
+ * @author   Brion Vibber <brion@status.net>
+ * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
+ * @link     http://status.net/
+ */
+
+class PluginList extends Widget
+{
+    var $plugins = array();
+
+    function __construct($plugins, $out)
+    {
+        parent::__construct($out);
+        $this->plugins = $plugins;
+    }
+
+    function show()
+    {
+        $this->startList();
+        $this->showPlugins();
+        $this->endList();
+    }
+
+    function startList()
+    {
+        $this->out->elementStart('table', 'plugin_list');
+    }
+
+    function endList()
+    {
+        $this->out->elementEnd('table');
+    }
+
+    function showPlugins()
+    {
+        foreach ($this->plugins as $plugin) {
+            $pli = $this->newListItem($plugin);
+            $pli->show();
+        }
+    }
+
+    function newListItem($plugin)
+    {
+        return new PluginListItem($plugin, $this->out);
+    }
+}
+
+class PluginListItem extends Widget
+{
+    /** Current plugin. */
+    var $plugin = null;
+
+    /** Local cache for plugin version info */
+    protected static $versions = false;
+
+    function __construct($plugin, $out)
+    {
+        parent::__construct($out);
+        $this->plugin = $plugin;
+    }
+
+    function show()
+    {
+        $meta = $this->metaInfo();
+
+        $this->out->elementStart('tr', array('id' => 'plugin-' . $this->plugin));
+
+        // Name and controls
+        $this->out->elementStart('td');
+        $this->out->elementStart('div');
+        if (!empty($meta['homepage'])) {
+            $this->out->elementStart('a', array('href' => $meta['homepage']));
+        }
+        $this->out->text($this->plugin);
+        if (!empty($meta['homepage'])) {
+            $this->out->elementEnd('a');
+        }
+        $this->out->elementEnd('div');
+        
+        $form = $this->getControlForm();
+        $form->show();
+
+        $this->out->elementEnd('td');
+
+        // Version and authors
+        $this->out->elementStart('td');
+        if (!empty($meta['version'])) {
+            $this->out->elementStart('div');
+            $this->out->text($meta['version']);
+            $this->out->elementEnd('div');
+        }
+        if (!empty($meta['author'])) {
+            $this->out->elementStart('div');
+            $this->out->text($meta['author']);
+            $this->out->elementEnd('div');
+        }
+        $this->out->elementEnd('td');
+
+        // Description
+        $this->out->elementStart('td');
+        if (!empty($meta['rawdescription'])) {
+            $this->out->raw($meta['rawdescription']);
+        }
+        $this->out->elementEnd('td');
+
+        $this->out->elementEnd('tr');
+    }
+
+    /**
+     * Pull up the appropriate control form for this plugin, depending
+     * on its current state.
+     *
+     * @return Form
+     */
+    protected function getControlForm()
+    {
+        $key = 'disable-' . $this->plugin;
+        if (common_config('plugins', $key)) {
+            return new PluginEnableForm($this->out, $this->plugin);
+        } else {
+            return new PluginDisableForm($this->out, $this->plugin);
+        }
+    }
+
+    /**
+     * Grab metadata about this plugin...
+     * Warning: horribly inefficient and may explode!
+     * Doesn't work for disabled plugins either.
+     *
+     * @fixme pull structured data from plugin source
+     */
+    function metaInfo()
+    {
+        $versions = self::getPluginVersions();
+        $found = false;
+
+        foreach ($versions as $info) {
+            // hack for URL shorteners... "LilUrl (ur1.ca)" etc
+            list($name, ) = explode(' ', $info['name']);
+
+            if ($name == $this->plugin) {
+                if ($found) {
+                    // hack for URL shorteners...
+                    $found['rawdescription'] .= "<br />\n" . $info['rawdescription'];
+                } else {
+                    $found = $info;
+                }
+            }
+        }
+
+        if ($found) {
+            return $found;
+        } else {
+            return array('name' => $this->plugin,
+                         'rawdescription' => _m('plugin-description',
+                                                '(Plugin descriptions unavailable when disabled.)'));
+        }
+    }
+
+    /**
+     * Lazy-load the set of active plugin version info
+     * @return array
+     */
+    protected static function getPluginVersions()
+    {
+        if (!is_array(self::$versions)) {
+            $versions = array();
+            Event::handle('PluginVersion', array(&$versions));
+            self::$versions = $versions;
+        }
+        return self::$versions;
+    }
+}