NavigationManager::init() - Code Metrics - Inspection of "Merge pull request #30870 from owncloud/multiple-r..." - owncloud/core - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( a0536e...e083c0 )

by Thomas

created 2018-04-12 09:30 UTC

NavigationManager::init() F

↳ Parent: NavigationManager

Complexity

Conditions	22
Paths	1557

Size

Total Lines	79
Code Lines	50

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	22
eloc	50
nc	1557
nop	0
dl	0
loc	79
rs	2.2578
c	0
b	0
f	0

How to fix Long Method Complexity

<?php
/**
 * @author Bart Visscher <[email protected]>
 * @author Joas Schilling <[email protected]>
 * @author Morris Jobke <[email protected]>
 * @author Robin McCorkell <[email protected]>
 * @author Thomas Müller <[email protected]>
 *
 * @copyright Copyright (c) 2018, 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;

use OCP\App\IAppManager;
use OCP\IGroupManager;
use OCP\INavigationManager;
use OCP\IURLGenerator;
use OCP\IUserSession;
use OCP\L10N\IFactory;

/**
 * Manages the ownCloud navigation
 */
class NavigationManager implements INavigationManager {
	protected $entries = [];
	protected $closureEntries = [];
	protected $activeEntry;
	/** @var bool */
	protected $init = false;
	/** @var IAppManager */
	protected $appManager;
	/** @var IURLGenerator */
	private $urlGenerator;
	/** @var IFactory */
	private $l10nFac;
	/** @var IUserSession */
	private $userSession;
	/** @var IGroupManager */
	private $groupManager;

	public function __construct(IAppManager $appManager = null,
						 IURLGenerator $urlGenerator = null,
						 IFactory $l10nFac = null,
						 IUserSession $userSession = null,
						 IGroupManager$groupManager = null) {
		$this->appManager = $appManager;
		$this->urlGenerator = $urlGenerator;
		$this->l10nFac = $l10nFac;
		$this->userSession = $userSession;
		$this->groupManager = $groupManager;
	}

	/**
	 * Creates a new navigation entry
	 *
	 * @param array|\Closure $entry Array containing: id, name, order, icon and href key
	 *					The use of a closure is preferred, because it will avoid
	 * 					loading the routing of your app, unless required.
	 * @return void
	 */
	public function add($entry) {
		if ($entry instanceof \Closure) {
			$this->closureEntries[] = $entry;
			return;
		}

		$entry['active'] = false;
		if(!isset($entry['icon'])) {
			$entry['icon'] = '';
		}
		$this->entries[] = $entry;
	}

	/**
	 * returns all the added Menu entries
	 * @return array an array of the added entries
	 */
	public function getAll() {
		$this->init();
		foreach ($this->closureEntries as $c) {
			$this->add($c());
		}
		$this->closureEntries = [];
		return $this->entries;
	}

	/**
	 * removes all the entries
	 */
	public function clear() {
		$this->entries = [];
		$this->closureEntries = [];
		$this->init = false;
	}

	/**
	 * Sets the current navigation entry of the currently running app
	 * @param string $id of the app entry to activate (from added $entry)
	 */
	public function setActiveEntry($id) {
		$this->activeEntry = $id;
	}

	/**
	 * gets the active Menu entry
	 * @return string id or empty string
	 *
	 * This function returns the id of the active navigation entry (set by
	 * setActiveEntry
	 */
	public function getActiveEntry() {
		return $this->activeEntry;
	}

