SimpleLockStrategyTest.php

Go to the documentation of this file.

<?php
namespace TYPO3\CMS\Core\Tests\Unit\Locking;

/*
 * 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!
 */

use TYPO3\CMS\Core\Locking\SimpleLockStrategy;
use TYPO3\CMS\Core\Tests\UnitTestCase;
use TYPO3\CMS\Core\Utility\GeneralUtility;

class SimpleLockStrategyTest extends UnitTestCase
{
    public function constructorCreatesLockDirectoryIfNotExisting()
    {
        GeneralUtility::rmdir(PATH_site . SimpleLockStrategy::FILE_LOCK_FOLDER, true);
        new SimpleLockStrategy('999999999');
        $this->assertTrue(is_dir(PATH_site . SimpleLockStrategy::FILE_LOCK_FOLDER));
    }

    public function constructorSetsResourceToPathWithIdIfUsingSimpleLocking()
    {
        $lock = $this->getAccessibleMock(SimpleLockStrategy::class, ['dummy'], ['999999999']);
        $this->assertSame(PATH_site . SimpleLockStrategy::FILE_LOCK_FOLDER . 'simple_' . md5('999999999'), $lock->_get('filePath'));
    }

    public function acquireFixesPermissionsOnLockFile()
    {
        if (TYPO3_OS === 'WIN') {
            $this->markTestSkipped('Test not available on Windows.');
        }
        // Use a very high id to be unique
        $lock = $this->getAccessibleMock(SimpleLockStrategy::class, ['dummy'], ['999999999']);

        $pathOfLockFile = $lock->_get('filePath');

        $GLOBALS['TYPO3_CONF_VARS']['SYS']['fileCreateMask'] = '0777';

        // Acquire lock, get actual file permissions and clean up
        $lock->acquire();
        clearstatcache();
        $resultFilePermissions = substr(decoct(fileperms($pathOfLockFile)), 2);
        $lock->release();
        $this->assertEquals($resultFilePermissions, '0777');
    }

    public function releaseRemovesLockfileInTypo3TempLocks()
    {
        $lock = $this->getAccessibleMock(SimpleLockStrategy::class, ['dummy'], ['999999999']);

        $pathOfLockFile = $lock->_get('filePath');

        $lock->acquire();
        $lock->release();

        $this->assertFalse(is_file($pathOfLockFile));
    }

    public function invalidFileReferences()
    {
        return [
            'not withing PATH_site' => ['/tmp/TYPO3-Lock-Test'],
            'directory traversal' => [PATH_site . 'typo3temp/../typo3temp/locks/foo'],
            'directory traversal 2' => [PATH_site . 'typo3temp/locks/../locks/foo'],
            'within uploads' => [PATH_site . 'uploads/TYPO3-Lock-Test']
        ];
    }

    public function releaseDoesNotRemoveFilesNotWithinTypo3TempLocksDirectory($file)
    {
        if (TYPO3_OS === 'WIN') {
            $this->markTestSkipped('releaseDoesNotRemoveFilesNotWithinTypo3TempLocksDirectory() test not available on Windows.');
        }
        // Create test file
        touch($file);
        if (!is_file($file)) {
            $this->markTestIncomplete('releaseDoesNotRemoveFilesNotWithinTypo3TempLocksDirectory() skipped: Test file could not be created');
        }
        // Create instance, set lock file to invalid path
        $lock = $this->getAccessibleMock(SimpleLockStrategy::class, ['dummy'], ['999999999']);
        $lock->_set('filePath', $file);
        $lock->_set('isAcquired', true);

        // Call release method
        $lock->release();
        // Check if file is still there and clean up
        $fileExists = is_file($file);
        if (is_file($file)) {
            unlink($file);
        }
        $this->assertTrue($fileExists);
    }
}