#6915 Renamed plugin management commands

CHANGELOG.md

@@ -4,6 +4,9 @@ This is a changelog for Piwik platform developers. All changes for our HTTP API'
 
 ## Piwik 2.11.0
 
+### Breaking Changes
+* The event `User.getLanguage` has been removed.
+
 ### Deprecations
 * The following methods have been deprecated in favor of the new `Piwik\Intl` component:
   * `Piwik\Common::getContinentsList()`: use `RegionDataProvider::getContinentList()` instead
@@ -11,14 +14,8 @@ This is a changelog for Piwik platform developers. All changes for our HTTP API'
   * `Piwik\Common::getLanguagesList()`: use `LanguageDataProvider::getLanguageList()` instead
   * `Piwik\Common::getLanguageToCountryList()`: use `LanguageDataProvider::getLanguageToCountryList()` instead
   * `Piwik\Metrics\Formatter::getCurrencyList()`: use `CurrencyDataProvider::getCurrencyList()` instead
-
-## Piwik 2.11.0
-
-### Breaking Changes
-* The event `User.getLanguage` has been removed.
-
-### Deprecations
 * The `Piwik\Translate` class has been deprecated in favor of `Piwik\Translation\Translator`.
+* The `core:plugin` console has been deprecated in favor of the new `plugin:list`, `plugin:activate` and `plugin:deactivate` commands
 
 ## Piwik 2.10.0
 

plugins/CoreConsole/Commands/ManagePlugin.php

@@ -9,7 +9,10 @@
 namespace Piwik\Plugins\CoreConsole\Commands;
 
 use Piwik\Plugin\ConsoleCommand;
-use Piwik\Plugin\Manager;
+use Piwik\Plugins\CorePluginsAdmin\Commands\ActivatePlugin;
+use Piwik\Plugins\CorePluginsAdmin\Commands\DeactivatePlugin;
+use Piwik\Plugins\CorePluginsAdmin\Commands\ListPlugins;
+use Symfony\Component\Console\Input\ArrayInput;
 use Symfony\Component\Console\Input\InputArgument;
 use Symfony\Component\Console\Input\InputInterface;
 use Symfony\Component\Console\Input\InputOption;
@@ -17,6 +20,8 @@ use Symfony\Component\Console\Output\OutputInterface;
 
 /**
  * core:plugin console command.
+ *
+ * @deprecated This command has been replaced with `plugin:*` commands.
  */
 class ManagePlugin extends ConsoleCommand
 {
@@ -72,27 +77,32 @@ class ManagePlugin extends ConsoleCommand
 
     private function activatePlugin(InputInterface $input, OutputInterface $output, $plugin)
     {
-        Manager::getInstance()->activatePlugin($plugin, $input, $output);
+        $output->writeln('<comment>Warning: the command core:plugin is deprecated, use plugin:activate instead.</comment>');
 
-        $output->writeln("Activated plugin <info>$plugin</info>");
+        $command = new ActivatePlugin();
+        $input = new ArrayInput(array(
+            'plugin' => $plugin,
+        ));
+        return $command->run($input, $output);
     }
 
     private function deactivatePlugin(InputInterface $input, OutputInterface $output, $plugin)
     {
-        Manager::getInstance()->deactivatePlugin($plugin, $input, $output);
+        $output->writeln('<comment>Warning: the command core:plugin is deprecated, use plugin:deactivate instead.</comment>');
 
-        $output->writeln("Deactivated plugin <info>$plugin</info>");
+        $command = new DeactivatePlugin();
+        $input = new ArrayInput(array(
+            'plugin' => $plugin,
+        ));
+        return $command->run($input, $output);
     }
 
-    private function listPlugins(InputInterface $input, OutputInterface $output, $plugin)
+    private function listPlugins(InputInterface $input, OutputInterface $output)
     {
-        $plugins = Manager::getInstance()->getPluginsLoadedAndActivated();
-
-        $count = count($plugins);
-        $output->writeln("Listing $count activated plugins:");
-        foreach($plugins as $plugin) {
-            $pluginName = $plugin->getPluginName();
-            $output->writeln("<info>$pluginName</info>");
-        };
+        $output->writeln('<comment>Warning: the command core:plugin is deprecated, use plugin:list instead.</comment>');
+
+        $command = new ListPlugins();
+        $input = new ArrayInput(array());
+        return $command->run($input, $output);
     }
 }
