ResourceStorageTest.php

Go to the documentation of this file.

<?php
 
declare(strict_types=1);
 
/*
 * This file is part of the TYPO3 CMS project.
 *
 * It is free software; you can redistribute it and/or modify it under
 * the terms of the GNU General Public License, either version 2
 * of the License, or any later version.
 *
 * For the full copyright and license information, please read the
 * LICENSE.txt file that was distributed with this source code.
 *
 * The TYPO3 project - inspiring people to share!
 */
 
namespace ‪TYPO3\CMS\Core\Tests\Unit\Resource;
 
use PHPUnit\Framework\MockObject\MockObject;
use Prophecy\Argument;
use Prophecy\PhpUnit\ProphecyTrait;
use Psr\EventDispatcher\EventDispatcherInterface;
use ‪TYPO3\CMS\Core\Cache\CacheManager;
use ‪TYPO3\CMS\Core\Cache\Frontend\FrontendInterface;
use ‪TYPO3\CMS\Core\Resource\Driver\AbstractDriver;
use ‪TYPO3\CMS\Core\Resource\Driver\LocalDriver;
use ‪TYPO3\CMS\Core\Resource\DuplicationBehavior;
use ‪TYPO3\CMS\Core\Resource\Exception\ExistingTargetFileNameException;
use ‪TYPO3\CMS\Core\Resource\File;
use ‪TYPO3\CMS\Core\Resource\FileInterface;
use ‪TYPO3\CMS\Core\Resource\FileRepository;
use ‪TYPO3\CMS\Core\Resource\Folder;
use ‪TYPO3\CMS\Core\Resource\Index\Indexer;
use ‪TYPO3\CMS\Core\Resource\ResourceFactory;
use ‪TYPO3\CMS\Core\Resource\ResourceStorage;
use ‪TYPO3\CMS\Core\Utility\ArrayUtility;
use ‪TYPO3\CMS\Core\Utility\GeneralUtility;
 
class ‪ResourceStorageTest extends ‪BaseTestCase
{
    use ProphecyTrait;
 
    protected ‪$resetSingletonInstances = true;
 
    protected ‪$subject;
 
    protected ‪$eventDispatcher;
 
    protected function ‪setUp(): void
    {
        parent::setUp();
        $fileRepositoryMock = $this->createMock(FileRepository::class);
        GeneralUtility::setSingletonInstance(
            FileRepository::class,
            $fileRepositoryMock
        );
        $cacheManagerProphecy = $this->prophesize(CacheManager::class);
        $cacheProphecy = $this->prophesize(FrontendInterface::class);
        $cacheManagerProphecy->getCache('runtime')->willReturn($cacheProphecy->reveal());
        $cacheProphecy->get(Argument::cetera())->willReturn(false);
        $cacheProphecy->set(Argument::cetera())->willReturn(false);
        GeneralUtility::setSingletonInstance(CacheManager::class, $cacheManagerProphecy->reveal());
        ‪$eventDispatcher = $this->prophesize(EventDispatcherInterface::class);
        ‪$eventDispatcher->dispatch(Argument::cetera())->willReturnArgument(0);
        $this->eventDispatcher = ‪$eventDispatcher->reveal();
    }
 
    protected function ‪prepareSubject(
        array $configuration,
        bool $mockPermissionChecks = false,
        ‪AbstractDriver $driverObject = null,
        ‪ResourceFactory $resourceFactory = null,
        array $storageRecord = [],
        array $mockedMethods = []
    ): void {
        $permissionMethods = [
            'assureFileAddPermissions',
            'checkFolderActionPermission',
            'checkFileActionPermission',
            'checkUserActionPermission',
            'checkFileExtensionPermission',
            'isWithinFileMountBoundaries',
            'assureFileRenamePermissions',
        ];
        $configuration = $this->‪convertConfigurationArrayToFlexformXml($configuration);
        $overruleArray = ['configuration' => $configuration];
        ‪ArrayUtility::mergeRecursiveWithOverrule($storageRecord, $overruleArray);
        if ($driverObject === null) {
            $driverObject = $this->getMockForAbstractClass(AbstractDriver::class, [], '', false);
        }
        if ($resourceFactory === null) {
            $resourceFactory = $this->createMock(ResourceFactory::class);
        }
        $mockedMethods[] = 'getResourceFactoryInstance';
        if ($mockPermissionChecks) {
            $mockedMethods = array_merge($mockedMethods, $permissionMethods);
        }
        $mockedMethods[] = 'getIndexer';
 
        $this->subject = $this->getMockBuilder(ResourceStorage::class)
            ->onlyMethods(array_unique($mockedMethods))
            ->setConstructorArgs([$driverObject, $storageRecord, $this->eventDispatcher])
            ->getMock();
        $this->subject->method('getResourceFactoryInstance')->willReturn($resourceFactory);
        $this->subject->method('getIndexer')->willReturn($this->createMock(Indexer::class));
        if ($mockPermissionChecks) {
            foreach ($permissionMethods as $method) {
                $this->subject->method($method)->willReturn(true);
            }
        }
    }
 
