Factory::__construct() - Code Metrics - Inspection of "Merge pull request #25677 from nextcloud/drop/cach..." - nextcloud/server - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 95af96...61f135 )

by Roeland

created 2021-03-09 18:37 UTC

Factory::__construct() C

↳ Parent: Factory

Complexity

Conditions	14
Paths	44

Size

Total Lines	52
Code Lines	35

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	14
eloc	35
nc	44
nop	5
dl	0
loc	52
rs	6.2666
c	0
b	0
f	0

How to fix Long Method Complexity

<?php
/**
 * @copyright Copyright (c) 2016, ownCloud, Inc.
 *
 * @author Christoph Wurst <[email protected]>
 * @author Joas Schilling <[email protected]>
 * @author Lukas Reschke <[email protected]>
 * @author Markus Goetz <[email protected]>
 * @author Morris Jobke <[email protected]>
 * @author Robin Appelman <[email protected]>
 * @author Robin McCorkell <[email protected]>
 * @author Roeland Jago Douma <[email protected]>
 * @author Stefan Weil <[email protected]>
 * @author Vincent Petry <[email protected]>
 *
 * @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\ICache;
use OCP\ICacheFactory;
use OCP\ILogger;
use OCP\IMemcache;

class Factory implements ICacheFactory {
	public const NULL_CACHE = NullCache::class;

	/**
	 * @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(string $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 (!class_exists($localCacheClass) || !$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 (!class_exists($distributedCacheClass) || !$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 && class_exists($distributedCacheClass) && $lockingCacheClass::isAvailable())) {
			// don't 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 IMemcache
	 */
	public function createLocking(string $prefix = ''): IMemcache {
		return new $this->lockingCacheClass($this->globalPrefix . '/' . $prefix);
	}

	/**
	 * create a distributed cache instance
	 *
	 * @param string $prefix
	 * @return ICache
	 */
	public function createDistributed(string $prefix = ''): ICache {
		return new $this->distributedCacheClass($this->globalPrefix . '/' . $prefix);
	}

	/**
	 * create a local cache instance
	 *
	 * @param string $prefix
	 * @return ICache
	 */
	public function createLocal(string $prefix = ''): ICache {
		return new $this->localCacheClass($this->globalPrefix . '/' . $prefix);
	}

	/**
	 * check memcache availability
	 *
	 * @return bool
	 */
	public function isAvailable(): bool {
		return ($this->distributedCacheClass !== self::NULL_CACHE);
	}

	/**
	 * @see \OC\Memcache\Factory::createLocal()
	 * @param string $prefix
	 * @return ICache
	 */
	public function createLowLatency(string $prefix = ''): ICache {
		return $this->createLocal($prefix);
	}

	/**
	 * Check if a local memory cache backend is available
	 *
	 * @return bool
	 */
	public function isLocalCacheAvailable(): bool {
		return ($this->localCacheClass !== self::NULL_CACHE);
	}
}


