DelegatingFilesystemFactory.php

Go to the documentation of this file.

<?php
 
declare(strict_types=1);
 
namespace ILIAS\Filesystem\Provider;
 
use ILIAS\Filesystem\Decorator\FilesystemWhitelistDecorator;
use ILIAS\Filesystem\Decorator\ReadOnlyDecorator;
use ILIAS\Filesystem\Filesystem;
use ILIAS\Filesystem\Provider\Configuration\LocalConfig;
use ILIAS\Filesystem\Provider\FlySystem\FlySystemFilesystemFactory;
use ILIAS\Filesystem\Security\Sanitizing\FilenameSanitizer;
use ILIAS\Filesystem\FileSystems\FilesystemWeb;
use ILIAS\Filesystem\Configuration\DirectoryPathConfig;
use ILIAS\Filesystem\FileSystems\FilesystemStorage;
use ILIAS\Filesystem\FileSystems\FilesystemTemp;
use ILIAS\Filesystem\FileSystems\FilesystemCustomizing;
use ILIAS\Filesystem\FileSystems\FilesystemLibs;
use ILIAS\Filesystem\FileSystems\FilesystemNodeModules;
 
final class DelegatingFilesystemFactory implements FilesystemFactory
{
    private FlySystemFilesystemFactory $implementation;
 
    public function __construct(
        private FilenameSanitizer $sanitizer,
        private DirectoryPathConfig $directory_path_config
    ) {
        /*
         * ---------- ABSTRACTION SWITCH -------------
         * Change the factory to switch to another filesystem abstraction!
         * current: FlySystem from the php league
         * -------------------------------------------
         */
        $this->implementation = new FlySystemFilesystemFactory();
    }
 
    public function getLocal(LocalConfig $config, bool $read_only = false): Filesystem
    {
        if ($read_only) {
            return new ReadOnlyDecorator(
                new FilesystemWhitelistDecorator($this->implementation->getLocal($config), $this->sanitizer)
            );
        }
        return new FilesystemWhitelistDecorator($this->implementation->getLocal($config), $this->sanitizer);
    }
 
    public function buildFor(string $fqdn_interface, bool $read_only = false): Filesystem
    {
        $config = match ($fqdn_interface) {
            FilesystemWeb::class => new LocalConfig($this->directory_path_config->getWebDirectoryPath()),
            FilesystemStorage::class => new LocalConfig($this->directory_path_config->getStorageDirectoryPath()),
            FilesystemTemp::class => new LocalConfig($this->directory_path_config->getTempDirectoryPath()),
            FilesystemCustomizing::class => new LocalConfig(
                $this->directory_path_config->getCustomizingDirectoryPath()
            ),
            FilesystemLibs::class => new LocalConfig($this->directory_path_config->getLibsDirectoryPath()),
            FilesystemNodeModules::class => new LocalConfig(
                $this->directory_path_config->getNodeModulesDirectoryPath()
            ),
            default => throw new \InvalidArgumentException("Unknown filesystem interface $fqdn_interface")
        };
 
        // the code directories are never written to at runtime
        $read_only = $read_only || in_array(
            $fqdn_interface,
            [FilesystemLibs::class, FilesystemNodeModules::class],
            true
        );
 
        if ($read_only) {
            return new ReadOnlyDecorator(
                new FilesystemWhitelistDecorator($this->implementation->getLocal($config), $this->sanitizer)
            );
        }
        return new FilesystemWhitelistDecorator($this->implementation->getLocal($config), $this->sanitizer);
    }
 
}