    protected function ‪convertConfigurationArrayToFlexformXml(array $configuration): string
    {
        $flexFormArray = ['data' => ['sDEF' => ['lDEF' => []]]];
        foreach ($configuration as $key => $value) {
            $flexFormArray['data']['sDEF']['lDEF'][$key] = ['vDEF' => $value];
        }
        $configuration = GeneralUtility::array2xml($flexFormArray);
        return $configuration;
    }
 
    protected function ‪createDriverMock(
        array $driverConfiguration,
        ResourceStorage $storageObject = null,
        array $mockedDriverMethods = []
    ) {
        $this->‪initializeVfs();
 
        if (!isset($driverConfiguration['basePath'])) {
            $driverConfiguration['basePath'] = $this->‪getMountRootUrl();
        }
 
        // We are using the LocalDriver here because PHPUnit can't mock concrete methods in abstract classes, so
        // when using the AbstractDriver we would be in trouble when wanting to mock away some concrete method
        $driver = $this->getMockBuilder(LocalDriver::class)
            ->onlyMethods($mockedDriverMethods)
            ->setConstructorArgs([$driverConfiguration])
            ->getMock();
        if ($storageObject instanceof ResourceStorage) {
            $storageObject->setDriver($driver);
        }
        $driver->setStorageUid(6);
        $driver->processConfiguration();
        $driver->initialize();
        return $driver;
    }
 
    public function ‪capabilitiesDataProvider(): array
    {
        return [
            'only public' => [
                [
                    'public' => true,
                    'writable' => false,
                    'browsable' => false,
                ],
            ],
            'only writable' => [
                [
                    'public' => false,
                    'writable' => true,
                    'browsable' => false,
                ],
            ],
            'only browsable' => [
                [
                    'public' => false,
                    'writable' => false,
                    'browsable' => true,
                ],
            ],
            'all capabilities' => [
                [
                    'public' => true,
                    'writable' => true,
                    'browsable' => true,
                ],
            ],
            'none' => [
                [
                    'public' => false,
                    'writable' => false,
                    'browsable' => false,
                ],
            ],
        ];
    }
 
    public function ‪addFileFailsIfFileDoesNotExist(): void
    {
        $mockedFolder = $this->createMock(Folder::class);
        $this->expectException(\InvalidArgumentException::class);
        $this->expectExceptionCode(1319552745);
        $this->‪prepareSubject([]);
        $this->subject->addFile('/some/random/file', $mockedFolder);
    }
 
    public function ‪getPublicUrlReturnsNullIfStorageIsNotOnline(): void
    {
        $driver = $this->getMockBuilder(LocalDriver::class)
            ->setConstructorArgs([['basePath' => $this->‪getMountRootUrl()]])
            ->getMock();
        $mockedResourceFactory = $this->createMock(ResourceFactory::class);
        ‪$subject = $this->getMockBuilder(ResourceStorage::class)
            ->onlyMethods(['isOnline', 'getResourceFactoryInstance'])
            ->setConstructorArgs([$driver, ['configuration' => []], $this->eventDispatcher])
            ->getMock();
        ‪$subject->expects(self::once())->method('isOnline')->willReturn(false);
        ‪$subject->method('getResourceFactoryInstance')->willReturn($mockedResourceFactory);
 
        $sourceFileIdentifier = '/sourceFile.ext';
        $sourceFile = $this->‪getSimpleFileMock($sourceFileIdentifier);
        $result = ‪$subject->‪getPublicUrl($sourceFile);
        self::assertNull($result);
    }
 
