Merge pull request #139 from Icinga/download-command

Download command

Author: yhabteab

application/clicommands/DownloadCommand.php

@@ -0,0 +1,80 @@
+<?php
+
+/* Icinga Reporting | (c) 2023 Icinga GmbH | GPLv2 */
+
+namespace Icinga\Module\Reporting\Clicommands;
+
+use InvalidArgumentException;
+use Icinga\Module\Pdfexport\ProvidedHook\Pdfexport;
+use Icinga\Module\Reporting\Cli\Command;
+use Icinga\Module\Reporting\Report;
+
+class DownloadCommand extends Command
+{
+    /**
+     * Download report with specified ID as PDF, CSV or JSON
+     *
+     * USAGE
+     *
+     *     icingacli reporting download <id> [--format=<pdf|csv|json>]
+     *
+     * OPTIONS
+     *
+     * --format=<pdf|csv|json>
+     *     Download report as PDF, CSV or JSON. Defaults to pdf.
+     *
+     * --output=<file>
+     *     Save report to the specified <file>.
+     *
+     * EXAMPLES
+     *
+     * Download report with ID 1:
+     *     icingacli reporting download 1
+     *
+     * Download report with ID 1 as CSV:
+     *     icingacli reporting download 1 --format=csv
+     *
+     * Download report with ID 1 as JSON to the specified file:
+     *     icingacli reporting download 1 --format=json --output=sla.json
+     */
+    public function defaultAction()
+    {
+        $id = $this->params->getStandalone();
+        if ($id === null) {
+            $this->fail($this->translate('Argument id is mandatory'));
+        }
+
+        $report = Report::fromDb($id);
+        $format = strtolower($this->params->get('format', 'pdf'));
+        switch ($format) {
+            case 'pdf':
+                $content = Pdfexport::first()->htmlToPdf($report->toPdf());
+                break;
+            case 'csv':
+                $content = $report->toCsv();
+                break;
+            case 'json':
+                $content = $report->toJson();
+                break;
+            default:
+                throw new InvalidArgumentException(sprintf('Format %s is not supported', $format));
+        }
+
+        $output = $this->params->get('output');
+        if ($output === null) {
+            $name = sprintf(
+                '%s (%s) %s',
+                $report->getName(),
+                $report->getTimeframe()->getName(),
+                date('Y-m-d H:i')
+            );
+
+            $output = "$name.$format";
+        } elseif (is_dir($output)) {
+            $this->fail($this->translate(sprintf('%s is a directory', $output)));
+        }
+
+        file_put_contents($output, $content);
+        echo "$output\n";
+    }
+}

library/Reporting/Web/Forms/ReportForm.php

@@ -10,6 +10,7 @@
 use Icinga\Module\Reporting\Web\Forms\Decorator\CompatDecorator;
 use ipl\Html\Contract\FormSubmitElement;
 use ipl\Html\Form;
+use ipl\Validator\CallbackValidator;
 use ipl\Web\Compat\CompatForm;
 
 class ReportForm extends CompatForm
@@ -49,7 +50,20 @@ protected function assemble()
             'description' => $this->translate(
                 'A unique name of this report. It is used when exporting to pdf, json or csv format'
                 . ' and also when listing the reports in the cli'
-            )
+            ),
+            'validators' => [
+                'Callback' => function ($value, CallbackValidator $validator) {
+                    if ($value !== null && strpos($value, '..') !== false) {
+                        $validator->addMessage(
+                            $this->translate('Double dots are not allowed in the report name')
+                        );
+
+                        return false;
+                    }
+
+                    return true;
+                }
+            ]
         ]);
 
         $this->addElement('select', 'timeframe', [