SettingsManager - Code Metrics - Inspection of "Add authentication admin settings section for user..." - owncloud/core - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( f6005e...7ab4f4 )

by Thomas

created 2017-03-06 10:47 UTC

SettingsManager D

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	360
Duplicated Lines	5 %

Coupling/Cohesion

Components	1
Dependencies	25

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	18
loc	360
rs	4.6
wmc	34
lcom	1
cbo	25

14 Methods

Rating	Name	Duplication	Size	Complexity
B	__construct()	0	27	1
A	getPersonalSections()	0	5	1
A	getAdminSections()	0	5	1
A	getPersonalPanels()	9	9	2
A	getAdminPanels()	9	9	2
A	getPanelsList()	0	5	3
A	findRegisteredPanels()	0	11	4
B	loadPanel()	0	22	4
B	loadPanels()	0	31	6
A	loadSection()	0	12	3
A	sortOrder()	0	8	1
B	getBuiltInSections()	0	24	3
B	getBuiltInPanels()	0	25	1
B	getBuiltInPanel()	0	39	2

How to fix Duplicated Code

<?php
/**
 * @author Tom Needham <[email protected]>
 *
 * @copyright Copyright (c) 2017, ownCloud GmbH
 * @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\Settings;

use OC\Security\CertificateManager;
use OC\Settings\Panels\Admin\Apps;
use OC\Settings\Panels\Helper;
use OCP\App\IAppManager;
use OCP\IDBConnection;
use OCP\L10N\IFactory;
use OCP\Lock\ILockingProvider;
use OCP\Settings\ISettingsManager;
use OCP\Settings\ISection;
use OCP\Settings\ISettings;
use OCP\ILogger;
use OCP\IL10N;
use OCP\IUserSession;
use OCP\AppFramework\QueryException;
use OCP\IConfig;
use OCP\IGroupManager;
use OCP\Defaults;
use OCP\IURLGenerator;

use OC\Settings\Panels\Personal\Profile;
use OC\Settings\Panels\Personal\Legacy as LegacyPersonal;
use OC\Settings\Panels\Admin\Legacy as LegacyAdmin;
use OC\Settings\Panels\Personal\Clients;
use OC\Settings\Panels\Personal\Version;
use OC\Settings\Panels\Personal\Tokens;
use OC\Settings\Panels\Personal\Quota;
use OC\Settings\Panels\Admin\BackgroundJobs;
use OC\Settings\Panels\Admin\Certificates;
use OC\Settings\Panels\Admin\Encryption;
use OC\Settings\Panels\Admin\FileSharing;
use OC\Settings\Panels\Admin\Mail;
use OC\Settings\Panels\Admin\Logging;
use OC\Settings\Panels\Admin\SecurityWarning;
use OC\Settings\Panels\Admin\Updater;
use OC\Settings\Panels\Admin\Tips;
use OC\Settings\Panels\Admin\Status;

/*
 * @since 10.0
 */
class SettingsManager implements ISettingsManager {

	/** @var IL10N */
	protected $l;
	/** @var IAppManager */
	protected $appManager;
	/** @var ILogger */
	protected $logger;
	/** @var IURLGenerator */
	protected $urlGenerator;
	/** @var Defaults  */
	protected $defaults;
	/** @var IUserSession  */
	protected $userSession;
	/** @var ILogger  */
	protected $log;
	/** @var IConfig  */
	protected $config;
	/** @var IGroupManager  */
	protected $groupManager;
	/** @var Helper */
	protected $helper;
	/** @var IFactory  */
	protected $lfactory;
	/** @var IDBConnection  */
	protected $dbconnection;
	/** @var ILockingProvider  */
	protected $lockingProvider;
	/** @var CertificateManager  */
	protected $certificateManager;

	/**
	 * Holds a cache of ISettings with keys for type
	 */
	protected $panels = [];

	/**
	 * Holds an array of sections
	 */
	protected $sections = [];

