CirclesMemberships::manageMembership() - Code Metrics - Inspection of "Circles 22" - nextcloud/circles - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#551)

by Maxence

created 2021-02-16 02:18 UTC

CirclesMemberships::manageMembership() A

↳ Parent: CirclesMemberships

Complexity

Conditions	4
Paths	4

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	14
rs	9.7998
c	0
b	0
f	0
cc	4
nc	4
nop	1

<?php

declare(strict_types=1);


/**
 * Circles - Bring cloud-users closer together.
 *
 * This file is licensed under the Affero General Public License version 3 or
 * later. See the COPYING file.
 *
 * @author Maxence Lange <[email protected]>
 * @copyright 2021
 * @license GNU AGPL version 3 or any later version
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 *
 * 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
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 */


namespace OCA\Circles\Command;

use daita\MySmallPhpTools\Exceptions\InvalidItemException;
use daita\MySmallPhpTools\Exceptions\ItemNotFoundException;
use daita\MySmallPhpTools\Exceptions\RequestNetworkException;
use daita\MySmallPhpTools\Exceptions\SignatoryException;
use daita\MySmallPhpTools\Exceptions\UnknownTypeException;
use daita\MySmallPhpTools\Model\Nextcloud\nc21\NC21TreeNode;
use daita\MySmallPhpTools\Model\SimpleDataStore;
use daita\MySmallPhpTools\Traits\Nextcloud\nc21\TNC21ConsoleTree;
use daita\MySmallPhpTools\Traits\TArrayTools;
use OC\Core\Command\Base;
use OCA\Circles\Db\MemberRequest;
use OCA\Circles\Db\MembershipRequest;
use OCA\Circles\Exceptions\CircleNotFoundException;
use OCA\Circles\Exceptions\FederatedUserException;
use OCA\Circles\Exceptions\FederatedUserNotFoundException;
use OCA\Circles\Exceptions\InvalidIdException;
use OCA\Circles\Exceptions\MemberNotFoundException;
use OCA\Circles\Exceptions\OwnerNotFoundException;
use OCA\Circles\Exceptions\RemoteInstanceException;
use OCA\Circles\Exceptions\RemoteNotFoundException;
use OCA\Circles\Exceptions\RemoteResourceNotFoundException;
use OCA\Circles\Exceptions\UnknownRemoteException;
use OCA\Circles\Exceptions\UserTypeNotFoundException;
use OCA\Circles\Model\FederatedUser;
use OCA\Circles\Model\Member;
use OCA\Circles\Model\Membership;
use OCA\Circles\Model\ModelManager;
use OCA\Circles\Service\ConfigService;
use OCA\Circles\Service\FederatedUserService;
use OCP\IUserManager;
use Symfony\Component\Console\Input\InputArgument;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Input\InputOption;
use Symfony\Component\Console\Output\OutputInterface;


/**
 * Class CirclesMembershipsIndex
 *
 * @package OCA\Circles\Command
 */
class CirclesMemberships extends Base {


	use TArrayTools;
	use TNC21ConsoleTree;


	/** @var IUserManager */
	private $userManager;

	/** @var MemberRequest */
	private $memberRequest;

	/** @var MembershipRequest */
	private $membershipRequest;

	/** @var ModelManager */
	private $modelManager;

	/** @var FederatedUserService */
	private $federatedUserService;

	/** @var ConfigService */
	private $configService;


	/** @var string */
	private $singleId;

	/** @var Membership[] */
	private $memberships = [];


	/**
	 * CirclesList constructor.
	 *
	 * @param IUserManager $userManager
	 * @param MembershipRequest $membershipRequest
	 * @param MemberRequest $memberRequest
	 * @param ModelManager $modelManager
	 * @param FederatedUserService $federatedUserService
	 * @param ConfigService $configService
	 */
	public function __construct(
		IUserManager $userManager,
		MembershipRequest $membershipRequest,
		MemberRequest $memberRequest,
		ModelManager $modelManager,
		FederatedUserService $federatedUserService,
		ConfigService $configService
	) {
		parent::__construct();
		$this->userManager = $userManager;
		$this->memberRequest = $memberRequest;
		$this->membershipRequest = $membershipRequest;
		$this->modelManager = $modelManager;
		$this->federatedUserService = $federatedUserService;
		$this->configService = $configService;
	}


