FlySystemFileStreamAccess.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

namespace ILIAS\Filesystem\Provider\FlySystem;

use ILIAS\Filesystem\Exception\FileAlreadyExistsException;
use ILIAS\Filesystem\Exception\FileNotFoundException;
use ILIAS\Filesystem\Exception\IOException;
use ILIAS\Filesystem\Provider\FileStreamAccess;
use ILIAS\Filesystem\Stream\FileStream;
use ILIAS\Filesystem\Stream\Streams;
use League\Flysystem\FilesystemOperator;
use League\Flysystem\UnableToWriteFile;
use League\Flysystem\UnableToRetrieveMetadata;
use League\Flysystem\UnableToReadFile;

final class FlySystemFileStreamAccess implements FileStreamAccess
{
    public function __construct(
        private FilesystemOperator $flysystem_operator
    ) {
    }

    public function readStream(string $path): FileStream
    {
        try {
            $resource = $this->flysystem_operator->readStream($path);
            if ($resource === false) {
                throw new IOException("Could not open stream for file \"$path\"");
            }
            return Streams::ofResource($resource);
        } catch (UnableToRetrieveMetadata|UnableToReadFile $ex) {
            throw new FileNotFoundException("File \"$path\" not found.", 0, $ex);
        }
    }

    public function writeStream(string $path, FileStream $stream): void
    {
        $resource = $stream->detach();
        if (!is_resource($resource)) {
            throw new \InvalidArgumentException('The given stream must not be detached.');
        }
        if ($this->flysystem_operator->fileExists($path)) {
            throw new FileAlreadyExistsException("File \"$path\" already exists.");
        }
        try {
            $this->flysystem_operator->writeStream($path, $resource);
        } catch (UnableToWriteFile $ex) {
            throw new IOException("Could not write stream to file \"$path\"", 0, $ex);
        } finally {
            if (is_resource($resource)) {
                fclose($resource);
            }
        }
    }

    public function putStream(string $path, FileStream $stream): void
    {
        $resource = $stream->detach();
        try {
            if (!is_resource($resource)) {
                throw new \InvalidArgumentException('The given stream must not be detached.');
            }

            $result = $this->flysystem_operator->putStream($path, $resource);

            if ($result === false) {
                throw new IOException("Could not put stream content into \"$path\"");
            }
        } finally {
            if (is_resource($resource)) {
                fclose($resource);
            }
        }
    }

    public function updateStream(string $path, FileStream $stream): void
    {
        $resource = $stream->detach();
        try {
            if (!is_resource($resource)) {
                throw new \InvalidArgumentException('The given stream must not be detached.');
            }
            // FlySystem 3 has no updateStream method, so we have to use writeStream instead.
            $this->flysystem_operator->writeStream($path, $resource);
        } catch (UnableToWriteFile $ex) {
            throw new FileNotFoundException("Unable to update Stream in \"$path\".", 0, $ex);
        } finally {
            if (is_resource($resource)) {
                fclose($resource);
            }
        }
    }
}