TYPO3 Core

<?php

/***************************************************************

* Copyright notice

*

* (c) 2010 Christian Kuhn <lolli@schwarzbu.ch>

* All rights reserved

*

* This script is part of the TYPO3 project. The TYPO3 project is

* free software; you can redistribute it and/or modify

* it under the terms of the GNU General Public License as published by

* the Free Software Foundation; either version 2 of the License, or

* (at your option) any later version.

*

* The GNU General Public License can be found at

* http://www.gnu.org/copyleft/gpl.html.

*

* This script is distributed in the hope that it will be useful,

* but WITHOUT ANY WARRANTY; without even the implied warranty of

* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the

* GNU General Public License for more details.

*

* This copyright notice MUST APPEAR in all copies of the script!

***************************************************************/

/**

* Testcase for the PHP source code cache frontend

*

* This file is a backport from FLOW3

*

* @author Christian Kuhn <lolli@schwarzbu.ch>

* @package TYPO3

* @subpackage tests

* @version $Id$

*/

class t3lib_cache_frontend_PhpFrontendTestCase extends tx_phpunit_testcase {

/**

* @test

* @author Robert Lemke <robert@typo3.org>

* @expectedException InvalidArgumentException

*/

public function setChecksIfTheIdentifierIsValid() {

$cache = $this->getMock('t3lib_cache_frontend_StringFrontend', array('isValidEntryIdentifier'), array(), '', FALSE);

$cache->expects($this->once())->method('isValidEntryIdentifier')->with('foo')->will($this->returnValue(FALSE));

$cache->set('foo', 'bar');

}

/**

* @test

* @author Robert Lemke <robert@typo3.org>

*/

public function setPassesPhpSourceCodeTagsAndLifetimeToBackend() {

$originalSourceCode = 'return "hello world!";';

$modifiedSourceCode = '<?php' . chr(10) . $originalSourceCode . chr(10) . '__halt_compiler();';

$mockBackend = $this->getMock('t3lib_cache_backend_PhpCapableBackend', array(), array(), '', FALSE);

$mockBackend->expects($this->once())->method('set')->with('Foo-Bar', $modifiedSourceCode, array('tags'), 1234);

$cache = t3lib_div::makeInstance('t3lib_cache_frontend_PhpFrontend', 'PhpFrontend', $mockBackend);

$cache->set('Foo-Bar', $originalSourceCode, array('tags'), 1234);

}

/**

* @test

* @author Robert Lemke <robert@typo3.org>

* @expectedException t3lib_cache_exception_InvalidData

*/

public function setThrowsInvalidDataExceptionOnNonStringValues() {

$cache = $this->getMock('t3lib_cache_frontend_PhpFrontend', array('dummy'), array(), '', FALSE);

$cache->set('Foo-Bar', array());

}

/**

* @test

* @author Robert Lemke <robert@typo3.org>

*/

public function requireOnceCallsTheBackendsRequireOnceMethod() {

$mockBackend = $this->getMock('t3lib_cache_backend_PhpCapableBackend', array(), array(), '', FALSE);

$mockBackend->expects($this->once())->method('requireOnce')->with('Foo-Bar')->will($this->returnValue('hello world!'));

$cache = t3lib_div::makeInstance('t3lib_cache_frontend_PhpFrontend', 'PhpFrontend', $mockBackend);

$result = $cache->requireOnce('Foo-Bar');

$this->assertSame('hello world!', $result);

}

}

?>

* (c) 2009-2010 Ingo Renner <ingo@typo3.org>

* @author Ingo Renner <ingo@typo3.org>

* @author Christian Kuhn <lolli@schwarzbu.ch>

/**

* Backup of global variable EXEC_TIME

*

* @var array

*/

protected $backupGlobalVariables;

/**

* @var string Directory for testing data, relative to PATH_site

*/

$this->backupGlobalVariables = array(

'EXEC_TIME' => $GLOBALS['EXEC_TIME'],

);

