ClientIdReadObjective.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

namespace ILIAS\Setup\Objective;

use ILIAS\Setup;

class ClientIdReadObjective implements Setup\Objective
{
    public function getHash(): string
    {
        return hash("sha256", self::class);
    }

    public function getLabel(): string
    {
        return "Read client-id from data-directory.";
    }

    public function isNotable(): bool
    {
        return false;
    }

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

    public function achieve(Setup\Environment $environment): Setup\Environment
    {
        $dir = $this->getDataDirectoryPath();
        $candidates = array_filter(
            $this->scanDirectory($dir),
            function ($c) use ($dir): bool {
                if ($c === "." || $c === "..") {
                    return false;
                }
                return $this->isDirectory($dir . "/" . $c);
            }
        );

        if (count($candidates) === 0) {
            throw new Setup\UnachievableException(
                "There are no directories in the webdata-dir at '$dir'. " .
                "Probably ILIAS is not installed."
            );
        }

        if (count($candidates) !== 1) {
            $ilias_version = ILIAS_VERSION_NUMERIC;

            throw new Setup\UnachievableException(
                "There is more than one directory in the webdata-dir at '$dir'. " .
                "Probably this is an ILIAS installation that uses clients. Clients " .
                "are not supported anymore since ILIAS $ilias_version " .
                "(see: https://docu.ilias.de/goto.php?target=wiki_1357_Setup_-_Abandon_Multi_Client)"
            );
        }

        $client_id = array_shift($candidates);
        return $environment->withResource(Setup\Environment::RESOURCE_CLIENT_ID, $client_id);
    }

    protected function getDataDirectoryPath(): string
    {
        return dirname(__DIR__, 5) . "/public/data";
    }

    protected function scanDirectory(string $path): array
    {
        if (!$this->isDirectory($path)) {
            return [];
        }

        return scandir($path);
    }

    protected function isDirectory(string $path): bool
    {
        return is_dir($path);
    }

    public function isApplicable(Setup\Environment $environment): bool
    {
        return $environment->getResource(Setup\Environment::RESOURCE_CLIENT_ID) === null;
    }
}