LICENSE000064400000002051144760122170005553 0ustar00Copyright (c) 2006-2015 Doctrine Project Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. README.md000064400000001666144760122170006040 0ustar00# Doctrine Cache [![Build Status](https://img.shields.io/travis/doctrine/cache/master.svg?style=flat-square)](http://travis-ci.org/doctrine/cache) [![Scrutinizer Code Quality](https://img.shields.io/scrutinizer/g/doctrine/cache/master.svg?style=flat-square)](https://scrutinizer-ci.com/g/doctrine/cache/?branch=master) [![Code Coverage](https://img.shields.io/scrutinizer/coverage/g/doctrine/cache/master.svg?style=flat-square)](https://scrutinizer-ci.com/g/doctrine/cache/?branch=master) [![Latest Stable Version](https://img.shields.io/packagist/v/doctrine/cache.svg?style=flat-square)](https://packagist.org/packages/doctrine/cache) [![Total Downloads](https://img.shields.io/packagist/dt/doctrine/cache.svg?style=flat-square)](https://packagist.org/packages/doctrine/cache) Cache component extracted from the Doctrine Common project. [Documentation](http://doctrine-orm.readthedocs.io/projects/doctrine-orm/en/latest/reference/caching.html) UPGRADE.md000064400000001326144760122170006163 0ustar00# Upgrade to 1.4 ## Minor BC Break: `Doctrine\Common\Cache\FileCache#$extension` is now `private`. If you need to override the value of `Doctrine\Common\Cache\FileCache#$extension`, then use the second parameter of `Doctrine\Common\Cache\FileCache#__construct()` instead of overriding the property in your own implementation. ## Minor BC Break: file based caches paths changed `Doctrine\Common\Cache\FileCache`, `Doctrine\Common\Cache\PhpFileCache` and `Doctrine\Common\Cache\FilesystemCache` are using a different cache paths structure. If you rely on warmed up caches for deployments, consider that caches generated with `doctrine/cache` `<1.4` are not compatible with the new directory structure, and will be ignored. composer.json000064400000002523144760122170007274 0ustar00{ "name": "doctrine/cache", "type": "library", "description": "Caching library offering an object-oriented API for many cache backends", "keywords": ["cache", "caching"], "homepage": "https://www.doctrine-project.org", "license": "MIT", "authors": [ {"name": "Guilherme Blanco", "email": "guilhermeblanco@gmail.com"}, {"name": "Roman Borschel", "email": "roman@code-factory.org"}, {"name": "Benjamin Eberlei", "email": "kontakt@beberlei.de"}, {"name": "Jonathan Wage", "email": "jonwage@gmail.com"}, {"name": "Johannes Schmitt", "email": "schmittjoh@gmail.com"} ], "require": { "php": "~7.1" }, "require-dev": { "alcaeus/mongo-php-adapter": "^1.1", "mongodb/mongodb": "^1.1", "phpunit/phpunit": "^7.0", "predis/predis": "~1.0", "doctrine/coding-standard": "^4.0" }, "suggest": { "alcaeus/mongo-php-adapter": "Required to use legacy MongoDB driver" }, "conflict": { "doctrine/common": ">2.2,<2.4" }, "autoload": { "psr-4": { "Doctrine\\Common\\Cache\\": "lib/Doctrine/Common/Cache" } }, "autoload-dev": { "psr-4": { "Doctrine\\Tests\\": "tests/Doctrine/Tests" } }, "extra": { "branch-alias": { "dev-master": "1.8.x-dev" } } } docs/en/index.rst000064400000015717144760122170007756 0ustar00Introduction ============ Doctrine Cache is a library that provides an interface for caching data. It comes with implementations for some of the most popular caching data stores. Here is what the ``Cache`` interface looks like. .. code-block:: php namespace Doctrine\Common\Cache; interface Cache { public function fetch($id); public function contains($id); public function save($id, $data, $lifeTime = 0); public function delete($id); public function getStats(); } Here is an example that uses Memcache. .. code-block:: php use Doctrine\Common\Cache\MemcacheCache; $memcache = new Memcache(); $cache = new MemcacheCache(); $cache->setMemcache($memcache); $cache->set('key', 'value'); echo $cache->get('key') // prints "value" Drivers ======= Doctrine ships with several common drivers that you can easily use. Below you can find information about all the available drivers. ApcCache -------- The ``ApcCache`` driver uses the ``apc_fetch``, ``apc_exists``, etc. functions that come with PHP so no additional setup is required in order to use it. .. code-block:: php $cache = new ApcCache(); ApcuCache --------- The ``ApcuCache`` driver uses the ``apcu_fetch``, ``apcu_exists``, etc. functions that come with PHP so no additional setup is required in order to use it. .. code-block:: php $cache = new ApcuCache(); ArrayCache ---------- The ``ArrayCache`` driver stores the cache data in PHPs memory and is not persisted anywhere. This can be useful for caching things in memory for a single process when you don't need the cache to be persistent across processes. .. code-block:: php $cache = new ArrayCache(); ChainCache ---------- The ``ChainCache`` driver lets you chain multiple other drivers together easily. .. code-block:: php $arrayCache = new ArrayCache(); $apcuCache = new ApcuCache(); $cache = new ChainCache([$arrayCache, $apcuCache]); CouchbaseBucketCache -------------------- The ``CouchbaseBucketCache`` driver uses Couchbase to store the cache data. .. code-block:: php $bucketName = 'bucket-name'; $authenticator = new Couchbase\PasswordAuthenticator(); $authenticator->username('username')->password('password'); $cluster = new CouchbaseCluster('couchbase://127.0.0.1'); $cluster->authenticate($authenticator); $bucket = $cluster->openBucket($bucketName); $cache = new CouchbaseBucketCache($bucket); FilesystemCache --------------- The ``FilesystemCache`` driver stores the cache data on the local filesystem. .. code-block:: php $cache = new FilesystemCache('/path/to/cache/directory'); MemecacheCache -------------- The ``MemcacheCache`` drivers stores the cache data in Memcache. .. code-block:: php $memcache = new Memcache(); $memcache->connect('localhost', 11211); $cache = new MemcacheCache(); $cache->setMemcache($memcache); MemcachedCache -------------- The ``MemcachedCache`` drivers stores the cache data in Memcached. .. code-block:: php $memcached = new Memcached(); $cache = new MemcachedCache(); $cache->setMemcached($memcached); MongoDBCache ------------ The ``MongoDBCache`` drivers stores the cache data in a MongoDB collection. .. code-block:: php $manager = new MongoDB\Driver\Manager("mongodb://localhost:27017"); $collection = new MongoDB\Collection($manager, 'database_name', 'collection_name'); $cache = new MongoDBCache($collection); PhpFileCache ------------ The ``PhpFileCache`` driver stores the cache data on the local filesystem like the ``FilesystemCache`` driver except the data is serialized using the ``serialize()`` and ``unserialize()`` functions available in PHP. The files are included so this means that the data can be cached in PHPs opcache. .. code-block:: php $cache = new PhpFileCache('/path/to/cache/directory'); PredisCache ----------- The ``PredisCache`` driver stores the cache data in Redis and depends on the ``predis/predis`` package which can be installed with composer. .. code-block:: bash $ composer require predis/predis Then you can use the ``Predis\Client`` class to pass to the ``PredisCache`` class. .. code-block:: php $client = new Predis\Client(); $cache = new PredisCache($client); RedisCache ---------- The ``RedisCache`` driver stores the cache data in Redis and depends on the ``phpredis`` extension which can be found `here `_. .. code-block:: php $redis = new Redis(); $cache = new RedisCache($redis); RiakCache --------- The ``RiakCache`` driver stores the cache data in Riak and depends on the ``riak`` extension which can be found `here `_. .. code-block:: php $connection = new Riak\Connection('localhost', 8087); $bucket = new Riak\Bucket($connection, 'bucket_name'); $cache = new RiakCache($bucket); SQLite3Cache ------------ The ``SQLite3Cache`` driver stores the cache data in a SQLite database and depends on the ``sqlite3`` extension which can be found `here `_. .. code-block:: php $db = new SQLite3('mydatabase.db'); $cache = new SQLite3Cache($db, 'table_name'); VoidCache --------- The ``VoidCache`` driver does not store the cache data anywhere. This can be useful for test environments where you don't want to cache the data anywhere but need to satisfy the dependency for the ``Doctrine\Common\Cache\Cache`` interface. .. code-block:: php $cache = new VoidCache(); WinCacheCache ------------- The ``WinCacheCache`` driver uses the ``wincache_ucache_get``, ``wincache_ucache_exists``, etc. functions that come with the ``wincache`` extension which can be found `here `_. .. code-block:: php $cache = new WinCacheCache(); XcacheCache ----------- The ``XcacheCache`` driver uses functions that come with the ``xcache`` extension which can be found `here `_. .. code-block:: php $cache = new XcacheCache(); ZendDataCache ------------- The ``ZendDataCache`` driver uses the Zend Data Cache API available in the Zend Platform. .. code-block:: php $cache = new ZendDataCache(); Custom Drivers ============== If you want to implement your own cache driver, you just need to implement the ``Doctrine\Common\Cache\Cache`` interface. Here is an example implementation skeleton. .. code-block:: php use Doctrine\Common\Cache\Cache; class MyCacheDriver implements Cache { public function fetch($id) { // fetch $id from the cache } public function contains($id) { // check if $id exists in the cache } public function save($id, $data, $lifeTime = 0) { // save $data under $id in the cache for $lifetime } public function delete($id) { // delete $id from the cache } public function getStats() { // get cache stats } } lib/Doctrine/Common/Cache/ApcCache.php000064400000004515144760122170013465 0ustar00= 50500) { $info['num_hits'] = $info['num_hits'] ?? $info['nhits']; $info['num_misses'] = $info['num_misses'] ?? $info['nmisses']; $info['start_time'] = $info['start_time'] ?? $info['stime']; } return [ Cache::STATS_HITS => $info['num_hits'], Cache::STATS_MISSES => $info['num_misses'], Cache::STATS_UPTIME => $info['start_time'], Cache::STATS_MEMORY_USAGE => $info['mem_size'], Cache::STATS_MEMORY_AVAILABLE => $sma['avail_mem'], ]; } } lib/Doctrine/Common/Cache/ApcuCache.php000064400000004170144760122170013647 0ustar00 $info['num_hits'], Cache::STATS_MISSES => $info['num_misses'], Cache::STATS_UPTIME => $info['start_time'], Cache::STATS_MEMORY_USAGE => $info['mem_size'], Cache::STATS_MEMORY_AVAILABLE => $sma['avail_mem'], ]; } } lib/Doctrine/Common/Cache/ArrayCache.php000064400000004035144760122170014035 0ustar00upTime = time(); } /** * {@inheritdoc} */ protected function doFetch($id) { if (! $this->doContains($id)) { $this->missesCount += 1; return false; } $this->hitsCount += 1; return $this->data[$id][0]; } /** * {@inheritdoc} */ protected function doContains($id) { if (! isset($this->data[$id])) { return false; } $expiration = $this->data[$id][1]; if ($expiration && $expiration < time()) { $this->doDelete($id); return false; } return true; } /** * {@inheritdoc} */ protected function doSave($id, $data, $lifeTime = 0) { $this->data[$id] = [$data, $lifeTime ? time() + $lifeTime : false]; return true; } /** * {@inheritdoc} */ protected function doDelete($id) { unset($this->data[$id]); return true; } /** * {@inheritdoc} */ protected function doFlush() { $this->data = []; return true; } /** * {@inheritdoc} */ protected function doGetStats() { return [ Cache::STATS_HITS => $this->hitsCount, Cache::STATS_MISSES => $this->missesCount, Cache::STATS_UPTIME => $this->upTime, Cache::STATS_MEMORY_USAGE => null, Cache::STATS_MEMORY_AVAILABLE => null, ]; } } lib/Doctrine/Common/Cache/Cache.php000064400000005355144760122170013044 0ustar00hits * Number of keys that have been requested and found present. * * - misses * Number of items that have been requested and not found. * * - uptime * Time that the server is running. * * - memory_usage * Memory used by this server to store items. * * - memory_available * Memory allowed to use for storage. * * @return array|null An associative array with server's statistics if available, NULL otherwise. */ public function getStats(); } lib/Doctrine/Common/Cache/CacheProvider.php000064400000020412144760122170014546 0ustar00namespace = (string) $namespace; $this->namespaceVersion = null; } /** * Retrieves the namespace that prefixes all cache ids. * * @return string */ public function getNamespace() { return $this->namespace; } /** * {@inheritdoc} */ public function fetch($id) { return $this->doFetch($this->getNamespacedId($id)); } /** * {@inheritdoc} */ public function fetchMultiple(array $keys) { if (empty($keys)) { return []; } // note: the array_combine() is in place to keep an association between our $keys and the $namespacedKeys $namespacedKeys = array_combine($keys, array_map([$this, 'getNamespacedId'], $keys)); $items = $this->doFetchMultiple($namespacedKeys); $foundItems = []; // no internal array function supports this sort of mapping: needs to be iterative // this filters and combines keys in one pass foreach ($namespacedKeys as $requestedKey => $namespacedKey) { if (! isset($items[$namespacedKey]) && ! array_key_exists($namespacedKey, $items)) { continue; } $foundItems[$requestedKey] = $items[$namespacedKey]; } return $foundItems; } /** * {@inheritdoc} */ public function saveMultiple(array $keysAndValues, $lifetime = 0) { $namespacedKeysAndValues = []; foreach ($keysAndValues as $key => $value) { $namespacedKeysAndValues[$this->getNamespacedId($key)] = $value; } return $this->doSaveMultiple($namespacedKeysAndValues, $lifetime); } /** * {@inheritdoc} */ public function contains($id) { return $this->doContains($this->getNamespacedId($id)); } /** * {@inheritdoc} */ public function save($id, $data, $lifeTime = 0) { return $this->doSave($this->getNamespacedId($id), $data, $lifeTime); } /** * {@inheritdoc} */ public function deleteMultiple(array $keys) { return $this->doDeleteMultiple(array_map([$this, 'getNamespacedId'], $keys)); } /** * {@inheritdoc} */ public function delete($id) { return $this->doDelete($this->getNamespacedId($id)); } /** * {@inheritdoc} */ public function getStats() { return $this->doGetStats(); } /** * {@inheritDoc} */ public function flushAll() { return $this->doFlush(); } /** * {@inheritDoc} */ public function deleteAll() { $namespaceCacheKey = $this->getNamespaceCacheKey(); $namespaceVersion = $this->getNamespaceVersion() + 1; if ($this->doSave($namespaceCacheKey, $namespaceVersion)) { $this->namespaceVersion = $namespaceVersion; return true; } return false; } /** * Prefixes the passed id with the configured namespace value. * * @param string $id The id to namespace. * * @return string The namespaced id. */ private function getNamespacedId(string $id) : string { $namespaceVersion = $this->getNamespaceVersion(); return sprintf('%s[%s][%s]', $this->namespace, $id, $namespaceVersion); } /** * Returns the namespace cache key. */ private function getNamespaceCacheKey() : string { return sprintf(self::DOCTRINE_NAMESPACE_CACHEKEY, $this->namespace); } /** * Returns the namespace version. */ private function getNamespaceVersion() : int { if ($this->namespaceVersion !== null) { return $this->namespaceVersion; } $namespaceCacheKey = $this->getNamespaceCacheKey(); $this->namespaceVersion = (int) $this->doFetch($namespaceCacheKey) ?: 1; return $this->namespaceVersion; } /** * Default implementation of doFetchMultiple. Each driver that supports multi-get should owerwrite it. * * @param array $keys Array of keys to retrieve from cache * @return array Array of values retrieved for the given keys. */ protected function doFetchMultiple(array $keys) { $returnValues = []; foreach ($keys as $key) { $item = $this->doFetch($key); if ($item === false && ! $this->doContains($key)) { continue; } $returnValues[$key] = $item; } return $returnValues; } /** * Fetches an entry from the cache. * * @param string $id The id of the cache entry to fetch. * * @return mixed|false The cached data or FALSE, if no cache entry exists for the given id. */ abstract protected function doFetch($id); /** * Tests if an entry exists in the cache. * * @param string $id The cache id of the entry to check for. * * @return bool TRUE if a cache entry exists for the given cache id, FALSE otherwise. */ abstract protected function doContains($id); /** * Default implementation of doSaveMultiple. Each driver that supports multi-put should override it. * * @param array $keysAndValues Array of keys and values to save in cache * @param int $lifetime The lifetime. If != 0, sets a specific lifetime for these * cache entries (0 => infinite lifeTime). * * @return bool TRUE if the operation was successful, FALSE if it wasn't. */ protected function doSaveMultiple(array $keysAndValues, $lifetime = 0) { $success = true; foreach ($keysAndValues as $key => $value) { if ($this->doSave($key, $value, $lifetime)) { continue; } $success = false; } return $success; } /** * Puts data into the cache. * * @param string $id The cache id. * @param string $data The cache entry/data. * @param int $lifeTime The lifetime. If != 0, sets a specific lifetime for this * cache entry (0 => infinite lifeTime). * * @return bool TRUE if the entry was successfully stored in the cache, FALSE otherwise. */ abstract protected function doSave($id, $data, $lifeTime = 0); /** * Default implementation of doDeleteMultiple. Each driver that supports multi-delete should override it. * * @param array $keys Array of keys to delete from cache * * @return bool TRUE if the operation was successful, FALSE if it wasn't */ protected function doDeleteMultiple(array $keys) { $success = true; foreach ($keys as $key) { if ($this->doDelete($key)) { continue; } $success = false; } return $success; } /** * Deletes a cache entry. * * @param string $id The cache id. * * @return bool TRUE if the cache entry was successfully deleted, FALSE otherwise. */ abstract protected function doDelete($id); /** * Flushes all cache entries. * * @return bool TRUE if the cache entries were successfully flushed, FALSE otherwise. */ abstract protected function doFlush(); /** * Retrieves cached information from the data store. * * @return array|null An associative array with server's statistics if available, NULL otherwise. */ abstract protected function doGetStats(); } lib/Doctrine/Common/Cache/ChainCache.php000064400000010467144760122170014007 0ustar00cacheProviders = $cacheProviders instanceof \Traversable ? iterator_to_array($cacheProviders, false) : array_values($cacheProviders); } /** * {@inheritDoc} */ public function setNamespace($namespace) { parent::setNamespace($namespace); foreach ($this->cacheProviders as $cacheProvider) { $cacheProvider->setNamespace($namespace); } } /** * {@inheritDoc} */ protected function doFetch($id) { foreach ($this->cacheProviders as $key => $cacheProvider) { if ($cacheProvider->doContains($id)) { $value = $cacheProvider->doFetch($id); // We populate all the previous cache layers (that are assumed to be faster) for ($subKey = $key - 1; $subKey >= 0; $subKey--) { $this->cacheProviders[$subKey]->doSave($id, $value); } return $value; } } return false; } /** * {@inheritdoc} */ protected function doFetchMultiple(array $keys) { /** @var CacheProvider[] $traversedProviders */ $traversedProviders = []; $keysCount = count($keys); $fetchedValues = []; foreach ($this->cacheProviders as $key => $cacheProvider) { $fetchedValues = $cacheProvider->doFetchMultiple($keys); // We populate all the previous cache layers (that are assumed to be faster) if (count($fetchedValues) === $keysCount) { foreach ($traversedProviders as $previousCacheProvider) { $previousCacheProvider->doSaveMultiple($fetchedValues); } return $fetchedValues; } $traversedProviders[] = $cacheProvider; } return $fetchedValues; } /** * {@inheritDoc} */ protected function doContains($id) { foreach ($this->cacheProviders as $cacheProvider) { if ($cacheProvider->doContains($id)) { return true; } } return false; } /** * {@inheritDoc} */ protected function doSave($id, $data, $lifeTime = 0) { $stored = true; foreach ($this->cacheProviders as $cacheProvider) { $stored = $cacheProvider->doSave($id, $data, $lifeTime) && $stored; } return $stored; } /** * {@inheritdoc} */ protected function doSaveMultiple(array $keysAndValues, $lifetime = 0) { $stored = true; foreach ($this->cacheProviders as $cacheProvider) { $stored = $cacheProvider->doSaveMultiple($keysAndValues, $lifetime) && $stored; } return $stored; } /** * {@inheritDoc} */ protected function doDelete($id) { $deleted = true; foreach ($this->cacheProviders as $cacheProvider) { $deleted = $cacheProvider->doDelete($id) && $deleted; } return $deleted; } /** * {@inheritdoc} */ protected function doDeleteMultiple(array $keys) { $deleted = true; foreach ($this->cacheProviders as $cacheProvider) { $deleted = $cacheProvider->doDeleteMultiple($keys) && $deleted; } return $deleted; } /** * {@inheritDoc} */ protected function doFlush() { $flushed = true; foreach ($this->cacheProviders as $cacheProvider) { $flushed = $cacheProvider->doFlush() && $flushed; } return $flushed; } /** * {@inheritDoc} */ protected function doGetStats() { // We return all the stats from all adapters $stats = []; foreach ($this->cacheProviders as $cacheProvider) { $stats[] = $cacheProvider->doGetStats(); } return $stats; } } lib/Doctrine/Common/Cache/ClearableCache.php000064400000000765144760122170014637 0ustar00bucket = $bucket; } /** * {@inheritdoc} */ protected function doFetch($id) { $id = $this->normalizeKey($id); try { $document = $this->bucket->get($id); } catch (Exception $e) { return false; } if ($document instanceof Document && $document->value !== false) { return unserialize($document->value); } return false; } /** * {@inheritdoc} */ protected function doContains($id) { $id = $this->normalizeKey($id); try { $document = $this->bucket->get($id); } catch (Exception $e) { return false; } if ($document instanceof Document) { return ! $document->error; } return false; } /** * {@inheritdoc} */ protected function doSave($id, $data, $lifeTime = 0) { $id = $this->normalizeKey($id); $lifeTime = $this->normalizeExpiry($lifeTime); try { $encoded = serialize($data); $document = $this->bucket->upsert($id, $encoded, [ 'expiry' => (int) $lifeTime, ]); } catch (Exception $e) { return false; } if ($document instanceof Document) { return ! $document->error; } return false; } /** * {@inheritdoc} */ protected function doDelete($id) { $id = $this->normalizeKey($id); try { $document = $this->bucket->remove($id); } catch (Exception $e) { return $e->getCode() === self::KEY_NOT_FOUND; } if ($document instanceof Document) { return ! $document->error; } return false; } /** * {@inheritdoc} */ protected function doFlush() { $manager = $this->bucket->manager(); // Flush does not return with success or failure, and must be enabled per bucket on the server. // Store a marker item so that we will know if it was successful. $this->doSave(__METHOD__, true, 60); $manager->flush(); if ($this->doContains(__METHOD__)) { $this->doDelete(__METHOD__); return false; } return true; } /** * {@inheritdoc} */ protected function doGetStats() { $manager = $this->bucket->manager(); $stats = $manager->info(); $nodes = $stats['nodes']; $node = $nodes[0]; $interestingStats = $node['interestingStats']; return [ Cache::STATS_HITS => $interestingStats['get_hits'], Cache::STATS_MISSES => $interestingStats['cmd_get'] - $interestingStats['get_hits'], Cache::STATS_UPTIME => $node['uptime'], Cache::STATS_MEMORY_USAGE => $interestingStats['mem_used'], Cache::STATS_MEMORY_AVAILABLE => $node['memoryFree'], ]; } private function normalizeKey(string $id) : string { $normalized = substr($id, 0, self::MAX_KEY_LENGTH); if ($normalized === false) { return $id; } return $normalized; } /** * Expiry treated as a unix timestamp instead of an offset if expiry is greater than 30 days. * @src https://developer.couchbase.com/documentation/server/4.1/developer-guide/expiry.html */ private function normalizeExpiry(int $expiry) : int { if ($expiry > self::THIRTY_DAYS_IN_SECONDS) { return time() + $expiry; } return $expiry; } } lib/Doctrine/Common/Cache/CouchbaseCache.php000064400000004413144760122170014653 0ustar00couchbase = $couchbase; } /** * Gets the Couchbase instance used by the cache. * * @return Couchbase|null */ public function getCouchbase() { return $this->couchbase; } /** * {@inheritdoc} */ protected function doFetch($id) { return $this->couchbase->get($id) ?: false; } /** * {@inheritdoc} */ protected function doContains($id) { return $this->couchbase->get($id) !== null; } /** * {@inheritdoc} */ protected function doSave($id, $data, $lifeTime = 0) { if ($lifeTime > 30 * 24 * 3600) { $lifeTime = time() + $lifeTime; } return $this->couchbase->set($id, $data, (int) $lifeTime); } /** * {@inheritdoc} */ protected function doDelete($id) { return $this->couchbase->delete($id); } /** * {@inheritdoc} */ protected function doFlush() { return $this->couchbase->flush(); } /** * {@inheritdoc} */ protected function doGetStats() { $stats = $this->couchbase->getStats(); $servers = $this->couchbase->getServers(); $server = explode(':', $servers[0]); $key = $server[0] . ':11210'; $stats = $stats[$key]; return [ Cache::STATS_HITS => $stats['get_hits'], Cache::STATS_MISSES => $stats['get_misses'], Cache::STATS_UPTIME => $stats['uptime'], Cache::STATS_MEMORY_USAGE => $stats['bytes'], Cache::STATS_MEMORY_AVAILABLE => $stats['limit_maxbytes'], ]; } } lib/Doctrine/Common/Cache/ExtMongoDBCache.php000064400000012265144760122170014731 0ustar00collection = $collection->withOptions(['typeMap' => null]); $this->database = new Database($collection->getManager(), $collection->getDatabaseName()); } /** * {@inheritdoc} */ protected function doFetch($id) { $document = $this->collection->findOne(['_id' => $id], [MongoDBCache::DATA_FIELD, MongoDBCache::EXPIRATION_FIELD]); if ($document === null) { return false; } if ($this->isExpired($document)) { $this->createExpirationIndex(); $this->doDelete($id); return false; } return unserialize($document[MongoDBCache::DATA_FIELD]->getData()); } /** * {@inheritdoc} */ protected function doContains($id) { $document = $this->collection->findOne(['_id' => $id], [MongoDBCache::EXPIRATION_FIELD]); if ($document === null) { return false; } if ($this->isExpired($document)) { $this->createExpirationIndex(); $this->doDelete($id); return false; } return true; } /** * {@inheritdoc} */ protected function doSave($id, $data, $lifeTime = 0) { try { $this->collection->updateOne( ['_id' => $id], [ '$set' => [ MongoDBCache::EXPIRATION_FIELD => ($lifeTime > 0 ? new UTCDateTime((time() + $lifeTime) * 1000): null), MongoDBCache::DATA_FIELD => new Binary(serialize($data), Binary::TYPE_GENERIC), ], ], ['upsert' => true] ); } catch (Exception $e) { return false; } return true; } /** * {@inheritdoc} */ protected function doDelete($id) { try { $this->collection->deleteOne(['_id' => $id]); } catch (Exception $e) { return false; } return true; } /** * {@inheritdoc} */ protected function doFlush() { try { // Use remove() in lieu of drop() to maintain any collection indexes $this->collection->deleteMany([]); } catch (Exception $e) { return false; } return true; } /** * {@inheritdoc} */ protected function doGetStats() { $uptime = null; $memoryUsage = null; try { $serverStatus = $this->database->command([ 'serverStatus' => 1, 'locks' => 0, 'metrics' => 0, 'recordStats' => 0, 'repl' => 0, ])->toArray()[0]; $uptime = $serverStatus['uptime'] ?? null; } catch (Exception $e) { } try { $collStats = $this->database->command(['collStats' => $this->collection->getCollectionName()])->toArray()[0]; $memoryUsage = $collStats['size'] ?? null; } catch (Exception $e) { } return [ Cache::STATS_HITS => null, Cache::STATS_MISSES => null, Cache::STATS_UPTIME => $uptime, Cache::STATS_MEMORY_USAGE => $memoryUsage, Cache::STATS_MEMORY_AVAILABLE => null, ]; } /** * Check if the document is expired. */ private function isExpired(BSONDocument $document) : bool { return isset($document[MongoDBCache::EXPIRATION_FIELD]) && $document[MongoDBCache::EXPIRATION_FIELD] instanceof UTCDateTime && $document[MongoDBCache::EXPIRATION_FIELD]->toDateTime() < new \DateTime(); } private function createExpirationIndex() : void { if ($this->expirationIndexCreated) { return; } $this->collection->createIndex([MongoDBCache::EXPIRATION_FIELD => 1], ['background' => true, 'expireAfterSeconds' => 0]); } } lib/Doctrine/Common/Cache/FileCache.php000064400000017245144760122170013645 0ustar00umask = $umask; if (! $this->createPathIfNeeded($directory)) { 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 )); } // YES, this needs to be *after* createPathIfNeeded() $this->directory = realpath($directory); $this->extension = (string) $extension; $this->directoryStringLength = strlen($this->directory); $this->extensionStringLength = strlen($this->extension); $this->isRunningOnWindows = defined('PHP_WINDOWS_VERSION_BUILD'); } /** * 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; } /** * @param string $id * * @return string */ protected function getFilename($id) { $hash = hash('sha256', $id); // This ensures that the filename is unique and that there are no invalid chars in it. if ($id === '' || ((strlen($id) * 2 + $this->extensionStringLength) > 255) || ($this->isRunningOnWindows && ($this->directoryStringLength + 4 + strlen($id) * 2 + $this->extensionStringLength) > 258) ) { // Most filesystems have a limit of 255 chars for each path component. On Windows the the whole path is limited // to 260 chars (including terminating null char). Using long UNC ("\\?\" prefix) does not work with the PHP API. // And there is a bug in PHP (https://bugs.php.net/bug.php?id=70943) with path lengths of 259. // So if the id in hex representation would surpass the limit, we use the hash instead. The prefix prevents // collisions between the hash and bin2hex. $filename = '_' . $hash; } else { $filename = bin2hex($id); } return $this->directory . DIRECTORY_SEPARATOR . substr($hash, 0, 2) . DIRECTORY_SEPARATOR . $filename . $this->extension; } /** * {@inheritdoc} */ protected function doDelete($id) { $filename = $this->getFilename($id); return @unlink($filename) || ! file_exists($filename); } /** * {@inheritdoc} */ protected function doFlush() { foreach ($this->getIterator() as $name => $file) { if ($file->isDir()) { // Remove the intermediate directories which have been created to balance the tree. It only takes effect // if the directory is empty. If several caches share the same directory but with different file extensions, // the other ones are not removed. @rmdir($name); } elseif ($this->isFilenameEndingWithExtension($name)) { // If an extension is set, only remove files which end with the given extension. // If no extension is set, we have no other choice than removing everything. @unlink($name); } } return true; } /** * {@inheritdoc} */ protected function doGetStats() { $usage = 0; foreach ($this->getIterator() as $name => $file) { if ($file->isDir() || ! $this->isFilenameEndingWithExtension($name)) { continue; } $usage += $file->getSize(); } $free = disk_free_space($this->directory); return [ Cache::STATS_HITS => null, Cache::STATS_MISSES => null, Cache::STATS_UPTIME => null, Cache::STATS_MEMORY_USAGE => $usage, Cache::STATS_MEMORY_AVAILABLE => $free, ]; } /** * Create path if needed. * * @return bool TRUE on success or if path already exists, FALSE if path cannot be created. */ private function createPathIfNeeded(string $path) : bool { if (! is_dir($path)) { if (@mkdir($path, 0777 & (~$this->umask), true) === false && ! is_dir($path)) { return false; } } return true; } /** * Writes a string content to file in an atomic way. * * @param string $filename Path to the file where to write the data. * @param string $content The content to write * * @return bool TRUE on success, FALSE if path cannot be created, if path is not writable or an any other error. */ protected function writeFile(string $filename, string $content) : bool { $filepath = pathinfo($filename, PATHINFO_DIRNAME); if (! $this->createPathIfNeeded($filepath)) { return false; } if (! is_writable($filepath)) { return false; } $tmpFile = tempnam($filepath, 'swap'); @chmod($tmpFile, 0666 & (~$this->umask)); if (file_put_contents($tmpFile, $content) !== false) { @chmod($tmpFile, 0666 & (~$this->umask)); if (@rename($tmpFile, $filename)) { return true; } @unlink($tmpFile); } return false; } private function getIterator() : \Iterator { return new \RecursiveIteratorIterator( new \RecursiveDirectoryIterator($this->directory, \FilesystemIterator::SKIP_DOTS), \RecursiveIteratorIterator::CHILD_FIRST ); } /** * @param string $name The filename */ private function isFilenameEndingWithExtension(string $name) : bool { return $this->extension === '' || strrpos($name, $this->extension) === (strlen($name) - $this->extensionStringLength); } } lib/Doctrine/Common/Cache/FilesystemCache.php000064400000004015144760122170015101 0ustar00getFilename($id); if (! is_file($filename)) { return false; } $resource = fopen($filename, 'r'); $line = fgets($resource); if ($line !== false) { $lifetime = (int) $line; } if ($lifetime !== 0 && $lifetime < time()) { fclose($resource); return false; } while (($line = fgets($resource)) !== false) { $data .= $line; } fclose($resource); return unserialize($data); } /** * {@inheritdoc} */ protected function doContains($id) { $lifetime = -1; $filename = $this->getFilename($id); if (! is_file($filename)) { return false; } $resource = fopen($filename, 'r'); $line = fgets($resource); if ($line !== false) { $lifetime = (int) $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); return $this->writeFile($filename, $lifeTime . PHP_EOL . $data); } } lib/Doctrine/Common/Cache/FlushableCache.php000064400000000536144760122170014666 0ustar00collection = $collection; } /** * {@inheritdoc} */ protected function doFetch($id) { $document = $this->collection->findOne(['_id' => $id], [MongoDBCache::DATA_FIELD, MongoDBCache::EXPIRATION_FIELD]); if ($document === null) { return false; } if ($this->isExpired($document)) { $this->createExpirationIndex(); $this->doDelete($id); return false; } return unserialize($document[MongoDBCache::DATA_FIELD]->bin); } /** * {@inheritdoc} */ protected function doContains($id) { $document = $this->collection->findOne(['_id' => $id], [MongoDBCache::EXPIRATION_FIELD]); if ($document === null) { return false; } if ($this->isExpired($document)) { $this->createExpirationIndex(); $this->doDelete($id); return false; } return true; } /** * {@inheritdoc} */ protected function doSave($id, $data, $lifeTime = 0) { try { $result = $this->collection->update( ['_id' => $id], [ '$set' => [ MongoDBCache::EXPIRATION_FIELD => ($lifeTime > 0 ? new MongoDate(time() + $lifeTime) : null), MongoDBCache::DATA_FIELD => new MongoBinData(serialize($data), MongoBinData::BYTE_ARRAY), ], ], ['upsert' => true, 'multiple' => false] ); } catch (MongoCursorException $e) { return false; } return ($result['ok'] ?? 1) == 1; } /** * {@inheritdoc} */ protected function doDelete($id) { $result = $this->collection->remove(['_id' => $id]); return ($result['ok'] ?? 1) == 1; } /** * {@inheritdoc} */ protected function doFlush() { // Use remove() in lieu of drop() to maintain any collection indexes $result = $this->collection->remove(); return ($result['ok'] ?? 1) == 1; } /** * {@inheritdoc} */ protected function doGetStats() { $serverStatus = $this->collection->db->command([ 'serverStatus' => 1, 'locks' => 0, 'metrics' => 0, 'recordStats' => 0, 'repl' => 0, ]); $collStats = $this->collection->db->command(['collStats' => 1]); return [ Cache::STATS_HITS => null, Cache::STATS_MISSES => null, Cache::STATS_UPTIME => $serverStatus['uptime'] ?? null, Cache::STATS_MEMORY_USAGE => $collStats['size'] ?? null, Cache::STATS_MEMORY_AVAILABLE => null, ]; } /** * Check if the document is expired. * * @param array $document */ private function isExpired(array $document) : bool { return isset($document[MongoDBCache::EXPIRATION_FIELD]) && $document[MongoDBCache::EXPIRATION_FIELD] instanceof MongoDate && $document[MongoDBCache::EXPIRATION_FIELD]->sec < time(); } private function createExpirationIndex() : void { if ($this->expirationIndexCreated) { return; } $this->expirationIndexCreated = true; $this->collection->createIndex([MongoDBCache::EXPIRATION_FIELD => 1], ['background' => true, 'expireAfterSeconds' => 0]); } } lib/Doctrine/Common/Cache/MemcacheCache.php000064400000004106144760122170014460 0ustar00memcache = $memcache; } /** * Gets the memcache instance used by the cache. * * @return Memcache|null */ public function getMemcache() { return $this->memcache; } /** * {@inheritdoc} */ protected function doFetch($id) { return $this->memcache->get($id); } /** * {@inheritdoc} */ protected function doContains($id) { $flags = null; $this->memcache->get($id, $flags); //if memcache has changed the value of "flags", it means the value exists return $flags !== null; } /** * {@inheritdoc} */ protected function doSave($id, $data, $lifeTime = 0) { if ($lifeTime > 30 * 24 * 3600) { $lifeTime = time() + $lifeTime; } return $this->memcache->set($id, $data, 0, (int) $lifeTime); } /** * {@inheritdoc} */ protected function doDelete($id) { // Memcache::delete() returns false if entry does not exist return $this->memcache->delete($id) || ! $this->doContains($id); } /** * {@inheritdoc} */ protected function doFlush() { return $this->memcache->flush(); } /** * {@inheritdoc} */ protected function doGetStats() { $stats = $this->memcache->getStats(); return [ Cache::STATS_HITS => $stats['get_hits'], Cache::STATS_MISSES => $stats['get_misses'], Cache::STATS_UPTIME => $stats['uptime'], Cache::STATS_MEMORY_USAGE => $stats['bytes'], Cache::STATS_MEMORY_AVAILABLE => $stats['limit_maxbytes'], ]; } } lib/Doctrine/Common/Cache/MemcachedCache.php000064400000005466144760122170014636 0ustar00memcached = $memcached; } /** * Gets the memcached instance used by the cache. * * @return Memcached|null */ public function getMemcached() { return $this->memcached; } /** * {@inheritdoc} */ protected function doFetch($id) { return $this->memcached->get($id); } /** * {@inheritdoc} */ protected function doFetchMultiple(array $keys) { return $this->memcached->getMulti($keys) ?: []; } /** * {@inheritdoc} */ protected function doSaveMultiple(array $keysAndValues, $lifetime = 0) { if ($lifetime > 30 * 24 * 3600) { $lifetime = time() + $lifetime; } return $this->memcached->setMulti($keysAndValues, $lifetime); } /** * {@inheritdoc} */ protected function doContains($id) { $this->memcached->get($id); return $this->memcached->getResultCode() === Memcached::RES_SUCCESS; } /** * {@inheritdoc} */ protected function doSave($id, $data, $lifeTime = 0) { if ($lifeTime > 30 * 24 * 3600) { $lifeTime = time() + $lifeTime; } return $this->memcached->set($id, $data, (int) $lifeTime); } /** * {@inheritdoc} */ protected function doDeleteMultiple(array $keys) { return $this->memcached->deleteMulti($keys) || $this->memcached->getResultCode() === Memcached::RES_NOTFOUND; } /** * {@inheritdoc} */ protected function doDelete($id) { return $this->memcached->delete($id) || $this->memcached->getResultCode() === Memcached::RES_NOTFOUND; } /** * {@inheritdoc} */ protected function doFlush() { return $this->memcached->flush(); } /** * {@inheritdoc} */ protected function doGetStats() { $stats = $this->memcached->getStats(); $servers = $this->memcached->getServerList(); $key = $servers[0]['host'] . ':' . $servers[0]['port']; $stats = $stats[$key]; return [ Cache::STATS_HITS => $stats['get_hits'], Cache::STATS_MISSES => $stats['get_misses'], Cache::STATS_UPTIME => $stats['uptime'], Cache::STATS_MEMORY_USAGE => $stats['bytes'], Cache::STATS_MEMORY_AVAILABLE => $stats['limit_maxbytes'], ]; } } lib/Doctrine/Common/Cache/MongoDBCache.php000064400000006132144760122170014244 0ustar00provider = new LegacyMongoDBCache($collection); } elseif ($collection instanceof Collection) { $this->provider = new ExtMongoDBCache($collection); } else { throw new \InvalidArgumentException('Invalid collection given - expected a MongoCollection or MongoDB\Collection instance'); } } /** * {@inheritdoc} */ protected function doFetch($id) { return $this->provider->doFetch($id); } /** * {@inheritdoc} */ protected function doContains($id) { return $this->provider->doContains($id); } /** * {@inheritdoc} */ protected function doSave($id, $data, $lifeTime = 0) { return $this->provider->doSave($id, $data, $lifeTime); } /** * {@inheritdoc} */ protected function doDelete($id) { return $this->provider->doDelete($id); } /** * {@inheritdoc} */ protected function doFlush() { return $this->provider->doFlush(); } /** * {@inheritdoc} */ protected function doGetStats() { return $this->provider->doGetStats(); } } lib/Doctrine/Common/Cache/MultiDeleteCache.php000064400000000717144760122170015177 0ustar00 infinite lifeTime). * * @return bool TRUE if the operation was successful, FALSE if it wasn't. */ public function saveMultiple(array $keysAndValues, $lifetime = 0); } lib/Doctrine/Common/Cache/PhpFileCache.php000064400000005154144760122170014311 0ustar00includeFileForId($id); if ($value === null) { return false; } if ($value['lifetime'] !== 0 && $value['lifetime'] < time()) { return false; } return $value['data']; } /** * {@inheritdoc} */ protected function doContains($id) { $value = $this->includeFileForId($id); if ($value === null) { return false; } 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); $value = [ 'lifetime' => $lifeTime, 'data' => $data, ]; if (is_object($data) && method_exists($data, '__set_state')) { $value = var_export($value, true); $code = sprintf('writeFile($filename, $code); } /** * @return array|null */ private function includeFileForId(string $id) : ?array { $fileName = $this->getFilename($id); // note: error suppression is still faster than `file_exists`, `is_file` and `is_readable` set_error_handler(self::$emptyErrorHandler); $value = include $fileName; restore_error_handler(); if (! isset($value['lifetime'])) { return null; } return $value; } } lib/Doctrine/Common/Cache/PredisCache.php000064400000006317144760122170014212 0ustar00client = $client; } /** * {@inheritdoc} */ protected function doFetch($id) { $result = $this->client->get($id); if ($result === null) { return false; } return unserialize($result); } /** * {@inheritdoc} */ protected function doFetchMultiple(array $keys) { $fetchedItems = call_user_func_array([$this->client, 'mget'], $keys); return array_map('unserialize', array_filter(array_combine($keys, $fetchedItems))); } /** * {@inheritdoc} */ protected function doSaveMultiple(array $keysAndValues, $lifetime = 0) { if ($lifetime) { $success = true; // Keys have lifetime, use SETEX for each of them foreach ($keysAndValues as $key => $value) { $response = (string) $this->client->setex($key, $lifetime, serialize($value)); if ($response == 'OK') { continue; } $success = false; } return $success; } // No lifetime, use MSET $response = $this->client->mset(array_map(function ($value) { return serialize($value); }, $keysAndValues)); return (string) $response == 'OK'; } /** * {@inheritdoc} */ protected function doContains($id) { return (bool) $this->client->exists($id); } /** * {@inheritdoc} */ protected function doSave($id, $data, $lifeTime = 0) { $data = serialize($data); if ($lifeTime > 0) { $response = $this->client->setex($id, $lifeTime, $data); } else { $response = $this->client->set($id, $data); } return $response === true || $response == 'OK'; } /** * {@inheritdoc} */ protected function doDelete($id) { return $this->client->del($id) >= 0; } /** * {@inheritdoc} */ protected function doDeleteMultiple(array $keys) { return $this->client->del($keys) >= 0; } /** * {@inheritdoc} */ protected function doFlush() { $response = $this->client->flushdb(); return $response === true || $response == 'OK'; } /** * {@inheritdoc} */ protected function doGetStats() { $info = $this->client->info(); return [ Cache::STATS_HITS => $info['Stats']['keyspace_hits'], Cache::STATS_MISSES => $info['Stats']['keyspace_misses'], Cache::STATS_UPTIME => $info['Server']['uptime_in_seconds'], Cache::STATS_MEMORY_USAGE => $info['Memory']['used_memory'], Cache::STATS_MEMORY_AVAILABLE => false, ]; } } lib/Doctrine/Common/Cache/RedisCache.php000064400000007423144760122170014031 0ustar00setOption(Redis::OPT_SERIALIZER, $this->getSerializerValue()); $this->redis = $redis; } /** * Gets the redis instance used by the cache. * * @return Redis|null */ public function getRedis() { return $this->redis; } /** * {@inheritdoc} */ protected function doFetch($id) { return $this->redis->get($id); } /** * {@inheritdoc} */ protected function doFetchMultiple(array $keys) { $fetchedItems = array_combine($keys, $this->redis->mget($keys)); // Redis mget returns false for keys that do not exist. So we need to filter those out unless it's the real data. $foundItems = []; foreach ($fetchedItems as $key => $value) { if ($value === false && ! $this->redis->exists($key)) { continue; } $foundItems[$key] = $value; } return $foundItems; } /** * {@inheritdoc} */ protected function doSaveMultiple(array $keysAndValues, $lifetime = 0) { if ($lifetime) { $success = true; // Keys have lifetime, use SETEX for each of them foreach ($keysAndValues as $key => $value) { if ($this->redis->setex($key, $lifetime, $value)) { continue; } $success = false; } return $success; } // No lifetime, use MSET return (bool) $this->redis->mset($keysAndValues); } /** * {@inheritdoc} */ protected function doContains($id) { $exists = $this->redis->exists($id); if (is_bool($exists)) { return $exists; } return $exists > 0; } /** * {@inheritdoc} */ protected function doSave($id, $data, $lifeTime = 0) { if ($lifeTime > 0) { return $this->redis->setex($id, $lifeTime, $data); } return $this->redis->set($id, $data); } /** * {@inheritdoc} */ protected function doDelete($id) { return $this->redis->del($id) >= 0; } /** * {@inheritdoc} */ protected function doDeleteMultiple(array $keys) { return $this->redis->del($keys) >= 0; } /** * {@inheritdoc} */ protected function doFlush() { return $this->redis->flushDB(); } /** * {@inheritdoc} */ protected function doGetStats() { $info = $this->redis->info(); return [ Cache::STATS_HITS => $info['keyspace_hits'], Cache::STATS_MISSES => $info['keyspace_misses'], Cache::STATS_UPTIME => $info['uptime_in_seconds'], Cache::STATS_MEMORY_USAGE => $info['used_memory'], Cache::STATS_MEMORY_AVAILABLE => false, ]; } /** * Returns the serializer constant to use. If Redis is compiled with * igbinary support, that is used. Otherwise the default PHP serializer is * used. * * @return int One of the Redis::SERIALIZER_* constants */ protected function getSerializerValue() { if (defined('Redis::SERIALIZER_IGBINARY') && extension_loaded('igbinary')) { return Redis::SERIALIZER_IGBINARY; } return Redis::SERIALIZER_PHP; } } lib/Doctrine/Common/Cache/RiakCache.php000064400000013163144760122170013647 0ustar00bucket = $bucket; } /** * {@inheritdoc} */ protected function doFetch($id) { try { $response = $this->bucket->get($id); // No objects found if (! $response->hasObject()) { return false; } // Check for attempted siblings $object = ($response->hasSiblings()) ? $this->resolveConflict($id, $response->getVClock(), $response->getObjectList()) : $response->getFirstObject(); // Check for expired object if ($this->isExpired($object)) { $this->bucket->delete($object); return false; } return unserialize($object->getContent()); } catch (Exception\RiakException $e) { // Covers: // - Riak\ConnectionException // - Riak\CommunicationException // - Riak\UnexpectedResponseException // - Riak\NotFoundException } return false; } /** * {@inheritdoc} */ protected function doContains($id) { try { // We only need the HEAD, not the entire object $input = new Input\GetInput(); $input->setReturnHead(true); $response = $this->bucket->get($id, $input); // No objects found if (! $response->hasObject()) { return false; } $object = $response->getFirstObject(); // Check for expired object if ($this->isExpired($object)) { $this->bucket->delete($object); return false; } return true; } catch (Exception\RiakException $e) { // Do nothing } return false; } /** * {@inheritdoc} */ protected function doSave($id, $data, $lifeTime = 0) { try { $object = new RiakObject($id); $object->setContent(serialize($data)); if ($lifeTime > 0) { $object->addMetadata(self::EXPIRES_HEADER, (string) (time() + $lifeTime)); } $this->bucket->put($object); return true; } catch (Exception\RiakException $e) { // Do nothing } return false; } /** * {@inheritdoc} */ protected function doDelete($id) { try { $this->bucket->delete($id); return true; } catch (Exception\BadArgumentsException $e) { // Key did not exist on cluster already } catch (Exception\RiakException $e) { // Covers: // - Riak\Exception\ConnectionException // - Riak\Exception\CommunicationException // - Riak\Exception\UnexpectedResponseException } return false; } /** * {@inheritdoc} */ protected function doFlush() { try { $keyList = $this->bucket->getKeyList(); foreach ($keyList as $key) { $this->bucket->delete($key); } return true; } catch (Exception\RiakException $e) { // Do nothing } return false; } /** * {@inheritdoc} */ protected function doGetStats() { // Only exposed through HTTP stats API, not Protocol Buffers API return null; } /** * Check if a given RiakObject has expired. */ private function isExpired(RiakObject $object) : bool { $metadataMap = $object->getMetadataMap(); return isset($metadataMap[self::EXPIRES_HEADER]) && $metadataMap[self::EXPIRES_HEADER] < time(); } /** * On-read conflict resolution. Applied approach here is last write wins. * Specific needs may override this method to apply alternate conflict resolutions. * * {@internal Riak does not attempt to resolve a write conflict, and store * it as sibling of conflicted one. By following this approach, it is up to * the next read to resolve the conflict. When this happens, your fetched * object will have a list of siblings (read as a list of objects). * In our specific case, we do not care about the intermediate ones since * they are all the same read from storage, and we do apply a last sibling * (last write) wins logic. * If by any means our resolution generates another conflict, it'll up to * next read to properly solve it.} * * @param string $id * @param string $vClock * @param array $objectList * * @return RiakObject */ protected function resolveConflict($id, $vClock, array $objectList) { // Our approach here is last-write wins $winner = $objectList[count($objectList) - 1]; $putInput = new Input\PutInput(); $putInput->setVClock($vClock); $mergedObject = new RiakObject($id); $mergedObject->setContent($winner->getContent()); $this->bucket->put($mergedObject, $putInput); return $mergedObject; } } lib/Doctrine/Common/Cache/SQLite3Cache.php000064400000011043144760122170014200 0ustar00sqlite = $sqlite; $this->table = (string) $table; $this->ensureTableExists(); } private function ensureTableExists() : void { $this->sqlite->exec( sprintf( 'CREATE TABLE IF NOT EXISTS %s(%s TEXT PRIMARY KEY NOT NULL, %s BLOB, %s INTEGER)', $this->table, static::ID_FIELD, static::DATA_FIELD, static::EXPIRATION_FIELD ) ); } /** * {@inheritdoc} */ protected function doFetch($id) { $item = $this->findById($id); if (! $item) { return false; } return unserialize($item[self::DATA_FIELD]); } /** * {@inheritdoc} */ protected function doContains($id) { return $this->findById($id, false) !== null; } /** * {@inheritdoc} */ protected function doSave($id, $data, $lifeTime = 0) { $statement = $this->sqlite->prepare(sprintf( 'INSERT OR REPLACE INTO %s (%s) VALUES (:id, :data, :expire)', $this->table, implode(',', $this->getFields()) )); $statement->bindValue(':id', $id); $statement->bindValue(':data', serialize($data), SQLITE3_BLOB); $statement->bindValue(':expire', $lifeTime > 0 ? time() + $lifeTime : null); return $statement->execute() instanceof SQLite3Result; } /** * {@inheritdoc} */ protected function doDelete($id) { list($idField) = $this->getFields(); $statement = $this->sqlite->prepare(sprintf( 'DELETE FROM %s WHERE %s = :id', $this->table, $idField )); $statement->bindValue(':id', $id); return $statement->execute() instanceof SQLite3Result; } /** * {@inheritdoc} */ protected function doFlush() { return $this->sqlite->exec(sprintf('DELETE FROM %s', $this->table)); } /** * {@inheritdoc} */ protected function doGetStats() { // no-op. } /** * Find a single row by ID. * * @param mixed $id * * @return array|null */ private function findById($id, bool $includeData = true) : ?array { list($idField) = $fields = $this->getFields(); if (! $includeData) { $key = array_search(static::DATA_FIELD, $fields); unset($fields[$key]); } $statement = $this->sqlite->prepare(sprintf( 'SELECT %s FROM %s WHERE %s = :id LIMIT 1', implode(',', $fields), $this->table, $idField )); $statement->bindValue(':id', $id, SQLITE3_TEXT); $item = $statement->execute()->fetchArray(SQLITE3_ASSOC); if ($item === false) { return null; } if ($this->isExpired($item)) { $this->doDelete($id); return null; } return $item; } /** * Gets an array of the fields in our table. * * @return array */ private function getFields() : array { return [static::ID_FIELD, static::DATA_FIELD, static::EXPIRATION_FIELD]; } /** * Check if the item is expired. * * @param array $item */ private function isExpired(array $item) : bool { return isset($item[static::EXPIRATION_FIELD]) && $item[self::EXPIRATION_FIELD] !== null && $item[self::EXPIRATION_FIELD] < time(); } } lib/Doctrine/Common/Cache/Version.php000064400000000137144760122170013457 0ustar00 $info['total_hit_count'], Cache::STATS_MISSES => $info['total_miss_count'], Cache::STATS_UPTIME => $info['total_cache_uptime'], Cache::STATS_MEMORY_USAGE => $meminfo['memory_total'], Cache::STATS_MEMORY_AVAILABLE => $meminfo['memory_free'], ]; } } lib/Doctrine/Common/Cache/XcacheCache.php000064400000004207144760122170014153 0ustar00doContains($id) ? unserialize(xcache_get($id)) : false; } /** * {@inheritdoc} */ protected function doContains($id) { return xcache_isset($id); } /** * {@inheritdoc} */ protected function doSave($id, $data, $lifeTime = 0) { return xcache_set($id, serialize($data), (int) $lifeTime); } /** * {@inheritdoc} */ protected function doDelete($id) { return xcache_unset($id); } /** * {@inheritdoc} */ protected function doFlush() { $this->checkAuthorization(); xcache_clear_cache(XC_TYPE_VAR); return true; } /** * Checks that xcache.admin.enable_auth is Off. * * @return void * * @throws \BadMethodCallException When xcache.admin.enable_auth is On. */ protected function checkAuthorization() { if (ini_get('xcache.admin.enable_auth')) { throw new \BadMethodCallException( 'To use all features of \Doctrine\Common\Cache\XcacheCache, ' . 'you must set "xcache.admin.enable_auth" to "Off" in your php.ini.' ); } } /** * {@inheritdoc} */ protected function doGetStats() { $this->checkAuthorization(); $info = xcache_info(XC_TYPE_VAR, 0); return [ Cache::STATS_HITS => $info['hits'], Cache::STATS_MISSES => $info['misses'], Cache::STATS_UPTIME => null, Cache::STATS_MEMORY_USAGE => $info['size'], Cache::STATS_MEMORY_AVAILABLE => $info['avail'], ]; } } lib/Doctrine/Common/Cache/ZendDataCache.php000064400000002333144760122170014450 0ustar00getNamespace(); if (empty($namespace)) { return zend_shm_cache_clear(); } return zend_shm_cache_clear($namespace); } /** * {@inheritdoc} */ protected function doGetStats() { return null; } }