class.ilAuthenticationSetupAgent.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

use ILIAS\Authentication\Setup\AbandonLoadDependantSessionDatabaseUpdateObjective;
use ILIAS\Setup;
use ILIAS\Refinery;

class ilAuthenticationSetupAgent implements Setup\Agent
{
    use Setup\Agent\HasNoNamedObjective;

    protected const DEFAULT_SESSION_EXPIRE_IN_SECONDS = 1_800;

    public function __construct(protected Refinery\Factory $refinery)
    {
    }

    public function hasConfig(): bool
    {
        return true;
    }

    public function getArrayToConfigTransformation(): Refinery\Transformation
    {
        return $this->refinery->custom()->transformation(function ($data): \ilAuthenticationSetupConfig {
            return new ilAuthenticationSetupConfig($data["session_max_idle"] ?? self::DEFAULT_SESSION_EXPIRE_IN_SECONDS);
        });
    }

    public function getInstallObjective(Setup\Config $config = null): Setup\Objective
    {
        if ($config !== null) {
            return new ilSessionMaxIdleIsSetObjective($config);
        }

        return new ilSessionMaxIdleIsSetObjective(
            new ilAuthenticationSetupConfig(self::DEFAULT_SESSION_EXPIRE_IN_SECONDS)
        );
    }

    public function getUpdateObjective(Setup\Config $config = null): Setup\Objective
    {
        if ($config !== null) {
            return new Setup\ObjectiveCollection(
                'Authentication',
                true,
                new ilDatabaseUpdateStepsExecutedObjective(
                    new ilAuthenticationDatabaseUpdateSteps8()
                ),
                new ilDatabaseUpdateStepsExecutedObjective(
                    new AbandonAuthRichTextEditorDatabaseUpdateSteps()
                ),
                new ilSessionMaxIdleIsSetObjective($config),
                new ilDatabaseUpdateStepsExecutedObjective(
                    new AbandonLoadDependantSessionDatabaseUpdateObjective()
                )
            );
        }

        return new Setup\ObjectiveCollection(
            'Authentication',
            true,
            new ilDatabaseUpdateStepsExecutedObjective(
                new ilAuthenticationDatabaseUpdateSteps8()
            ),
            new ilDatabaseUpdateStepsExecutedObjective(
                new AbandonAuthRichTextEditorDatabaseUpdateSteps()
            ),
            new ilDatabaseUpdateStepsExecutedObjective(
                new AbandonLoadDependantSessionDatabaseUpdateObjective()
            )
        );
    }

    public function getBuildObjective(): Setup\Objective
    {
        return new Setup\Objective\NullObjective();
    }

    public function getStatusObjective(Setup\Metrics\Storage $storage): Setup\Objective
    {
        return new Setup\ObjectiveCollection(
            'Component Authentication',
            true,
            new ilDatabaseUpdateStepsMetricsCollectedObjective(
                $storage,
                new ilAuthenticationDatabaseUpdateSteps8()
            ),
            new ilDatabaseUpdateStepsMetricsCollectedObjective(
                $storage,
                new AbandonAuthRichTextEditorDatabaseUpdateSteps()
            ),
        );
    }

    public function getMigrations(): array
    {
        return [];
    }
}