class.ilFileSystemDirectoryCopiedRecursivelyObjective.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

use ILIAS\Setup;

class ilFileSystemDirectoryCopiedRecursivelyObjective implements Setup\Objective
{
    protected string $source_folder;
    protected string $target_folder;
    protected bool $data_dir;
    protected bool $bare;

    public function __construct(
        string $source_folder,
        string $target_folder,
        bool $data_dir = false,
        bool $bare = false
    ) {
        $this->source_folder = $source_folder;
        $this->target_folder = $target_folder;
        $this->data_dir = $data_dir;
        $this->bare = $bare;
    }

    public function getHash(): string
    {
        return hash("sha256", self::class . $this->getSourceName($this->source_folder) . $this->target_folder);
    }

    public function getLabel(): string
    {
        $source = $this->getSourceName($this->source_folder);
        return "Copy directory from $source to $this->target_folder.";
    }

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

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

    public function achieve(Setup\Environment $environment): Setup\Environment
    {
        $source = $this->source_folder;

        if (!$this->bare) {
            $ini = $environment->getResource(Setup\Environment::RESOURCE_ILIAS_INI);

            $root = $ini->readVariable("server", "absolute_path");

            if ($this->data_dir) {
                $root = $ini->readVariable("clients", "datadir");
            }

            $source = $root . DIRECTORY_SEPARATOR . $this->source_folder;
        }

        if (file_exists($this->target_folder)) {
            $this->deleteDirRecursive($this->target_folder);
        } else {
            mkdir($this->target_folder, 0755);
        }

        $iterator = new RecursiveIteratorIterator(
            new RecursiveDirectoryIterator($source, FilesystemIterator::SKIP_DOTS),
            RecursiveIteratorIterator::SELF_FIRST
        );

        foreach ($iterator as $item) {
            if ($item->isDir()) {
                mkdir($this->target_folder . DIRECTORY_SEPARATOR . $iterator->getSubPathname());
            } else {
                copy($item->getPathname(), $this->target_folder . DIRECTORY_SEPARATOR . $iterator->getSubPathname());
            }
        }

        return $environment;
    }

    public function isApplicable(Setup\Environment $environment): bool
    {
        $source = $this->source_folder;

        if (!$this->bare) {
            $ini = $environment->getResource(Setup\Environment::RESOURCE_ILIAS_INI);

            $root = $ini->readVariable("server", "absolute_path");
            if ($this->data_dir) {
                $root = $ini->readVariable("clients", "datadir");
            }

            $source = $root . DIRECTORY_SEPARATOR . $this->source_folder;
        }

        return
            file_exists($source) &&
            is_writable(pathinfo($this->target_folder, PATHINFO_DIRNAME))
        ;
    }

    protected function deleteDirRecursive(string $path): void
    {
        $files = new RecursiveIteratorIterator(
            new RecursiveDirectoryIterator($path, FilesystemIterator::SKIP_DOTS),
            RecursiveIteratorIterator::CHILD_FIRST
        );

        foreach ($files as $file_info) {
            if ($file_info->isDir()) {
                rmdir($file_info->getRealPath());
                continue;
            }
            unlink($file_info->getRealPath());
        }
    }

    protected function getSourceName(string $source): string
    {
        if ($source !== "") {
            return $source;
        }

        if ($this->data_dir) {
            return "ilias data dir";
        }

        return "ilias root";
    }
}