FlySystemLocalFilesystemFactory.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

namespace ILIAS\Filesystem\Provider\FlySystem;

use ILIAS\Filesystem\FilesystemFacade;
use ILIAS\Filesystem\Filesystem;
use ILIAS\Filesystem\Provider\Configuration\LocalConfig;
use League\Flysystem\Adapter\Local;

/******************************************************************************
 *
 * 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 FlySystemLocalFilesystemFactory
{
    public const PRIVATE_ACCESS_KEY = 'private';
    public const PUBLIC_ACCESS_KEY = 'public';
    public const FILE_ACCESS_KEY = 'file';
    public const DIRECTORY_ACCESS_KEY = 'dir';

    public function getInstance(LocalConfig $config): \ILIAS\Filesystem\FilesystemFacade
    {
        $this->validateFileLockMode($config->getLockMode());

        $adapter = new Local(
            $config->getRootPath(),
            $config->getLockMode(),
            $this->mapConfigLinkToLocalLinks($config->getLinkBehaviour()),
            [
                self::FILE_ACCESS_KEY => [
                    self::PRIVATE_ACCESS_KEY => $config->getFileAccessPrivate(),
                    self::PUBLIC_ACCESS_KEY => $config->getFileAccessPublic()
                ],
                self::DIRECTORY_ACCESS_KEY => [
                    self::PRIVATE_ACCESS_KEY => $config->getDirectoryAccessPrivate(),
                    self::PUBLIC_ACCESS_KEY => $config->getDirectoryAccessPublic()
                ]
            ]
        );

        //switch the path separator to a forward slash, see Mantis 0022554
        $reflection = new \ReflectionObject($adapter);
        $property = $reflection->getProperty("pathSeparator");
        $property->setAccessible(true);
        $property->setValue($adapter, '/');

        /* set new path separator in path prefix, the library will replace the old path ending
           while setting the path prefix.
        */
        $adapter->setPathPrefix($adapter->getPathPrefix());


        $filesystem = new \League\Flysystem\Filesystem($adapter);
        $fileAccess = new FlySystemFileAccess($filesystem);
        $facade = new FilesystemFacade(
            new FlySystemFileStreamAccess($filesystem),
            $fileAccess,
            new FlySystemDirectoryAccess($filesystem, $fileAccess)
        );

        return $facade;
    }


    private function mapConfigLinkToLocalLinks(int $configLinkBehaviour): int
    {
        switch ($configLinkBehaviour) {
            case LocalConfig::DISALLOW_LINKS:
                return Local::DISALLOW_LINKS;
            case LocalConfig::SKIP_LINKS:
                return Local::SKIP_LINKS;
            default:
                throw new \InvalidArgumentException("The supplied value \"$configLinkBehaviour\" is not a valid LocalConfig link behaviour constant.");
        }
    }


    private function validateFileLockMode(int $code): void
    {
        if ($code === LOCK_EX || $code === LOCK_SH) {
            return;
        }

        throw new \InvalidArgumentException("The supplied value \"$code\" is not a valid file lock mode please check your local file storage configurations.");
    }
}