class.ilComponentBuildPluginInfoObjective.php

Go to the documentation of this file.

<?php

use ILIAS\Setup;

class ilComponentBuildPluginInfoObjective extends Setup\Artifact\BuildArtifactObjective
{
    protected const BASE_PATH = "./public/Customizing/global/plugins/";
    protected const PLUGIN_PHP = "plugin.php";
    protected const PLUGIN_CLASS_FILE = "classes/class.il%sPlugin.php";


    public function getArtifactName(): string
    {
        return "plugin_data";
    }

    public function build(): Setup\Artifact
    {
        $data = [];
        foreach (['Modules', 'Services'] as $type) {
            $base_path = static::BASE_PATH . $type . '/';
            if (! $this->isDir($base_path)) {
                continue;
            }
            $components = $this->scanDir($base_path);
            foreach ($components as $component) {
                if ($this->isDotFile($component)
                    || ! $this->isDir($base_path . "$component")) {
                    continue;
                }
                $slots = $this->scanDir($base_path . "$component");
                foreach ($slots as $slot) {
                    if ($this->isDotFile($slot)
                        || ! $this->isDir($base_path . "$component/$slot")) {
                        continue;
                    }
                    $plugins = $this->scanDir($base_path . "$component/$slot");
                    foreach ($plugins as $plugin) {
                        if ($this->isDotFile($plugin)
                            || ! $this->isDir($base_path . "$component/$slot/$plugin")) {
                            continue;
                        }
                        $this->addPlugin($data, $type, $component, $slot, $plugin);
                    }
                }
            }
        }
        return new Setup\Artifact\ArrayArtifact($data);
    }

    protected function addPlugin(array &$data, string $type, string $component, string $slot, string $plugin): void
    {
        $plugin_path = $this->buildPluginPath($type, $component, $slot, $plugin);
        $plugin_php = $plugin_path . static::PLUGIN_PHP;
        if (!$this->fileExists($plugin_php)) {
            throw new \RuntimeException(
                "Cannot read $plugin_php."
            );
        }

        $plugin_class = $plugin_path . sprintf(static::PLUGIN_CLASS_FILE, $plugin);
        if (!$this->fileExists($plugin_class)) {
            throw new \RuntimeException(
                "Cannot read $plugin_class."
            );
        }

        require_once($plugin_php);
        if (!isset($id)) {
            throw new \InvalidArgumentException("$plugin does not define \$id");
        }
        if (!isset($version)) {
            throw new \InvalidArgumentException("$plugin does not define \$version");
        }
        if (!isset($ilias_min_version)) {
            throw new \InvalidArgumentException("$plugin does not define \$ilias_min_version");
        }
        if (!isset($ilias_max_version)) {
            throw new \InvalidArgumentException("$plugin does not define \$ilias_max_version");
        }

        if (isset($data[$id])) {
            throw new \RuntimeException(
                "Plugin with id $id already exists."
            );
        }

        $data[$id] = [
            $type,
            $component,
            $slot,
            $plugin,
            $version,
            $ilias_min_version,
            $ilias_max_version,
            $responsible ?? "",
            $responsible_mail ?? "",
            $learning_progress ?? null,
            $supports_export ?? null,
            $supports_cli_setup ?? null
        ];
    }

    protected function scanDir(string $dir): array
    {
        if (!file_exists($dir)) {
            return [];
        }
        $result = scandir($dir);
        return array_values(array_diff($result, [".", ".."]));
    }

    protected function fileExists(string $path): bool
    {
        return file_exists($path) && is_file($path);
    }

    protected function isDir(string $dir): bool
    {
        return file_exists($dir) && is_dir($dir);
    }

    protected function isDotFile(string $file): bool
    {
        return (substr($file, 0, 1) === '.');
    }

    protected function buildPluginPath(string $type, string $component, string $slot, string $plugin): string
    {
        return static::BASE_PATH . "$type/$component/$slot/$plugin/";
    }
}