	/**
	 * @param IL10N $l
	 * @param IAppManager $appManager
	 * @param IUserSession $userSession
	 * @param ILogger $logger
	 * @param IGroupManager $groupManager
	 * @param IConfig $config
	 * @param Defaults $defaults
	 * @param IURLGenerator $urlGenerator
	 * @param Helper $helper
	 * @param ILockingProvider $lockingProvider
	 * @param IDBConnection $dbconnection
	 * @param CertificateManager $certificateManager
	 * @param IFactory $lfactory
	 */
	public function __construct(IL10N $l,
								IAppManager $appManager,
								IUserSession $userSession,
								ILogger $logger,
								IGroupManager $groupManager,
								IConfig $config,
								Defaults $defaults,
								IURLGenerator $urlGenerator,
								Helper $helper,
								ILockingProvider $lockingProvider,
								IDBConnection $dbconnection,
								$certificateManager,
								IFactory $lfactory) {
		$this->l = $l;
		$this->appManager = $appManager;
		$this->userSession = $userSession;
		$this->config = $config;
		$this->groupManager = $groupManager;
		$this->log = $logger;
		$this->defaults = $defaults;
		$this->urlGenerator = $urlGenerator;
		$this->helper = $helper;
		$this->lockingProvider = $lockingProvider;
		$this->dbconnection = $dbconnection;
		$this->certificateManager = $certificateManager;
		$this->lfactory = $lfactory;
	}

	public function getPersonalSections() {
		// Trigger a load of all personal panels to discover sections
		$this->loadPanels('personal');
		return $this->sections['personal'];
	}

	public function getAdminSections() {
		// Trigger a load of all admin panels to discover sections
		$this->loadPanels('admin');
		return $this->sections['admin'];
	}

	/**
	 * Returns ISettings for the personal settings in the given section
	 * @param string $sectionID
	 * @return array of ISection
	 */
	public function getPersonalPanels($sectionID) {
		// Trigger a load of all personal panels to discover sections
		$this->loadPanels('personal');
		if(isset($this->panels['personal'][$sectionID])) {
			return $this->panels['personal'][$sectionID];
		} else {
			return [];
		}
	}

	/**
	 * Returns ISettings for the admin settings in the given section
	 * @param string $sectionID
	 * @return array of ISection
	 */
	public function getAdminPanels($sectionID) {
		// Trigger a load of all admin panels to discover sections
		$this->loadPanels('admin');
		if(isset($this->panels['admin'][$sectionID])) {
			return $this->panels['admin'][$sectionID];
		} else {
			return [];
		}
	}

	/**
	 * Returns the default set of ISections used in core
	 * @param string $type the type of sections to return
	 * @return array of ISection
	 */
	private function getBuiltInSections($type) {
		if($type === 'admin') {
			return [
				new Section('general', $this->l->t('General'), 100),
				new Section('storage', $this->l->t('Storage'), 95, 'folder'),
				new Section('security', $this->l->t('Security'), 90, 'password'),
				new Section('authentication', $this->l->t('Authentication'), 87, 'user'),
				new Section('encryption', $this->l->t('Encryption'), 85, 'password'),
				new Section('sharing', $this->l->t('Sharing'), 80, 'share'),
				new Section('monitoring', $this->l->t('Monitoring'), 75, 'search'),
				new Section('apps', $this->l->t('Apps'), 70, 'list'),
				new Section('updates', $this->l->t('Updates'), 20, 'update'),
				new Section('additional', $this->l->t('Additional'), -10, 'more'),
			];
		} else if($type === 'personal') {
			return [
				new Section('general', $this->l->t('General'), 100, 'user'),
				new Section('storage', $this->l->t('Storage'), 50, 'folder'),
				new Section('security', $this->l->t('Security'), 30, 'password'),
				new Section('encryption', $this->l->t('Encryption'), 20),
				new Section('additional', $this->l->t('Additional'), 5, 'more'),
			];
		}
	}

