ilManScoringSettingsToOwnDbTableMigration.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

namespace ILIAS\Test\Setup;

use ILIAS\Setup;
use ILIAS\Setup\Environment;
use ilDatabaseInitializedObjective;
use ilDatabaseUpdatedObjective;
use ilDBInterface;
use Exception;
use ILIAS\Setup\CLI\IOWrapper;

class ilManScoringSettingsToOwnDbTableMigration implements Setup\Migration
{
    private const TABLE_NAME = 'manscoring_done';
    private const TESTS_PER_STEP = 10000;

    private ilDBInterface $db;

    private mixed $io;

    private function manScoringDoneEntryExists(int $activeId): bool
    {
        $result = $this->db->queryF(
            "SELECT active_id FROM manscoring_done WHERE active_id = %s",
            ["integer"],
            [$activeId]
        );

        return $result->numRows() === 1;
    }

    public function getLabel(): string
    {
        return "Migrate manual scoring done setting from ilSettings db table to own table for improved performance";
    }

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

    public function getPreconditions(Environment $environment): array
    {
        return [
            new ilDatabaseInitializedObjective()
        ];
    }

    public function prepare(Environment $environment): void
    {
        $this->db = $environment->getResource(Setup\Environment::RESOURCE_DATABASE);
        $this->io = $environment->getResource(Environment::RESOURCE_ADMIN_INTERACTION);
    }

    public function step(Environment $environment): void
    {
        $failed = [];

        $success = [];

        $totalCount = 0;
        $this->db->setLimit(self::TESTS_PER_STEP);
        $result = $this->db->query(
            "SELECT keyword, value FROM settings WHERE " . $this->db->like('keyword', 'text', 'manscoring_done_%')
        );
        while ($row = $this->db->fetchAssoc($result)) {
            $totalCount++;

            $keyword = $row["keyword"];
            $match = [];
            if (!preg_match('/manscoring_done_(\d+)$/', $keyword, $match)) {
                continue;
            }
            $activeId = $match[1];
            if (!is_numeric($activeId)) {
                continue;
            }

            $activeId = (int) $activeId;

            if ($this->manScoringDoneEntryExists($activeId)) {
                $failed[$activeId] = "Entry with active_id '$activeId' already exists in table '" . self::TABLE_NAME . "'.";
                continue;
            }

            if ((int) $this->db->manipulateF(
                "INSERT INTO " . self::TABLE_NAME . " (active_id, done) VALUES (%s, %s)",
                ["integer", "integer"],
                [$activeId, (int) $row["value"]]
            ) !== 1) {
                $failed[$activeId] = "Error occurred while trying to insert manscoring done status into new table ' " . self::TABLE_NAME . "'.";
                continue;
            }

            if ((int) $this->db->manipulateF(
                "DELETE FROM settings WHERE keyword = %s",
                ["text"],
                [$keyword]
            ) !== 1) {
                $failed[$activeId] = "Error occurred while trying to delete manscoring done status '$keyword' from old table 'settings'.";
                continue;
            }

            $success[] = $activeId;
        }

        //To get into new line for cleaner error reporting.
        $this->io->text("");
        foreach ($failed as $reason) {
            $this->io->error($reason);
        }

        $successCount = count($success);
        $failedCount = count($failed);

        $this->io->success(
            "Successfully migrated $successCount of $totalCount ($failedCount failed) entries " .
            "from table 'settings' to table '" . self::TABLE_NAME . "'."
        );
    }

    public function getRemainingAmountOfSteps(): int
    {
        $result = $this->db->query(
            "SELECT COUNT(*) AS cnt FROM settings WHERE " . $this->db->like('keyword', 'text', 'manscoring_done_%')
        );
        $row = $this->db->fetchAssoc($result);

        $num_legacy_tests = (int) ($row['cnt'] ?? 0);

        return (int) ceil($num_legacy_tests / self::TESTS_PER_STEP);
    }
}