class.ilObjectTileImageMigration.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

namespace ILIAS\Object\Setup;

use ILIAS\Setup\Migration;
use ILIAS\Setup\Environment;
use ILIAS\Setup\AdminInteraction;
use ILIAS\ResourceStorage\Flavour\FlavourBuilder;
use ILIAS\Object\Properties\CoreProperties\TileImage\ilObjectTileImageStakeholder;
use ILIAS\Object\Properties\CoreProperties\TileImage\ilObjectTileImageFlavourDefinition;

class ilObjectTileImageMigration implements Migration
{
    private \ilResourceStorageMigrationHelper $helper;
    private FlavourBuilder $flavour_builder;
    private ilObjectTileImageFlavourDefinition $flavour_definition;
    private AdminInteraction $admin_interaction;

    public function getLabel(): string
    {
        return "Migration of Tile Images to the Resource Storage Service.";
    }

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

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

    public function prepare(Environment $environment): void
    {
        $this->helper = new \ilResourceStorageMigrationHelper(
            new ilObjectTileImageStakeholder(),
            $environment
        );
        $this->admin_interaction = $environment->getResource(Environment::RESOURCE_ADMIN_INTERACTION);
        $this->flavour_builder = $this->helper->getFlavourBuilder();
        $this->flavour_definition = new ilObjectTileImageFlavourDefinition();
    }

    public function step(Environment $environment): void
    {
        $query_select = $this->helper->getDatabase()->query('
            SELECT
                cs.id,
                cs.value AS extension,
                o.owner
            FROM container_settings AS cs
            INNER JOIN object_data AS o
                ON cs.id = o.obj_id
            WHERE cs.keyword = "tile_image"
            ORDER BY cs.id
            LIMIT 1;
        ');
        $next_record = $this->helper->getDatabase()->fetchObject($query_select);

        if ($next_record === null) {
            $this->cleanupTileInformationWithoutCorrespondingObject();
            return;
        }

        $path = $this->getFullPath($next_record->id, $next_record->extension);

        if (is_readable(dirname(dirname($path)))
            && (!file_exists(dirname($path))
                || is_readable(dirname($path)) && !file_exists($path))) {
            $this->deleteTileImageInfoFromContainerSettings($next_record->id);
            $this->admin_interaction->inform(
                "The tile image for the object with the id {$next_record->id} and the path {$path} "
                . 'could not be migrated. The entry linking the image to the object '
                . 'was removed, the path to the image has been left on the system.'
            );
            return;
        }

        $rid = $this->helper->movePathToStorage(
            $path,
            $next_record->owner
        );

        if ($rid === null) {
            $this->deleteTileImageInfoFromContainerSettings($next_record->id);
            $this->admin_interaction->inform(
                "The tile image for the object with the id {$next_record->id} and the path {$path} "
                . 'could not be migrated. The database entry linking the image to the object '
                . 'was removed, the path to the image has been left on the system.'
            );
            return;
        }
        $this->flavour_builder->get($rid, $this->flavour_definition, true);

        $this->helper->getDatabase()->update(
            'object_data',
            ['tile_image_rid' => ['text', $rid->serialize()]],
            ['obj_id' => ['integer', $next_record->id],]
        );

        $this->removeDirectoryOrInform(\dirname($path), $next_record);
        $this->deleteTileImageInfoFromContainerSettings($next_record->id);
    }

    private function removeDirectoryOrInform(string $directory, \stdClass $record): void
    {
        if (!is_dir($directory)) {
            return;
        }

        $files = array_diff(scandir($directory), ['.', '..']);
        if (empty($files)) {
            rmdir($directory);
        } else {
            $file_list = implode(', ', $files);
            $this->admin_interaction->inform(
                "The tile image for the object with the id $record->id was probably migrated successfully. "
                . "However, the directory $directory could not be removed because it is not empty. "
                . "Remaining files: $file_list. "
                . 'You may want to verify that the tile image is visible for the object, and remove '
                . 'the remaining files manually if they are not needed.'
            );
        }
    }

    private function getFullPath(int $object_id, ?string $extension): string
    {
        return implode(
            DIRECTORY_SEPARATOR,
            [
                CLIENT_WEB_DIR,
                'obj_data',
                'tile_image',
                'tile_image_' . $object_id,
                'tile_image.' . $extension
            ]
        );
    }

    private function cleanupTileInformationWithoutCorrespondingObject(): void
    {
        $select_next_id = $this->helper->getDatabase()->query('
            SELECT
                id,
                value AS extension
            FROM container_settings
            WHERE keyword = "tile_image"
            ORDER BY id
            LIMIT 1;
        ');
        $next_record = $this->helper->getDatabase()->fetchObject($select_next_id);

        if ($next_record === null) {
            return;
        }

        $check_object_query = $this->helper->getDatabase()->queryF(
            'SELECT
                    count(obj_id) AS objs
                FROM object_data
                WHERE obj_id = %s;
            ',
            ['integer'],
            [$next_record->id]
        );
        $has_objects = $this->helper->getDatabase()->fetchObject($check_object_query);
        $path = $this->getFullPath($next_record->id, $next_record->extension);

        if ($has_objects->objs > 0) {
            return;
        }

        if (is_file($path)) {
            unlink($path);
        }

        $this->removeDirectoryOrInform(\dirname($path), $next_record);
        $this->deleteTileImageInfoFromContainerSettings($next_record->id);
    }

    private function deleteTileImageInfoFromContainerSettings(int $id): void
    {
        $query_delete = $this->helper->getDatabase()->queryF('
            DELETE FROM container_settings
            WHERE keyword = "tile_image" AND id = %s
        ', ['integer'], [$id]);
        $this->helper->getDatabase()->execute($query_delete);
    }

    public function getRemainingAmountOfSteps(): int
    {
        $query = $this->helper->getDatabase()->query('
            SELECT
                count(container_settings.id) AS amount
            FROM container_settings
            WHERE container_settings.keyword = "tile_image"
        ');
        $r = $this->helper->getDatabase()->fetchObject($query);

        return (int) $r->amount;
    }
}