	protected function configure() {
		parent::configure();
		$this->setName('circles:memberships')
			 ->setDescription('index and display memberships for local and federated users')
			 ->addArgument('userId', InputArgument::OPTIONAL, 'userId to generate memberships', '')
			 ->addOption('all', '', InputOption::VALUE_NONE, 'index all local users')
			 ->addOption(
				 'type', '', InputOption::VALUE_REQUIRED, 'type of the user',
				 Member::$DEF_TYPE[Member::TYPE_USER]
			 );
	}


	/**
	 * @param InputInterface $input
	 * @param OutputInterface $output
	 *
	 * @return int
	 * @throws CircleNotFoundException
	 * @throws InvalidItemException
	 * @throws UserTypeNotFoundException
	 * @throws FederatedUserException
	 * @throws FederatedUserNotFoundException
	 * @throws InvalidIdException
	 * @throws OwnerNotFoundException
	 * @throws RemoteInstanceException
	 * @throws RemoteNotFoundException
	 * @throws RemoteResourceNotFoundException
	 * @throws UnknownRemoteException
	 * @throws RequestNetworkException
	 * @throws SignatoryException
	 * @throws MemberNotFoundException
	 */
	protected function execute(InputInterface $input, OutputInterface $output): int {
		$all = $input->getOption('all');
		$userId = $input->getArgument('userId');

		if (!$all && $userId === '') {
			$output->writeln('<error>specify a user, or use --all</error>');

			return 0;
		}

		$type = Member::parseTypeString($input->getOption('type'));
		$federatedUser = $this->federatedUserService->getFederatedUser($userId, (int)$type);

		$output->writeln('Id: <info>' . $federatedUser->getUserId() . '</info>');
		$output->writeln('Instance: <info>' . $federatedUser->getInstance() . '</info>');
		$output->writeln('Type: <info>' . Member::$DEF_TYPE[$federatedUser->getUserType()] . '</info>');
		$output->writeln('SingleId: <info>' . $federatedUser->getSingleId() . '</info>');

		$this->singleId = $federatedUser->getSingleId();
		$tree = new NC21TreeNode(null, new SimpleDataStore(['federatedUser' => $federatedUser]));
		$this->generateMemberships($this->singleId, $tree);
		$this->saveMemberships();

		$output->writeln('Memberships:');
		foreach ($federatedUser->getMemberships() as $membership) {
			$output->writeln(
				'- <info>' . $membership->getCircleId() . '</info> ('
				. Member::$DEF_LEVEL[$membership->getLevel()] . ')'
			);
		}
		$output->writeln('');

		$this->drawTree(
			$tree, [$this, 'displayLeaf'],
			[
				'height'       => 3,
				'node-spacing' => 0,
				'item-spacing' => 1,
			]
		);

		return 0;
	}


	/**
	 * @param string $id
	 * @param NC21TreeNode $tree
	 * @param array $knownIds
	 */
	private function generateMemberships(string $id, NC21TreeNode $tree, array $knownIds = []) {
		if (in_array($id, $knownIds)) {
			return;
		}
		$knownIds[] = $id;

		$members = $this->memberRequest->getMembersBySingleId($id);
		foreach ($members as $member) {
			$membership = new Membership($member);
			$membership->setId($this->singleId);
			$this->manageMembership($membership);

			$item = new NC21TreeNode(
				$tree, new SimpleDataStore(
						 [
							 'member'  => $member,
							 'cycling' => in_array($member->getCircleId(), $knownIds)
						 ]
					 )
			);
			$this->generateMemberships($member->getCircleId(), $item, $knownIds);
		}
	}