    public function ‪checkFolderPermissionsFilesystemPermissionsDataProvider(): array
    {
        return [
            'read action on readable/writable folder' => [
                'read',
                ['r' => true, 'w' => true],
                true,
            ],
            'read action on unreadable folder' => [
                'read',
                ['r' => false, 'w' => true],
                false,
            ],
            'write action on read-only folder' => [
                'write',
                ['r' => true, 'w' => false],
                false,
            ],
        ];
    }
 
    public function ‪checkFolderPermissionsRespectsFilesystemPermissions(
        string $action,
        array $permissionsFromDriver,
        bool $expectedResult
    ): void {
        $mockedDriver = $this->createMock(LocalDriver::class);
        $mockedDriver->method('getPermissions')->willReturn($permissionsFromDriver);
        $mockedResourceFactory = $this->createMock(ResourceFactory::class);
        $mockedFolder = $this->createMock(Folder::class);
        // Let all other checks pass
        ‪$subject = $this->getMockBuilder(ResourceStorage::class)
            ->onlyMethods(['isWritable', 'isBrowsable', 'checkUserActionPermission', 'getResourceFactoryInstance'])
            ->setConstructorArgs([$mockedDriver, [], $this->eventDispatcher])
            ->getMock();
        ‪$subject->method('isWritable')->willReturn(true);
        ‪$subject->method('isBrowsable')->willReturn(true);
        ‪$subject->method('checkUserActionPermission')->willReturn(true);
        ‪$subject->method('getResourceFactoryInstance')->willReturn($mockedResourceFactory);
        ‪$subject->‪setDriver($mockedDriver);
 
        self::assertSame($expectedResult, ‪$subject->‪checkFolderActionPermission($action, $mockedFolder));
    }
 
    public function ‪checkUserActionPermissionsAlwaysReturnsTrueIfNoUserPermissionsAreSet(): void
    {
        $this->‪prepareSubject([]);
        self::assertTrue($this->subject->checkUserActionPermission('read', 'folder'));
    }
 
    public function ‪checkUserActionPermissionReturnsFalseIfPermissionIsSetToZero(): void
    {
        $this->‪prepareSubject([]);
        $this->subject->setUserPermissions(['readFolder' => true, 'writeFile' => true]);
        self::assertTrue($this->subject->checkUserActionPermission('read', 'folder'));
    }
 
    public function ‪checkUserActionPermission_arbitraryPermissionDataProvider(): array
    {
        return [
            'all lower cased' => [
                ['readFolder' => true],
                'read',
                'folder',
            ],
            'all upper case' => [
                ['readFolder' => true],
                'READ',
                'FOLDER',
            ],
            'mixed case' => [
                ['readFolder' => true],
                'ReaD',
                'FoLdEr',
            ],
        ];
    }
 
    public function ‪checkUserActionPermissionAcceptsArbitrarilyCasedArguments(array $permissions, string $action, string $type): void
    {
        $this->‪prepareSubject([]);
        $this->subject->setUserPermissions($permissions);
        self::assertTrue($this->subject->checkUserActionPermission($action, $type));
    }
 
    public function ‪userActionIsDisallowedIfPermissionIsSetToFalse(): void
    {
        $this->‪prepareSubject([]);
        $this->subject->setEvaluatePermissions(true);
        $this->subject->setUserPermissions(['readFolder' => false]);
        self::assertFalse($this->subject->checkUserActionPermission('read', 'folder'));
    }
 
    public function ‪userActionIsDisallowedIfPermissionIsNotSet(): void
    {
        $this->‪prepareSubject([]);
        $this->subject->setEvaluatePermissions(true);
        $this->subject->setUserPermissions(['readFolder' => true]);
        self::assertFalse($this->subject->checkUserActionPermission('write', 'folder'));
    }
 
    public function ‪metaDataEditIsNotAllowedWhenWhenNoFileMountsAreSet(): void
    {
        $this->‪prepareSubject([], false, null, null, [], ['isWithinProcessingFolder']);
        $this->subject->setEvaluatePermissions(true);
        self::assertFalse($this->subject->checkFileActionPermission('editMeta', new ‪File(['identifier' => '/foo/bar.jpg'], $this->subject)));
    }
 