\ No newline at end of file

plugins/CorePluginsAdmin/Commands/ActivatePlugin.php

+<?php
+/**
+ * Piwik - free/libre analytics platform
+ *
+ * @link http://piwik.org
+ * @license http://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
+ */
+
+namespace Piwik\Plugins\CorePluginsAdmin\Commands;
+
+use Piwik\Plugin\ConsoleCommand;
+use Piwik\Plugin\Manager;
+use Symfony\Component\Console\Input\InputArgument;
+use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Output\OutputInterface;
+
+/**
+ * plugin:activate console command.
+ */
+class ActivatePlugin extends ConsoleCommand
+{
+    protected function configure()
+    {
+        $this->setName('plugin:activate');
+        $this->setDescription('Activate a plugin.');
+        $this->addArgument('plugin', InputArgument::REQUIRED, 'The plugin name.');
+    }
+
+    protected function execute(InputInterface $input, OutputInterface $output)
+    {
+        $pluginManager = Manager::getInstance();
+
+        $plugin = $input->getArgument('plugin');
+
+        if ($pluginManager->isPluginActivated($plugin)) {
+            $output->writeln('<comment>The plugin is already activated.</comment>');
+            return;
+        }
+
+        $pluginManager->activatePlugin($plugin);
+
+        $output->writeln("Activated plugin <info>$plugin</info>");
+    }
+}

plugins/CorePluginsAdmin/Commands/DeactivatePlugin.php

+<?php
+/**
+ * Piwik - free/libre analytics platform
+ *
+ * @link http://piwik.org
+ * @license http://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
+ */
+
+namespace Piwik\Plugins\CorePluginsAdmin\Commands;
+
+use Piwik\Plugin\ConsoleCommand;
+use Piwik\Plugin\Manager;
+use Symfony\Component\Console\Input\InputArgument;
+use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Output\OutputInterface;
+
+/**
+ * plugin:deactivate console command.
+ */
+class DeactivatePlugin extends ConsoleCommand
+{
+    protected function configure()
+    {
+        $this->setName('plugin:deactivate');
+        $this->setDescription('Deactivate a plugin.');
+        $this->addArgument('plugin', InputArgument::REQUIRED, 'The plugin name.');
+    }
+
+    protected function execute(InputInterface $input, OutputInterface $output)
+    {
+        $pluginManager = Manager::getInstance();
+
+        $plugin = $input->getArgument('plugin');
+
+        if (!$pluginManager->isPluginActivated($plugin)) {
+            $output->writeln('<comment>The plugin is already deactivated.</comment>');
+            return;
+        }
+
+        $pluginManager->deactivatePlugin($plugin);
+
+        $output->writeln("Deactivated plugin <info>$plugin</info>");
+    }
+}

plugins/CorePluginsAdmin/Commands/ListPlugins.php

+<?php
+/**
+ * Piwik - free/libre analytics platform
+ *
+ * @link http://piwik.org
+ * @license http://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
+ */
+
+namespace Piwik\Plugins\CorePluginsAdmin\Commands;
+
+use Piwik\Plugin\ConsoleCommand;
+use Piwik\Plugin\Manager;
+use Symfony\Component\Console\Helper\Table;
+use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Output\OutputInterface;
+
+/**
+ * plugin:list console command.
+ */
+class ListPlugins extends ConsoleCommand
+{
+    protected function configure()
+    {
+        $this->setName('plugin:list');
+        $this->setDescription('List installed plugins.');
+    }
+
+    protected function execute(InputInterface $input, OutputInterface $output)
+    {
+        $pluginManager = Manager::getInstance();
+
+        $plugins = $pluginManager->getInstalledPluginsName();
+
+        $plugins = array_map(function ($plugin) use ($pluginManager) {
+            return array(
+                '<info>' . $plugin . '</info>',
+                $pluginManager->isPluginBundledWithCore($plugin) ? 'Core' : 'Optional',
+                $pluginManager->isPluginActivated($plugin) ? 'Activated' : '<comment>Not activated</comment>',
+            );
+        }, $plugins);
+
+        // Sort Core plugins first
+        usort($plugins, function ($a, $b) {
+            return strcmp($a[1], $b[1]);
+        });
+
+        $table = new Table($output);
+        $table
+            ->setHeaders(array('Plugin', 'Core or optional?', 'Status'))
+            ->setRows($plugins)
+        ;
+        $table->render();
+    }
+}