	/**
	 * Returns an array of classnames for built in settings panels
	 * @return array of strings
	 */
	private function getBuiltInPanels() {
		return [
			'personal' => [
				Profile::class,
				Clients::class,
				LegacyPersonal::class,
				Version::class,
				Tokens::class,
				Quota::class,
			],
			'admin' => [
				LegacyAdmin::class,
				BackgroundJobs::class,
				Logging::class,
				Tips::class,
				SecurityWarning::class,
				Mail::class,
				FileSharing::class,
				Encryption::class,
				Certificates::class,
				Apps::class,
				Status::class
			]
		];
	}

	/**
	 * Gets panel objects with dependencies instantiated from the container
	 * @param string $className
	 * @return array|false
	 */
	public function getBuiltInPanel($className) {
		$panels = [
			// Personal
			Profile::class => new Profile(
				$this->config,
				$this->groupManager,
				$this->userSession,
				$this->lfactory),
			LegacyPersonal::class => new LegacyPersonal($this->helper),
			Clients::class => new Clients($this->config, $this->defaults),
			Version::class => new Version(),
			Tokens::class => new Tokens(),
			Quota::class => new Quota($this->helper),
			// Admin
			BackgroundJobs::class => new BackgroundJobs($this->config),
			Certificates::class => new Certificates(
				$this->config,
				$this->urlGenerator,
				$this->certificateManager),
			Encryption::class => new Encryption(),
			FileSharing::class => new FileSharing($this->config, $this->helper),
			Logging::class => new Logging($this->config, $this->urlGenerator, $this->helper),
			Mail::class => new Mail($this->config, $this->helper),
			SecurityWarning::class => new SecurityWarning(
				$this->l,
				$this->config,
				$this->dbconnection,
				$this->helper,
				$this->lockingProvider),
			Tips::class => new Tips(),
			LegacyAdmin::class => new LegacyAdmin($this->helper),
			Apps::class => new Apps($this->config)
		];
		if(isset($panels[$className])) {
			return $panels[$className];
		} else {
			return false;
		}
	}

	/**
	 * Gets all the panels for ownCloud
	 * @param string $type the type of sections to return
	 * @return array of strings
	 */
	public function getPanelsList($type) {
		$registered = isset($this->findRegisteredPanels()[$type]) ? $this->findRegisteredPanels()[$type] : [];
		$builtIn = isset($this->getBuiltInPanels()[$type]) ? $this->getBuiltInPanels()[$type] : [];
		return array_merge($registered, $builtIn);
	}


	/**
	 * Searches through the currently enabled apps and returns the panels registered
	 * @return array of strings
	 */
	protected function findRegisteredPanels() {
		$panels = [];
		foreach($this->appManager->getEnabledAppsForUser($this->userSession->getUser()) as $app) {
/** @return stdClass|null */
function mayReturnNull() { }

function doesNotAcceptNull(stdClass $x) { }

// With potential error.
function withoutCheck() {
    $x = mayReturnNull();
    doesNotAcceptNull($x); // Potential error here.
}

// Safe - Alternative 1
function withCheck1() {
    $x = mayReturnNull();
    if ( ! $x instanceof stdClass) {
        throw new \LogicException('$x must be defined.');
    }
    doesNotAcceptNull($x);
}

// Safe - Alternative 2
function withCheck2() {
    $x = mayReturnNull();
    if ($x instanceof stdClass) {
        doesNotAcceptNull($x);
    }
}
			if(isset($this->appManager->getAppInfo($app)['settings'])) {
				foreach($this->appManager->getAppInfo($app)['settings'] as $type => $panel) {
					$panels[$type][] = (string) $panel;
				}
			}
		}
		return $panels;
	}