    public function ‪metaDataEditIsAllowedWhenWhenInFileMount(): void
    {
        $driverMock = $this->getMockForAbstractClass(AbstractDriver::class, [], '', false);
        $resourceFactory = $this->prophesize(ResourceFactory::class);
        $this->‪prepareSubject([], false, $driverMock, $resourceFactory->reveal(), [], ['isWithinProcessingFolder']);
 
        $folderStub = new ‪Folder($this->subject, '/foo/', 'foo');
        $resourceFactory->createFolderObject(Argument::cetera())->willReturn($folderStub);
        $fileStub = new ‪File(['identifier' => '/foo/bar.jpg', 'name' => 'bar.jpg'], $this->subject);
        $driverMock->expects(self::once())
            ->method('isWithin')
            ->with($folderStub->getIdentifier(), $fileStub->getIdentifier())
            ->willReturn(true);
        $driverMock->expects(self::once())
            ->method('getFolderInfoByIdentifier')
            ->with($folderStub->getIdentifier())
            ->willReturn(['identifier' => $folderStub->getIdentifier(), 'name' => $folderStub->getName()]);
 
        $this->subject->setEvaluatePermissions(true);
        $this->subject->addFileMount('/foo/', [
            'path' => '/foo/',
            'title' => 'Foo',
            'folder' => $folderStub,
        ]);
        self::assertTrue($this->subject->checkFileActionPermission('editMeta', $fileStub));
    }
 
    public function ‪metaDataEditIsNotAllowedWhenWhenInReadOnlyFileMount(): void
    {
        $driverMock = $this->getMockForAbstractClass(AbstractDriver::class, [], '', false);
        $resourceFactory = $this->prophesize(ResourceFactory::class);
        $this->‪prepareSubject([], false, $driverMock, $resourceFactory->reveal(), [], ['isWithinProcessingFolder']);
 
        $fileStub = new ‪File(['identifier' => '/foo/bar.jpg', 'name' => 'bar.jpg'], $this->subject);
        $folderStub = new ‪Folder($this->subject, '/foo/', 'foo');
        $resourceFactory->createFolderObject(Argument::cetera())->willReturn($folderStub);
        $driverMock->expects(self::once())
            ->method('isWithin')
            ->with($folderStub->getIdentifier(), $fileStub->getIdentifier())
            ->willReturn(true);
        $driverMock->expects(self::once())
            ->method('getFolderInfoByIdentifier')
            ->with($folderStub->getIdentifier())
            ->willReturn(['identifier' => $folderStub->getIdentifier(), 'name' => $folderStub->getName()]);
 
        $this->subject->setEvaluatePermissions(true);
        $this->subject->addFileMount('/foo/', [
            'path' => '/foo/',
            'title' => 'Foo',
            'folder' => $folderStub,
            'read_only' => true,
        ]);
        self::assertFalse($this->subject->checkFileActionPermission('editMeta', $fileStub));
    }
 
    public function ‪getEvaluatePermissionsWhenSetFalse(): void
    {
        $this->‪prepareSubject([]);
        $this->subject->setEvaluatePermissions(false);
        self::assertFalse($this->subject->getEvaluatePermissions());
    }
 
    public function ‪getEvaluatePermissionsWhenSetTrue(): void
    {
        $this->‪prepareSubject([]);
        $this->subject->setEvaluatePermissions(true);
        self::assertTrue($this->subject->getEvaluatePermissions());
    }
 
    public function ‪deleteFolderThrowsExceptionIfFolderIsNotEmptyAndRecursiveDeleteIsDisabled(): void
    {
        $this->expectException(\RuntimeException::class);
        $this->expectExceptionCode(1325952534);
 
        $folderMock = $this->createMock(Folder::class);
        $mockedDriver = $this->getMockForAbstractClass(AbstractDriver::class);
        $mockedDriver->expects(self::once())->method('isFolderEmpty')->willReturn(false);
 
        ‪$subject = $this->getAccessibleMock(ResourceStorage::class, ['checkFolderActionPermission'], [], '', false);
        ‪$subject->method('checkFolderActionPermission')->willReturn(true);
        ‪$subject->_set('driver', $mockedDriver);
        ‪$subject->‪deleteFolder($folderMock, false);
    }
 
