IOWrapper.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

namespace ILIAS\Setup\CLI;

use ILIAS\Setup\AdminInteraction;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Output\OutputInterface;
use Symfony\Component\Console\Style\SymfonyStyle;

class IOWrapper implements AdminInteraction
{
    public const LABEL_WIDTH = 75;
    public const ELLIPSIS = "...";

    protected InputInterface $in;
    protected OutputInterface $out;
    protected SymfonyStyle $style;
    protected bool $last_objective_was_notable = false;
    protected string $last_objective_label = "";
    protected bool $output_in_objective = false;

    public function __construct(InputInterface $in, OutputInterface $out)
    {
        $this->in = $in;
        $this->out = $out;
        $this->style = new SymfonyStyle($in, $out);
    }

    // Implementation of AdminInteraction
    public function startProgress(int $max): void
    {
        $this->style->progressStart($max);
    }

    public function advanceProgress(): void
    {
        $this->style->progressAdvance();
    }

    public function stopProgress(): void
    {
        $this->style->progressFinish();
    }

    public function inform(string $message): void
    {
        $this->outputInObjective();
        $this->style->note($message);
    }

    public function confirmExplicit(string $message, string $type_text_to_confirm): bool
    {
        $this->outputInObjective();
        if (!$this->shouldSayYes()) {
            return $this->style->ask(
                $message,
                null,
                fn (string $input): bool => $type_text_to_confirm === $input
            );
        } else {
            $this->inform("Automatically confirmed:\n\n$message");
            return true;
        }
    }

    public function confirmOrDeny(string $message): bool
    {
        $this->outputInObjective();
        if (!$this->shouldSayYes()) {
            return $this->style->confirm($message, false);
        } else {
            $this->inform("Automatically confirmed:\n\n$message");
            return true;
        }
    }

    // For CLI-Setup

    public function printLicenseMessage(): void
    {
        if ($this->shouldSayYes() || ($this->in->hasOption("no-interaction") && $this->in->getOption("no-interaction"))) {
            return;
        }
        $this->text(
            "   ILIAS Copyright (C) 1998-2019 ILIAS Open Source e.V. - GPLv3\n\n" .
            "This program comes with ABSOLUTELY NO WARRANTY. This is free software,\n" .
            "and you are welcome to redistribute it under certain conditions. Look\n" .
            "into the LICENSE file for details."
        );
    }

    protected function shouldSayYes(): bool
    {
        return $this->in->getOption("yes") ?? false;
    }

    public function title(string $title): void
    {
        $this->style->title($title);
    }

    public function success(string $text): void
    {
        $this->style->success($text);
    }

    public function error(string $text): void
    {
        $this->style->error($text);
    }

    public function text(string $text): void
    {
        $this->style->text($text);
    }

    public function startObjective(string $label, bool $is_notable): void
    {
        $this->last_objective_was_notable = $is_notable;
        $this->last_objective_label = $label;
        $this->output_in_objective = false;
        if ($this->showLastObjectiveLabel()) {
            $this->style->write(str_pad($label . "...", self::LABEL_WIDTH));
        }
    }

    public function finishedLastObjective(): void
    {
        if ($this->output_in_objective) {
            $this->startObjective($this->last_objective_label, $this->last_objective_was_notable);
        }

        if ($this->showLastObjectiveLabel()) {
            $this->style->write("[<fg=green>OK</>]\n");
        }
    }

    public function failedLastObjective(): void
    {
        // Always show label of failed objectives.
        if ($this->output_in_objective || !$this->last_objective_was_notable) {
            $this->startObjective($this->last_objective_label, true);
        }

        if ($this->showLastObjectiveLabel()) {
            $this->style->write("[<fg=red>FAILED</>]\n");
        }
    }

    protected function outputInObjective(): void
    {
        if (!$this->output_in_objective && $this->showLastObjectiveLabel()) {
            $this->output_in_objective = true;
            $this->style->write("[in progress]\n");
        }
    }

    protected function showLastObjectiveLabel(): bool
    {
        return $this->last_objective_was_notable
            || $this->out->isVeryVerbose()
            || $this->out->isDebug();
    }

    public function isVerbose(): bool
    {
        return $this->out->isVerbose();
    }
}