Add command to generate a system check (#17832)

* Add command to generate a system check

* Update plugins/CoreConsole/Commands/GenerateSystemCheck.php

Co-authored-by: Stefan Giehl <stefan@matomo.org>

* fix sprintf

Co-authored-by: Stefan Giehl <stefan@matomo.org>
Co-authored-by: diosmosis <diosmosis@users.noreply.github.com>

1 files changed, 106 insertions, 0 deletions

diff --git a/plugins/CoreConsole/Commands/GenerateSystemCheck.php b/plugins/CoreConsole/Commands/GenerateSystemCheck.php
new file mode 100644
index 0000000000..00f64529b0
--- /dev/null
+++ b/plugins/CoreConsole/Commands/GenerateSystemCheck.php
@@ -0,0 +1,106 @@
+<?php
+/**
+ * Matomo - free/libre analytics platform
+ *
+ * @link https://matomo.org
+ * @license http://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
+ *
+ */
+
+namespace Piwik\Plugins\CoreConsole\Commands;
+
+use Piwik\Common;
+use Piwik\Plugin\Manager;
+use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Input\InputOption;
+use Symfony\Component\Console\Output\OutputInterface;
+
+class GenerateSystemCheck extends GeneratePluginBase
+{
+    protected function configure()
+    {
+        $this->setName('generate:system-check')
+            ->setDescription('Adds a new system check to an existing plugin')
+            ->addOption('pluginname', null, InputOption::VALUE_REQUIRED, 'The name of an existing plugin which does not have a menu defined yet')
+            ->addOption('checkname', null, InputOption::VALUE_REQUIRED, 'The name of the system check you want to create');
+    }
+
+    protected function execute(InputInterface $input, OutputInterface $output)
+    {
+        $pluginName = $this->getPluginName($input, $output);
+        $this->checkAndUpdateRequiredPiwikVersion($pluginName, $output);
+
+        $checkName = $this->getSystemCheckName($input, $output);
+        $className = ucfirst(str_replace(' ' , '', $checkName));
+        if (!Common::stringEndsWith($className, 'check') && !Common::stringEndsWith($className, 'Check'))  {
+            $className .= 'Check';
+        }
+
+        $exampleFolder  = Manager::getPluginDirectory('ExamplePlugin');
+        $replace        = array('ExampleCheck'  => $className,
+                                'Example Check'  => $checkName,
+                                'ExamplePlugin'  => $pluginName,
+        );
+
+        $whitelistFiles = array('/Diagnostic', '/Diagnostic/ExampleCheck.php');
+
+        $this->copyTemplateToPlugin($exampleFolder, $pluginName, $replace, $whitelistFiles);
+
+        $this->writeSuccessMessage($output, array(
+            sprintf('plugins/%s/Diagnostic/%s.php for %s generated.', $pluginName, $className, $pluginName),
+            sprintf('You should now implement the method called <comment>execute</comment> in %s.php', $className),
+            'You also need to make the diagnostic check known to Matomo in your "plugins/'.$pluginName.'/config/config.php".',
+            'Read more about this here: https://developer.matomo.org/guides/system-check',
+            'Enjoy!'
+        ));
+    }
+
+    /**
+     * @param InputInterface $input
+     * @param OutputInterface $output
+     * @return string
+     * @throws \RuntimeException
+     */
+    protected function getSystemCheckName(InputInterface $input, OutputInterface $output)
+    {
+        $validate = function ($checkName) {
+            if (empty($checkName)) {
+                throw new \InvalidArgumentException('Please enter the name of your system check');
+            }
+
+            if (preg_match("/[^A-Za-z0-9 ]/", $checkName)) {
+                throw new \InvalidArgumentException('Only alpha numerical characters and whitespaces are allowed');
+            }
+
+            return $checkName;
+        };
+
+        $checkName = $input->getOption('checkname');
+
+        if (empty($checkName)) {
+            $dialog = $this->getHelperSet()->get('dialog');
+            $checkName = $dialog->askAndValidate($output, 'Enter the name of your system check, for example "PDF PHP Extension Check": ', $validate);
+        } else {
+            $validate($checkName);
+        }
+
+        $checkName = ucfirst($checkName);
+
+        return $checkName;
+    }
+
+    /**
+     * @param InputInterface $input
+     * @param OutputInterface $output
+     * @return string
+     * @throws \RuntimeException
+     */
+    protected function getPluginName(InputInterface $input, OutputInterface $output)
+    {
+        $pluginNames = $this->getPluginNames();
+        $invalidName = 'You have to enter a name of an existing plugin.';
+
+        return $this->askPluginNameAndValidate($input, $output, $pluginNames, $invalidName);
+    }
+
+}