class.ilBadgesFilesMigration.php

Go to the documentation of this file.

<?php
 
declare(strict_types=1);
 
use ILIAS\ResourceStorage\Collection\ResourceCollection;
use ILIAS\Setup\Environment;
use ILIAS\Setup\Migration;
use ILIAS\Setup\CLI\IOWrapper;
 
class ilBadgesFilesMigration implements Migration
{
    private const TABLE_NAME = 'badge_badge';
 
    private ilResourceStorageMigrationHelper $helper;
    private ?IOWrapper $io = null;
 
    public function getLabel(): string
    {
        return 'Migration of files of badges to the resource storage service.';
    }
 
    public function getDefaultAmountOfStepsPerRun(): int
    {
        return 1000;
    }
 
    public function getPreconditions(Environment $environment): array
    {
        return ilResourceStorageMigrationHelper::getPreconditions();
    }
 
    public function prepare(Environment $environment): void
    {
        $this->helper = new ilResourceStorageMigrationHelper(
            new ilBadgeFileStakeholder(),
            $environment
        );
        $io = $environment->getResource(Environment::RESOURCE_ADMIN_INTERACTION);
        if ($io instanceof IOWrapper) {
            $this->io = $io;
        }
    }
 
    public function step(Environment $environment): void
    {
        $this->helper->getDatabase()->setLimit(1);
        $res = $this->helper->getDatabase()->query(
            'SELECT id, image, image_rid FROM ' . self::TABLE_NAME . " WHERE image_rid IS NULL OR image_rid = ''"
        );
        $row = $this->helper->getDatabase()->fetchObject($res);
        if (!($row instanceof stdClass)) {
            return;
        }
 
        $id = (int) $row->id;
        $image = $row->image;
 
        if ($image !== '' && $image !== null) {
            $image_path = $this->getImagePath($id, $image);
 
            try {
                $this->inform("Trying to move badge file $image_path for id $id to the storage service.");
                $identification = $this->helper->movePathToStorage($image_path, ResourceCollection::NO_SPECIFIC_OWNER);
                $this->inform('Migration proceeded without error.');
                if ($identification === null) {
                    $this->error(
                        'IRSS returned NULL as identification when trying to move badge ' .
                        "file $image_path for id $id to the storage service."
                    );
                } else {
                    $this->inform("IRSS identification for badge with id $id: {$identification->serialize()}", true);
                }
            } catch (Throwable $e) {
                $this->error("Failed to move badge file {$image_path} for id {$id} to the storage service with exception: {$e->getMessage()}");
                $this->error($e->getTraceAsString());
                throw $e;
            }
 
            if ($identification === null) {
                $identification = '-';
            } else {
                $identification = $identification->serialize();
            }
 
            $this->helper->getDatabase()->update(
                self::TABLE_NAME,
                [
                    'image_rid' => [ilDBConstants::T_TEXT, $identification],
                    'image' => [ilDBConstants::T_TEXT, null]
                ],
                ['id' => [ilDBConstants::T_INTEGER, $id]]
            );
        } else {
            $this->inform(
                'Cannot migrate badge with id ' . $id
                . ' (table: ' . self::TABLE_NAME . ') because no image is set.',
                true
            );
        }
    }
 
    private function getImagePath(int $id, string $image): string
    {
        $exp = explode('.', $image);
        $suffix = strtolower(array_pop($exp));
 
        return $this->getFilePath($id) . '/img' . $id . '.' . $suffix;
    }
 
    private function getFilePath(int $a_id): string
    {
        return ILIAS_ABSOLUTE_PATH . '/' . ILIAS_WEB_DIR . '/' . CLIENT_ID . '/sec/ilBadge/' . $this->createLegacyPathSegmentForBadgeId($a_id);
    }
 
    private function createLegacyPathSegmentForBadgeId(int $id): string
    {
        $path = [];
        $found = false;
        $num = $id;
        $path_string = '';
        for ($i = 3; $i > 0; $i--) {
            $factor = 100 ** $i;
            if (($tmp = (int) ($num / $factor)) || $found) {
                $path[] = $tmp;
                $num %= $factor;
                $found = true;
            }
        }
 
        if (count($path)) {
            $path_string = (implode('/', $path) . '/');
        }
 
        return $path_string . 'badge_' . $id;
    }
 
    public function getRemainingAmountOfSteps(): int
    {
        $res = $this->helper->getDatabase()->query(
            'SELECT COUNT(id) as amount FROM ' . self::TABLE_NAME . " WHERE image_rid IS NULL OR image_rid = ''"
        );
        $row = $this->helper->getDatabase()->fetchObject($res);
 
        return (int) ($row->amount ?? 0);
    }
 
    public function getRevisionNameCallback(): Closure
    {
        return static function (string $file_name): string {
            return md5($file_name);
        };
    }
 
    private function inform(string $text, bool $force = false): void
    {
        if ($this->io === null || (!$force && !$this->io->isVerbose())) {
            return;
        }
 
        $this->io->inform($text);
    }
 
    private function error(string $text): void
    {
        if ($this->io === null) {
            return;
        }
 
        $this->io->error($text);
    }
}