    public function ‪createFolderThrowsExceptionIfParentFolderDoesNotExist(): void
    {
        $this->expectException(\InvalidArgumentException::class);
        $this->expectExceptionCode(1325689164);
        $mockedParentFolder = $this->‪getSimpleFolderMock('/someFolder/');
        $this->‪prepareSubject([], true);
        $mockedDriver = $this->‪createDriverMock([], $this->subject, ['folderExists']);
        $mockedDriver->expects(self::once())->method('folderExists')->with(self::equalTo('/someFolder/'))->willReturn(false);
        $this->subject->createFolder('newFolder', $mockedParentFolder);
    }
 
    public function ‪renameFileRenamesFileAsRequested(): void
    {
        $mockedDriver = $this->‪createDriverMock([], $this->subject, ['renameFile']);
        $mockedDriver->expects(self::once())->method('renameFile')->willReturn('bar');
        $this->‪prepareSubject([], true, $mockedDriver, null);
        $file = new ‪File(['identifier' => 'foo', 'name' => 'foo'], $this->subject);
        $result = $this->subject->renameFile($file, 'bar');
        // fake what the indexer does in updateIndexEntry
        $result->updateProperties(['name' => $result->getIdentifier()]);
        self::assertSame('bar', $result->getName());
    }
 
    public function ‪renameFileRenamesWithUniqueNameIfConflictAndConflictModeIsRename(): void
    {
        $mockedDriver = $this->‪createDriverMock([], $this->subject, ['renameFile', 'sanitizeFileName']);
        $mockedDriver->method('renameFile')->will(self::onConsecutiveCalls(self::throwException(new ‪ExistingTargetFileNameException(
            'foo',
            1489593090
        )), 'bar_01'));
        $mockedDriver->method('sanitizeFileName')->will(self::onConsecutiveCalls(
            'bar',
            'bar_01'
        ));
        $this->‪prepareSubject(
            [],
            true,
            $mockedDriver,
            null,
            [],
            ['getUniqueName', 'createFolderObject']
        );
        $this->subject->expects(self::once())->method('createFolderObject')->willReturn(new ‪Folder($this->subject, '', ''));
        $file = new ‪File(['identifier' => 'foo', 'name' => 'foo'], $this->subject);
        $this->subject->method('getUniqueName')->willReturn('bar_01');
        $result = $this->subject->renameFile($file, 'bar');
        // fake what the indexer does in updateIndexEntry
        $result->updateProperties(['name' => $result->getIdentifier()]);
        self::assertSame('bar_01', $result->getName());
    }
 
    public function ‪renameFileThrowsExceptionIfConflictAndConflictModeIsCancel(): void
    {
        $mockedDriver = $this->‪createDriverMock([], $this->subject, ['renameFile']);
        $mockedDriver->expects(self::once())->method('renameFile')->will(self::throwException(new ‪ExistingTargetFileNameException(
            'foo',
            1489593099
        )));
        $this->‪prepareSubject([], true, $mockedDriver);
        $file = new ‪File(['identifier' => 'foo', 'name' => 'foo'], $this->subject);
        $this->expectException(ExistingTargetFileNameException::class);
        $this->subject->renameFile($file, 'bar', ‪DuplicationBehavior::CANCEL);
    }
 
    public function ‪renameFileReplacesIfConflictAndConflictModeIsReplace(): void
    {
        $mockedDriver = $this->‪createDriverMock([], $this->subject, ['renameFile', 'sanitizeFileName']);
        $mockedDriver->expects(self::once())->method('renameFile')->will(self::throwException(new ‪ExistingTargetFileNameException(
            'foo',
            1489593098
        )));
        $mockedDriver->method('sanitizeFileName')->willReturn('bar');
        $resourceFactory = $this->prophesize(ResourceFactory::class);
        $this->‪prepareSubject([], true, $mockedDriver, $resourceFactory->reveal(), [], [
            'replaceFile',
            'getPublicUrl',
        ]);
        $this->subject->expects(self::once())->method('getPublicUrl')->willReturn('somePath');
        $file = $this->prophesize(FileInterface::class);
        $resourceFactory->getFileObjectFromCombinedIdentifier(Argument::any())->willReturn($file->reveal());
        $this->subject->expects(self::once())->method('replaceFile')->willReturn($file->reveal());
        $file = new ‪File(['identifier' => 'foo', 'name' => 'foo', 'missing' => false], $this->subject);
        $this->subject->renameFile($file, 'bar', ‪DuplicationBehavior::REPLACE);
    }
}