FilesystemWhitelistDecorator.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

namespace ILIAS\Filesystem\Decorator;

use ILIAS\Data\DataSize;
use ILIAS\Filesystem\Exception\DirectoryNotFoundException;
use ILIAS\Filesystem\Exception\IOException;
use ILIAS\Filesystem\Filesystem;
use ILIAS\Filesystem\Finder\Finder;
use ILIAS\Filesystem\Security\Sanitizing\FilenameSanitizer;
use ILIAS\Filesystem\Stream\FileStream;
use ILIAS\Filesystem\Visibility;

final class FilesystemWhitelistDecorator implements Filesystem
{
    public function __construct(private Filesystem $filesystem, private FilenameSanitizer $sanitizer)
    {
    }

    public function hasDir(string $path): bool
    {
        return $this->filesystem->hasDir($path);
    }

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

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

    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->copy($content->getPath(), $destinationFilePath);
                }
            }
        }
    }

    public function deleteDir(string $path): void
    {
        $this->filesystem->deleteDir($path);
    }

    public function read(string $path): string
    {
        return $this->filesystem->read($path);
    }

    public function has(string $path): bool
    {
        return $this->filesystem->has($path);
    }

    public function getMimeType(string $path): string
    {
        return $this->filesystem->getMimeType($path);
    }

    public function getTimestamp(string $path): \DateTimeImmutable
    {
        return $this->filesystem->getTimestamp($path);
    }

    public function getSize(string $path, int $unit): DataSize
    {
        return $this->filesystem->getSize(
            $path,
            $unit
        );
    }

    public function setVisibility(string $path, string $visibility): bool
    {
        return $this->filesystem->setVisibility(
            $this->sanitizer->sanitize($path),
            $visibility
        );
    }

    public function getVisibility(string $path): string
    {
        return $this->filesystem->getVisibility($path);
    }

    public function readStream(string $path): FileStream
    {
        return $this->filesystem->readStream($path);
    }

    public function writeStream(string $path, FileStream $stream): void
    {
        $this->filesystem->writeStream($this->sanitizer->sanitize($path), $stream);
    }

    public function putStream(string $path, FileStream $stream): void
    {
        $this->filesystem->putStream($this->sanitizer->sanitize($path), $stream);
    }

    public function updateStream(string $path, FileStream $stream): void
    {
        $this->filesystem->updateStream($this->sanitizer->sanitize($path), $stream);
    }

    public function write(string $path, string $content): void
    {
        $this->filesystem->write($this->sanitizer->sanitize($path), $content);
    }

    public function update(string $path, string $new_content): void
    {
        $this->filesystem->update($this->sanitizer->sanitize($path), $new_content);
    }

    public function put(string $path, string $content): void
    {
        $this->filesystem->put($this->sanitizer->sanitize($path), $content);
    }

    public function delete(string $path): void
    {
        $this->filesystem->delete($path);
    }

    public function readAndDelete(string $path): string
    {
        return $this->filesystem->readAndDelete($path);
    }

    public function rename(string $path, string $new_path): void
    {
        $this->filesystem->rename(
            $path,
            $this->sanitizer->sanitize($new_path)
        );
    }

    public function copy(string $path, string $copy_path): void
    {
        $this->filesystem->copy(
            $path,
            $this->sanitizer->sanitize($copy_path)
        );
    }

    private function ensureEmptyDirectory(string $path): void
    {
        //check if destination dir is empty
        try {
            $destinationContent = $this->listContents($path, true);
            if ($destinationContent !== []) {
                throw new IOException("Destination \"$path\" is not empty can not copy files.");
            }
        } catch (DirectoryNotFoundException) {
            //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 finder(): Finder
    {
        return $this->filesystem->finder();
    }
}