Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

Merge pull request #151 from FabioBatSilva/DCOM101

[DCOM-101] Implement FilesystemCache / PhpFileCache
  • Loading branch information...
commit 8df9cdf3b921a3b59bbba51d5ba9063509ef6a1a 2 parents f0b548a + d06d9d5
@guilhermeblanco guilhermeblanco authored
View
132 lib/Doctrine/Common/Cache/FileCache.php
@@ -0,0 +1,132 @@
+<?php
+
+/*
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+ * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+ * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+ * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+ * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+ * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+ * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ *
+ * This software consists of voluntary contributions made by many individuals
+ * and is licensed under the MIT license. For more information, see
+ * <http://www.doctrine-project.org>.
+ */
+
+namespace Doctrine\Common\Cache;
+
+/**
+ * Base file cache driver.
+ *
+ * @since 2.3
+ * @author Fabio B. Silva <fabio.bat.silva@gmail.com>
+ */
+abstract class FileCache extends CacheProvider
+{
+ /**
+ * @var string Cache directory.
+ */
+ protected $directory;
+
+ /**
+ * @var string Cache file extension.
+ */
+ protected $extension;
+
+ /**
+ * Constructor
+ *
+ * @param string $directory Cache directory.
+ * @param string $directory Cache file extension.
+ *
+ * @throws \InvalidArgumentException
+ */
+ public function __construct($directory, $extension = null)
+ {
+ if ( ! is_dir($directory) && ! @mkdir($directory, 0777, true)) {
+ throw new \InvalidArgumentException(sprintf(
+ 'The directory "%s" does not exist and could not be created.',
+ $directory
+ ));
+ }
+
+ if ( ! is_writable($directory)) {
+ throw new \InvalidArgumentException(sprintf(
+ 'The directory "%s" is not writable.',
+ $directory
+ ));
+ }
+
+ $this->directory = realpath($directory);
+ $this->extension = $extension ?: $this->extension;
+ }
+
+ /**
+ * Gets the cache directory.
+ *
+ * @return string
+ */
+ public function getDirectory()
+ {
+ return $this->directory;
+ }
+
+ /**
+ * Gets the cache file extension.
+ *
+ * @return string
+ */
+ public function getExtension()
+ {
+ return $this->extension;
+ }
+
+ /**
+ * @return string
+ */
+ protected function getFilename($id)
+ {
+ $path = implode(str_split(md5($id), 12), DIRECTORY_SEPARATOR);
+ $path = $this->directory . DIRECTORY_SEPARATOR . $path;
+
+ return $path . DIRECTORY_SEPARATOR . $id . $this->extension;
+ }
+
+ /**
+ * {@inheritdoc}
+ */
+ protected function doDelete($id)
+ {
+ return unlink($this->getFilename($id));
+ }
+
+ /**
+ * {@inheritdoc}
+ */
+ protected function doFlush()
+ {
+ $pattern = '/^.+\\' . $this->extension . '$/i';
+ $iterator = new \RecursiveDirectoryIterator($this->directory);
+ $iterator = new \RecursiveIteratorIterator($iterator);
+ $iterator = new \RegexIterator($iterator, $pattern);
+
+ foreach ($iterator as $name => $file) {
+ unlink($name);
+ }
+
+ return true;
+ }
+
+ /**
+ * {@inheritdoc}
+ */
+ protected function doGetStats()
+ {
+ return null;
+ }
+}
View
114 lib/Doctrine/Common/Cache/FilesystemCache.php
@@ -0,0 +1,114 @@
+<?php
+
+/*
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+ * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+ * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+ * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+ * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+ * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+ * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ *
+ * This software consists of voluntary contributions made by many individuals
+ * and is licensed under the MIT license. For more information, see
+ * <http://www.doctrine-project.org>.
+ */
+
+namespace Doctrine\Common\Cache;
+
+/**
+ * Filesystem cache driver.
+ *
+ * @since 2.3
+ * @author Fabio B. Silva <fabio.bat.silva@gmail.com>
+ */
+class FilesystemCache extends FileCache
+{
+ const EXTENSION = '.doctrinecache.data';
+
+ /**
+ * {@inheritdoc}
+ */
+ protected $extension = self::EXTENSION;
+
+ /**
+ * {@inheritdoc}
+ */
+ protected function doFetch($id)
+ {
+ $data = '';
+ $lifetime = -1;
+ $filename = $this->getFilename($id);
+
+ if ( ! file_exists($filename)) {
+ return false;
+ }
+
+ $resource = fopen($filename, "r");
+
+ if (false !== ($line = fgets($resource))) {
+ $lifetime = (integer) $line;
+ }
+
+ if ($lifetime !== 0 && $lifetime < time()) {
+ fclose($resource);
+
+ return false;
+ }
+
+ while (false !== ($line = fgets($resource))) {
+ $data .= $line;
+ }
+
+ fclose($resource);
+
+ return unserialize($data);
+ }
+
+ /**
+ * {@inheritdoc}
+ */
+ protected function doContains($id)
+ {
+ $lifetime = -1;
+ $filename = $this->getFilename($id);
+
+ if ( ! file_exists($filename)) {
+ return false;
+ }
+
+ $resource = fopen($filename, "r");
+
+ if (false !== ($line = fgets($resource))) {
+ $lifetime = (integer) $line;
+ }
+
+ fclose($resource);
+
+ return $lifetime === 0 || $lifetime > time();
+ }
+
+ /**
+ * {@inheritdoc}
+ */
+ protected function doSave($id, $data, $lifeTime = 0)
+ {
+ if ($lifeTime > 0) {
+ $lifeTime = time() + $lifeTime;
+ }
+
+ $data = serialize($data);
+ $filename = $this->getFilename($id);
+ $filepath = pathinfo($filename, PATHINFO_DIRNAME);
+
+ if ( ! is_dir($filepath)) {
+ mkdir($filepath, 0777, true);
+ }
+
+ return file_put_contents($filename, $lifeTime . PHP_EOL . $data);
+ }
+}
View
106 lib/Doctrine/Common/Cache/PhpFileCache.php
@@ -0,0 +1,106 @@
+<?php
+
+/*
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+ * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+ * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+ * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+ * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+ * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+ * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ *
+ * This software consists of voluntary contributions made by many individuals
+ * and is licensed under the MIT license. For more information, see
+ * <http://www.doctrine-project.org>.
+ */
+
+namespace Doctrine\Common\Cache;
+
+/**
+ * Php file cache driver.
+ *
+ * @since 2.3
+ * @author Fabio B. Silva <fabio.bat.silva@gmail.com>
+ */
+class PhpFileCache extends FileCache
+{
+ const EXTENSION = '.doctrinecache.php';
+
+ /**
+ * {@inheritdoc}
+ */
+ protected $extension = self::EXTENSION;
+
+ /**
+ * {@inheritdoc}
+ */
+ protected function doFetch($id)
+ {
+ $filename = $this->getFilename($id);
+
+ if ( ! file_exists($filename)) {
+ return false;
+ }
+
+ $value = include $filename;
+
+ if ($value['lifetime'] !== 0 && $value['lifetime'] < time()) {
+ return false;
+ }
+
+ return $value['data'];
+ }
+
+ /**
+ * {@inheritdoc}
+ */
+ protected function doContains($id)
+ {
+ $filename = $this->getFilename($id);
+
+ if ( ! file_exists($filename)) {
+ return false;
+ }
+
+ $value = include $filename;
+
+ return $value['lifetime'] === 0 || $value['lifetime'] > time();
+ }
+
+ /**
+ * {@inheritdoc}
+ */
+ protected function doSave($id, $data, $lifeTime = 0)
+ {
+ if ($lifeTime > 0) {
+ $lifeTime = time() + $lifeTime;
+ }
+
+ $filename = $this->getFilename($id);
+ $filepath = pathinfo($filename, PATHINFO_DIRNAME);
+ $serialize = is_object($data) && ! method_exists($data, '__set_state');
+
+ if ( ! is_dir($filepath)) {
+ mkdir($filepath, 0777, true);
+ }
+
+ $value = array(
+ 'lifetime' => $lifeTime,
+ 'data' => $data
+ );
+
+ if ($serialize) {
+ $value = serialize($value);
+ }
+
+ $value = var_export($value, true);
+ $code = $serialize ? "unserialize($value)" : $value;
+ $code = sprintf('<?php return %s;', $code);
+
+ return file_put_contents($filename, $code);
+ }
+}
View
8 tests/Doctrine/Tests/Common/Cache/ArrayCacheTest.php
@@ -10,4 +10,12 @@ protected function _getCacheDriver()
{
return new ArrayCache();
}
+
+ public function testGetStats()
+ {
+ $cache = $this->_getCacheDriver();
+ $stats = $cache->getStats();
+
+ $this->assertNull($stats);
+ }
}
View
5 tests/Doctrine/Tests/Common/Cache/CacheTest.php
@@ -69,14 +69,9 @@ public function testNamespace()
*/
public function testGetStats()
{
- if ($this instanceof ArrayCacheTest || $this instanceof ZendDataCacheTest ) {
- $this->markTestSkipped("Statistics are not available for this driver");
- }
-
$cache = $this->_getCacheDriver();
$stats = $cache->getStats();
-
$this->assertArrayHasKey(Cache::STATS_HITS, $stats);
$this->assertArrayHasKey(Cache::STATS_MISSES, $stats);
$this->assertArrayHasKey(Cache::STATS_UPTIME, $stats);
View
97 tests/Doctrine/Tests/Common/Cache/FilesystemCacheTest.php
@@ -0,0 +1,97 @@
+<?php
+
+namespace Doctrine\Tests\Common\Cache;
+
+use Doctrine\Common\Cache\FilesystemCache;
+
+/**
+ * @group DCOM-101
+ */
+class FilesystemCacheTest extends CacheTest
+{
+ /**
+ * @var \Doctrine\Common\Cache\FilesystemCache
+ */
+ private $driver;
+
+ protected function _getCacheDriver()
+ {
+ $dir = sys_get_temp_dir() . "/doctrine_cache_". uniqid();
+ $this->assertFalse(is_dir($dir));
+
+ $this->driver = new FilesystemCache($dir);
+ $this->assertTrue(is_dir($dir));
+
+ return $this->driver;
+ }
+
+ public function testLifetime()
+ {
+ $cache = $this->_getCacheDriver();
+
+ // Test save
+ $cache->save('test_key', 'testing this out', 10);
+
+ // Test contains to test that save() worked
+ $this->assertTrue($cache->contains('test_key'));
+
+ // Test fetch
+ $this->assertEquals('testing this out', $cache->fetch('test_key'));
+
+ // access private methods
+ $getFilename = new \ReflectionMethod($cache, 'getFilename');
+ $getNamespacedId = new \ReflectionMethod($cache, 'getNamespacedId');
+
+ $getFilename->setAccessible(true);
+ $getNamespacedId->setAccessible(true);
+
+ $id = $getNamespacedId->invoke($cache, 'test_key');
+ $filename = $getFilename->invoke($cache, $id);
+
+ $data = '';
+ $lifetime = 0;
+ $resource = fopen($filename, "r");
+
+ if (false !== ($line = fgets($resource))) {
+ $lifetime = (integer) $line;
+ }
+
+ while (false !== ($line = fgets($resource))) {
+ $data .= $line;
+ }
+
+ $this->assertNotEquals(0, $lifetime, "previous lifetime could not be loaded");
+
+ // update lifetime
+ $lifetime = $lifetime - 20;
+ file_put_contents($filename, $lifetime . PHP_EOL . $data);
+
+ // test expired data
+ $this->assertFalse($cache->contains('test_key'));
+ $this->assertFalse($cache->fetch('test_key'));
+ }
+
+ public function testGetStats()
+ {
+ $cache = $this->_getCacheDriver();
+ $stats = $cache->getStats();
+
+ $this->assertNull($stats);
+ }
+
+ public function tearDown()
+ {
+ $dir = $this->driver->getDirectory();
+ $ext = $this->driver->getExtension();
+ $iterator = new \RecursiveDirectoryIterator($dir);
+
+ foreach (new \RecursiveIteratorIterator($iterator, \RecursiveIteratorIterator::CHILD_FIRST) as $file) {
+ if ($file->isFile()) {
+ @unlink($file->getRealPath());
+ } else {
+ @rmdir($file->getRealPath());
+ }
+ }
+ }
+
+}
View
148 tests/Doctrine/Tests/Common/Cache/PhpFileCacheTest.php
@@ -0,0 +1,148 @@
+<?php
+
+namespace Doctrine\Tests\Common\Cache;
+
+use Doctrine\Common\Cache\PhpFileCache;
+
+/**
+ * @group DCOM-101
+ */
+class PhpFileCacheTest extends CacheTest
+{
+ /**
+ * @var \Doctrine\Common\Cache\PhpFileCache
+ */
+ private $driver;
+
+ protected function _getCacheDriver()
+ {
+ $dir = sys_get_temp_dir() . "/doctrine_cache_". uniqid();
+ $this->assertFalse(is_dir($dir));
+
+ $this->driver = new PhpFileCache($dir);
+ $this->assertTrue(is_dir($dir));
+
+ return $this->driver;
+ }
+
+ public function testLifetime()
+ {
+ $cache = $this->_getCacheDriver();
+
+ // Test save
+ $cache->save('test_key', 'testing this out', 10);
+
+ // Test contains to test that save() worked
+ $this->assertTrue($cache->contains('test_key'));
+
+ // Test fetch
+ $this->assertEquals('testing this out', $cache->fetch('test_key'));
+
+ // access private methods
+ $getFilename = new \ReflectionMethod($cache, 'getFilename');
+ $getNamespacedId = new \ReflectionMethod($cache, 'getNamespacedId');
+
+ $getFilename->setAccessible(true);
+ $getNamespacedId->setAccessible(true);
+
+ $id = $getNamespacedId->invoke($cache, 'test_key');
+ $path = $getFilename->invoke($cache, $id);
+ $value = include $path;
+
+ // update lifetime
+ $value['lifetime'] = $value['lifetime'] - 20;
+ file_put_contents($path, '<?php return unserialize(' . var_export(serialize($value), true) . ');');
+
+ // test expired data
+ $this->assertFalse($cache->contains('test_key'));
+ $this->assertFalse($cache->fetch('test_key'));
+ }
+
+ public function testImplementsSetState()
+ {
+ $cache = $this->_getCacheDriver();
+
+ // Test save
+ $cache->save('test_set_state', new SetStateClass(array(1,2,3)));
+
+ //Test __set_state call
+ $this->assertCount(0, SetStateClass::$values);
+
+ // Test fetch
+ $value = $cache->fetch('test_set_state');
+ $this->assertInstanceOf('Doctrine\Tests\Common\Cache\SetStateClass', $value);
+ $this->assertEquals(array(1,2,3), $value->getValue());
+
+ //Test __set_state call
+ $this->assertCount(1, SetStateClass::$values);
+
+ // Test contains
+ $this->assertTrue($cache->contains('test_set_state'));
+ }
+
+ public function testNotImplementsSetState()
+ {
+ $cache = $this->_getCacheDriver();
+
+ // Test save
+ $cache->save('test_not_set_state', new NotSetStateClass(array(1,2,3)));
+
+ // Test fetch
+ $value = $cache->fetch('test_not_set_state');
+ $this->assertInstanceOf('Doctrine\Tests\Common\Cache\NotSetStateClass', $value);
+ $this->assertEquals(array(1,2,3), $value->getValue());
+
+ // Test contains
+ $this->assertTrue($cache->contains('test_not_set_state'));
+ }
+
+ public function testGetStats()
+ {
+ $cache = $this->_getCacheDriver();
+ $stats = $cache->getStats();
+
+ $this->assertNull($stats);
+ }
+
+ public function tearDown()
+ {
+ $dir = $this->driver->getDirectory();
+ $ext = $this->driver->getExtension();
+ $iterator = new \RecursiveDirectoryIterator($dir);
+
+ foreach (new \RecursiveIteratorIterator($iterator, \RecursiveIteratorIterator::CHILD_FIRST) as $file) {
+ if ($file->isFile()) {
+ @unlink($file->getRealPath());
+ } else {
+ @rmdir($file->getRealPath());
+ }
+ }
+ }
+
+}
+
+class NotSetStateClass
+{
+ private $value;
+
+ public function __construct($value)
+ {
+ $this->value = $value;
+ }
+
+ public function getValue()
+ {
+ return $this->value;
+ }
+}
+
+class SetStateClass extends NotSetStateClass
+{
+ public static $values = array();
+
+ public static function __set_state($data)
+ {
+ self::$values = $data;
+ return new self($data['value']);
+ }
+}
View
8 tests/Doctrine/Tests/Common/Cache/ZendDataCacheTest.php
@@ -13,6 +13,14 @@ public function setUp()
}
}
+ public function testGetStats()
+ {
+ $cache = $this->_getCacheDriver();
+ $stats = $cache->getStats();
+
+ $this->assertNull($stats);
+ }
+
protected function _getCacheDriver()
{
return new ZendDataCache();
Please sign in to comment.
Something went wrong with that request. Please try again.