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\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
 *
 *****************************************************************************/
final class FlySystemFileStreamAccess implements FileStreamAccess
{
    private FilesystemInterface $flySystemFS;

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

    public function readStream(string $path): FileStream
    {
        try {
            $resource = $this->flySystemFS->readStream($path);
            if ($resource === false) {
                throw new IOException("Could not open stream for file \"$path\"");
            }

            $stream = Streams::ofResource($resource);
            return $stream;
        } catch (\League\Flysystem\FileNotFoundException $ex) {
            throw new FileNotFoundException("File \"$path\" not found.", 0, $ex);
        }
    }


    public function writeStream(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->flySystemFS->writeStream($path, $resource);

            if ($result === false) {
                throw new IOException("Could not write stream to file \"$path\"");
            }
        } catch (FileExistsException $ex) {
            throw new FileAlreadyExistsException("File \"$path\" already exists.", 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->flySystemFS->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.');
            }

            $result = $this->flySystemFS->updateStream($path, $resource);

            if ($result === false) {
                throw new IOException("Could not update file \"$path\"");
            }
        } catch (\League\Flysystem\FileNotFoundException $ex) {
            throw new FileNotFoundException("File \"$path\" not found.", 0, $ex);
        } finally {
            if (is_resource($resource)) {
                fclose($resource);
            }
        }
    }
}