CirclesMemberships::configure() - 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-24 12:31 UTC

CirclesMemberships::configure() A

↳ Parent: CirclesMemberships

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	10
rs	9.9332
c	0
b	0
f	0
cc	1
nc	1
nop	0

<?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 daita\MySmallPhpTools\Traits\TStringTools;
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\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\Circle;
use OCA\Circles\Model\FederatedUser;
use OCA\Circles\Model\Member;
use OCA\Circles\Service\ConfigService;
use OCA\Circles\Service\FederatedUserService;
use OCA\Circles\Service\MembershipService;
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 CirclesMemberships
 *
 * @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 FederatedUserService */
	private $federatedUserService;

	/** @var MembershipService */
	private $membershipsService;

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


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


	/**
	 * CirclesMemberships constructor.
	 *
	 * @param IUserManager $userManager
	 * @param MembershipRequest $membershipRequest
	 * @param MemberRequest $memberRequest
	 * @param MembershipService $membershipsService
	 * @param FederatedUserService $federatedUserService
	 * @param ConfigService $configService
	 */
	public function __construct(
		IUserManager $userManager,
		MembershipRequest $membershipRequest,
		MemberRequest $memberRequest,
		MembershipService $membershipsService,
		FederatedUserService $federatedUserService,
		ConfigService $configService
	) {
		parent::__construct();
		$this->userManager = $userManager;
		$this->memberRequest = $memberRequest;
		$this->membershipRequest = $membershipRequest;
		$this->membershipsService = $membershipsService;
		$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::REQUIRED, 'userId to generate memberships')
			 ->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 FederatedUserException
	 * @throws FederatedUserNotFoundException
	 * @throws InvalidItemException
	 * @throws MemberNotFoundException
	 * @throws OwnerNotFoundException
	 * @throws RemoteInstanceException
	 * @throws RemoteNotFoundException
	 * @throws RemoteResourceNotFoundException
	 * @throws RequestNetworkException
	 * @throws SignatoryException
	 * @throws UnknownRemoteException
	 * @throws UserTypeNotFoundException
	 */
	protected function execute(InputInterface $input, OutputInterface $output): int {
		$userId = $input->getArgument('userId');

		$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>');

		$output->writeln('');
		$output->writeln('Memberships:');
		$count = $this->membershipsService->onMemberUpdate($federatedUser);
		if ($count === 0) {
			$output->writeln('(database not updated)');
		} else {
			$output->writeln('(' . $count . ' entries generated/updated in the database)');
		}

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

		$output->writeln('');

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

		$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 generateTree(string $id, NC21TreeNode $tree, array $knownIds = []) {
		if (in_array($id, $knownIds)) {
			return;
		}
		$knownIds[] = $id;

		$members = $this->memberRequest->getMembersBySingleId($id);
		foreach ($members as $member) {
			if ($member->getCircle()->isConfig(Circle::CFG_SINGLE)) {
				continue;
			}

			$item = new NC21TreeNode(
				$tree, new SimpleDataStore(
						 [
							 'member'  => $member,
							 'cycling' => in_array($member->getCircleId(), $knownIds)
						 ]
					 )
			);
			$this->generateTree($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(", ", Circle::getCircleTypes($circle, Circle::TYPES_LONG));
					$line .= ($type === '') ? '' : '<info>Config</info>: ' . $type;
				}

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

		return '';
	}

}



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 daita\MySmallPhpTools\Traits\TStringTools;
44			use OC\Core\Command\Base;
45			use OCA\Circles\Db\MemberRequest;
46			use OCA\Circles\Db\MembershipRequest;
47			use OCA\Circles\Exceptions\CircleNotFoundException;
48			use OCA\Circles\Exceptions\FederatedUserException;
49			use OCA\Circles\Exceptions\FederatedUserNotFoundException;
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\Circle;
58			use OCA\Circles\Model\FederatedUser;
59			use OCA\Circles\Model\Member;
60			use OCA\Circles\Service\ConfigService;
61			use OCA\Circles\Service\FederatedUserService;
62			use OCA\Circles\Service\MembershipService;
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 CirclesMemberships
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 FederatedUserService */
92			private $federatedUserService;
93
94			/** @var MembershipService */
95			private $membershipsService;
96
97			/** @var ConfigService */
98			private $configService;
99
100
101			/** @var array */
102			private $memberships = [];
103
104
105			/**
106			* CirclesMemberships constructor.
107			*
108			* @param IUserManager $userManager
109			* @param MembershipRequest $membershipRequest
110			* @param MemberRequest $memberRequest
111			* @param MembershipService $membershipsService
112			* @param FederatedUserService $federatedUserService
113			* @param ConfigService $configService
114			*/
115			public function __construct(
116			IUserManager $userManager,
117			MembershipRequest $membershipRequest,
118			MemberRequest $memberRequest,
119			MembershipService $membershipsService,
120			FederatedUserService $federatedUserService,
121			ConfigService $configService
122			) {
123			parent::__construct();
124			$this->userManager = $userManager;
125			$this->memberRequest = $memberRequest;
126			$this->membershipRequest = $membershipRequest;
127			$this->membershipsService = $membershipsService;
128			$this->federatedUserService = $federatedUserService;
129			$this->configService = $configService;
130			}
131
132
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::REQUIRED, 'userId to generate memberships')
141			->addOption(
142			'type', '', InputOption::VALUE_REQUIRED, 'type of the user',
143			Member::$DEF_TYPE[Member::TYPE_USER]
144			);
145			}
146
147
148			/**
149			* @param InputInterface $input
150			* @param OutputInterface $output
151			*
152			* @return int
153			* @throws CircleNotFoundException
154			* @throws FederatedUserException
155			* @throws FederatedUserNotFoundException
156			* @throws InvalidItemException
157			* @throws MemberNotFoundException
158			* @throws OwnerNotFoundException
159			* @throws RemoteInstanceException
160			* @throws RemoteNotFoundException
161			* @throws RemoteResourceNotFoundException
162			* @throws RequestNetworkException
163			* @throws SignatoryException
164			* @throws UnknownRemoteException
165			* @throws UserTypeNotFoundException
166			*/
167			protected function execute(InputInterface $input, OutputInterface $output): int {
168			$userId = $input->getArgument('userId');
169
170			$type = Member::parseTypeString($input->getOption('type'));
171			$federatedUser = $this->federatedUserService->getFederatedUser($userId, (int)$type);
172
173			$output->writeln('Id: <info>' . $federatedUser->getUserId() . '</info>');
174			$output->writeln('Instance: <info>' . $federatedUser->getInstance() . '</info>');
175			$output->writeln('Type: <info>' . Member::$DEF_TYPE[$federatedUser->getUserType()] . '</info>');
176			$output->writeln('SingleId: <info>' . $federatedUser->getSingleId() . '</info>');
177
178			$output->writeln('');
179			$output->writeln('Memberships:');
180			$count = $this->membershipsService->onMemberUpdate($federatedUser);
181			if ($count === 0) {
182			$output->writeln('(database not updated)');
183			} else {
184			$output->writeln('(' . $count . ' entries generated/updated in the database)');
185			}
186
187			foreach ($federatedUser->getMemberships() as $membership) {
188			$this->memberships[$membership->getCircleId()] = $membership;
189			$output->writeln(
190			'- <info>' . $membership->getCircleId() . '</info> ('
191			. Member::$DEF_LEVEL[$membership->getLevel()] . ')'
192			);
193			}
194
195			$output->writeln('');
196
197			$tree = new NC21TreeNode(null, new SimpleDataStore(['federatedUser' => $federatedUser]));
198			$this->generateTree($federatedUser->getSingleId(), $tree);
199
200			$this->drawTree(
201			$tree, [$this, 'displayLeaf'],
202			[
203			'height' => 3,
204			'node-spacing' => 0,
205			'item-spacing' => 1,
206			]
207			);
208
209			return 0;
210			}
211
212
213			/**
214			* @param string $id
215			* @param NC21TreeNode $tree
216			* @param array $knownIds
217			*/
218			private function generateTree(string $id, NC21TreeNode $tree, array $knownIds = []) {
219			if (in_array($id, $knownIds)) {
220			return;
221			}
222			$knownIds[] = $id;
223
224			$members = $this->memberRequest->getMembersBySingleId($id);
225			foreach ($members as $member) {
226			if ($member->getCircle()->isConfig(Circle::CFG_SINGLE)) {
227			continue;
228			}
229
230			$item = new NC21TreeNode(
231			$tree, new SimpleDataStore(
232			[
233			'member' => $member,
234			'cycling' => in_array($member->getCircleId(), $knownIds)
235			]
236			)
237			);
238			$this->generateTree($member->getCircleId(), $item, $knownIds);
239			}
240			}
241
242
243			/**
244			* @param SimpleDataStore $data
245			* @param int $lineNumber
246			*
247			* @return string
248			* @throws OwnerNotFoundException
249			*/
250			public function displayLeaf(SimpleDataStore $data, int $lineNumber): string {
251			if ($lineNumber === 3) {
252			return ($data->gBool('cycling')) ? '<comment>(loop detected)</comment>' : '';
253			}
254
255			try {
256			$line = '';
257			if ($data->hasKey('federatedUser')) {
258			/** @var FederatedUser $federatedUser */
259			$federatedUser = $data->gObj('federatedUser', FederatedUser::class);
260
261			if ($lineNumber === 2) {
262			return '';
263			}
264			$line .= '<info>' . $federatedUser->getSingleId() . '</info>';
265			if (!$this->configService->isLocalInstance($federatedUser->getInstance())) {
266			$line .= '@' . $federatedUser->getInstance();
267			}
268
269			return $line;
270			}
271
272			if ($data->hasKey('member')) {
273			/** @var Member $member */
274			$member = $data->gObj('member', Member::class);
275			$circle = $member->getCircle();
276
277			if ($lineNumber === 1) {
278			$line .= '<info>' . $circle->getId() . '</info>';
279			if (!$this->configService->isLocalInstance($circle->getInstance())) {
280			$line .= '@' . $circle->getInstance();
281			}
282			$line .= ' (' . $circle->getName() . ')';
283			$line .= ' <info>Level</info>: ' . Member::$DEF_LEVEL[$member->getLevel()];
284
285			$knownMembership = $this->memberships[$member->getCircleId()];
286			if ($member->getLevel() !== $knownMembership->getLevel()) {
287			$line .= ' (' . Member::$DEF_LEVEL[$knownMembership->getLevel()] . ')';
288			}
289			}
290
291			if ($lineNumber === 2) {
292			$owner = $circle->getOwner();
293			$line .= '<info>Owner</info>: ' . $owner->getUserId() . '@' . $owner->getInstance() . ' ';
294			$type = implode(", ", Circle::getCircleTypes($circle, Circle::TYPES_LONG));
295			$line .= ($type === '') ? '' : '<info>Config</info>: ' . $type;
296			}
297
298			return $line;
299			}
300			} catch (InvalidItemException \| ItemNotFoundException \| UnknownTypeException $e) {
301			}
302
303			return '';
304			}
305
306			}
307
308

nextcloud / circles

Pull Request — master (#551)

CirclesMemberships::configure() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like