diff options
author | Roeland Jago Douma <rullzer@owncloud.com> | 2016-04-15 09:22:37 +0200 |
---|---|---|
committer | Roeland Jago Douma <rullzer@owncloud.com> | 2016-04-15 09:22:37 +0200 |
commit | d9007ccacf09d6542b81df0a9c3b682fc76a0df2 (patch) | |
tree | a77bc67171615edd8a199256c3f390cd8bb27c64 /lib/private/Cache | |
parent | 3ffe1f2e1a88a43687d82e3eedae2c3bb1939aa7 (diff) | |
download | nextcloud-server-d9007ccacf09d6542b81df0a9c3b682fc76a0df2.tar.gz nextcloud-server-d9007ccacf09d6542b81df0a9c3b682fc76a0df2.zip |
Move \OC\Cache to PSR-4
Diffstat (limited to 'lib/private/Cache')
-rw-r--r-- | lib/private/Cache/CappedMemoryCache.php | 87 | ||||
-rw-r--r-- | lib/private/Cache/File.php | 199 |
2 files changed, 286 insertions, 0 deletions
diff --git a/lib/private/Cache/CappedMemoryCache.php b/lib/private/Cache/CappedMemoryCache.php new file mode 100644 index 00000000000..e3efbf76a23 --- /dev/null +++ b/lib/private/Cache/CappedMemoryCache.php @@ -0,0 +1,87 @@ +<?php +/** + * @author Robin Appelman <icewind@owncloud.com> + * + * @copyright Copyright (c) 2016, ownCloud, Inc. + * @license AGPL-3.0 + * + * This code is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License, version 3, + * as published by the Free Software Foundation. + * + * This program 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 Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License, version 3, + * along with this program. If not, see <http://www.gnu.org/licenses/> + * + */ + +namespace OC\Cache; + +use OCP\ICache; + +/** + * In-memory cache with a capacity limit to keep memory usage in check + * + * Uses a simple FIFO expiry mechanism + */ +class CappedMemoryCache implements ICache, \ArrayAccess { + + private $capacity; + private $cache = []; + + public function __construct($capacity = 512) { + $this->capacity = $capacity; + } + + public function hasKey($key) { + return isset($this->cache[$key]); + } + + public function get($key) { + return isset($this->cache[$key]) ? $this->cache[$key] : null; + } + + public function set($key, $value, $ttl = 0) { + $this->cache[$key] = $value; + $this->garbageCollect(); + } + + public function remove($key) { + unset($this->cache[$key]); + return true; + } + + public function clear($prefix = '') { + $this->cache = []; + return true; + } + + public function offsetExists($offset) { + return $this->hasKey($offset); + } + + public function &offsetGet($offset) { + return $this->cache[$offset]; + } + + public function offsetSet($offset, $value) { + $this->set($offset, $value); + } + + public function offsetUnset($offset) { + $this->remove($offset); + } + + + private function garbageCollect() { + while (count($this->cache) > $this->capacity) { + reset($this->cache); + $key = key($this->cache); + $this->remove($key); + } + } +} diff --git a/lib/private/Cache/File.php b/lib/private/Cache/File.php new file mode 100644 index 00000000000..989e05275b7 --- /dev/null +++ b/lib/private/Cache/File.php @@ -0,0 +1,199 @@ +<?php +/** + * @author Joas Schilling <nickvergessen@owncloud.com> + * @author Lukas Reschke <lukas@owncloud.com> + * @author Roeland Jago Douma <rullzer@owncloud.com> + * @author Thomas Müller <thomas.mueller@tmit.eu> + * @author Vincent Petry <pvince81@owncloud.com> + * + * @copyright Copyright (c) 2016, ownCloud, Inc. + * @license AGPL-3.0 + * + * This code is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License, version 3, + * as published by the Free Software Foundation. + * + * This program 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 Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License, version 3, + * along with this program. If not, see <http://www.gnu.org/licenses/> + * + */ + +namespace OC\Cache; + +use OC\Files\Filesystem; +use OC\Files\View; +use OCP\ICache; +use OCP\Security\ISecureRandom; + +class File implements ICache { + + /** @var View */ + protected $storage; + + /** + * Returns the cache storage for the logged in user + * + * @return \OC\Files\View cache storage + * @throws \OC\ForbiddenException + * @throws \OC\User\NoUserException + */ + protected function getStorage() { + if (isset($this->storage)) { + return $this->storage; + } + if (\OC_User::isLoggedIn()) { + $rootView = new View(); + $user = \OC::$server->getUserSession()->getUser(); + Filesystem::initMountPoints($user->getUID()); + if (!$rootView->file_exists('/' . $user->getUID() . '/cache')) { + $rootView->mkdir('/' . $user->getUID() . '/cache'); + } + $this->storage = new View('/' . $user->getUID() . '/cache'); + return $this->storage; + } else { + \OCP\Util::writeLog('core', 'Can\'t get cache storage, user not logged in', \OCP\Util::ERROR); + throw new \OC\ForbiddenException('Can\t get cache storage, user not logged in'); + } + } + + /** + * @param string $key + * @return mixed|null + * @throws \OC\ForbiddenException + */ + public function get($key) { + $result = null; + if ($this->hasKey($key)) { + $storage = $this->getStorage(); + $result = $storage->file_get_contents($key); + } + return $result; + } + + /** + * Returns the size of the stored/cached data + * + * @param string $key + * @return int + */ + public function size($key) { + $result = 0; + if ($this->hasKey($key)) { + $storage = $this->getStorage(); + $result = $storage->filesize($key); + } + return $result; + } + + /** + * @param string $key + * @param mixed $value + * @param int $ttl + * @return bool|mixed + * @throws \OC\ForbiddenException + */ + public function set($key, $value, $ttl = 0) { + $storage = $this->getStorage(); + $result = false; + // unique id to avoid chunk collision, just in case + $uniqueId = \OC::$server->getSecureRandom()->generate( + 16, + ISecureRandom::CHAR_DIGITS . ISecureRandom::CHAR_LOWER . ISecureRandom::CHAR_UPPER + ); + + // use part file to prevent hasKey() to find the key + // while it is being written + $keyPart = $key . '.' . $uniqueId . '.part'; + if ($storage and $storage->file_put_contents($keyPart, $value)) { + if ($ttl === 0) { + $ttl = 86400; // 60*60*24 + } + $result = $storage->touch($keyPart, time() + $ttl); + $result &= $storage->rename($keyPart, $key); + } + return $result; + } + + /** + * @param string $key + * @return bool + * @throws \OC\ForbiddenException + */ + public function hasKey($key) { + $storage = $this->getStorage(); + if ($storage && $storage->is_file($key) && $storage->isReadable($key)) { + return true; + } + return false; + } + + /** + * @param string $key + * @return bool|mixed + * @throws \OC\ForbiddenException + */ + public function remove($key) { + $storage = $this->getStorage(); + if (!$storage) { + return false; + } + return $storage->unlink($key); + } + + /** + * @param string $prefix + * @return bool + * @throws \OC\ForbiddenException + */ + public function clear($prefix = '') { + $storage = $this->getStorage(); + if ($storage and $storage->is_dir('/')) { + $dh = $storage->opendir('/'); + if (is_resource($dh)) { + while (($file = readdir($dh)) !== false) { + if ($file != '.' and $file != '..' and ($prefix === '' || strpos($file, $prefix) === 0)) { + $storage->unlink('/' . $file); + } + } + } + } + return true; + } + + /** + * Runs GC + * @throws \OC\ForbiddenException + */ + public function gc() { + $storage = $this->getStorage(); + if ($storage and $storage->is_dir('/')) { + $now = time(); + $dh = $storage->opendir('/'); + if (!is_resource($dh)) { + return null; + } + while (($file = readdir($dh)) !== false) { + if ($file != '.' and $file != '..') { + try { + $mtime = $storage->filemtime('/' . $file); + if ($mtime < $now) { + $storage->unlink('/' . $file); + } + } catch (\OCP\Lock\LockedException $e) { + // ignore locked chunks + \OC::$server->getLogger()->debug('Could not cleanup locked chunk "' . $file . '"', array('app' => 'core')); + } catch (\OCP\Files\ForbiddenException $e) { + \OC::$server->getLogger()->debug('Could not cleanup forbidden chunk "' . $file . '"', array('app' => 'core')); + } catch (\OCP\Files\LockNotAcquiredException $e) { + \OC::$server->getLogger()->debug('Could not cleanup locked chunk "' . $file . '"', array('app' => 'core')); + } + } + } + } + } +} |