diff options
Diffstat (limited to 'lib/private/memcache/factory.php')
| -rw-r--r-- | lib/private/memcache/factory.php | 189 |
1 files changed, 0 insertions, 189 deletions
diff --git a/lib/private/memcache/factory.php b/lib/private/memcache/factory.php deleted file mode 100644 index 204ded7d5ab..00000000000 --- a/lib/private/memcache/factory.php +++ /dev/null @@ -1,189 +0,0 @@ -<?php -/** - * @author Andreas Fischer <bantu@owncloud.com> - * @author Lukas Reschke <lukas@owncloud.com> - * @author Markus Goetz <markus@woboq.com> - * @author Morris Jobke <hey@morrisjobke.de> - * @author Robin Appelman <icewind@owncloud.com> - * @author Robin McCorkell <robin@mccorkell.me.uk> - * @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\Memcache; - -use \OCP\ICacheFactory; -use \OCP\ILogger; - -class Factory implements ICacheFactory { - const NULL_CACHE = '\\OC\\Memcache\\NullCache'; - - /** - * @var string $globalPrefix - */ - private $globalPrefix; - - /** - * @var ILogger $logger - */ - private $logger; - - /** - * @var string $localCacheClass - */ - private $localCacheClass; - - /** - * @var string $distributedCacheClass - */ - private $distributedCacheClass; - - /** - * @var string $lockingCacheClass - */ - private $lockingCacheClass; - - /** - * @param string $globalPrefix - * @param ILogger $logger - * @param string|null $localCacheClass - * @param string|null $distributedCacheClass - * @param string|null $lockingCacheClass - */ - public function __construct($globalPrefix, ILogger $logger, - $localCacheClass = null, $distributedCacheClass = null, $lockingCacheClass = null) - { - $this->logger = $logger; - $this->globalPrefix = $globalPrefix; - - if (!$localCacheClass) { - $localCacheClass = self::NULL_CACHE; - } - if (!$distributedCacheClass) { - $distributedCacheClass = $localCacheClass; - } - - $missingCacheMessage = 'Memcache {class} not available for {use} cache'; - $missingCacheHint = 'Is the matching PHP module installed and enabled?'; - if (!$localCacheClass::isAvailable()) { - if (\OC::$CLI && !defined('PHPUNIT_RUN')) { - // CLI should not hard-fail on broken memcache - $this->logger->info($missingCacheMessage, [ - 'class' => $localCacheClass, - 'use' => 'local', - 'app' => 'cli' - ]); - $localCacheClass = self::NULL_CACHE; - } else { - throw new \OC\HintException(strtr($missingCacheMessage, [ - '{class}' => $localCacheClass, '{use}' => 'local' - ]), $missingCacheHint); - } - } - if (!$distributedCacheClass::isAvailable()) { - if (\OC::$CLI && !defined('PHPUNIT_RUN')) { - // CLI should not hard-fail on broken memcache - $this->logger->info($missingCacheMessage, [ - 'class' => $distributedCacheClass, - 'use' => 'distributed', - 'app' => 'cli' - ]); - $distributedCacheClass = self::NULL_CACHE; - } else { - throw new \OC\HintException(strtr($missingCacheMessage, [ - '{class}' => $distributedCacheClass, '{use}' => 'distributed' - ]), $missingCacheHint); - } - } - if (!($lockingCacheClass && $lockingCacheClass::isAvailable())) { - // dont fallback since the fallback might not be suitable for storing lock - $lockingCacheClass = self::NULL_CACHE; - } - - $this->localCacheClass = $localCacheClass; - $this->distributedCacheClass = $distributedCacheClass; - $this->lockingCacheClass = $lockingCacheClass; - } - - /** - * create a cache instance for storing locks - * - * @param string $prefix - * @return \OCP\IMemcache - */ - public function createLocking($prefix = '') { - return new $this->lockingCacheClass($this->globalPrefix . '/' . $prefix); - } - - /** - * create a distributed cache instance - * - * @param string $prefix - * @return \OC\Memcache\Cache - */ - public function createDistributed($prefix = '') { - return new $this->distributedCacheClass($this->globalPrefix . '/' . $prefix); - } - - /** - * create a local cache instance - * - * @param string $prefix - * @return \OC\Memcache\Cache - */ - public function createLocal($prefix = '') { - return new $this->localCacheClass($this->globalPrefix . '/' . $prefix); - } - - /** - * @see \OC\Memcache\Factory::createDistributed() - * @param string $prefix - * @return \OC\Memcache\Cache - */ - public function create($prefix = '') { - return $this->createDistributed($prefix); - } - - /** - * check memcache availability - * - * @return bool - */ - public function isAvailable() { - return ($this->distributedCacheClass !== self::NULL_CACHE); - } - - /** - * @see \OC\Memcache\Factory::createLocal() - * @param string $prefix - * @return Cache - */ - public function createLowLatency($prefix = '') { - return $this->createLocal($prefix); - } - - /** - * check local memcache availability - * - * @return bool - */ - public function isAvailableLowLatency() { - return ($this->localCacheClass !== self::NULL_CACHE); - } -} |