PluginManager::populate() - Code Metrics - Inspection of "Merge pull request #25580 from nextcloud/enh/fix/p..." - nextcloud/server - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 45118d...84de7a )

by Roeland

created 2021-02-15 08:11 UTC

PluginManager::populate() B

↳ Parent: PluginManager

Complexity

Conditions	9
Paths	19

Size

Total Lines	30
Code Lines	19

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	9
eloc	19
nc	19
nop	0
dl	0
loc	30
rs	8.0555
c	0
b	0
f	0

<?php

declare(strict_types=1);

/**
 * @copyright Copyright (c) 2016, ownCloud GmbH.
 *
 * @author Christoph Wurst <[email protected]>
 * @author Georg Ehrke <[email protected]>
 * @author Julius Härtl <[email protected]>
 * @author Roeland Jago Douma <[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 OCA\DAV\AppInfo;

use OC\ServerContainer;
use OCA\DAV\CalDAV\Integration\ICalendarProvider;
use OCA\DAV\CardDAV\Integration\IAddressBookProvider;
use OCP\App\IAppManager;
use OCP\AppFramework\QueryException;
use Sabre\DAV\Collection;
use Sabre\DAV\ServerPlugin;
use function array_map;
use function class_exists;
use function is_array;

/**
 * Manager for DAV plugins from apps, used to register them
 * to the Sabre server.
 */
class PluginManager {

	/**
	 * @var ServerContainer
	 */
	private $container;

	/**
	 * @var IAppManager
	 */
	private $appManager;

	/**
	 * App plugins
	 *
	 * @var ServerPlugin[]
	 */
	private $plugins = [];

	/**
	 * App collections
	 *
	 * @var Collection[]
	 */
	private $collections = [];

	/**
	 * Address book plugins
	 *
	 * @var IAddressBookProvider[]
	 */
	private $addressBookPlugins = [];

	/**
	 * Calendar plugins
	 *
	 * @var ICalendarProvider[]
	 */
	private $calendarPlugins = [];

	/** @var bool */
	private $populated = false;

	/**
	 * Contstruct a PluginManager
	 *
	 * @param ServerContainer $container server container for resolving plugin classes
	 * @param IAppManager $appManager app manager to loading apps and their info
	 */
	public function __construct(ServerContainer $container, IAppManager $appManager) {
		$this->container = $container;
		$this->appManager = $appManager;
	}

	/**
	 * Returns an array of app-registered plugins
	 *
	 * @return ServerPlugin[]
	 */
	public function getAppPlugins() {
		$this->populate();
		return $this->plugins;
	}

	/**
	 * Returns an array of app-registered collections
	 *
	 * @return array
	 */
	public function getAppCollections() {
		$this->populate();
		return $this->collections;
	}

	/**
	 * @return IAddressBookProvider[]
	 */
	public function getAddressBookPlugins(): array {
		$this->populate();
		return $this->addressBookPlugins;
	}

	/**
	 * Returns an array of app-registered calendar plugins
	 *
	 * @return ICalendarProvider[]
	 */
	public function getCalendarPlugins():array {
		$this->populate();
		return $this->calendarPlugins;
	}

	/**
	 * Retrieve plugin and collection list and populate attributes
	 */
	private function populate(): void {
		if ($this->populated) {
			return;
		}
		$this->populated = true;

		foreach ($this->appManager->getInstalledApps() as $app) {
			// load plugins and collections from info.xml
			$info = $this->appManager->getAppInfo($app);
			if (!isset($info['types']) || !in_array('dav', $info['types'], true)) {
				continue;
			}
			$plugins = $this->loadSabrePluginsFromInfoXml($this->extractPluginList($info));
			foreach ($plugins as $plugin) {
				$this->plugins[] = $plugin;
			}

			$collections = $this->loadSabreCollectionsFromInfoXml($this->extractCollectionList($info));
			foreach ($collections as $collection) {
				$this->collections[] = $collection;
			}

			$addresbookPlugins = $this->loadSabreAddressBookPluginsFromInfoXml($this->extractAddressBookPluginList($info));
			foreach ($addresbookPlugins as $addresbookPlugin) {
				$this->addressBookPlugins[] = $addresbookPlugin;
			}

			$calendarPlugins = $this->loadSabreCalendarPluginsFromInfoXml($this->extractCalendarPluginList($info));
			foreach ($calendarPlugins as $calendarPlugin) {
				$this->calendarPlugins[] = $calendarPlugin;
			}
		}
	}

