PublicAssetManager.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

namespace ILIAS\Component\Resource;

class PublicAssetManager
{
    public const REGEXP = '%^(/\w+|\w+[\-.]\w+)+$%';

    public const DONT_PURGE = ["data", "Customizing"];

    protected $assets = [];


    public function addAssets(PublicAsset ...$assets): void
    {
        foreach ($assets as $asset) {
            $this->insertInto($this->assets, explode("/", $asset->getTarget()), $asset);
        }
    }

    protected function insertInto(array &$assets, array $path, PublicAsset $asset): void
    {
        $key = array_shift($path);
        $key_exists = array_key_exists($key, $assets);
        $target_reached = count($path) === 0;

        if (!$key_exists && $target_reached) {
            $assets[$key] = $asset;
            return;
        }

        if (!$target_reached && (!$key_exists || is_array($assets[$key]))) {
            if (!$key_exists) {
                $assets[$key] = [];
            }
            $this->insertInto($assets[$key], $path, $asset);
            return;
        }

        $first_asset = $assets[$key];
        while (!$first_asset instanceof PublicAsset) {
            $first_asset = array_shift($first_asset);
        }

        throw new \LogicException(
            "There are (at least) two assets for the same target '{$asset->getTarget()}': " .
            "'{$first_asset->getSource()}' and '{$asset->getSource()}'"
        );
    }

    public function buildPublicFolder(string $ilias_base, string $target): void
    {
        if (!preg_match(self::REGEXP, $ilias_base)) {
            throw new \InvalidArgumentException(
                "'{$ilias_base}' is not a valid path to ILIAS base folder."
            );
        }
        if (!preg_match(self::REGEXP, $target)) {
            throw new \InvalidArgumentException(
                "'{$target}' is not a valid target path for public assets."
            );
        }

        $this->purge($target, array_map(fn($v) => $target . "/" . $v, self::DONT_PURGE));
        $this->makeDir($target);
        $this->buildPublicFolderRecursivelyArray($ilias_base, $target, $this->assets);
    }

    protected function buildPublicFolderRecursively(string $ilias_base, string $target, PublicAsset|array $asset): void
    {
        if (is_array($asset)) {
            $this->makeDir("$target");
            $this->buildPublicFolderRecursivelyArray($ilias_base, $target, $asset);
        } else {
            $targets = explode("/", $asset->getTarget());
            $this->copy("$ilias_base/{$asset->getSource()}", "$target");
        }
    }

    protected function buildPublicFolderRecursivelyArray(string $ilias_base, string $target, array $assets): void
    {
        foreach ($assets as $key => $asset) {
            $this->buildPublicFolderRecursively($ilias_base, "$target/$key", $asset);
        }
    }

    protected function copy(string $source, string $target): void
    {
        if (is_file($source)) {
            copy($source, $target);
        } elseif (is_dir($source)) {
            $dir = new \RecursiveDirectoryIterator($source, \FilesystemIterator::SKIP_DOTS);
            $this->makeDir($target);
            foreach ($dir as $d) {
                $name = $d->getBasename();
                $this->copy("$source/$name", "$target/$name");
            }
        } else {
            throw new \RuntimeException(
                "Cannot copy $source, not a file or directory."
            );
        }
    }

    protected function purge(string $path, array $dont_purge): bool
    {
        if (in_array($path, $dont_purge)) {
            return false;
        }

        if (!file_exists($path)) {
            return true;
        }

        if (is_file($path)) {
            unlink($path);
            return true;
        }

        if (is_dir($path)) {
            $purged = true;
            foreach (array_diff(scandir($path), ['.', '..']) as $item) {
                $purged = $this->purge($path . "/" . $item, $dont_purge) && $purged;
            }
            if ($purged) {
                rmdir($path);
            }
            return $purged;
        }

        throw new \LogicException("Don't know how to purge $path");
    }

    protected function makeDir(string $path): void
    {
        if (!file_exists($path)) {
            mkdir($path, 0755);
        }
    }
}