	private function init() {
		if ($this->init) {
			return;
		}
		$this->init = true;
		if ($this->appManager === null) {
			return;
		}
		foreach ($this->appManager->getInstalledApps() as $app) {
			// load plugins and collections from info.xml
			$info = $this->appManager->getAppInfo($app);
			if (!isset($info['navigation'])) {
				continue;
			}
			$nav = $info['navigation'];
			// either a route or a static page must be defined
			if (!isset($nav['route']) && !isset($nav['static'])) {
				continue;
			}

			$role = isset($nav['@attributes']['role']) ? $nav['@attributes']['role'] : 'all';
			/**
			 * Can have multiple roles like role="admin,sub-admin"
			 */
			$role = explode(',', $role);
			//Remove whitespace in the role elements
			$role = array_map('trim', $role);

			$shallContinue = false;
			if ($this->isAdmin() && (in_array('admin', $role, true) === true)) {
				$shallContinue = true;
			}
			if ($this->isSubAdmin() && (in_array('sub-admin', $role, true) === true)) {
				$shallContinue = true;
			}
			if (in_array('all', $role, true) === true) {
				$shallContinue = true;
			}

			if ($shallContinue === false) {
				continue;
			}

			$l = $this->l10nFac->get($app);
			$order = isset($nav['order']) ? $nav['order'] : 100;
			if (isset($nav['route'])) {
				$route = $this->urlGenerator->linkToRoute($nav['route']);
			} else {
				$html = 'index.html';
				if (isset($nav['static'])) {
					$html = $nav['static'];
				}
				$route = $this->urlGenerator->linkTo($app, $html);
			}
			$name = isset($nav['name']) ? $nav['name'] : ucfirst($app);
			$icon = isset($nav['icon']) ? $nav['icon'] : 'app.svg';
			$iconPath = null;
			foreach ([$icon, "$app.svg"] as $i) {
				try {
					$iconPath = $this->urlGenerator->imagePath($app, $i);
					break;
				} catch (\RuntimeException $ex) {
					// no icon? - ignore it then
				}
			}

			if ($iconPath === null) {
				$iconPath = $this->urlGenerator->imagePath('core', 'default-app-icon.svg');
			}

			$this->add([
				'id' => $app,
				'order' => $order,
				'href' => $route,
				'icon' => $iconPath,
				'name' => $l->t($name),
			]);
		}
	}

	private function isAdmin() {
		$user = $this->userSession->getUser();
		if ($user !== null) {
			return $this->groupManager->isAdmin($user->getUID());
		}
		return false;
	}

	private function isSubAdmin() {
		$user = $this->userSession->getUser();
		if ($user !== null) {
			return $this->groupManager->getSubAdmin()->isSubAdmin($user);
		}
		return false;
	}

}


