class.ilArtifactComponentRepository.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

use ILIAS\Data;

class ilArtifactComponentRepository implements ilComponentRepositoryWrite
{
    public const COMPONENT_DATA_PATH = "Services/Component/artifacts/component_data.php";
    public const PLUGIN_DATA_PATH = "Services/Component/artifacts/plugin_data.php";

    protected Data\Factory $data_factory;
    protected ilPluginStateDB $plugin_state_db;
    protected Data\Version $ilias_version;

    protected array $components;
    protected array $component_id_by_type_and_name;
    protected array $pluginslot_by_id;
    protected array $plugin_by_id;
    protected array $plugin_by_name;

    public function __construct(Data\Factory $data_factory, ilPluginStateDB $plugin_state_db, Data\Version $ilias_version)
    {
        $this->data_factory = $data_factory;
        $this->plugin_state_db = $plugin_state_db;
        $this->ilias_version = $ilias_version;

        $this->buildDatabase();
    }

    protected function buildDatabase(): void
    {
        $component_data = $this->readComponentData();
        $plugin_data = $this->readPluginData();
        $this->components = [];
        $this->component_id_by_type_and_name = [
            "Modules" => [],
            "Services" => []
        ];
        $this->pluginslot_by_id = [];
        $plugins_per_slot = [];
        foreach ($component_data as $comp_id => [$type, $comp_name, $slot_data]) {
            $slots = [];
            $component = new ilComponentInfo(
                $comp_id,
                $type,
                $comp_name,
                $slots
            );
            foreach ($slot_data as [$slot_id, $slot_name]) {
                $plugins_per_slot[$slot_id] = [];
                $slots[$slot_id] = new ilPluginSlotInfo(
                    $component,
                    $slot_id,
                    $slot_name,
                    $plugins_per_slot[$slot_id]
                );
                $this->pluginslot_by_id[$slot_id] = $slots[$slot_id];
            }
            $this->components[$comp_id] = $component;
            $this->component_id_by_type_and_name[$type][$comp_name] = $comp_id;
            unset($slots);
        }
        $this->plugin_by_id = [];
        foreach ($plugin_data as $plugin_id => $data) {
            [
                $type,
                $comp_name,
                $slot_name,
                $plugin_name,
                $plugin_version,
                $ilias_min_version,
                $ilias_max_version,
                $responsible,
                $responsible_mail,
                $learning_progress,
                $supports_export,
                $supports_cli_setup
            ] = $data;
            if (!$this->hasComponent($type, $comp_name)) {
                throw new \InvalidArgumentException(
                    "Can't find component $type/$comp_name for plugin $plugin_name"
                );
            }
            $component = $this->getComponentByTypeAndName($type, $comp_name);
            if (!$component->hasPluginSlotName($slot_name)) {
                throw new \InvalidArgumentException(
                    "Can't find slot $type/$comp_name/$slot_name for plugin $plugin_name"
                );
            }
            $slot = $component->getPluginSlotByName($slot_name);
            $this->plugin_by_id[$plugin_id] = new ilPluginInfo(
                $this->ilias_version,
                $slot,
                $plugin_id,
                $plugin_name,
                $this->plugin_state_db->isPluginActivated($plugin_id),
                $this->plugin_state_db->getCurrentPluginVersion($plugin_id),
                $this->plugin_state_db->getCurrentPluginDBVersion($plugin_id),
                $this->data_factory->version($plugin_version),
                $this->data_factory->version($ilias_min_version),
                $this->data_factory->version($ilias_max_version),
                $responsible,
                $responsible_mail,
                $learning_progress ?? false,
                $supports_export ?? false,
                $supports_cli_setup ?? true
            );
            $plugins_per_slot[$slot->getId()][$plugin_id] = $this->plugin_by_id[$plugin_id];
        }
    }

    protected function readComponentData(): array
    {
        return require self::COMPONENT_DATA_PATH;
    }

    protected function readPluginData(): array
    {
        return require self::PLUGIN_DATA_PATH;
    }