public function getCacheDirectoryReturnsTheCurrentCacheDirectory() {

$mockCache = $this->getMock('t3lib_cache_frontend_AbstractFrontend', array(), array(), '', FALSE);

$mockCache->expects($this->atLeastOnce())->method('getIdentifier')->will($this->returnValue('UnitTestCache'));

$this->backend->setCache($mockCache);

$mockCache = $this->getMock('t3lib_cache_frontend_AbstractFrontend', array(), array(), '', FALSE);

$mockCache->expects($this->atLeastOnce())->method('getIdentifier')->will($this->returnValue('UnitTestCache'));

$this->backend->setCache($mockCache);

$pathAndFilename = $this->backend->getCacheDirectory() . $entryIdentifier;

$this->backend->set($entryIdentifier, $data, array(), 10);

$this->assertFileExists($pathAndFilename);

$retrievedData = file_get_contents($pathAndFilename, NULL, NULL, 0, strlen($data));

$this->assertEquals($data, $retrievedData);

$mockCache = $this->getMock('t3lib_cache_frontend_AbstractFrontend', array(), array(), '', FALSE);

$mockCache->expects($this->atLeastOnce())->method('getIdentifier')->will($this->returnValue('UnitTestCache'));

$this->backend->setCache($mockCache);

// Setting a second entry with the same identifier, but different

$pathAndFilename = $this->backend->getCacheDirectory() . $entryIdentifier;

$this->assertFileExists($pathAndFilename);

$retrievedData = file_get_contents($pathAndFilename, NULL, NULL, 0, strlen($data2));

public function setAlsoSavesSpecifiedTags() {

$mockCache = $this->getMock('t3lib_cache_frontend_AbstractFrontend', array(), array(), '', FALSE);

$mockCache->expects($this->atLeastOnce())->method('getIdentifier')->will($this->returnValue('UnitTestCache'));

$this->backend->setCache($mockCache);

$this->backend->set($entryIdentifier, $data, array('Tag1', 'Tag2'));

$pathAndFilename = $this->backend->getCacheDirectory() . $entryIdentifier;

$this->assertFileExists($pathAndFilename);

$retrievedData = file_get_contents($pathAndFilename, NULL, NULL, (strlen($data) + t3lib_cache_backend_FileBackend::EXPIRYTIME_LENGTH), 9);

$this->assertEquals('Tag1 Tag2', $retrievedData);

* @author Karsten Dambekalns <karsten@typo3.org>

public function setWithUnlimitedLifetimeWritesCorrectEntry() {

$mockCache = $this->getMock('t3lib_cache_frontend_AbstractFrontend', array(), array(), '', FALSE);

$mockCache->expects($this->atLeastOnce())->method('getIdentifier')->will($this->returnValue('UnitTestCache'));

$data = 'some data' . microtime();

$this->backend->setCache($mockCache);

$pathAndFilename = $this->backend->getCacheDirectory() . $entryIdentifier;

$this->backend->set($entryIdentifier, $data, array(), 0);

$this->assertFileExists($pathAndFilename);

$dataSize = (integer)file_get_contents($pathAndFilename, NULL, NULL, filesize($pathAndFilename) - t3lib_cache_backend_FileBackend::DATASIZE_DIGITS, t3lib_cache_backend_FileBackend::DATASIZE_DIGITS);

$retrievedData = file_get_contents($pathAndFilename, NULL, NULL, 0, $dataSize);

$this->assertEquals($data, $retrievedData, 'The original and the retrieved data don\'t match.');

*/

public function getReturnsFalseForExpiredEntries() {

$mockCache = $this->getMock('t3lib_cache_frontend_AbstractFrontend', array(), array(), '', FALSE);

$mockCache->expects($this->atLeastOnce())->method('getIdentifier')->will($this->returnValue('UnitTestCache'));

$backend = $this->getMock('t3lib_cache_backend_FileBackend', array('isCacheFileExpired'), array(), '', FALSE);

$fullPathToCacheFile = t3lib_div::getIndpEnv('TYPO3_DOCUMENT_ROOT') . '/typo3temp/cache/UnitTestCache/ExpiredEntry';

$backend->expects($this->once())->method('isCacheFileExpired')->with($fullPathToCacheFile)->will($this->returnValue(TRUE));

$backend->setCache($mockCache);

$this->assertFalse($backend->get('ExpiredEntry'));

}

/**

* @test

* @author Robert Lemke <robert@typo3.org>

public function hasReturnsTrueIfAnEntryExists() {

$mockCache = $this->getMock('t3lib_cache_frontend_AbstractFrontend', array(), array(), '', FALSE);

$mockCache->expects($this->atLeastOnce())->method('getIdentifier')->will($this->returnValue('UnitTestCache'));

$this->backend->setCache($mockCache);

*/

public function hasReturnsFalseForExpiredEntries() {

$backend = $this->getMock('t3lib_cache_backend_FileBackend', array('isCacheFileExpired'), array(), '', FALSE);

$backend->expects($this->exactly(2))->method('isCacheFileExpired')->will($this->onConsecutiveCalls(TRUE, FALSE));

$this->assertFalse($backend->has('foo'));

$this->assertTrue($backend->has('bar'));

}

/**

* @test

* @author Robert Lemke <robert@typo3.org>

$mockCache = $this->getMock('t3lib_cache_frontend_AbstractFrontend', array(), array(), '', FALSE);

$mockCache->expects($this->atLeastOnce())->method('getIdentifier')->will($this->returnValue('UnitTestCache'));

$entryIdentifier = 'BackendFileTest';

$this->backend->setCache($mockCache);

$pathAndFilename = $this->backend->getCacheDirectory() . $entryIdentifier;

$this->assertFileExists($pathAndFilename);

$this->assertFileNotExists($pathAndFilename);

$mockCache = $this->getMock('t3lib_cache_frontend_AbstractFrontend', array(), array(), '', FALSE);

$mockCache->expects($this->atLeastOnce())->method('getIdentifier')->will($this->returnValue('UnitTestCache'));

$this->backend->setCache($mockCache);

$pathAndFilename = $this->backend->getCacheDirectory() . $entryIdentifier;

$this->assertFileExists($pathAndFilename);

$GLOBALS['EXEC_TIME'] += 2;

$this->assertFileNotExists($pathAndFilename);

$mockCache = $this->getMock('t3lib_cache_frontend_AbstractFrontend', array(), array(), '', FALSE);

$mockCache->expects($this->atLeastOnce())->method('getIdentifier')->will($this->returnValue('UnitTestCache'));

$this->backend->setCache($mockCache);

$pathAndFilename = $this->backend->getCacheDirectory() . $entryIdentifier;

$this->backend->set($entryIdentifier . 'A', $data, array(), NULL);

$this->backend->set($entryIdentifier . 'B', $data, array(), 10);

$this->backend->set($entryIdentifier . 'D', $data, array(), 1);

$this->assertFileExists($pathAndFilename . 'A');

$this->assertFileExists($pathAndFilename . 'B');

$this->assertFileExists($pathAndFilename . 'C');

$this->assertFileExists($pathAndFilename . 'D');

$GLOBALS['EXEC_TIME'] += 2;

$this->assertFileExists($pathAndFilename . 'A');

$this->assertFileExists($pathAndFilename . 'B');

$this->assertFileNotExists($pathAndFilename . 'C');

$this->assertFileNotExists($pathAndFilename . 'D');

public function findIdentifiersByTagFindsCacheEntriesWithSpecifiedTag() {

$mockCache = $this->getMock('t3lib_cache_frontend_AbstractFrontend', array(), array(), '', FALSE);

$mockCache->expects($this->atLeastOnce())->method('getIdentifier')->will($this->returnValue('UnitTestCache'));

$this->backend->setCache($mockCache);

$this->backend->set('BackendFileTest1', $data, array('UnitTestTag%test', 'UnitTestTag%boring'));

$this->backend->set('BackendFileTest2', $data, array('UnitTestTag%test', 'UnitTestTag%special'));

$this->backend->set('BackendFileTest3', $data, array('UnitTestTag%test'));

$expectedEntry = 'BackendFileTest2';

$actualEntries = $this->backend->findIdentifiersByTag('UnitTestTag%special');

$this->assertTrue(is_array($actualEntries), 'actualEntries is not an array.');

$this->assertEquals($expectedEntry, array_pop($actualEntries));

public function findIdentifiersByTagDoesNotReturnExpiredEntries() {

$mockCache = $this->getMock('t3lib_cache_frontend_AbstractFrontend', array(), array(), '', FALSE);

$mockCache->expects($this->atLeastOnce())->method('getIdentifier')->will($this->returnValue('UnitTestCache'));

$this->backend->setCache($mockCache);

$data = 'some data';

$this->backend->set('BackendFileTest2', $data, array('UnitTestTag%test', 'UnitTestTag%special'), -100);

$this->assertSame(array(), $this->backend->findIdentifiersByTag('UnitTestTag%special'));

$foundIdentifiers = $this->backend->findIdentifiersByTag('UnitTestTag%test');

sort($foundIdentifiers);

$this->assertSame(array('BackendFileTest1', 'BackendFileTest3'), $foundIdentifiers);

public function flushRemovesAllCacheEntries() {

$mockCache = $this->getMock('t3lib_cache_frontend_AbstractFrontend', array(), array(), '', FALSE);

$mockCache->expects($this->atLeastOnce())->method('getIdentifier')->will($this->returnValue('UnitTestCache'));

$this->backend->setCache($mockCache);

$pattern = $this->backend->getCacheDirectory() . '*';

$mockCache = $this->getMock('t3lib_cache_frontend_AbstractFrontend', array(), array(), '', FALSE);

$mockCache->expects($this->atLeastOnce())->method('getIdentifier')->will($this->returnValue('UnitTestCache'));

$this->backend->setCache($mockCache);

t3lib_div::rmdir($directory, TRUE);

foreach ($this->backupGlobalVariables as $key => $data) {

$GLOBALS[$key] = $data;

}

?>

<?php

/***************************************************************

* Copyright notice

*

* (c) 2010 Christian Kuhn <lolli@schwarzbu.ch>

* All rights reserved

*

* This script is part of the TYPO3 project. The TYPO3 project is

* free software; you can redistribute it and/or modify

* it under the terms of the GNU General Public License as published by

* the Free Software Foundation; either version 2 of the License, or

* (at your option) any later version.

*

* The GNU General Public License can be found at

* http://www.gnu.org/copyleft/gpl.html.

*

* This script is distributed in the hope that it will be useful,

* but WITHOUT ANY WARRANTY; without even the implied warranty of

* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the

* GNU General Public License for more details.

*

* This copyright notice MUST APPEAR in all copies of the script!

***************************************************************/

/**

* A cache frontend tailored to PHP code.

*

* This file is a backport from FLOW3

*

* @package TYPO3

* @subpackage t3lib_cache

* @api

* @scope prototype

* @version $Id$

*/

class t3lib_cache_frontend_PhpFrontend extends t3lib_cache_frontend_StringFrontend {

/**

* Constructs the cache

*

* @param string $identifier A identifier which describes this cache

* @param t3lib_cache_backend_PhpCapableBackend $backend Backend to be used for this cache

* @author Robert Lemke <robert@typo3.org>

*/

public function __construct($identifier, t3lib_cache_backend_PhpCapableBackend $backend) {

parent::__construct($identifier, $backend);

}

/**

* Saves the PHP source code in the cache.

*

* @param string $entryIdentifier An identifier used for this cache entry, for example the class name

* @param string $sourceCode PHP source code

* @param array $tags Tags to associate with this cache entry

* @param integer $lifetime Lifetime of this cache entry in seconds. If NULL is specified, the default lifetime is used. "0" means unlimited liftime.

* @return void

* @author Robert Lemke <robert@typo3.org>

* @api

*/

public function set($entryIdentifier, $sourceCode, $tags = array(), $lifetime = NULL) {

if (!$this->isValidEntryIdentifier($entryIdentifier)) {

throw new InvalidArgumentException(

'"' . $entryIdentifier . '" is not a valid cache entry identifier.',

1264023823

);

}

if (!is_string($sourceCode)) {

throw new t3lib_cache_exception_InvalidData(

'The given source code is not a valid string.',

1264023824

);

}

foreach ($tags as $tag) {

if (!$this->isValidTag($tag)) {

throw new InvalidArgumentException(

'"' . $tag . '" is not a valid tag for a cache entry.',

1264023825

);

}

}

$sourceCode = '<?php' . chr(10) . $sourceCode . chr(10) . '__halt_compiler();';

$this->backend->set($entryIdentifier, $sourceCode, $tags, $lifetime);

}

/**

* Loads PHP code from the cache and require_onces it right away.

*

* @param string $entryIdentifier An identifier which describes the cache entry to load

* @return mixed Potential return value from the include operation

* @author Robert Lemke <robert@typo3.org>

* @api

*/

public function requireOnce($entryIdentifier) {

return $this->backend->requireOnce($entryIdentifier);

}

}

if (defined('TYPO3_MODE') && $GLOBALS['TYPO3_CONF_VARS'][TYPO3_MODE]['XCLASS']['t3lib/cache/class.t3lib_cache_frontend_phpfrontend.php']) {

include_once($GLOBALS['TYPO3_CONF_VARS'][TYPO3_MODE]['XCLASS']['t3lib/cache/class.t3lib_cache_frontend_phpfrontend.php']);

}

?>

<?php

/***************************************************************

* Copyright notice

*

* (c) 2010 Christian Kuhn <lolli@schwarzbu.ch>

* All rights reserved

*

* This script is part of the TYPO3 project. The TYPO3 project is

* free software; you can redistribute it and/or modify

* it under the terms of the GNU General Public License as published by

* the Free Software Foundation; either version 2 of the License, or

* (at your option) any later version.

*

* The GNU General Public License can be found at

* http://www.gnu.org/copyleft/gpl.html.

* A copy is found in the textfile GPL.txt and important notices to the license

* from the author is found in LICENSE.txt distributed with these scripts.

*

*

* This script is distributed in the hope that it will be useful,

* but WITHOUT ANY WARRANTY; without even the implied warranty of

* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the

* GNU General Public License for more details.

*

* This copyright notice MUST APPEAR in all copies of the script!

***************************************************************/

/**

* A contract for a cache backend which is capable of storing, retrieving and

* including PHP source code.

*

* @version $Id$

* @api

* @author Robert Lemke <robert@typo3.org>

*/

interface t3lib_cache_backend_PhpCapableBackend extends t3lib_cache_backend_Backend {

/**

* Loads PHP code from the cache and require_onces it right away.

*

* @param string $entryIdentifier An identifier which describes the cache entry to load

* @return mixed Potential return value from the include operation

* @api

*/

public function requireOnce($entryIdentifier);

}

?>

class t3lib_cache_backend_FileBackend extends t3lib_cache_backend_AbstractBackend implements t3lib_cache_backend_PhpCapableBackend {

const DATASIZE_DIGITS = 10;

/**

* @var string Absolute path to root, usually document root of website

*/

if (is_null($this->maximumPathLength)) {

$this->maximumPathLength = t3lib_div::getMaximumPathLength();

}

}

/**

* Sets a reference to the cache frontend which uses this backend and

* initializes the default cache directory

*

* @void

* @author Robert Lemke <robert@typo3.org>

*/

public function setCache(t3lib_cache_frontend_frontend $cache) {

parent::setCache($cache);

$basedirs = explode($delimiter, $open_basedir);

// Absolute path to cache directory.

// After this point all paths have '/' as directory seperator

$cacheDirectory .= $this->cacheIdentifier;

if ($cacheDirectory[strlen($cacheDirectory) - 1] !== '/') {

$cacheDirectory .= '/';

}

* @api

* @param string $entryIdentifier An identifier for this specific cache entry

* @param string $data The data to be stored

* @param array $tags Tags to associate with this cache entry

* @param integer $lifetime Lifetime of this cache entry in seconds. If NULL is specified, the default lifetime is used. "0" means unlimited lifetime.

* @api

$temporaryCacheEntryPathAndFilename = $this->root . $this->cacheDirectory . uniqid() . '.temp';

if (strlen($temporaryCacheEntryPathAndFilename) > $this->maximumPathLength) {

'The length of the temporary cache file path "' . $temporaryCacheEntryPathAndFilename .

'" is ' . strlen($temporaryCacheEntryPathAndFilename) . ' characters long and exceeds the maximum path length of ' .

$expiryTime = ($lifetime === NULL) ? 0 : ($GLOBALS['EXEC_TIME'] + $lifetime);

$metaData = str_pad($expiryTime, self::EXPIRYTIME_LENGTH) . implode(' ', $tags) . str_pad(strlen($data), self::DATASIZE_DIGITS);

$result = file_put_contents($temporaryCacheEntryPathAndFilename, $data . $metaData);

throw new t3lib_cache_exception(

'The temporary cache file "' . $temporaryCacheEntryPathAndFilename . '" could not be written.',

$i = 0;

$cacheEntryPathAndFilename = $this->root . $this->cacheDirectory . $entryIdentifier;

// @TODO: Figure out why the heck this is done and maybe find a smarter solution, report to FLOW3

while (!rename($temporaryCacheEntryPathAndFilename, $cacheEntryPathAndFilename) && $i < 5) {

$i++;

// @FIXME: At least the result of rename() should be handled here, report to FLOW3

throw new t3lib_cache_exception(

'The cache file "' . $cacheEntryPathAndFilename . '" could not be written.',

* @param string $entryIdentifier An identifier which describes the cache entry to load

* @api

$pathAndFilename = $this->root . $this->cacheDirectory . $entryIdentifier;

if ($this->isCacheFileExpired($pathAndFilename)) {

return FALSE;

}

$dataSize = (integer)file_get_contents($pathAndFilename, NULL, NULL, filesize($pathAndFilename) - self::DATASIZE_DIGITS, self::DATASIZE_DIGITS);

return file_get_contents($pathAndFilename, NULL, NULL, 0, $dataSize);

* @param string $entryIdentifier Specifies the cache entry to remove

* @return boolean TRUE if (at least) an entry could be removed or FALSE if no entry was found

* @api

return !$this->isCacheFileExpired($this->root . $this->cacheDirectory . $entryIdentifier);

* @param string $entryIdentifier Specifies the cache entry to remove

* @api

$pathAndFilename = $this->root . $this->cacheDirectory . $entryIdentifier;

* @param string $searchedTag The tag to search for

* @api

public function findIdentifiersByTag($searchedTag) {

$entryIdentifiers = array();

$now = $GLOBALS['EXEC_TIME'];

for ($directoryIterator = t3lib_div::makeInstance('DirectoryIterator', $this->root . $this->cacheDirectory); $directoryIterator->valid(); $directoryIterator->next()) {

if ($directoryIterator->isDot()) {

continue;

}

$cacheEntryPathAndFilename = $directoryIterator->getPathname();

$index = (integer)file_get_contents($cacheEntryPathAndFilename, NULL, NULL, filesize($cacheEntryPathAndFilename) - self::DATASIZE_DIGITS, self::DATASIZE_DIGITS);

$metaData = file_get_contents($cacheEntryPathAndFilename, NULL, NULL, $index);

$expiryTime = (integer)substr($metaData, 0, self::EXPIRYTIME_LENGTH);

if ($expiryTime !== 0 && $expiryTime < $now) {

continue;

if (in_array($searchedTag, explode(' ', substr($metaData, self::EXPIRYTIME_LENGTH, -self::DATASIZE_DIGITS)))) {

$entryIdentifiers[] = $directoryIterator->getFilename();

}

return $entryIdentifiers;

* @param array $searchedTags Array of tags to search for

* @author Christian Kuhn <lolli@schwarzbu.ch>

* @api

public function findIdentifiersByTags(array $searchedTags) {

$entryIdentifiers = array();

for ($directoryIterator = t3lib_div::makeInstance('DirectoryIterator', $this->root . $this->cacheDirectory); $directoryIterator->valid(); $directoryIterator->next()) {

if ($directoryIterator->isDot()) {

continue;

}

$cacheEntryPathAndFilename = $directoryIterator->getPathname();

$index = (integer)file_get_contents($cacheEntryPathAndFilename, NULL, NULL, filesize($cacheEntryPathAndFilename) - self::DATASIZE_DIGITS, self::DATASIZE_DIGITS);

$metaData = file_get_contents($cacheEntryPathAndFilename, NULL, NULL, $index);