class.ilFileSystemComponentDataDirectoryCreatedObjective.php

Go to the documentation of this file.

<?php

use ILIAS\Setup\Objective\DirectoryCreatedObjective;
use ILIAS\Setup\Objective;
use ILIAS\Setup\Environment;
use ILIAS\Setup\UnachievableException;

class ilFileSystemComponentDataDirectoryCreatedObjective extends DirectoryCreatedObjective implements Objective
{
    public const DATADIR = 1;
    public const WEBDIR = 2;

    protected string $component_dir;

    public function __construct(
        string $component_dir,
        protected int $base_location = self::DATADIR
    ) {
        parent::__construct($component_dir);

        $this->component_dir = $component_dir;
    }

    #[\Override]
    public function getHash(): string
    {
        return hash("sha256", self::class . "::" . $this->component_dir . $this->base_location);
    }

    protected function buildPath(Environment $environment): string
    {
        $ini = $environment->getResource(Environment::RESOURCE_ILIAS_INI);
        $client_id = $environment->getResource(Environment::RESOURCE_CLIENT_ID);

        if ($this->base_location === self::DATADIR) {
            $data_dir = $ini->readVariable('clients', 'datadir');
        } elseif ($this->base_location === self::WEBDIR) {
            $data_dir = dirname(__DIR__, 5) . "/public/data";
        }
        if (!isset($data_dir)) {
            throw new LogicException('cannot determine base directory');
        }

        $client_data_dir = $data_dir . '/' . $client_id;

        return $client_data_dir . '/' . $this->component_dir;
    }

    #[\Override]
    public function getPreconditions(Environment $environment): array
    {
        // case if it is a fresh ILIAS installation
        if ($environment->hasConfigFor("filesystem")) {
            $config = $environment->getConfigFor("filesystem");
            return [
                new ilFileSystemDirectoriesCreatedObjective($config)
            ];
        }

        // case if ILIAS is already installed
        return [
            new ilIniFilesLoadedObjective()
        ];
    }

    #[\Override]
    public function achieve(Environment $environment): Environment
    {
        if (!$this->checkEnvironment($environment)) {
            throw new UnachievableException("Environment is not ready for this objective");
        }
        $this->path = $this->buildPath($environment);
        return parent::achieve($environment);
    }

    #[\Override]
    public function isApplicable(Environment $environment): bool
    {
        if (!$this->checkEnvironment($environment)) {
            return false;
        }
        $this->path = $this->buildPath($environment);
        return parent::isApplicable($environment);
    }

    private function checkEnvironment(Environment $environment): bool
    {
        if (null === $environment->getResource(Environment::RESOURCE_ILIAS_INI)) {
            return false;
        }
        return null !== $environment->getResource(Environment::RESOURCE_CLIENT_ID);
    }
}