FlySystemDirectoryAccess.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

namespace ILIAS\Filesystem\Provider\FlySystem;

;

use ILIAS\Filesystem\DTO\Metadata;
use ILIAS\Filesystem\Exception\DirectoryNotFoundException;
use ILIAS\Filesystem\Exception\IOException;
use ILIAS\Filesystem\MetadataType;
use ILIAS\Filesystem\Provider\DirectoryAccess;
use ILIAS\Filesystem\Visibility;
use League\Flysystem\FilesystemInterface;
use League\Flysystem\RootViolationException;

/******************************************************************************
 *
 * This file is part of ILIAS, a powerful learning management system.
 *
 * ILIAS is licensed with the GPL-3.0, you should have received a copy
 * of said license along with the source code.
 *
 * If this is not the case or you just want to try ILIAS, you'll find
 * us at:
 *      https://www.ilias.de
 *      https://github.com/ILIAS-eLearning
 *
 *****************************************************************************/
class FlySystemDirectoryAccess implements DirectoryAccess
{
    private FilesystemInterface $flySystemFS;
    private FlySystemFileAccess $fileAccess;
    private static string $metaTypeKey = 'type';
    private static string $metaPathKey = 'path';


    public function __construct(FilesystemInterface $flySystemFS, FlySystemFileAccess $fileAccess)
    {
        $this->flySystemFS = $flySystemFS;
        $this->fileAccess = $fileAccess;
    }


    public function hasDir(string $path): bool
    {
        if ($this->flySystemFS->has($path)) {
            $meta = $this->flySystemFS->getMetadata($path);

            if (!(is_array($meta) && array_key_exists(self::$metaTypeKey, $meta))) {
                throw new IOException("Could not evaluate path type: \"$path\"");
            }

            return strcmp($meta[self::$metaTypeKey], MetadataType::DIRECTORY) === 0;
        }

        return false;
    }


    public function listContents(string $path = '', bool $recursive = false): array
    {
        if ($path !== '') {
            $this->ensureDirectoryExistence($path);
        }

        $contents = $this->flySystemFS->listContents($path, $recursive);
        $metadataCollection = [];

        foreach ($contents as $content) {
            if (!(array_key_exists(self::$metaTypeKey, $content) && array_key_exists(self::$metaPathKey, $content))) {
                throw new IOException("Invalid metadata received for path \"$path\"");
            }

            $metadataCollection[] = $this->arrayToMetadata($content);
        }

        return $metadataCollection;
    }


    public function createDir(string $path, string $visibility = Visibility::PUBLIC_ACCESS): void
    {
        $this->validateVisibility($visibility);

        $config = ['visibility' => $visibility];
        $successful = $this->flySystemFS->createDir($path, $config);

        if (!$successful) {
            throw new IOException("Could not create directory \"$path\"");
        }
    }


    public function copyDir(string $source, string $destination): void
    {
        $this->ensureDirectoryExistence($source);
        $this->ensureEmptyDirectory($destination);

        $contentList = $this->listContents($source, true);

        //foreach file and dir
        foreach ($contentList as $content) {

            //ignore the directories and only copy the files
            if ($content->isFile()) {

                //create destination path
                $position = strpos($content->getPath(), $source);
                if ($position !== false) {
                    $destinationFilePath = substr_replace($content->getPath(), $destination, $position, strlen($source));
                    $this->fileAccess->copy($content->getPath(), $destinationFilePath);
                }
            }
        }
    }


    private function ensureEmptyDirectory(string $path): void
    {

        //check if destination dir is empty
        try {
            $destinationContent = $this->listContents($path, true);
            if (count($destinationContent) !== 0) {
                throw new IOException("Destination \"$path\" is not empty can not copy files.");
            }
        } catch (DirectoryNotFoundException $ex) {
            //nothing needs to be done the destination was not found
        }
    }


    private function ensureDirectoryExistence(string $path): void
    {
        if (!$this->hasDir($path)) {
            throw new DirectoryNotFoundException("Directory \"$path\" not found.");
        }
    }


    public function deleteDir(string $path): void
    {
        try {
            if ($this->flySystemFS->deleteDir($path) === false) {
                throw new IOException("Could not delete directory \"$path\".");
            }
        } catch (RootViolationException $ex) {
            throw new IOException('The filesystem root must not be deleted.', 0, $ex);
        }
    }


    private function arrayToMetadata(array $metadataArray): \ILIAS\Filesystem\DTO\Metadata
    {
        return new Metadata(
            $metadataArray[self::$metaPathKey],
            $metadataArray[self::$metaTypeKey]
        );
    }


    private function validateVisibility(string $visibility): void
    {
        if (strcmp($visibility, Visibility::PRIVATE_ACCESS) !== 0 && strcmp($visibility, Visibility::PUBLIC_ACCESS) !== 0) {
            throw new \InvalidArgumentException("Invalid visibility expected public or private but got \"$visibility\".");
        }
    }
}