	/**
	 * @param array $array
	 * @return string[]
	 */
	private function extractPluginList(array $array): array {
		if (isset($array['sabre']) && is_array($array['sabre'])) {
			if (isset($array['sabre']['plugins']) && is_array($array['sabre']['plugins'])) {
				if (isset($array['sabre']['plugins']['plugin'])) {
					$items = $array['sabre']['plugins']['plugin'];
					if (!is_array($items)) {
						$items = [$items];
					}
					return $items;
				}
			}
		}
		return [];
	}

	/**
	 * @param array $array
	 * @return string[]
	 */
	private function extractCollectionList(array $array): array {
		if (isset($array['sabre']) && is_array($array['sabre'])) {
			if (isset($array['sabre']['collections']) && is_array($array['sabre']['collections'])) {
				if (isset($array['sabre']['collections']['collection'])) {
					$items = $array['sabre']['collections']['collection'];
					if (!is_array($items)) {
						$items = [$items];
					}
					return $items;
				}
			}
		}
		return [];
	}

	/**
	 * @param array $array
	 * @return string[]
	 */
	private function extractAddressBookPluginList(array $array): array {
		if (!isset($array['sabre']) || !is_array($array['sabre'])) {
			return [];
		}
		if (!isset($array['sabre']['address-book-plugins']) || !is_array($array['sabre']['address-book-plugins'])) {
			return [];
		}
		if (!isset($array['sabre']['address-book-plugins']['plugin'])) {
			return [];
		}

		$items = $array['sabre']['address-book-plugins']['plugin'];
		if (!is_array($items)) {
			$items = [$items];
		}
		return $items;
	}

	/**
	 * @param array $array
	 * @return string[]
	 */
	private function extractCalendarPluginList(array $array): array {
		if (isset($array['sabre']) && is_array($array['sabre'])) {
			if (isset($array['sabre']['calendar-plugins']) && is_array($array['sabre']['calendar-plugins'])) {
				if (isset($array['sabre']['calendar-plugins']['plugin'])) {
					$items = $array['sabre']['calendar-plugins']['plugin'];
					if (!is_array($items)) {
						$items = [$items];
					}
					return $items;
				}
			}
		}
		return [];
	}

	private function createClass(string $className): object {
		try {
			return $this->container->query($className);
		} catch (QueryException $e) {
			if (class_exists($className)) {
				return new $className();
			}
		}

		throw new \Exception('Could not load ' . $className, 0, $e);
	}


	/**
	 * @param string[] $classes
	 * @return ServerPlugin[]
	 * @throws \Exception
	 */
	private function loadSabrePluginsFromInfoXml(array $classes): array {
		return array_map(function (string $className): ServerPlugin {
			$instance = $this->createClass($className);
			if (!($instance instanceof ServerPlugin)) {
				throw new \Exception('Sabre server plugin ' . $className . ' does not implement the ' . ServerPlugin::class . ' interface');
			}
			return $instance;
		}, $classes);
	}

	/**
	 * @param string[] $classes
	 * @return Collection[]
	 */
	private function loadSabreCollectionsFromInfoXml(array $classes): array {
		return array_map(function (string $className): Collection {
			$instance = $this->createClass($className);
			if (!($instance instanceof Collection)) {
				throw new \Exception('Sabre collection plugin ' . $className . ' does not implement the ' . Collection::class . ' interface');
			}
			return $instance;
		}, $classes);
	}

	/**
	 * @param string[] $classes
	 * @return IAddressBookProvider[]
	 */
	private function loadSabreAddressBookPluginsFromInfoXml(array $classes): array {
		return array_map(function (string $className): IAddressBookProvider {
			$instance = $this->createClass($className);
			if (!($instance instanceof IAddressBookProvider)) {
				throw new \Exception('Sabre address book plugin class ' . $className . ' does not implement the ' . IAddressBookProvider::class . ' interface');
			}
			return $instance;
		}, $classes);
	}

	/**
	 * @param string[] $classes
	 * @return ICalendarProvider[]
	 */
	private function loadSabreCalendarPluginsFromInfoXml(array $classes): array {
		return array_map(function (string $className): ICalendarProvider {
			$instance = $this->createClass($className);
			if (!($instance instanceof ICalendarProvider)) {
				throw new \Exception('Sabre calendar plugin class ' . $className . ' does not implement the ' . ICalendarProvider::class . ' interface');
			}
			return $instance;
		}, $classes);
	}
}


