Add page to show the list of plugins

2015-09-26 15:57:39 -04:00 · 2015-09-26 15:57:39 -04:00 · 9ca4b43a97
parent 47c1bc9652
commit 9ca4b43a97
30 changed files with 194 additions and 2 deletions
--- a/app/Controller/Config.php
+++ b/app/Controller/Config.php
@ -77,6 +77,19 @@ class Config extends Base
        )));
    }

+    /**
+     * Display the plugin page
+     *
+     * @access public
+     */
+    public function plugins()
+    {
+        $this->response->html($this->layout('config/plugins', array(
+            'plugins' => $this->pluginLoader->plugins,
+            'title' => t('Settings').' &gt; '.t('Plugins'),
+        )));
+    }
+
    /**
     * Display the application settings page
     *
--- a/app/Core/Base.php
+++ b/app/Core/Base.php
@ -23,6 +23,7 @@ use Pimple\Container;
 * @property \Core\ObjectStorage\ObjectStorageInterface        $objectStorage
 * @property \Core\Cache\Cache                                 $memoryCache
 * @property \Core\Plugin\Hook                                 $hook
+ * @property \Core\Plugin\Loader                               $pluginLoader
 * @property \Integration\BitbucketWebhook                     $bitbucketWebhook
 * @property \Integration\GithubWebhook                        $githubWebhook
 * @property \Integration\GitlabWebhook                        $gitlabWebhook
--- a/app/Core/Plugin/Base.php
+++ b/app/Core/Plugin/Base.php
@ -44,4 +44,56 @@ abstract class Base extends \Core\Base
            call_user_func($callback, $container);
        });
    }
+
+    /**
+     * Get plugin name
+     *
+     * This method should be overrided by your Plugin class
+     *
+     * @access public
+     * @return string
+     */
+    public function getPluginName()
+    {
+        return ucfirst(substr(get_called_class(), 7, -7));
+    }
+
+    /**
+     * Get plugin description
+     *
+     * This method should be overrided by your Plugin class
+     *
+     * @access public
+     * @return string
+     */
+    public function getPluginDescription()
+    {
+        return '';
+    }
+
+    /**
+     * Get plugin author
+     *
+     * This method should be overrided by your Plugin class
+     *
+     * @access public
+     * @return string
+     */
+    public function getPluginAuthor()
+    {
+        return '?';
+    }
+
+    /**
+     * Get plugin version
+     *
+     * This method should be overrided by your Plugin class
+     *
+     * @access public
+     * @return string
+     */
+    public function getPluginVersion()
+    {
+        return '?';
+    }
 }
--- a/app/Core/Plugin/Loader.php
+++ b/app/Core/Plugin/Loader.php
@ -21,6 +21,14 @@ class Loader extends \Core\Base
     */
    const TABLE_SCHEMA = 'plugin_schema_versions';

