FlySystemFileAccess.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

namespace ILIAS\Filesystem\Provider\FlySystem;

use ILIAS\Data\DataSize;
use ILIAS\Filesystem\Exception\FileAlreadyExistsException;
use ILIAS\Filesystem\Exception\FileNotFoundException;
use ILIAS\Filesystem\Exception\IOException;
use ILIAS\Filesystem\Provider\FileAccess;
use ILIAS\Filesystem\Visibility;
use League\Flysystem\FileExistsException;
use League\Flysystem\FilesystemInterface;

/******************************************************************************
 *
 * 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 FlySystemFileAccess implements FileAccess
{
    private FilesystemInterface $flySystemFS;


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


    public function read(string $path): string
    {
        try {
            $path = Util::normalizeRelativePath($path);
            $adapter = $this->flySystemFS->getAdapter();
            if (!$adapter->has($path)) {
                throw new \League\Flysystem\FileNotFoundException($path);
            }
            $object = $adapter->read($path);
            $result = $object['contents'];

            if ($result === false) {
                throw new IOException("Could not access the file \"$path\".");
            }

            return $result;
        } catch (\League\Flysystem\FileNotFoundException $ex) {
            throw new FileNotFoundException("File \"$path\" not found.", 0, $ex);
        }
    }


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


    public function getMimeType(string $path): string
    {
        try {
            $mimeType = $this->flySystemFS->getMimetype($path);
            if ($mimeType === false) {
                throw new IOException("Could not determine the MIME type of the file \"$path\".");
            }

            return $mimeType;
        } catch (\League\Flysystem\FileNotFoundException $ex) {
            throw new FileNotFoundException("File \"$path\" not found.", 0, $ex);
        }
    }


    public function getTimestamp(string $path): \DateTimeImmutable
    {
        try {
            $rawTimestamp = $this->flySystemFS->getTimestamp($path);
            if ($rawTimestamp === false) {
                throw new IOException("Could not lookup timestamp of the file \"$path\".");
            }

            if (is_numeric($rawTimestamp)) {
                $rawTimestamp = '@' . $rawTimestamp;
            }

            return new \DateTimeImmutable($rawTimestamp);
        } catch (\League\Flysystem\FileNotFoundException $ex) {
            throw new FileNotFoundException("File \"$path\" not found.", 0, $ex);
        }
    }


    public function getSize(string $path, int $fileSizeUnit): DataSize
    {
        try {
            $byteSize = $this->flySystemFS->getSize($path);

            //check if the fly system adapter failed
            if ($byteSize === false) {
                throw new IOException("Could not calculate the file size of the file \"$path\".");
            }

            $size = new DataSize($byteSize, $fileSizeUnit);
            return  $size;
        } catch (\League\Flysystem\FileNotFoundException $ex) {
            throw new FileNotFoundException("File \"$path\" not found.");
        }
    }


    public function setVisibility(string $path, string $visibility): bool
    {
        if ($this->has($path) === false) {
            throw new FileNotFoundException("Path \"$path\" not found.");
        }

        $this->validateVisibility($visibility);

        return $this->flySystemFS->setVisibility($path, $visibility);
    }


    private function validateVisibility(string $visibility): void
    {
        if (strcmp($visibility, Visibility::PUBLIC_ACCESS) !== 0 && strcmp($visibility, Visibility::PRIVATE_ACCESS) !== 0) {
            throw new \InvalidArgumentException("The access must be 'public' or 'private' but '$visibility' was given.");
        }
    }


    public function getVisibility(string $path): string
    {
        if ($this->has($path) === false) {
            throw new FileNotFoundException("Path \"$path\" not found.");
        }

        $visibility = $this->flySystemFS->getVisibility($path);

        if ($visibility === false) {
            throw new IOException("Could not determine visibility for path '$path'.");
        }

        return $visibility;
    }


    public function write(string $path, string $content): void
    {
        try {
            if ($this->flySystemFS->write($path, $content) === false) {
                throw new IOException("Could not write to file \"$path\" because a general IO error occurred. Please check that your destination is writable.");
            }
        } catch (FileExistsException $ex) {
            throw new FileAlreadyExistsException("File \"$path\" already exists.", 0, $ex);
        }
    }


    public function update(string $path, string $new_content): void
    {
        try {
            if ($this->flySystemFS->update($path, $new_content) === false) {
                throw new IOException("Could not write to file \"$path\" because a general IO error occurred. Please check that your destination is writable.");
            }
        } catch (\League\Flysystem\FileNotFoundException $ex) {
            throw new FileNotFoundException("File \"$path\" was not found update failed.", 0, $ex);
        }
    }


    public function put(string $path, string $content): void
    {
        if ($this->flySystemFS->put($path, $content) === false) {
            throw new IOException("Could not write to file \"$path\" because a general IO error occurred. Please check that your destination is writable.");
        }
    }


    public function delete(string $path): void
    {
        try {
            if ($this->flySystemFS->delete($path) === false) {
                throw new IOException("Could not delete file \"$path\" because a general IO error occurred. Please check that your target is writable.");
            }
        } catch (\League\Flysystem\FileNotFoundException $ex) {
            throw new FileNotFoundException("File \"$path\" was not found delete operation failed.");
        }
    }


    public function readAndDelete(string $path): string
    {
        $content = $this->read($path);
        $this->delete($path);

        return $content;
    }


    public function rename(string $path, string $new_path): void
    {
        try {
            if ($this->flySystemFS->rename($path, $new_path) === false) {
                throw new IOException("Could not move file from \"$path\" to \"$new_path\".");
            }
        } catch (FileExistsException $ex) {
            throw new FileAlreadyExistsException("File \"$new_path\" already exists.");
        } catch (\League\Flysystem\FileNotFoundException $ex) {
            throw new FileNotFoundException("File \"$path\" not found.");
        }
    }


    public function copy(string $path, string $copy_path): void
    {
        try {
            if ($this->flySystemFS->copy($path, $copy_path) === false) {
                throw new IOException("Could not copy file \"$path\" to destination \"$copy_path\" because a general IO error occurred. Please check that your destination is writable.");
            }
        } catch (FileExistsException $ex) {
            throw new FileAlreadyExistsException("File destination \"$copy_path\" already exists copy failed.");
        } catch (\League\Flysystem\FileNotFoundException $ex) {
            throw new FileNotFoundException("File source \"$path\" was not found copy failed.");
        }
    }
}