1		<?php
2		/**
3		* @author Bart Visscher <[email protected]>
4		* @author Joas Schilling <[email protected]>
5		* @author Morris Jobke <[email protected]>
6		* @author Robin McCorkell <[email protected]>
7		* @author Thomas Müller <[email protected]>
8		*
9		* @copyright Copyright (c) 2018, ownCloud GmbH
10		* @license AGPL-3.0
11		*
12		* This code is free software: you can redistribute it and/or modify
13		* it under the terms of the GNU Affero General Public License, version 3,
14		* as published by the Free Software Foundation.
15		*
16		* This program is distributed in the hope that it will be useful,
17		* but WITHOUT ANY WARRANTY; without even the implied warranty of
18		* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19		* GNU Affero General Public License for more details.
20		*
21		* You should have received a copy of the GNU Affero General Public License, version 3,
22		* along with this program. If not, see <http://www.gnu.org/licenses/>
23		*
24		*/
25
26		namespace OC;
27
28		use OCP\App\IAppManager;
29		use OCP\IGroupManager;
30		use OCP\INavigationManager;
31		use OCP\IURLGenerator;
32		use OCP\IUserSession;
33		use OCP\L10N\IFactory;
34
35		/**
36		* Manages the ownCloud navigation
37		*/
38		class NavigationManager implements INavigationManager {
39		protected $entries = [];
40		protected $closureEntries = [];
41		protected $activeEntry;
42		/** @var bool */
43		protected $init = false;
44		/** @var IAppManager */
45		protected $appManager;
46		/** @var IURLGenerator */
47		private $urlGenerator;
48		/** @var IFactory */
49		private $l10nFac;
50		/** @var IUserSession */
51		private $userSession;
52		/** @var IGroupManager */
53		private $groupManager;
54
55		public function __construct(IAppManager $appManager = null,
56		IURLGenerator $urlGenerator = null,
57		IFactory $l10nFac = null,
58		IUserSession $userSession = null,
59		IGroupManager$groupManager = null) {
60		$this->appManager = $appManager;
61		$this->urlGenerator = $urlGenerator;
62		$this->l10nFac = $l10nFac;
63		$this->userSession = $userSession;
64		$this->groupManager = $groupManager;
65		}
66
67		/**
68		* Creates a new navigation entry
69		*
70		* @param array\|\Closure $entry Array containing: id, name, order, icon and href key
71		* The use of a closure is preferred, because it will avoid
72		* loading the routing of your app, unless required.
73		* @return void
74		*/
75		public function add($entry) {
76		if ($entry instanceof \Closure) {
77		$this->closureEntries[] = $entry;
78		return;
79		}
80
81		$entry['active'] = false;
82		if(!isset($entry['icon'])) {
83		$entry['icon'] = '';
84		}
85		$this->entries[] = $entry;
86		}
87
88		/**
89		* returns all the added Menu entries
90		* @return array an array of the added entries
91		*/
92		public function getAll() {
93		$this->init();
94		foreach ($this->closureEntries as $c) {
95		$this->add($c());
96		}
97		$this->closureEntries = [];
98		return $this->entries;
99		}
100
101		/**
102		* removes all the entries
103		*/
104		public function clear() {
105		$this->entries = [];
106		$this->closureEntries = [];
107		$this->init = false;
108		}
109
110		/**
111		* Sets the current navigation entry of the currently running app
112		* @param string $id of the app entry to activate (from added $entry)
113		*/
114		public function setActiveEntry($id) {
115		$this->activeEntry = $id;
116		}
117
118		/**
119		* gets the active Menu entry
120		* @return string id or empty string
121		*
122		* This function returns the id of the active navigation entry (set by
123		* setActiveEntry
124		*/
125		public function getActiveEntry() {
126		return $this->activeEntry;
127		}
128
129		private function init() {
130		if ($this->init) {
131		return;
132		}
133		$this->init = true;
134		if ($this->appManager === null) {
135		return;
136		}
137		foreach ($this->appManager->getInstalledApps() as $app) {
138		// load plugins and collections from info.xml
139		$info = $this->appManager->getAppInfo($app);
140		if (!isset($info['navigation'])) {
141		continue;
142		}
143		$nav = $info['navigation'];
144		// either a route or a static page must be defined
145		if (!isset($nav['route']) && !isset($nav['static'])) {
146		continue;
147		}
148
149		$role = isset($nav['@attributes']['role']) ? $nav['@attributes']['role'] : 'all';
150		/**
151		* Can have multiple roles like role="admin,sub-admin"
152		*/
153		$role = explode(',', $role);
154		//Remove whitespace in the role elements
155		$role = array_map('trim', $role);
156
157		$shallContinue = false;
158		if ($this->isAdmin() && (in_array('admin', $role, true) === true)) {
159		$shallContinue = true;
160		}
161		if ($this->isSubAdmin() && (in_array('sub-admin', $role, true) === true)) {
162		$shallContinue = true;
163		}
164		if (in_array('all', $role, true) === true) {
165		$shallContinue = true;
166		}
167
168		if ($shallContinue === false) {
169		continue;
170		}
171
172		$l = $this->l10nFac->get($app);
173		$order = isset($nav['order']) ? $nav['order'] : 100;
174		if (isset($nav['route'])) {
175		$route = $this->urlGenerator->linkToRoute($nav['route']);
176		} else {
177		$html = 'index.html';
178		if (isset($nav['static'])) {
179		$html = $nav['static'];
180		}
181		$route = $this->urlGenerator->linkTo($app, $html);
182		}
183		$name = isset($nav['name']) ? $nav['name'] : ucfirst($app);
184		$icon = isset($nav['icon']) ? $nav['icon'] : 'app.svg';
185		$iconPath = null;
186		foreach ([$icon, "$app.svg"] as $i) {
187		try {
188		$iconPath = $this->urlGenerator->imagePath($app, $i);
189		break;
190		} catch (\RuntimeException $ex) {
191		// no icon? - ignore it then
192		}
193		}
194
195		if ($iconPath === null) {
196		$iconPath = $this->urlGenerator->imagePath('core', 'default-app-icon.svg');
197		}
198
199		$this->add([
200		'id' => $app,
201		'order' => $order,
202		'href' => $route,
203		'icon' => $iconPath,
204		'name' => $l->t($name),
205		]);
206		}
207		}
208
209	View Code Duplication	private function isAdmin() {
210		$user = $this->userSession->getUser();
211		if ($user !== null) {
212		return $this->groupManager->isAdmin($user->getUID());
213		}
214		return false;
215		}
216
217		private function isSubAdmin() {
218		$user = $this->userSession->getUser();
219		if ($user !== null) {
220		return $this->groupManager->getSubAdmin()->isSubAdmin($user);
221		}
222		return false;
223		}
224
225		}
226

owncloud / core

Push — master ( a0536e...e083c0 )

NavigationManager::init() F

Complexity

Size

Duplication

Importance

How to fix Long Method Complexity

Long Method

Duplication Side-by-Side

Filter issues like