	/**
	 * @param SimpleDataStore $data
	 * @param int $lineNumber
	 *
	 * @return string
	 * @throws OwnerNotFoundException
	 */
	public function displayLeaf(SimpleDataStore $data, int $lineNumber): string {
		if ($lineNumber === 3) {
			return ($data->gBool('cycling')) ? '<comment>(loop detected)</comment>' : '';
		}

		try {
			$line = '';
			if ($data->hasKey('federatedUser')) {
				/** @var FederatedUser $federatedUser */
				$federatedUser = $data->gObj('federatedUser', FederatedUser::class);

				if ($lineNumber === 2) {
					return '';
				}
				$line .= '<info>' . $federatedUser->getSingleId() . '</info>';
				if (!$this->configService->isLocalInstance($federatedUser->getInstance())) {
					$line .= '@' . $federatedUser->getInstance();
				}

				return $line;
			}

			if ($data->hasKey('member')) {
				/** @var Member $member */
				$member = $data->gObj('member', Member::class);
				$circle = $member->getCircle();

				if ($lineNumber === 1) {
					$line .= '<info>' . $circle->getId() . '</info>';
					if (!$this->configService->isLocalInstance($circle->getInstance())) {
						$line .= '@' . $circle->getInstance();
					}
					$line .= ' (' . $circle->getName() . ')';
					$line .= ' <info>Level</info>: ' . Member::$DEF_LEVEL[$member->getLevel()];

					$knownMembership = $this->memberships[$member->getCircleId()];
					if ($member->getLevel() !== $knownMembership->getLevel()) {
						$line .= ' (' . Member::$DEF_LEVEL[$knownMembership->getLevel()] . ')';
					}
				}

				if ($lineNumber === 2) {
					$owner = $circle->getOwner();
					$line .= '<info>Owner</info>: ' . $owner->getUserId() . '@' . $owner->getInstance() . ' ';
					$type =
						implode(", ", $this->modelManager->getCircleTypes($circle, ModelManager::TYPES_LONG));
					$line .= ($type === '') ? '' : '<info>Config</info>: ' . $type;
				}

				return $line;
			}
		} catch (InvalidItemException | ItemNotFoundException | UnknownTypeException $e) {
		}

		return '';
	}


	/**
	 * @param Membership $membership
	 */
	private function manageMembership(Membership $membership): void {
		foreach ($this->memberships as $known) {
			if ($known->getCircleId() === $membership->getCircleId()) {
				if ($known->getLevel() < $membership->getLevel()) {
					$known->setLevel($membership->getLevel());
					$known->setMemberId($membership->getMemberId());
				}

				return;
			}
		}

		$this->memberships[$membership->getCircleId()] = $membership;
	}


	/**
	 *
	 */
	private function saveMemberships() {
		$known = $this->membershipRequest->getMemberships($this->singleId);

		// Check deprecated memberships
		$circleIds = array_map(
			function(Membership $membership): string {
				return $membership->getCircleId();
			}, $this->memberships
		);

		foreach ($known as $item) {
			if (!in_array($item->getCircleId(), $circleIds)) {
				$this->membershipRequest->delete($item);
			}
		}

		// Update/Create memberships
		$circleIds = array_map(
			function(Membership $membership): string {
				return $membership->getCircleId();
			}, $known
		);

		foreach ($this->memberships as $item) {
			if (!in_array($item->getCircleId(), $circleIds)) {
				$this->membershipRequest->insert($item);
			} else {
				foreach ($known as $knownItem) {
					if ($knownItem->getCircleId() === $item->getCircleId()) {
						if ($knownItem->getLevel() !== $item->getLevel()) {
							$this->membershipRequest->update($item);
						}

						break;
					}
				}
			}
		}

	}

}



