class.ilUserProfilePictureMigration.php

Go to the documentation of this file.

<?php

use ILIAS\Setup;
use ILIAS\Refinery;
use ILIAS\Setup\Environment;
use ILIAS\Setup\Objective;
use ILIAS\UI;

class ilUserProfilePictureMigration implements Setup\Migration
{
    protected \ilResourceStorageMigrationHelper $helper;

    public function getLabel(): string
    {
        return "Migration of Profile Pictures 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 \ilUserProfilePictureStakeholder(),
            $environment
        );
    }

    public function step(Environment $environment): void
    {
        $r = $this->helper->getDatabase()->query(
            "SELECT
                        usr_id
                    FROM usr_data
                    WHERE usr_data.rid IS NULL OR usr_data.rid = ''
                    LIMIT 1;"
        );

        $d = $this->helper->getDatabase()->fetchObject($r);
        $user_id = (int)$d->usr_id;

        $base_path = $this->buildBasePath();
        $pattern = '/.*\/(usr|upload)\_' . $user_id . '\..*/m';

        $rid = $this->helper->moveFirstFileOfPatternToStorage(
            $base_path,
            $pattern,
            $user_id
        );

        $save_rid = $rid === null ? '-' : $rid->serialize();
        $this->helper->getDatabase()->update(
            'usr_data',
            ['rid' => ['text', $save_rid]],
            ['usr_id' => ['integer', $user_id],]
        );
    }

    public function getRemainingAmountOfSteps(): int
    {
        $r = $this->helper->getDatabase()->query(
            "SELECT
                        count(usr_data.usr_id) AS amount
                    FROM usr_data
                    WHERE usr_data.rid IS NULL OR usr_data.rid = '';"
        );
        $d = $this->helper->getDatabase()->fetchObject($r);

        return (int)$d->amount;
    }

    protected function buildBasePath(): string
    {
        return CLIENT_WEB_DIR . '/usr_images/';
    }
}