1			<?php
2
3			declare(strict_types=1);
4
5			/**
6			* @copyright Copyright (c) 2016, ownCloud GmbH.
7			*
8			* @author Christoph Wurst <[email protected]>
9			* @author Georg Ehrke <[email protected]>
10			* @author Julius Härtl <[email protected]>
11			* @author Roeland Jago Douma <[email protected]>
12			* @author Vincent Petry <[email protected]>
13			*
14			* @license AGPL-3.0
15			*
16			* This code is free software: you can redistribute it and/or modify
17			* it under the terms of the GNU Affero General Public License, version 3,
18			* as published by the Free Software Foundation.
19			*
20			* This program is distributed in the hope that it will be useful,
21			* but WITHOUT ANY WARRANTY; without even the implied warranty of
22			* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
23			* GNU Affero General Public License for more details.
24			*
25			* You should have received a copy of the GNU Affero General Public License, version 3,
26			* along with this program. If not, see <http://www.gnu.org/licenses/>
27			*
28			*/
29
30			namespace OCA\DAV\AppInfo;
31
32			use OC\ServerContainer;
33			use OCA\DAV\CalDAV\Integration\ICalendarProvider;
34			use OCA\DAV\CardDAV\Integration\IAddressBookProvider;
35			use OCP\App\IAppManager;
36			use OCP\AppFramework\QueryException;
37			use Sabre\DAV\Collection;
38			use Sabre\DAV\ServerPlugin;
39			use function array_map;
40			use function class_exists;
41			use function is_array;
42
43			/**
44			* Manager for DAV plugins from apps, used to register them
45			* to the Sabre server.
46			*/
47			class PluginManager {
48
49			/**
50			* @var ServerContainer
51			*/
52			private $container;
53
54			/**
55			* @var IAppManager
56			*/
57			private $appManager;
58
59			/**
60			* App plugins
61			*
62			* @var ServerPlugin[]
63			*/
64			private $plugins = [];
65
66			/**
67			* App collections
68			*
69			* @var Collection[]
70			*/
71			private $collections = [];
72
73			/**
74			* Address book plugins
75			*
76			* @var IAddressBookProvider[]
77			*/
78			private $addressBookPlugins = [];
79
80			/**
81			* Calendar plugins
82			*
83			* @var ICalendarProvider[]
84			*/
85			private $calendarPlugins = [];
86
87			/** @var bool */
88			private $populated = false;
89
90			/**
91			* Contstruct a PluginManager
92			*
93			* @param ServerContainer $container server container for resolving plugin classes
94			* @param IAppManager $appManager app manager to loading apps and their info
95			*/
96			public function __construct(ServerContainer $container, IAppManager $appManager) {
97			$this->container = $container;
98			$this->appManager = $appManager;
99			}
100
101			/**
102			* Returns an array of app-registered plugins
103			*
104			* @return ServerPlugin[]
105			*/
106			public function getAppPlugins() {
107			$this->populate();
108			return $this->plugins;
109			}
110
111			/**
112			* Returns an array of app-registered collections
113			*
114			* @return array
115			*/
116			public function getAppCollections() {
117			$this->populate();
118			return $this->collections;
119			}
120
121			/**
122			* @return IAddressBookProvider[]
123			*/
124			public function getAddressBookPlugins(): array {
125			$this->populate();
126			return $this->addressBookPlugins;
127			}
128
129			/**
130			* Returns an array of app-registered calendar plugins
131			*
132			* @return ICalendarProvider[]
133			*/
134			public function getCalendarPlugins():array {
135			$this->populate();
136			return $this->calendarPlugins;
137			}
138
139			/**
140			* Retrieve plugin and collection list and populate attributes
141			*/
142			private function populate(): void {
143			if ($this->populated) {
144			return;
145			}
146			$this->populated = true;
147
148			foreach ($this->appManager->getInstalledApps() as $app) {
149			// load plugins and collections from info.xml
150			$info = $this->appManager->getAppInfo($app);
151			if (!isset($info['types']) \|\| !in_array('dav', $info['types'], true)) {
152			continue;
153			}
154			$plugins = $this->loadSabrePluginsFromInfoXml($this->extractPluginList($info));
155			foreach ($plugins as $plugin) {
156			$this->plugins[] = $plugin;
157			}
158
159			$collections = $this->loadSabreCollectionsFromInfoXml($this->extractCollectionList($info));
160			foreach ($collections as $collection) {
161			$this->collections[] = $collection;
162			}
163
164			$addresbookPlugins = $this->loadSabreAddressBookPluginsFromInfoXml($this->extractAddressBookPluginList($info));
165			foreach ($addresbookPlugins as $addresbookPlugin) {
166			$this->addressBookPlugins[] = $addresbookPlugin;
167			}
168
169			$calendarPlugins = $this->loadSabreCalendarPluginsFromInfoXml($this->extractCalendarPluginList($info));
170			foreach ($calendarPlugins as $calendarPlugin) {
171			$this->calendarPlugins[] = $calendarPlugin;
172			}
173			}
174			}
175
176			/**
177			* @param array $array
178			* @return string[]
179			*/
180			private function extractPluginList(array $array): array {
181			if (isset($array['sabre']) && is_array($array['sabre'])) {
182			if (isset($array['sabre']['plugins']) && is_array($array['sabre']['plugins'])) {
183			if (isset($array['sabre']['plugins']['plugin'])) {
184			$items = $array['sabre']['plugins']['plugin'];
185			if (!is_array($items)) {
186			$items = [$items];
187			}
188			return $items;
189			}
190			}
191			}
192			return [];
193			}
194
195			/**
196			* @param array $array
197			* @return string[]
198			*/
199			private function extractCollectionList(array $array): array {
200			if (isset($array['sabre']) && is_array($array['sabre'])) {
201			if (isset($array['sabre']['collections']) && is_array($array['sabre']['collections'])) {
202			if (isset($array['sabre']['collections']['collection'])) {
203			$items = $array['sabre']['collections']['collection'];
204			if (!is_array($items)) {
205			$items = [$items];
206			}
207			return $items;
208			}
209			}
210			}
211			return [];
212			}
213
214			/**
215			* @param array $array
216			* @return string[]
217			*/
218			private function extractAddressBookPluginList(array $array): array {
219			if (!isset($array['sabre']) \|\| !is_array($array['sabre'])) {
220			return [];
221			}
222			if (!isset($array['sabre']['address-book-plugins']) \|\| !is_array($array['sabre']['address-book-plugins'])) {
223			return [];
224			}
225			if (!isset($array['sabre']['address-book-plugins']['plugin'])) {
226			return [];
227			}
228
229			$items = $array['sabre']['address-book-plugins']['plugin'];
230			if (!is_array($items)) {
231			$items = [$items];
232			}
233			return $items;
234			}
235
236			/**
237			* @param array $array
238			* @return string[]
239			*/
240			private function extractCalendarPluginList(array $array): array {
241			if (isset($array['sabre']) && is_array($array['sabre'])) {
242			if (isset($array['sabre']['calendar-plugins']) && is_array($array['sabre']['calendar-plugins'])) {
243			if (isset($array['sabre']['calendar-plugins']['plugin'])) {
244			$items = $array['sabre']['calendar-plugins']['plugin'];
245			if (!is_array($items)) {
246			$items = [$items];
247			}
248			return $items;
249			}
250			}
251			}
252			return [];
253			}
254
255			private function createClass(string $className): object {
256			try {
257			return $this->container->query($className);
258			} catch (QueryException $e) {
259			if (class_exists($className)) {
260			return new $className();
261			}
262			}
263
264			throw new \Exception('Could not load ' . $className, 0, $e);
265			}
266
267
268			/**
269			* @param string[] $classes
270			* @return ServerPlugin[]
271			* @throws \Exception
272			*/
273			private function loadSabrePluginsFromInfoXml(array $classes): array {
274			return array_map(function (string $className): ServerPlugin {
275			$instance = $this->createClass($className);
276			if (!($instance instanceof ServerPlugin)) {
277			throw new \Exception('Sabre server plugin ' . $className . ' does not implement the ' . ServerPlugin::class . ' interface');
278			}
279			return $instance;
280			}, $classes);
281			}
282
283			/**
284			* @param string[] $classes
285			* @return Collection[]
286			*/
287			private function loadSabreCollectionsFromInfoXml(array $classes): array {
288			return array_map(function (string $className): Collection {
289			$instance = $this->createClass($className);
290			if (!($instance instanceof Collection)) {
291			throw new \Exception('Sabre collection plugin ' . $className . ' does not implement the ' . Collection::class . ' interface');
292			}
293			return $instance;
294			}, $classes);
295			}
296
297			/**
298			* @param string[] $classes
299			* @return IAddressBookProvider[]
300			*/
301			private function loadSabreAddressBookPluginsFromInfoXml(array $classes): array {
302			return array_map(function (string $className): IAddressBookProvider {
303			$instance = $this->createClass($className);
304			if (!($instance instanceof IAddressBookProvider)) {
305			throw new \Exception('Sabre address book plugin class ' . $className . ' does not implement the ' . IAddressBookProvider::class . ' interface');
306			}
307			return $instance;
308			}, $classes);
309			}
310
311			/**
312			* @param string[] $classes
313			* @return ICalendarProvider[]
314			*/
315			private function loadSabreCalendarPluginsFromInfoXml(array $classes): array {
316			return array_map(function (string $className): ICalendarProvider {
317			$instance = $this->createClass($className);
318			if (!($instance instanceof ICalendarProvider)) {
319			throw new \Exception('Sabre calendar plugin class ' . $className . ' does not implement the ' . ICalendarProvider::class . ' interface');
320			}
321			return $instance;
322			}, $classes);
323			}
324			}
325

nextcloud / server

Push — master ( 45118d...84de7a )

PluginManager::populate() B

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like