+    /**
+     * Plugin instances
+     *
+     * @access public
+     * @var array
+     */
+    public $plugins = array();
+
    /**
     * Scan plugin folder and load plugins
     *
@ -55,6 +63,7 @@ class Loader extends \Core\Base
        Tool::buildDic($this->container, $instance->getClasses());

        $instance->initialize();
+        $this->plugins[] = $instance;
    }

    /**
--- a/app/Locale/cs_CZ/translations.php
+++ b/app/Locale/cs_CZ/translations.php
@ -1012,4 +1012,8 @@ return array(
    // 'Table of contents' => '',
    // 'Gantt' => '',
    // 'Help with project permissions' => '',
+    // 'Author' => '',
+    // 'Version' => '',
+    // 'Plugins' => '',
+    // 'There is no plugin loaded.' => '',
 );
--- a/app/Locale/da_DK/translations.php
+++ b/app/Locale/da_DK/translations.php
@ -1012,4 +1012,8 @@ return array(
    // 'Table of contents' => '',
    // 'Gantt' => '',
    // 'Help with project permissions' => '',
+    // 'Author' => '',
+    // 'Version' => '',
+    // 'Plugins' => '',
+    // 'There is no plugin loaded.' => '',
 );
--- a/app/Locale/de_DE/translations.php
+++ b/app/Locale/de_DE/translations.php
@ -1012,4 +1012,8 @@ return array(
    // 'Table of contents' => '',
    // 'Gantt' => '',
    // 'Help with project permissions' => '',
+    // 'Author' => '',
+    // 'Version' => '',
+    // 'Plugins' => '',
+    // 'There is no plugin loaded.' => '',
 );
--- a/app/Locale/es_ES/translations.php
+++ b/app/Locale/es_ES/translations.php
@ -1012,4 +1012,8 @@ return array(
    'Table of contents' => 'Tabla de contenido',
    'Gantt' => 'Gantt',
    'Help with project permissions' => 'Ayuda con permisos del proyecto',
+    // 'Author' => '',
+    // 'Version' => '',
+    // 'Plugins' => '',
+    // 'There is no plugin loaded.' => '',
 );
--- a/app/Locale/fi_FI/translations.php
+++ b/app/Locale/fi_FI/translations.php
@ -1012,4 +1012,8 @@ return array(
    // 'Table of contents' => '',
    // 'Gantt' => '',
    // 'Help with project permissions' => '',
+    // 'Author' => '',
+    // 'Version' => '',
+    // 'Plugins' => '',
+    // 'There is no plugin loaded.' => '',
 );
--- a/app/Locale/fr_FR/translations.php
+++ b/app/Locale/fr_FR/translations.php
@ -1014,4 +1014,8 @@ return array(
    'Table of contents' => 'Table des matières',
    'Gantt' => 'Gantt',
    'Help with project permissions' => 'Aide avec les permissions des projets',
+    'Author' => 'Auteur',
+    'Version' => 'Version',
+    'Plugins' => 'Extensions',
+    'There is no plugin loaded.' => 'Il n\'y a aucune extension chargée.',
 );
--- a/app/Locale/hu_HU/translations.php
+++ b/app/Locale/hu_HU/translations.php
@ -1012,4 +1012,8 @@ return array(
    // 'Table of contents' => '',
    // 'Gantt' => '',
    // 'Help with project permissions' => '',
+    // 'Author' => '',
+    // 'Version' => '',
+    // 'Plugins' => '',
+    // 'There is no plugin loaded.' => '',
 );
--- a/app/Locale/id_ID/translations.php
+++ b/app/Locale/id_ID/translations.php
@ -1012,4 +1012,8 @@ return array(
    'Table of contents' => 'Daftar isi',
    'Gantt' => 'Gantt',
    'Help with project permissions' => 'Bantuan dengan izin proyek',
+    // 'Author' => '',
+    // 'Version' => '',
+    // 'Plugins' => '',
+    // 'There is no plugin loaded.' => '',
 );
--- a/app/Locale/it_IT/translations.php
+++ b/app/Locale/it_IT/translations.php
@ -1012,4 +1012,8 @@ return array(
    // 'Table of contents' => '',
    // 'Gantt' => '',
    // 'Help with project permissions' => '',
+    // 'Author' => '',
+    // 'Version' => '',
+    // 'Plugins' => '',
+    // 'There is no plugin loaded.' => '',
 );
--- a/app/Locale/ja_JP/translations.php
+++ b/app/Locale/ja_JP/translations.php
@ -1012,4 +1012,8 @@ return array(
    // 'Table of contents' => '',
    // 'Gantt' => '',
    // 'Help with project permissions' => '',
+    // 'Author' => '',
+    // 'Version' => '',
+    // 'Plugins' => '',
+    // 'There is no plugin loaded.' => '',
 );
--- a/app/Locale/nb_NO/translations.php
+++ b/app/Locale/nb_NO/translations.php
@ -1012,4 +1012,8 @@ return array(
    'Table of contents' => 'Innholdsfortegnelse',
    'Gantt' => 'Gantt',
    'Help with project permissions' => 'Hjelp med prosjekttilganger',
+    // 'Author' => '',
+    // 'Version' => '',
+    // 'Plugins' => '',
+    // 'There is no plugin loaded.' => '',
 );
--- a/app/Locale/nl_NL/translations.php
+++ b/app/Locale/nl_NL/translations.php
@ -1012,4 +1012,8 @@ return array(
    // 'Table of contents' => '',
    // 'Gantt' => '',
    // 'Help with project permissions' => '',
+    // 'Author' => '',
+    // 'Version' => '',
+    // 'Plugins' => '',
+    // 'There is no plugin loaded.' => '',
 );
--- a/app/Locale/pl_PL/translations.php
+++ b/app/Locale/pl_PL/translations.php
@ -1012,4 +1012,8 @@ return array(
    // 'Table of contents' => '',
    // 'Gantt' => '',
    // 'Help with project permissions' => '',
+    // 'Author' => '',
+    // 'Version' => '',
+    // 'Plugins' => '',
+    // 'There is no plugin loaded.' => '',
 );
--- a/app/Locale/pt_BR/translations.php
+++ b/app/Locale/pt_BR/translations.php
@ -1012,4 +1012,8 @@ return array(
    'Table of contents' => 'Índice',
    'Gantt' => 'Gantt',
    'Help with project permissions' => 'Ajuda com as permissões dos projetos',
+    // 'Author' => '',
+    // 'Version' => '',
+    // 'Plugins' => '',
+    // 'There is no plugin loaded.' => '',
 );
--- a/app/Locale/pt_PT/translations.php
+++ b/app/Locale/pt_PT/translations.php
@ -1012,4 +1012,8 @@ return array(
    'Table of contents' => 'Tabela de conteúdos',
    'Gantt' => 'Gantt',
    'Help with project permissions' => 'Ajuda com permissões de projecto',
+    // 'Author' => '',
+    // 'Version' => '',
+    // 'Plugins' => '',
+    // 'There is no plugin loaded.' => '',
 );
--- a/app/Locale/ru_RU/translations.php
+++ b/app/Locale/ru_RU/translations.php
@ -1012,4 +1012,8 @@ return array(
    'Table of contents' => 'Сожержание',
    'Gantt' => 'Гантт',
    'Help with project permissions' => 'Помощь с правами доступа по проекту',
+    // 'Author' => '',
+    // 'Version' => '',
+    // 'Plugins' => '',
+    // 'There is no plugin loaded.' => '',
 );
--- a/app/Locale/sr_Latn_RS/translations.php
+++ b/app/Locale/sr_Latn_RS/translations.php
@ -1012,4 +1012,8 @@ return array(
    // 'Table of contents' => '',
    // 'Gantt' => '',
    // 'Help with project permissions' => '',
+    // 'Author' => '',
+    // 'Version' => '',
+    // 'Plugins' => '',
+    // 'There is no plugin loaded.' => '',
 );
--- a/app/Locale/sv_SE/translations.php
+++ b/app/Locale/sv_SE/translations.php
@ -1012,4 +1012,8 @@ return array(
    // 'Table of contents' => '',
    // 'Gantt' => '',
    // 'Help with project permissions' => '',
+    // 'Author' => '',
+    // 'Version' => '',
+    // 'Plugins' => '',
+    // 'There is no plugin loaded.' => '',
 );
--- a/app/Locale/th_TH/translations.php
+++ b/app/Locale/th_TH/translations.php
@ -1012,4 +1012,8 @@ return array(
    // 'Table of contents' => '',
    // 'Gantt' => '',
    // 'Help with project permissions' => '',
+    // 'Author' => '',
+    // 'Version' => '',
+    // 'Plugins' => '',
+    // 'There is no plugin loaded.' => '',
 );
--- a/app/Locale/tr_TR/translations.php
+++ b/app/Locale/tr_TR/translations.php
@ -1012,4 +1012,8 @@ return array(
    // 'Table of contents' => '',
    // 'Gantt' => '',
    // 'Help with project permissions' => '',
+    // 'Author' => '',
+    // 'Version' => '',
+    // 'Plugins' => '',
+    // 'There is no plugin loaded.' => '',
 );
--- a/app/Locale/zh_CN/translations.php
+++ b/app/Locale/zh_CN/translations.php
@ -1012,4 +1012,8 @@ return array(
    // 'Table of contents' => '',
    // 'Gantt' => '',
    // 'Help with project permissions' => '',
+    // 'Author' => '',
+    // 'Version' => '',
+    // 'Plugins' => '',
+    // 'There is no plugin loaded.' => '',
 );
--- a/app/ServiceProvider/ClassProvider.php
+++ b/app/ServiceProvider/ClassProvider.php
@ -2,6 +2,7 @@

 namespace ServiceProvider;

+use Core\Plugin\Loader;
 use Core\ObjectStorage\FileStorage;
 use Core\Paginator;
 use Core\OAuth2;
@ -117,5 +118,7 @@ class ClassProvider implements ServiceProviderInterface
        $container['objectStorage'] = function() {
            return new FileStorage(FILES_DIR);
        };
+
+        $container['pluginLoader'] = new Loader($container);
    }
 }
--- a/app/Template/config/plugins.php
+++ b/app/Template/config/plugins.php
@ -0,0 +1,24 @@
+<div class="page-header">
+    <h2><?= t('Plugins') ?></h2>
+</div>
+
+<?php if (empty($plugins)): ?>
+    <p class="alert"><?= t('There is no plugin loaded.') ?></p>
+<?php else: ?>
+    <table class="table-stripped">
+        <tr>
+            <th class="column-20"><?= t('Name') ?></th>
+            <th class="column-20"><?= t('Author') ?></th>
+            <th class="column-10"><?= t('Version') ?></th>
+            <th><?= t('Description') ?></th>
+        </tr>
+
+    <?php foreach($plugins as $plugin): ?>
+    <tr>
+        <td><?= $this->e($plugin->getPluginName()) ?></td>
+        <td><?= $this->e($plugin->getPluginAuthor()) ?></td>
+        <td><?= $this->e($plugin->getPluginVersion()) ?></td>
+        <td><?= $this->e($plugin->getPluginDescription()) ?></td>
+    </tr>
+    <?php endforeach ?>
+<?php endif ?>
--- a/app/Template/config/sidebar.php
+++ b/app/Template/config/sidebar.php
@ -4,6 +4,9 @@
        <li <?= $this->app->getRouterAction() === 'index' ? 'class="active"' : '' ?>>
            <?= $this->url->link(t('About'), 'config', 'index') ?>
        </li>
+        <li <?= $this->app->getRouterAction() === 'plugins' ? 'class="active"' : '' ?>>
+            <?= $this->url->link(t('Plugins'), 'config', 'plugins') ?>
+        </li>
        <li <?= $this->app->getRouterAction() === 'application' ? 'class="active"' : '' ?>>
            <?= $this->url->link(t('Application settings'), 'config', 'application') ?>
        </li>
--- a/app/common.php
+++ b/app/common.php
@ -33,5 +33,4 @@ if (ENABLE_URL_REWRITE) {
    require __DIR__.'/routes.php';
 }

-$plugin = new Core\Plugin\Loader($container);
-$plugin->scan();
+$container['pluginLoader']->scan();
--- a/doc/plugins.markdown
+++ b/doc/plugins.markdown
@ -70,6 +70,10 @@ Available methods from `Core\Plugin\Base`:
 - `initialize()`: Executed when the plugin is loaded
 - `getClasses()`: Return all classes that should be stored in the dependency injection container
 - `on($event, $callback)`: Listen on internal events
+- `getPluginName()`: Get plugin name
+- `getPluginAuthor()`: Get plugin author
+- `getPluginVersion()`: Get plugin version
+- `getPluginDescription()`: Get plugin description

 Your plugin registration class also inherit from `Core\Base`, that means you can access to all classes and methods of Kanboard easily.