1			<?php
2			/**
3			* @copyright Copyright (c) 2016, ownCloud, Inc.
4			*
5			* @author Christoph Wurst <[email protected]>
6			* @author Joas Schilling <[email protected]>
7			* @author Lukas Reschke <[email protected]>
8			* @author Markus Goetz <[email protected]>
9			* @author Morris Jobke <[email protected]>
10			* @author Robin Appelman <[email protected]>
11			* @author Robin McCorkell <[email protected]>
12			* @author Roeland Jago Douma <[email protected]>
13			* @author Stefan Weil <[email protected]>
14			* @author Vincent Petry <[email protected]>
15			*
16			* @license AGPL-3.0
17			*
18			* This code is free software: you can redistribute it and/or modify
19			* it under the terms of the GNU Affero General Public License, version 3,
20			* as published by the Free Software Foundation.
21			*
22			* This program is distributed in the hope that it will be useful,
23			* but WITHOUT ANY WARRANTY; without even the implied warranty of
24			* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
25			* GNU Affero General Public License for more details.
26			*
27			* You should have received a copy of the GNU Affero General Public License, version 3,
28			* along with this program. If not, see <http://www.gnu.org/licenses/>
29			*
30			*/
31
32			namespace OC\Memcache;
33
34			use OCP\ICache;
35			use OCP\ICacheFactory;
36			use OCP\ILogger;
37			use OCP\IMemcache;
38
39			class Factory implements ICacheFactory {
40			public const NULL_CACHE = NullCache::class;
41
42			/**
43			* @var string $globalPrefix
44			*/
45			private $globalPrefix;
46
47			/**
48			* @var ILogger $logger
49			*/
50			private $logger;
51
52			/**
53			* @var string $localCacheClass
54			*/
55			private $localCacheClass;
56
57			/**
58			* @var string $distributedCacheClass
59			*/
60			private $distributedCacheClass;
61
62			/**
63			* @var string $lockingCacheClass
64			*/
65			private $lockingCacheClass;
66
67			/**
68			* @param string $globalPrefix
69			* @param ILogger $logger
70			* @param string\|null $localCacheClass
71			* @param string\|null $distributedCacheClass
72			* @param string\|null $lockingCacheClass
73			*/
74			public function __construct(string $globalPrefix, ILogger $logger,
75			$localCacheClass = null, $distributedCacheClass = null, $lockingCacheClass = null) {
76			$this->logger = $logger;
77			$this->globalPrefix = $globalPrefix;
78
79			if (!$localCacheClass) {
80			$localCacheClass = self::NULL_CACHE;
81			}
82			if (!$distributedCacheClass) {
83			$distributedCacheClass = $localCacheClass;
84			}
85
86			$missingCacheMessage = 'Memcache {class} not available for {use} cache';
87			$missingCacheHint = 'Is the matching PHP module installed and enabled?';
88			if (!class_exists($localCacheClass) \|\| !$localCacheClass::isAvailable()) {
89			if (\OC::$CLI && !defined('PHPUNIT_RUN')) {
90			// CLI should not hard-fail on broken memcache
91			$this->logger->info($missingCacheMessage, [
92			'class' => $localCacheClass,
93			'use' => 'local',
94			'app' => 'cli'
95			]);
96			$localCacheClass = self::NULL_CACHE;
97			} else {
98			throw new \OC\HintException(strtr($missingCacheMessage, [
99			'{class}' => $localCacheClass, '{use}' => 'local'
100			]), $missingCacheHint);
101			}
102			}
103			if (!class_exists($distributedCacheClass) \|\| !$distributedCacheClass::isAvailable()) {
104			if (\OC::$CLI && !defined('PHPUNIT_RUN')) {
105			// CLI should not hard-fail on broken memcache
106			$this->logger->info($missingCacheMessage, [
107			'class' => $distributedCacheClass,
108			'use' => 'distributed',
109			'app' => 'cli'
110			]);
111			$distributedCacheClass = self::NULL_CACHE;
112			} else {
113			throw new \OC\HintException(strtr($missingCacheMessage, [
114			'{class}' => $distributedCacheClass, '{use}' => 'distributed'
115			]), $missingCacheHint);
116			}
117			}
118			if (!($lockingCacheClass && class_exists($distributedCacheClass) && $lockingCacheClass::isAvailable())) {
119			// don't fallback since the fallback might not be suitable for storing lock
120			$lockingCacheClass = self::NULL_CACHE;
121			}
122
123			$this->localCacheClass = $localCacheClass;
124			$this->distributedCacheClass = $distributedCacheClass;
125			$this->lockingCacheClass = $lockingCacheClass;
126			}
127
128			/**
129			* create a cache instance for storing locks
130			*
131			* @param string $prefix
132			* @return IMemcache
133			*/
134			public function createLocking(string $prefix = ''): IMemcache {
135			return new $this->lockingCacheClass($this->globalPrefix . '/' . $prefix);
136			}
137
138			/**
139			* create a distributed cache instance
140			*
141			* @param string $prefix
142			* @return ICache
143			*/
144			public function createDistributed(string $prefix = ''): ICache {
145			return new $this->distributedCacheClass($this->globalPrefix . '/' . $prefix);
146			}
147
148			/**
149			* create a local cache instance
150			*
151			* @param string $prefix
152			* @return ICache
153			*/
154			public function createLocal(string $prefix = ''): ICache {
155			return new $this->localCacheClass($this->globalPrefix . '/' . $prefix);
156			}
157
158			/**
159			* check memcache availability
160			*
161			* @return bool
162			*/
163			public function isAvailable(): bool {
164			return ($this->distributedCacheClass !== self::NULL_CACHE);
165			}
166
167			/**
168			* @see \OC\Memcache\Factory::createLocal()
169			* @param string $prefix
170			* @return ICache
171			*/
172			public function createLowLatency(string $prefix = ''): ICache {
173			return $this->createLocal($prefix);
174			}
175
176			/**
177			* Check if a local memory cache backend is available
178			*
179			* @return bool
180			*/
181			public function isLocalCacheAvailable(): bool {
182			return ($this->localCacheClass !== self::NULL_CACHE);
183			}
184			}
185

nextcloud / server

Push — master ( 95af96...61f135 )

Factory::__construct() C

Complexity

Size

Duplication

Importance

How to fix Long Method Complexity

Long Method

Duplication Side-by-Side

Filter issues like