DownloadCommand.php

<?php

// SPDX-FileCopyrightText: 2022 Icinga GmbH <https://icinga.com>
// SPDX-License-Identifier: GPL-3.0-or-later

namespace Icinga\Module\Reporting\Clicommands;

use Icinga\Application\Hook\PdfexportHook;
use Icinga\Exception\NotFoundError;
use Icinga\Module\Pdfexport\ProvidedHook\Pdfexport;
use Icinga\Module\Reporting\Cli\Command;
use Icinga\Module\Reporting\Database;
use Icinga\Module\Reporting\Model;
use Icinga\Module\Reporting\Report;
use Icinga\Util\Environment;
use InvalidArgumentException;
use ipl\Stdlib\Filter;

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'));
        }

        /** @var Model\Report $report */
        $report = Model\Report::on(Database::get())
            ->with('timeframe')
            ->filter(Filter::equal('id', $id))
            ->first();

        if ($report === null) {
            throw new NotFoundError('Report not found');
        }

        Environment::raiseExecutionTime();
        Environment::raiseMemoryLimit();

        $report = Report::fromModel($report);

        /** @var string $format */
        $format = $this->params->get('format', 'pdf');
        $format = strtolower($format);
        switch ($format) {
            case 'pdf':
                // TODO: Remove this once the dependency on the Pdfexport module is removed
                $exporter = method_exists(PdfexportHook::class, 'first')
                    ? PdfexportHook::first()
                    : Pdfexport::first();
                $content = $exporter->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));
        }

        /** @var string $output */
        $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";
    }
}