	/**
	 * Attempts to load a ISettings using the class name
	 * @param string $className
	 * @throws QueryException
	 * @return ISettings
	 */
	protected function loadPanel($className) {
		try {
			if(!$panel = $this->getBuiltInPanel($className)) {
				$panel = \OC::$server->query($className);
			}
			if(!$panel instanceof ISettings) {
				$this->log->error(
					'Class: {class} not an instance of OCP\Settings\ISettings',
					['class' => $className]);
			} else {
				return $panel;
			}
		} catch (QueryException $e) {
			$this->log->error(
				'Failed to load panel: {class} with error: {error}',
				[
					'class' => $className,
					'error' => $e->getMessage()
				]);
			throw $e;
		}
	}

	/**
	 * Find and return ISettings for the given type
	 * @param string $type of panels to load
	 * @return array of ISettings
	 */
	public function loadPanels($type) {
		// If already loaded just return
		if(!empty($this->panels[$type])) {
			return $this->panels[$type];
		}
		// Find the panels from info xml
		$panels = $this->getPanelsList($type);
		// Load the classes using the server container
		if(empty($panels)) {
			return [];
		}
		foreach($panels as $panelClassName) {
			// Attempt to load the panel
			try {
				$panel = $this->loadPanel($panelClassName);
				$section = $this->loadSection($type, $panel->getSectionID());
				$this->panels[$type][$section->getID()][] = $panel;
				$this->sections[$type][$section->getID()] = $section;
				// Now try and initialise the ISection from the panel
			} catch (QueryException $e) {
				// Just skip this panel, either its section of panel could not be loaded
			}
		}
		// Return the panel array sorted
		foreach($this->panels[$type] as $sectionID => $section) {
			$this->panels[$type][$sectionID] = $this->sortOrder($this->panels[$type][$sectionID]);
		}
		// sort section array
		$this->sections[$type] = $this->sortOrder($this->sections[$type]);
		return $this->panels[$type];
	}

	/**
	 * Return the section object for the corresponding type and sectionID
	 * @param string $type
	 * @param string $sectionID
	 * @throws QueryException
	 * @return ISection
	 */
	protected function loadSection($type, $sectionID) {
		// Load sections from default list
		foreach($this->getBuiltInSections($type) as $section) {
$collection = json_decode($data, true);
if ( ! is_array($collection)) {
    throw new \RuntimeException('$collection must be an array.');
}

foreach ($collection as $item) { /** ... */ }
			if($section->getID() === $sectionID) {
				return $section;
			}
		}
		$this->log->error(
			'Failed to load section with id: {id}',
			['id' => $sectionID]);
		return new Section($sectionID, ucfirst($sectionID), -9);
	}

	/**
	 * Sort the array of ISettings or ISections by their priority attribute
	 * @param array $objects (ISections of ISettings)
	 * @return array
	 */
	protected function sortOrder($objects) {
		usort($objects, function($a, $b) {
			/** @var ISection | ISettings $a */
			/** @var ISection | ISettings $b */
			return $a->getPriority() < $b->getPriority();
		});
		return $objects;
	}

}


