class.ilFileObjectToStorageMigration.php

Go to the documentation of this file.

<?php

use ILIAS\Filesystem\Provider\Configuration\LocalConfig;
use ILIAS\Filesystem\Provider\FlySystem\FlySystemFilesystemFactory;
use ILIAS\Setup;
use ILIAS\Setup\Environment;

class ilFileObjectToStorageMigration implements Setup\Migration
{
    private const FILE_PATH_REGEX = '/.*\/file_([\d]*)$/';
    public const MIGRATION_LOG_CSV = "migration_log.csv";
    private ?ilFileObjectToStorageMigrationHelper $helper = null;

    protected bool $prepared = false;
    private bool $confirmed = false;
    protected ?ilFileObjectToStorageMigrationRunner $runner;
    protected ?ilDBInterface $database;

    public function getLabel(): string
    {
        return "Migration of File-Objects to Storage service";
    }

    public function getDefaultAmountOfStepsPerRun(): int
    {
        return 10;
    }

    public function getPreconditions(Environment $environment): array
    {
        return ilResourceStorageMigrationHelper::getPreconditions();
    }

    public function prepare(Environment $environment): void
    {
        $irss_helper = new ilResourceStorageMigrationHelper(
            new ilObjFileStakeholder(),
            $environment
        );

        $legacy_files_dir = $irss_helper->getClientDataDir() . "/ilFile";
        $this->helper = new ilFileObjectToStorageMigrationHelper(
            $irss_helper
        );

        global $DIC;
        $DIC['ilDB'] = $irss_helper->getDatabase(); // needed inside some method calls to ILIAS

        $storage_configuration = new LocalConfig($irss_helper->getClientDataDir());
        $f = new FlySystemFilesystemFactory();

        $this->runner = new ilFileObjectToStorageMigrationRunner(
            $f->getLocal($storage_configuration),
            $irss_helper,
            self::MIGRATION_LOG_CSV
        );

        $this->database = $irss_helper->getDatabase();
    }

    public function step(Environment $environment): void
    {
        if ($this->helper === null) {
            $environment->getResource(Environment::RESOURCE_ADMIN_INTERACTION)->inform(
                "No migration possible, base-directory not found."
            );
            return;
        }
        $this->showConfirmation($environment);
        $item = $this->helper->getNext();
        $this->runner->migrate($item);
    }

    public function getRemainingAmountOfSteps(): int
    {
        $r = $this->database->query("SELECT COUNT(file_id) AS amount FROM file_data WHERE rid IS NULL OR rid = '';");
        $d = $this->database->fetchObject($r);

        return (int) $d->amount;
    }

    protected function showConfirmation(Environment $environment): void
    {
        if (!$this->confirmed) {
            $io = $environment->getResource(Setup\Environment::RESOURCE_ADMIN_INTERACTION);
            $this->confirmed = $io->confirmExplicit(
                'The migration of File-Objects should be done in ILIAS 7 not 8, see Modules/File/classes/Setup/MISSING_MIGRATION.md, type "Understood" to proceed',
                'Understood'
            );
        }
    }
}