    public function hasComponent(string $type, string $name): bool
    {
        if (!in_array($type, ilComponentInfo::TYPES)) {
            throw new \InvalidArgumentException(
                "Unknown component type $type."
            );
        }

        return isset($this->component_id_by_type_and_name[$type][$name]);
    }

    public function hasComponentId(string $id): bool
    {
        return isset($this->components[$id]);
    }

    public function getComponents(): Iterator
    {
        foreach ($this->components as $id => $comp) {
            yield $id => $comp;
        }
    }

    public function getComponentById(string $id): ilComponentInfo
    {
        if (!$this->hasComponentId($id)) {
            throw new \InvalidArgumentException(
                "Unknown component $id"
            );
        }
        return $this->components[$id];
    }

    public function getComponentByTypeAndName(string $type, string $name): ilComponentInfo
    {
        if (!$this->hasComponent($type, $name)) {
            throw new \InvalidArgumentException(
                "Unknown component $type/$name"
            );
        }
        return $this->components[$this->component_id_by_type_and_name[$type][$name]];
    }


    public function hasPluginSlotId(string $id): bool
    {
        return isset($this->pluginslot_by_id[$id]);
    }

    public function getPluginSlots(): Iterator
    {
        foreach ($this->pluginslot_by_id as $id => $slot) {
            yield $id => $slot;
        }
    }

    public function getPluginSlotById(string $id): ilPluginSlotInfo
    {
        if (!$this->hasPluginSlotId($id)) {
            throw new \InvalidArgumentException(
                "Unknown pluginslot $id"
            );
        }
        return $this->pluginslot_by_id[$id];
    }

    public function hasPluginId(string $id): bool
    {
        return isset($this->plugin_by_id[$id]);
    }

    public function getPlugins(): Iterator
    {
        foreach ($this->plugin_by_id as $id => $plugin) {
            yield $id => $plugin;
        }
    }

    public function getPluginById(string $id): ilPluginInfo
    {
        if (!$this->hasPluginId($id)) {
            throw new \InvalidArgumentException(
                "Unknown plugin $id."
            );
        }
        return $this->plugin_by_id[$id];
    }

    public function getPluginByName(string $name): ilPluginInfo
    {
        foreach ($this->getPlugins() as $plugin) {
            if ($plugin->getName() === $name) {
                return $plugin;
            }
        }
        throw new \InvalidArgumentException(
            "No plugin with name $name."
        );
    }

    public function setCurrentPluginVersion(string $plugin_id, Data\Version $version, int $db_version): void
    {
        $plugin = $this->getPluginById($plugin_id);
        if ($plugin->getCurrentVersion() !== null && $plugin->getCurrentVersion()->isGreaterThan($version)) {
            throw new \RuntimeException(
                "Cannot downgrade plugins version from {$plugin->getCurrentVersion()} to $version"
            );
        }
        if ($plugin->getCurrentDBVersion() !== null && $plugin->getCurrentDBVersion() > $db_version) {
            throw new \RuntimeException(
                "Cannot downgrade plugins db version from {$plugin->getCurrentDBVersion()} to $db_version"
            );
        }
        $this->plugin_state_db->setCurrentPluginVersion($plugin_id, $version, $db_version);
        $this->buildDatabase();
    }

    public function setActivation(string $plugin_id, bool $activated): void
    {
        if (!$this->hasPluginId($plugin_id)) {
            throw new \InvalidArgumentException(
                "Unknown plugin $plugin_id."
            );
        }
        $this->plugin_state_db->setActivation($plugin_id, $activated);
        $this->buildDatabase();
    }

    public function removeStateInformationOf(string $plugin_id): void
    {
        if (!$this->hasPluginId($plugin_id)) {
            throw new \InvalidArgumentException(
                "Unknown plugin $plugin_id."
            );
        }
        $this->plugin_state_db->remove($plugin_id);
        $this->buildDatabase();
    }

    public function hasActivatedPlugin(string $id): bool
    {
        return ($this->hasPluginId($id) && $this->getPluginById($id)->isActivated());
    }
}