1		<?php
2		/**
3		* @author Tom Needham <[email protected]>
4		*
5		* @copyright Copyright (c) 2017, ownCloud GmbH
6		* @license AGPL-3.0
7		*
8		* This code is free software: you can redistribute it and/or modify
9		* it under the terms of the GNU Affero General Public License, version 3,
10		* as published by the Free Software Foundation.
11		*
12		* This program is distributed in the hope that it will be useful,
13		* but WITHOUT ANY WARRANTY; without even the implied warranty of
14		* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15		* GNU Affero General Public License for more details.
16		*
17		* You should have received a copy of the GNU Affero General Public License, version 3,
18		* along with this program. If not, see <http://www.gnu.org/licenses/>
19		*
20		*/
21
22		namespace OC\Settings;
23
24		use OC\Security\CertificateManager;
25		use OC\Settings\Panels\Admin\Apps;
26		use OC\Settings\Panels\Helper;
27		use OCP\App\IAppManager;
28		use OCP\IDBConnection;
29		use OCP\L10N\IFactory;
30		use OCP\Lock\ILockingProvider;
31		use OCP\Settings\ISettingsManager;
32		use OCP\Settings\ISection;
33		use OCP\Settings\ISettings;
34		use OCP\ILogger;
35		use OCP\IL10N;
36		use OCP\IUserSession;
37		use OCP\AppFramework\QueryException;
38		use OCP\IConfig;
39		use OCP\IGroupManager;
40		use OCP\Defaults;
41		use OCP\IURLGenerator;
42
43		use OC\Settings\Panels\Personal\Profile;
44		use OC\Settings\Panels\Personal\Legacy as LegacyPersonal;
45		use OC\Settings\Panels\Admin\Legacy as LegacyAdmin;
46		use OC\Settings\Panels\Personal\Clients;
47		use OC\Settings\Panels\Personal\Version;
48		use OC\Settings\Panels\Personal\Tokens;
49		use OC\Settings\Panels\Personal\Quota;
50		use OC\Settings\Panels\Admin\BackgroundJobs;
51		use OC\Settings\Panels\Admin\Certificates;
52		use OC\Settings\Panels\Admin\Encryption;
53		use OC\Settings\Panels\Admin\FileSharing;
54		use OC\Settings\Panels\Admin\Mail;
55		use OC\Settings\Panels\Admin\Logging;
56		use OC\Settings\Panels\Admin\SecurityWarning;
57		use OC\Settings\Panels\Admin\Updater;
58		use OC\Settings\Panels\Admin\Tips;
59		use OC\Settings\Panels\Admin\Status;
60
61		/*
62		* @since 10.0
63		*/
64		class SettingsManager implements ISettingsManager {
65
66		/** @var IL10N */
67		protected $l;
68		/** @var IAppManager */
69		protected $appManager;
70		/** @var ILogger */
71		protected $logger;
72		/** @var IURLGenerator */
73		protected $urlGenerator;
74		/** @var Defaults */
75		protected $defaults;
76		/** @var IUserSession */
77		protected $userSession;
78		/** @var ILogger */
79		protected $log;
80		/** @var IConfig */
81		protected $config;
82		/** @var IGroupManager */
83		protected $groupManager;
84		/** @var Helper */
85		protected $helper;
86		/** @var IFactory */
87		protected $lfactory;
88		/** @var IDBConnection */
89		protected $dbconnection;
90		/** @var ILockingProvider */
91		protected $lockingProvider;
92		/** @var CertificateManager */
93		protected $certificateManager;
94
95		/**
96		* Holds a cache of ISettings with keys for type
97		*/
98		protected $panels = [];
99
100		/**
101		* Holds an array of sections
102		*/
103		protected $sections = [];
104
105		/**
106		* @param IL10N $l
107		* @param IAppManager $appManager
108		* @param IUserSession $userSession
109		* @param ILogger $logger
110		* @param IGroupManager $groupManager
111		* @param IConfig $config
112		* @param Defaults $defaults
113		* @param IURLGenerator $urlGenerator
114		* @param Helper $helper
115		* @param ILockingProvider $lockingProvider
116		* @param IDBConnection $dbconnection
117		* @param CertificateManager $certificateManager
118		* @param IFactory $lfactory
119		*/
120		public function __construct(IL10N $l,
121		IAppManager $appManager,
122		IUserSession $userSession,
123		ILogger $logger,
124		IGroupManager $groupManager,
125		IConfig $config,
126		Defaults $defaults,
127		IURLGenerator $urlGenerator,
128		Helper $helper,
129		ILockingProvider $lockingProvider,
130		IDBConnection $dbconnection,
131		$certificateManager,
132		IFactory $lfactory) {
133		$this->l = $l;
134		$this->appManager = $appManager;
135		$this->userSession = $userSession;
136		$this->config = $config;
137		$this->groupManager = $groupManager;
138		$this->log = $logger;
139		$this->defaults = $defaults;
140		$this->urlGenerator = $urlGenerator;
141		$this->helper = $helper;
142		$this->lockingProvider = $lockingProvider;
143		$this->dbconnection = $dbconnection;
144		$this->certificateManager = $certificateManager;
145		$this->lfactory = $lfactory;
146		}
147
148		public function getPersonalSections() {
149		// Trigger a load of all personal panels to discover sections
150		$this->loadPanels('personal');
151		return $this->sections['personal'];
152		}
153
154		public function getAdminSections() {
155		// Trigger a load of all admin panels to discover sections
156		$this->loadPanels('admin');
157		return $this->sections['admin'];
158		}
159
160		/**
161		* Returns ISettings for the personal settings in the given section
162		* @param string $sectionID
163		* @return array of ISection
164		*/
165	View Code Duplication	public function getPersonalPanels($sectionID) {
166		// Trigger a load of all personal panels to discover sections
167		$this->loadPanels('personal');
168		if(isset($this->panels['personal'][$sectionID])) {
169		return $this->panels['personal'][$sectionID];
170		} else {
171		return [];
172		}
173		}
174
175		/**
176		* Returns ISettings for the admin settings in the given section
177		* @param string $sectionID
178		* @return array of ISection
179		*/
180	View Code Duplication	public function getAdminPanels($sectionID) {
181		// Trigger a load of all admin panels to discover sections
182		$this->loadPanels('admin');
183		if(isset($this->panels['admin'][$sectionID])) {
184		return $this->panels['admin'][$sectionID];
185		} else {
186		return [];
187		}
188		}
189
190		/**
191		* Returns the default set of ISections used in core
192		* @param string $type the type of sections to return
193		* @return array of ISection
194		*/
195		private function getBuiltInSections($type) {
196		if($type === 'admin') {
197		return [
198		new Section('general', $this->l->t('General'), 100),
199		new Section('storage', $this->l->t('Storage'), 95, 'folder'),
200		new Section('security', $this->l->t('Security'), 90, 'password'),
201		new Section('authentication', $this->l->t('Authentication'), 87, 'user'),
202		new Section('encryption', $this->l->t('Encryption'), 85, 'password'),
203		new Section('sharing', $this->l->t('Sharing'), 80, 'share'),
204		new Section('monitoring', $this->l->t('Monitoring'), 75, 'search'),
205		new Section('apps', $this->l->t('Apps'), 70, 'list'),
206		new Section('updates', $this->l->t('Updates'), 20, 'update'),
207		new Section('additional', $this->l->t('Additional'), -10, 'more'),
208		];
209		} else if($type === 'personal') {
210		return [
211		new Section('general', $this->l->t('General'), 100, 'user'),
212		new Section('storage', $this->l->t('Storage'), 50, 'folder'),
213		new Section('security', $this->l->t('Security'), 30, 'password'),
214		new Section('encryption', $this->l->t('Encryption'), 20),
215		new Section('additional', $this->l->t('Additional'), 5, 'more'),
216		];
217		}
218		}
219
220		/**
221		* Returns an array of classnames for built in settings panels
222		* @return array of strings
223		*/
224		private function getBuiltInPanels() {
225		return [
226		'personal' => [
227		Profile::class,
228		Clients::class,
229		LegacyPersonal::class,
230		Version::class,
231		Tokens::class,
232		Quota::class,
233		],
234		'admin' => [
235		LegacyAdmin::class,
236		BackgroundJobs::class,
237		Logging::class,
238		Tips::class,
239		SecurityWarning::class,
240		Mail::class,
241		FileSharing::class,
242		Encryption::class,
243		Certificates::class,
244		Apps::class,
245		Status::class
246		]
247		];
248		}
249
250		/**
251		* Gets panel objects with dependencies instantiated from the container
252		* @param string $className
253		* @return array\|false
254		*/
255		public function getBuiltInPanel($className) {
256		$panels = [
257		// Personal
258		Profile::class => new Profile(
259		$this->config,
260		$this->groupManager,
261		$this->userSession,
262		$this->lfactory),
263		LegacyPersonal::class => new LegacyPersonal($this->helper),
264		Clients::class => new Clients($this->config, $this->defaults),
265		Version::class => new Version(),
266		Tokens::class => new Tokens(),
267		Quota::class => new Quota($this->helper),
268		// Admin
269		BackgroundJobs::class => new BackgroundJobs($this->config),
270		Certificates::class => new Certificates(
271		$this->config,
272		$this->urlGenerator,
273		$this->certificateManager),
274		Encryption::class => new Encryption(),
275		FileSharing::class => new FileSharing($this->config, $this->helper),
276		Logging::class => new Logging($this->config, $this->urlGenerator, $this->helper),
277		Mail::class => new Mail($this->config, $this->helper),
278		SecurityWarning::class => new SecurityWarning(
279		$this->l,
280		$this->config,
281		$this->dbconnection,
282		$this->helper,
283		$this->lockingProvider),
284		Tips::class => new Tips(),
285		LegacyAdmin::class => new LegacyAdmin($this->helper),
286		Apps::class => new Apps($this->config)
287		];
288		if(isset($panels[$className])) {
289		return $panels[$className];
290		} else {
291		return false;
292		}
293		}
294
295		/**
296		* Gets all the panels for ownCloud
297		* @param string $type the type of sections to return
298		* @return array of strings
299		*/
300		public function getPanelsList($type) {
301		$registered = isset($this->findRegisteredPanels()[$type]) ? $this->findRegisteredPanels()[$type] : [];
302		$builtIn = isset($this->getBuiltInPanels()[$type]) ? $this->getBuiltInPanels()[$type] : [];
303		return array_merge($registered, $builtIn);
304		}
305
306
307		/**
308		* Searches through the currently enabled apps and returns the panels registered
309		* @return array of strings
310		*/
311		protected function findRegisteredPanels() {
312		$panels = [];
313		foreach($this->appManager->getEnabledAppsForUser($this->userSession->getUser()) as $app) {
		0 ignored issues – show Bug introduced 2016-12-02 12:52 UTC by Report Bug Copy Issue Report It seems like `$this->userSession->getUser()` can be `null`; however, `getEnabledAppsForUser()` does not accept `null`, maybe add an additional type check? Unless you are absolutely sure that the expression can never be null because of other conditions, we strongly recommend to add an additional type check to your code: /** @return stdClass\|null */ function mayReturnNull() { } function doesNotAcceptNull(stdClass $x) { } // With potential error. function withoutCheck() { $x = mayReturnNull(); doesNotAcceptNull($x); // Potential error here. } // Safe - Alternative 1 function withCheck1() { $x = mayReturnNull(); if ( ! $x instanceof stdClass) { throw new \LogicException('$x must be defined.'); } doesNotAcceptNull($x); } // Safe - Alternative 2 function withCheck2() { $x = mayReturnNull(); if ($x instanceof stdClass) { doesNotAcceptNull($x); } } Loading history...
314		if(isset($this->appManager->getAppInfo($app)['settings'])) {
315		foreach($this->appManager->getAppInfo($app)['settings'] as $type => $panel) {
316		$panels[$type][] = (string) $panel;
317		}
318		}
319		}
320		return $panels;
321		}
322
323		/**
324		* Attempts to load a ISettings using the class name
325		* @param string $className
326		* @throws QueryException
327		* @return ISettings
328		*/
329		protected function loadPanel($className) {
330		try {
331		if(!$panel = $this->getBuiltInPanel($className)) {
332		$panel = \OC::$server->query($className);
333		}
334		if(!$panel instanceof ISettings) {
335		$this->log->error(
336		'Class: {class} not an instance of OCP\Settings\ISettings',
337		['class' => $className]);
338		} else {
339		return $panel;
340		}
341		} catch (QueryException $e) {
342		$this->log->error(
343		'Failed to load panel: {class} with error: {error}',
344		[
345		'class' => $className,
346		'error' => $e->getMessage()
347		]);
348		throw $e;
349		}
350		}
351
352		/**
353		* Find and return ISettings for the given type
354		* @param string $type of panels to load
355		* @return array of ISettings
356		*/
357		public function loadPanels($type) {
358		// If already loaded just return
359		if(!empty($this->panels[$type])) {
360		return $this->panels[$type];
361		}
362		// Find the panels from info xml
363		$panels = $this->getPanelsList($type);
364		// Load the classes using the server container
365		if(empty($panels)) {
366		return [];
367		}
368		foreach($panels as $panelClassName) {
369		// Attempt to load the panel
370		try {
371		$panel = $this->loadPanel($panelClassName);
372		$section = $this->loadSection($type, $panel->getSectionID());
373		$this->panels[$type][$section->getID()][] = $panel;
374		$this->sections[$type][$section->getID()] = $section;
375		// Now try and initialise the ISection from the panel
376		} catch (QueryException $e) {
377		// Just skip this panel, either its section of panel could not be loaded
378		}
379		}
380		// Return the panel array sorted
381		foreach($this->panels[$type] as $sectionID => $section) {
382		$this->panels[$type][$sectionID] = $this->sortOrder($this->panels[$type][$sectionID]);
383		}
384		// sort section array
385		$this->sections[$type] = $this->sortOrder($this->sections[$type]);
386		return $this->panels[$type];
387		}
388
389		/**
390		* Return the section object for the corresponding type and sectionID
391		* @param string $type
392		* @param string $sectionID
393		* @throws QueryException
394		* @return ISection
395		*/
396		protected function loadSection($type, $sectionID) {
397		// Load sections from default list
398		foreach($this->getBuiltInSections($type) as $section) {
		0 ignored issues – show Bug introduced 2016-12-09 21:10 UTC by Report Bug Copy Issue Report The expression `$this->getBuiltInSections($type)` of type `array<integer,object<OC\...tings\\Section>"}>\|null` is not guaranteed to be traversable. How about adding an additional type check? There are different options of fixing this problem. If you want to be on the safe side, you can add an additional type-check: $collection = json_decode($data, true); if ( ! is_array($collection)) { throw new \RuntimeException('$collection must be an array.'); } foreach ($collection as $item) { /** ... / } If you are sure that the expression is traversable, you might want to add a doc comment cast* to improve IDE auto-completion and static analysis: /** @var array $collection / $collection = json_decode($data, true); foreach ($collection as $item) { /* .. / } Mark the issue as a false-positive*: Just hover the remove button, in the top-right corner of this issue for more options. Loading history...
399		if($section->getID() === $sectionID) {
400		return $section;
401		}
402		}
403		$this->log->error(
404		'Failed to load section with id: {id}',
405		['id' => $sectionID]);
406		return new Section($sectionID, ucfirst($sectionID), -9);
407		}
408
409		/**
410		* Sort the array of ISettings or ISections by their priority attribute
411		* @param array $objects (ISections of ISettings)
412		* @return array
413		*/
414		protected function sortOrder($objects) {
415		usort($objects, function($a, $b) {
416		/** @var ISection \| ISettings $a */
417		/** @var ISection \| ISettings $b */
418		return $a->getPriority() < $b->getPriority();
419		});
420		return $objects;
421		}
422
423		}
424

owncloud / core

Push — master ( f6005e...7ab4f4 )

SettingsManager D

Complexity

Size/Duplication

Coupling/Cohesion

Importance

14 Methods

How to fix Duplicated Code

Duplicated Code

Duplication Side-by-Side

Filter issues like