MigrationObjective.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

namespace ILIAS\Setup\Objective;

use ILIAS\Setup;

class MigrationObjective implements Setup\Objective
{
    protected Setup\Migration $migration;
    protected int $steps;

    public function __construct(Setup\Migration $migration, ?int $steps = null)
    {
        $this->migration = $migration;
        $this->steps = $steps ?? $migration->getDefaultAmountOfStepsPerRun();
    }

    public function getHash(): string
    {
        return hash("sha256", self::class . '' . get_class($this->migration));
    }

    public function getLabel(): string
    {
        return $this->migration->getLabel();
    }

    public function isNotable(): bool
    {
        return true;
    }

    public function getPreconditions(Setup\Environment $environment): array
    {
        return $this->migration->getPreconditions($environment);
    }

    public function achieve(Setup\Environment $environment): Setup\Environment
    {
        $io = $environment->getResource(Setup\Environment::RESOURCE_ADMIN_INTERACTION);
        $key = (new \ReflectionClass($this->migration))->getShortName();
        $confirmation = $io->confirmExplicit(
            "Do you really want to run the following migration? Make sure you have a backup\n" .
            "of all your data. You will run this migration on your own risk.\n\n" .
            "Please type '$key' to confirm and start.",
            $key
        );
        if (!$confirmation) {
            $io->error("Migration '$key' aborted.");
            return $environment;
        }
        $io->inform("Preparing Migration: This may take quite a long time (e.g. all files are collected.");
        $this->migration->prepare($environment);
        $io->inform("Preparing Migration: done.");

        $steps = $this->steps;
        $remaining = $this->migration->getRemainingAmountOfSteps();
        if ($steps === Setup\Migration::INFINITE || $remaining < $steps) {
            $steps = $remaining;
        }
        $io->inform("Trigger {$steps} step(s) in {$this->getLabel()}");
        $step = 0;
        $io->startProgress($steps);

        while ($step < $steps) {
            $io->advanceProgress();
            $this->migration->step($environment);
            $step++;
        }
        $io->stopProgress();
        $remaining = $this->migration->getRemainingAmountOfSteps();
        if ($remaining == 0) {
            $io->inform("Migration '{$key}' has no remaining steps left.");
        }
        else {
            $io->inform("{$remaining} step(s) remaining. Run again to proceed.");
        }
        
        return $environment;
    }

    public function isApplicable(Setup\Environment $environment): bool
    {
        $this->migration->prepare($environment);

        return $this->migration->getRemainingAmountOfSteps() > 0;
    }
}