class.ilForumPostingFilesMigration.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;

class ilForumPostingFilesMigration implements Migration
{
    protected ilResourceStorageMigrationHelper $helper;

    public function getLabel(): string
    {
        return 'Migration of Files in Forum Posts 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 ilForumPostingFileStakeholder(),
            $environment
        );
    }

    public function step(Environment $environment): void
    {
        $r = $this->helper->getDatabase()->query(
            "SELECT
    frm_posts.pos_pk AS posting_id,
    frm_posts.pos_author_id AS owner_id,
    frm_data.top_frm_fk AS object_id
FROM frm_posts
JOIN frm_data ON frm_posts.pos_top_fk = frm_data.top_pk
WHERE frm_posts.rcid IS NULL OR frm_posts.rcid = ''
LIMIT 1;"
        );

        $d = $this->helper->getDatabase()->fetchObject($r);
        if (!($d instanceof stdClass)) {
            return;
        }

        $posting_id = (int) $d->posting_id;
        $object_id = (int) $d->object_id;
        $resource_owner_id = (int) $d->owner_id;

        $base_path = $this->buildBasePath();
        $filename_pattern = '/^' . $object_id . '\_' . $posting_id . '\_(.*)/m';
        $pattern = '/.*\/' . $object_id . '\_' . $posting_id . '\_(.*)/m';

        if (is_dir($base_path) && count(scandir($base_path)) > 2) {
            $collection_id = $this->helper->moveFilesOfPatternToCollection(
                $base_path,
                $pattern,
                $resource_owner_id,
                ResourceCollection::NO_SPECIFIC_OWNER,
                $this->getFileNameCallback($filename_pattern),
                $this->getRevisionNameCallback()
            );

            $save_colletion_id = $collection_id === null ? '-' : $collection_id->serialize();
            $this->helper->getDatabase()->update(
                'frm_posts',
                ['rcid' => ['text', $save_colletion_id]],
                ['pos_pk' => ['integer', $posting_id],]
            );
        } else {
            $this->helper->getDatabase()->update(
                'frm_posts',
                ['rcid' => ['text', '-']],
                ['pos_pk' => ['integer', $posting_id],]
            );
        }
    }

    public function getRemainingAmountOfSteps(): int
    {
        $r = $this->helper->getDatabase()->query(
            "SELECT
    count(frm_posts.pos_pk) AS amount
FROM frm_posts
JOIN frm_data ON frm_posts.pos_top_fk = frm_data.top_pk
WHERE frm_posts.rcid IS NULL OR frm_posts.rcid = '';"
        );
        $d = $this->helper->getDatabase()->fetchObject($r);

        return (int) $d->amount;
    }

    protected function buildBasePath(): string
    {
        return CLIENT_DATA_DIR . '/forum/';
    }

    public function getFileNameCallback(string $pattern): Closure
    {
        return static function (string $file_name) use ($pattern): string {
            if (preg_match($pattern, $file_name, $matches)) {
                return $matches[1] ?? $file_name;
            }
            return $file_name;
        };
    }

    public function getRevisionNameCallback(): Closure
    {
        return static function (string $file_name): string {
            return md5($file_name);
        };
    }
}