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 $helper;
    protected $prepared = false;
    protected $runner;
    protected $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 [
            new ilIniFilesLoadedObjective(),
            new ilDatabaseInitializedObjective(),
            new ilDatabaseUpdatedObjective(),
            new ilStorageContainersExistingObjective()
        ];
    }

    public function prepare(Environment $environment) : void
    {
        $ilias_ini = $environment->getResource(Setup\Environment::RESOURCE_ILIAS_INI);
        $this->database = $environment->getResource(Setup\Environment::RESOURCE_DATABASE);

        $client_id = $environment->getResource(Setup\Environment::RESOURCE_CLIENT_ID);
        $data_dir = $ilias_ini->readVariable('clients', 'datadir');

        if (!$this->prepared) {
            global $DIC;
            $DIC['ilDB'] = $this->database;
            $DIC['ilBench'] = null;

            $legacy_files_dir = "{$data_dir}/{$client_id}/ilFile";
            if (!defined("CLIENT_DATA_DIR")) {
                define('CLIENT_DATA_DIR', "{$data_dir}/{$client_id}");
            }
            if (!defined("CLIENT_ID")) {
                define('CLIENT_ID', $client_id);
            }
            if (!defined("ILIAS_ABSOLUTE_PATH")) {
                define("ILIAS_ABSOLUTE_PATH", dirname(__FILE__, 5));
            }
            if (!defined("ILIAS_WEB_DIR")) {
                define('ILIAS_WEB_DIR', dirname(__DIR__, 4) . "/data/");
            }
            if (!defined("CLIENT_WEB_DIR")) {
                define("CLIENT_WEB_DIR", dirname(__DIR__, 4) . "/data/" . $client_id);
            }

            // if dir doesn't exists there are no steps to do,
            // so don't initialize ilFileObjectToStorageMigrationHelper
            if (!is_dir($legacy_files_dir)) {
                $io = $environment->getResource(Environment::RESOURCE_ADMIN_INTERACTION);
                $io->inform("The legacy ilFile-directory ($legacy_files_dir) cannot be found, we cant perform a migration.");
                return;
            }

            if (!is_readable($legacy_files_dir)) {
                throw new Exception("{$legacy_files_dir} is not readable, abort...");
            }

            if (!is_writable("{$data_dir}/{$client_id}/storage")) {
                throw new Exception("storage directory is not writable, abort...");
            }

            $this->helper = new ilFileObjectToStorageMigrationHelper($legacy_files_dir, $this->database);

            $storageConfiguration = new LocalConfig("{$data_dir}/{$client_id}");
            $f = new FlySystemFilesystemFactory();

            $this->runner = new ilFileObjectToStorageMigrationRunner(
                $f->getLocal($storageConfiguration),
                $this->database,
                $legacy_files_dir . "/" . self::MIGRATION_LOG_CSV
            );

        }
    }

    public function step(Environment $environment) : void
    {
        if ($this->helper === null) {
            return;
        }
        $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;
    }

}