1			<?php
2
3			declare(strict_types=1);
4
5
6			/**
7			* Circles - Bring cloud-users closer together.
8			*
9			* This file is licensed under the Affero General Public License version 3 or
10			* later. See the COPYING file.
11			*
12			* @author Maxence Lange <[email protected]>
13			* @copyright 2021
14			* @license GNU AGPL version 3 or any later version
15			*
16			* This program is free software: you can redistribute it and/or modify
17			* it under the terms of the GNU Affero General Public License as
18			* published by the Free Software Foundation, either version 3 of the
19			* License, or (at your option) any later version.
20			*
21			* This program is distributed in the hope that it will be useful,
22			* but WITHOUT ANY WARRANTY; without even the implied warranty of
23			* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
24			* GNU Affero General Public License for more details.
25			*
26			* You should have received a copy of the GNU Affero General Public License
27			* along with this program. If not, see <http://www.gnu.org/licenses/>.
28			*
29			*/
30
31
32			namespace OCA\Circles\Command;
33
34			use daita\MySmallPhpTools\Exceptions\InvalidItemException;
35			use daita\MySmallPhpTools\Exceptions\ItemNotFoundException;
36			use daita\MySmallPhpTools\Exceptions\RequestNetworkException;
37			use daita\MySmallPhpTools\Exceptions\SignatoryException;
38			use daita\MySmallPhpTools\Exceptions\UnknownTypeException;
39			use daita\MySmallPhpTools\Model\Nextcloud\nc21\NC21TreeNode;
40			use daita\MySmallPhpTools\Model\SimpleDataStore;
41			use daita\MySmallPhpTools\Traits\Nextcloud\nc21\TNC21ConsoleTree;
42			use daita\MySmallPhpTools\Traits\TArrayTools;
43			use OC\Core\Command\Base;
44			use OCA\Circles\Db\MemberRequest;
45			use OCA\Circles\Db\MembershipRequest;
46			use OCA\Circles\Exceptions\CircleNotFoundException;
47			use OCA\Circles\Exceptions\FederatedUserException;
48			use OCA\Circles\Exceptions\FederatedUserNotFoundException;
49			use OCA\Circles\Exceptions\InvalidIdException;
50			use OCA\Circles\Exceptions\MemberNotFoundException;
51			use OCA\Circles\Exceptions\OwnerNotFoundException;
52			use OCA\Circles\Exceptions\RemoteInstanceException;
53			use OCA\Circles\Exceptions\RemoteNotFoundException;
54			use OCA\Circles\Exceptions\RemoteResourceNotFoundException;
55			use OCA\Circles\Exceptions\UnknownRemoteException;
56			use OCA\Circles\Exceptions\UserTypeNotFoundException;
57			use OCA\Circles\Model\FederatedUser;
58			use OCA\Circles\Model\Member;
59			use OCA\Circles\Model\Membership;
60			use OCA\Circles\Model\ModelManager;
61			use OCA\Circles\Service\ConfigService;
62			use OCA\Circles\Service\FederatedUserService;
63			use OCP\IUserManager;
64			use Symfony\Component\Console\Input\InputArgument;
65			use Symfony\Component\Console\Input\InputInterface;
66			use Symfony\Component\Console\Input\InputOption;
67			use Symfony\Component\Console\Output\OutputInterface;
68
69
70			/**
71			* Class CirclesMembershipsIndex
72			*
73			* @package OCA\Circles\Command
74			*/
75			class CirclesMemberships extends Base {
76
77
78			use TArrayTools;
79			use TNC21ConsoleTree;
80
81
82			/** @var IUserManager */
83			private $userManager;
84
85			/** @var MemberRequest */
86			private $memberRequest;
87
88			/** @var MembershipRequest */
89			private $membershipRequest;
90
91			/** @var ModelManager */
92			private $modelManager;
93
94			/** @var FederatedUserService */
95			private $federatedUserService;
96
97			/** @var ConfigService */
98			private $configService;
99
100
101			/** @var string */
102			private $singleId;
103
104			/** @var Membership[] */
105			private $memberships = [];
106
107
108			/**
109			* CirclesList constructor.
110			*
111			* @param IUserManager $userManager
112			* @param MembershipRequest $membershipRequest
113			* @param MemberRequest $memberRequest
114			* @param ModelManager $modelManager
115			* @param FederatedUserService $federatedUserService
116			* @param ConfigService $configService
117			*/
118			public function __construct(
119			IUserManager $userManager,
120			MembershipRequest $membershipRequest,
121			MemberRequest $memberRequest,
122			ModelManager $modelManager,
123			FederatedUserService $federatedUserService,
124			ConfigService $configService
125			) {
126			parent::__construct();
127			$this->userManager = $userManager;
128			$this->memberRequest = $memberRequest;
129			$this->membershipRequest = $membershipRequest;
130			$this->modelManager = $modelManager;
131			$this->federatedUserService = $federatedUserService;
132			$this->configService = $configService;
133			}
134
135
136			protected function configure() {
137			parent::configure();
138			$this->setName('circles:memberships')
139			->setDescription('index and display memberships for local and federated users')
140			->addArgument('userId', InputArgument::OPTIONAL, 'userId to generate memberships', '')
141			->addOption('all', '', InputOption::VALUE_NONE, 'index all local users')
142			->addOption(
143			'type', '', InputOption::VALUE_REQUIRED, 'type of the user',
144			Member::$DEF_TYPE[Member::TYPE_USER]
145			);
146			}
147
148
149			/**
150			* @param InputInterface $input
151			* @param OutputInterface $output
152			*
153			* @return int
154			* @throws CircleNotFoundException
155			* @throws InvalidItemException
156			* @throws UserTypeNotFoundException
157			* @throws FederatedUserException
158			* @throws FederatedUserNotFoundException
159			* @throws InvalidIdException
160			* @throws OwnerNotFoundException
161			* @throws RemoteInstanceException
162			* @throws RemoteNotFoundException
163			* @throws RemoteResourceNotFoundException
164			* @throws UnknownRemoteException
165			* @throws RequestNetworkException
166			* @throws SignatoryException
167			* @throws MemberNotFoundException
168			*/
169			protected function execute(InputInterface $input, OutputInterface $output): int {
170			$all = $input->getOption('all');
171			$userId = $input->getArgument('userId');
172
173			if (!$all && $userId === '') {
174			$output->writeln('<error>specify a user, or use --all</error>');
175
176			return 0;
177			}
178
179			$type = Member::parseTypeString($input->getOption('type'));
180			$federatedUser = $this->federatedUserService->getFederatedUser($userId, (int)$type);
181
182			$output->writeln('Id: <info>' . $federatedUser->getUserId() . '</info>');
183			$output->writeln('Instance: <info>' . $federatedUser->getInstance() . '</info>');
184			$output->writeln('Type: <info>' . Member::$DEF_TYPE[$federatedUser->getUserType()] . '</info>');
185			$output->writeln('SingleId: <info>' . $federatedUser->getSingleId() . '</info>');
186
187			$this->singleId = $federatedUser->getSingleId();
188			$tree = new NC21TreeNode(null, new SimpleDataStore(['federatedUser' => $federatedUser]));
189			$this->generateMemberships($this->singleId, $tree);
190			$this->saveMemberships();
191
192			$output->writeln('Memberships:');
193			foreach ($federatedUser->getMemberships() as $membership) {
194			$output->writeln(
195			'- <info>' . $membership->getCircleId() . '</info> ('
196			. Member::$DEF_LEVEL[$membership->getLevel()] . ')'
197			);
198			}
199			$output->writeln('');
200
201			$this->drawTree(
202			$tree, [$this, 'displayLeaf'],
203			[
204			'height' => 3,
205			'node-spacing' => 0,
206			'item-spacing' => 1,
207			]
208			);
209
210			return 0;
211			}
212
213
214			/**
215			* @param string $id
216			* @param NC21TreeNode $tree
217			* @param array $knownIds
218			*/
219			private function generateMemberships(string $id, NC21TreeNode $tree, array $knownIds = []) {
220			if (in_array($id, $knownIds)) {
221			return;
222			}
223			$knownIds[] = $id;
224
225			$members = $this->memberRequest->getMembersBySingleId($id);
226			foreach ($members as $member) {
227			$membership = new Membership($member);
228			$membership->setId($this->singleId);
229			$this->manageMembership($membership);
230
231			$item = new NC21TreeNode(
232			$tree, new SimpleDataStore(
233			[
234			'member' => $member,
235			'cycling' => in_array($member->getCircleId(), $knownIds)
236			]
237			)
238			);
239			$this->generateMemberships($member->getCircleId(), $item, $knownIds);
240			}
241			}
242
243
244			/**
245			* @param SimpleDataStore $data
246			* @param int $lineNumber
247			*
248			* @return string
249			* @throws OwnerNotFoundException
250			*/
251			public function displayLeaf(SimpleDataStore $data, int $lineNumber): string {
252			if ($lineNumber === 3) {
253			return ($data->gBool('cycling')) ? '<comment>(loop detected)</comment>' : '';
254			}
255
256			try {
257			$line = '';
258			if ($data->hasKey('federatedUser')) {
259			/** @var FederatedUser $federatedUser */
260			$federatedUser = $data->gObj('federatedUser', FederatedUser::class);
261
262			if ($lineNumber === 2) {
263			return '';
264			}
265			$line .= '<info>' . $federatedUser->getSingleId() . '</info>';
266			if (!$this->configService->isLocalInstance($federatedUser->getInstance())) {
267			$line .= '@' . $federatedUser->getInstance();
268			}
269
270			return $line;
271			}
272
273			if ($data->hasKey('member')) {
274			/** @var Member $member */
275			$member = $data->gObj('member', Member::class);
276			$circle = $member->getCircle();
277
278			if ($lineNumber === 1) {
279			$line .= '<info>' . $circle->getId() . '</info>';
280			if (!$this->configService->isLocalInstance($circle->getInstance())) {
281			$line .= '@' . $circle->getInstance();
282			}
283			$line .= ' (' . $circle->getName() . ')';
284			$line .= ' <info>Level</info>: ' . Member::$DEF_LEVEL[$member->getLevel()];
285
286			$knownMembership = $this->memberships[$member->getCircleId()];
287			if ($member->getLevel() !== $knownMembership->getLevel()) {
288			$line .= ' (' . Member::$DEF_LEVEL[$knownMembership->getLevel()] . ')';
289			}
290			}
291
292			if ($lineNumber === 2) {
293			$owner = $circle->getOwner();
294			$line .= '<info>Owner</info>: ' . $owner->getUserId() . '@' . $owner->getInstance() . ' ';
295			$type =
296			implode(", ", $this->modelManager->getCircleTypes($circle, ModelManager::TYPES_LONG));
297			$line .= ($type === '') ? '' : '<info>Config</info>: ' . $type;
298			}
299
300			return $line;
301			}
302			} catch (InvalidItemException \| ItemNotFoundException \| UnknownTypeException $e) {
303			}
304
305			return '';
306			}
307
308
309			/**
310			* @param Membership $membership
311			*/
312			private function manageMembership(Membership $membership): void {
313			foreach ($this->memberships as $known) {
314			if ($known->getCircleId() === $membership->getCircleId()) {
315			if ($known->getLevel() < $membership->getLevel()) {
316			$known->setLevel($membership->getLevel());
317			$known->setMemberId($membership->getMemberId());
318			}
319
320			return;
321			}
322			}
323
324			$this->memberships[$membership->getCircleId()] = $membership;
325			}
326
327
328			/**
329			*
330			*/
331			private function saveMemberships() {
332			$known = $this->membershipRequest->getMemberships($this->singleId);
333
334			// Check deprecated memberships
335			$circleIds = array_map(
336			function(Membership $membership): string {
337			return $membership->getCircleId();
338			}, $this->memberships
339			);
340
341			foreach ($known as $item) {
342			if (!in_array($item->getCircleId(), $circleIds)) {
343			$this->membershipRequest->delete($item);
344			}
345			}
346
347			// Update/Create memberships
348			$circleIds = array_map(
349			function(Membership $membership): string {
350			return $membership->getCircleId();
351			}, $known
352			);
353
354			foreach ($this->memberships as $item) {
355			if (!in_array($item->getCircleId(), $circleIds)) {
356			$this->membershipRequest->insert($item);
357			} else {
358			foreach ($known as $knownItem) {
359			if ($knownItem->getCircleId() === $item->getCircleId()) {
360			if ($knownItem->getLevel() !== $item->getLevel()) {
361			$this->membershipRequest->update($item);
362			}
363
364			break;
365			}
366			}
367			}
368			}
369
370			}
371
372			}
373
374

nextcloud / circles

Pull Request — master (#551)

CirclesMemberships::manageMembership() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like