CirclesService::createCircle() - Code Metrics - Inspection of "Federated Circles & Global Scale" - nextcloud/circles - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#362)

by Maxence

created 2020-03-24 01:20 UTC

CirclesService::createCircle() B

↳ Parent: CirclesService

Complexity

Conditions	5
Paths	6

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	43
rs	8.9208
c	0
b	0
f	0
cc	5
nc	6
nop	3

<?php
/**
 * 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]>
 * @author Vinicius Cubas Brand <[email protected]>
 * @author Daniel Tygel <[email protected]>
 *
 * @copyright 2017
 * @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\Service;


use Exception;
use OC;
use OCA\Circles\AppInfo\Application;
use OCA\Circles\Db\CircleProviderRequest;
use OCA\Circles\Db\CirclesRequest;
use OCA\Circles\Db\FederatedLinksRequest;
use OCA\Circles\Db\MembersRequest;
use OCA\Circles\Db\SharesRequest;
use OCA\Circles\Exceptions\CircleAlreadyExistsException;
use OCA\Circles\Exceptions\CircleDoesNotExistException;
use OCA\Circles\Exceptions\CircleTypeDisabledException;
use OCA\Circles\Exceptions\ConfigNoCircleAvailableException;
use OCA\Circles\Exceptions\FederatedCircleNotAllowedException;
use OCA\Circles\Exceptions\MemberAlreadyExistsException;
use OCA\Circles\Exceptions\MemberDoesNotExistException;
use OCA\Circles\Exceptions\MemberIsNotOwnerException;
use OCA\Circles\Exceptions\MembersLimitException;
use OCA\Circles\Model\Circle;
use OCA\Circles\Model\GlobalScale\GSEvent;
use OCA\Circles\Model\Member;
use OCP\IGroupManager;
use OCP\IL10N;

class CirclesService {

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

	/** @var IL10N */
	private $l10n;

	/** @var IGroupManager */
	private $groupManager;

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

	/** @var CirclesRequest */
	private $circlesRequest;

	/** @var MembersRequest */
	private $membersRequest;

	/** @var SharesRequest */
	private $sharesRequest;

	/** @var FederatedLinksRequest */
	private $federatedLinksRequest;

	/** @var GSUpstreamService */
	private $gsUpstreamService;

	/** @var EventsService */
	private $eventsService;

	/** @var CircleProviderRequest */
	private $circleProviderRequest;

	/** @var MiscService */
	private $miscService;


	/**
	 * CirclesService constructor.
	 *
	 * @param string $userId
	 * @param IL10N $l10n
	 * @param IGroupManager $groupManager
	 * @param ConfigService $configService
	 * @param CirclesRequest $circlesRequest
	 * @param MembersRequest $membersRequest
	 * @param SharesRequest $sharesRequest
	 * @param FederatedLinksRequest $federatedLinksRequest
	 * @param GSUpstreamService $gsUpstreamService
	 * @param EventsService $eventsService
	 * @param CircleProviderRequest $circleProviderRequest
	 * @param MiscService $miscService
	 */
	public function __construct(
		$userId,
		IL10N $l10n,
		IGroupManager $groupManager,
		ConfigService $configService,
		CirclesRequest $circlesRequest,
		MembersRequest $membersRequest,
		SharesRequest $sharesRequest,
		FederatedLinksRequest $federatedLinksRequest,
		GSUpstreamService $gsUpstreamService,
		EventsService $eventsService,
		CircleProviderRequest $circleProviderRequest,
		MiscService $miscService
	) {
		$this->userId = $userId;
		$this->l10n = $l10n;
		$this->groupManager = $groupManager;
		$this->configService = $configService;
		$this->circlesRequest = $circlesRequest;
		$this->membersRequest = $membersRequest;
		$this->sharesRequest = $sharesRequest;
		$this->federatedLinksRequest = $federatedLinksRequest;
		$this->gsUpstreamService = $gsUpstreamService;
		$this->eventsService = $eventsService;
		$this->circleProviderRequest = $circleProviderRequest;
		$this->miscService = $miscService;
	}


	/**
	 * Create circle using this->userId as owner
	 *
	 * @param int|string $type
	 * @param string $name
	 *
	 * @param string $ownerId
	 *
	 * @return Circle
	 * @throws CircleAlreadyExistsException
	 * @throws CircleTypeDisabledException
	 * @throws MemberAlreadyExistsException
	 * @throws Exception
	 */
	public function createCircle($type, $name, string $ownerId = '') {
		$type = $this->convertTypeStringToBitValue($type);
		$type = (int)$type;

		if ($type === '') {

			throw new CircleTypeDisabledException(
				$this->l10n->t('You need a specify a type of circle')
			);
		}

		if (!$this->configService->isCircleAllowed($type)) {
			throw new CircleTypeDisabledException(
				$this->l10n->t('You cannot create this type of circle')
			);
		}

		$circle = new Circle($type, $name);

		if ($ownerId === '') {
			$ownerId = $this->userId;
		}

		if (!$this->circlesRequest->isCircleUnique($circle, $ownerId)) {
			throw new CircleAlreadyExistsException(
				$this->l10n->t('A circle with that name exists')
			);
		}

		$circle->generateUniqueId();

		$owner = new Member($ownerId, Member::TYPE_USER);
		$owner->setCircleId($circle->getUniqueId())
			  ->setLevel(Member::LEVEL_OWNER)
			  ->setStatus(Member::STATUS_MEMBER);
		$circle->setOwner($owner)
			   ->setViewer($owner);

		$event = new GSEvent(GSEvent::CIRCLE_CREATE, true);
		$event->setCircle($circle);
		$this->gsUpstreamService->newEvent($event);

		return $circle;
	}


	/**
	 * list Circles depends on type (or all) and name (parts) and minimum level.
	 *
	 * @param string $userId
	 * @param mixed $type
	 * @param string $name
	 * @param int $level
	 *
	 * @param bool $forceAll
	 *
	 * @return Circle[]
	 * @throws CircleTypeDisabledException
	 * @throws Exception
	 */
	public function listCircles($userId, $type, $name = '', $level = 0, $forceAll = false) {
		$type = $this->convertTypeStringToBitValue($type);

		if ($userId === '') {
			throw new Exception('UserID cannot be null');
		}

		if (!$this->configService->isCircleAllowed((int)$type)) {
			throw new CircleTypeDisabledException(
				$this->l10n->t('You cannot display this type of circle')
			);
		}

		$data = [];
		$result = $this->circlesRequest->getCircles($userId, $type, $name, $level, $forceAll);
		foreach ($result as $item) {
			$data[] = $item;
		}

		return $data;
	}


	/**
	 * returns details on circle and its members if this->userId is a member itself.
	 *
	 * @param string $circleUniqueId
	 * @param bool $forceAll
	 *
	 * @return Circle
	 * @throws Exception
	 */
	public function detailsCircle($circleUniqueId, $forceAll = false) {

		try {
			$circle = $this->circlesRequest->getCircle($circleUniqueId, $this->userId, '', $forceAll);
			if ($this->viewerIsAdmin()
				|| $circle->getHigherViewer()
						  ->isLevel(Member::LEVEL_MEMBER)
				|| $forceAll === true
			) {
				$this->detailsCircleMembers($circle);
				$this->detailsCircleLinkedGroups($circle);
				$this->detailsCircleFederatedCircles($circle);
			}
		} catch (Exception $e) {
			throw $e;
		}

		return $circle;
	}


	/**
	 * get the Members list and add the result to the Circle.
	 *
	 * @param Circle $circle
	 *
	 * @throws Exception
	 */
	private function detailsCircleMembers(Circle &$circle) {
		if ($this->viewerIsAdmin()) {
			$members = $this->membersRequest->forceGetMembers($circle->getUniqueId(), 0);
		} else {
			$members = $this->membersRequest->getMembers(
				$circle->getUniqueId(), $circle->getHigherViewer()
			);
		}

		$circle->setMembers($members);
	}


	/**
	 * get the Linked Group list and add the result to the Circle.
	 *
	 * @param Circle $circle
	 *
	 * @throws MemberDoesNotExistException
	 */
	private function detailsCircleLinkedGroups(Circle &$circle) {
		$groups = [];
		if ($this->configService->isLinkedGroupsAllowed()) {
			$groups =
				$this->membersRequest->getGroupsFromCircle(
					$circle->getUniqueId(), $circle->getHigherViewer()
				);
		}

		$circle->setGroups($groups);
	}


	/**
	 * get the Federated Circles list and add the result to the Circle.
	 *
	 * @param Circle $circle
	 */
	private function detailsCircleFederatedCircles(Circle &$circle) {
		$links = [];

		try {
			if ($this->configService->isFederatedCirclesAllowed()) {
				$circle->hasToBeFederated();
				$links = $this->federatedLinksRequest->getLinksFromCircle($circle->getUniqueId());
			}
		} catch (FederatedCircleNotAllowedException $e) {

		}

		$circle->setLinks($links);
	}


	/**
	 * save new settings if current user is admin.
	 *
	 * @param string $circleUniqueId
	 * @param array $settings
	 *
	 * @return Circle
	 * @throws Exception
	 */
	public function settingsCircle(string $circleUniqueId, array $settings) {
		$circle = $this->circlesRequest->getCircle($circleUniqueId, $this->userId);
		$this->hasToBeOwner($circle->getHigherViewer());

		if (!$this->viewerIsAdmin()) {
			$settings['members_limit'] = $circle->getSetting('members_limit');
		}

		// can only be run from the instance of the circle's owner.
		$event = new GSEvent(GSEvent::CIRCLE_UPDATE);
		$event->setCircle($circle);
		$event->getData()
			  ->sBool('local_admin', $this->viewerIsAdmin())
			  ->sArray('settings', $settings);

		$this->gsUpstreamService->newEvent($event);

		return $circle;
	}


	/**
	 * Join a circle.
	 *
	 * @param string $circleUniqueId
	 *
	 * @return null|Member
	 * @throws Exception
	 */
	public function joinCircle($circleUniqueId) {
		try {
			$circle = $this->circlesRequest->getCircle($circleUniqueId, $this->userId);
			$member = $this->membersRequest->getFreshNewMember(
				$circleUniqueId, $this->userId, Member::TYPE_USER, ''
			);

			$event = new GSEvent(GSEvent::MEMBER_JOIN);
			$event->setCircle($circle);
			$event->setMember($member);
			$this->gsUpstreamService->newEvent($event);
		} catch (Exception $e) {
			throw $e;
		}

		return $member;
	}


	/**
	 * Leave a circle.
	 *
	 * @param string $circleUniqueId
	 *
	 * @return null|Member
	 * @throws Exception
	 */
	public function leaveCircle($circleUniqueId) {
		$circle = $this->circlesRequest->getCircle($circleUniqueId, $this->userId);
		$member = $circle->getViewer();

		$event = new GSEvent(GSEvent::MEMBER_LEAVE);
		$event->setCircle($circle);
		$event->setMember($member);
		$this->gsUpstreamService->newEvent($event);

		return $member;
	}


	/**
	 * destroy a circle.
	 *
	 * @param string $circleUniqueId
	 *
	 * @param bool $force
	 *
	 * @throws CircleDoesNotExistException
	 * @throws MemberIsNotOwnerException
	 * @throws ConfigNoCircleAvailableException
	 * @throws Exception
	 */
	public function removeCircle($circleUniqueId, bool $force = false) {
		if ($force) {

			$circle = $this->circlesRequest->forceGetCircle($circleUniqueId);
		} else {
			$circle = $this->circlesRequest->getCircle($circleUniqueId, $this->userId);
			$this->hasToBeOwner($circle->getHigherViewer());
		}

		// removing a Circle is done only by owner, so can already be done by local user, or admin, or occ
		// at this point, we already know that all condition are filled. we can force it.
		$event = new GSEvent(GSEvent::CIRCLE_DESTROY, false, true);
		$event->setCircle($circle);

		$this->gsUpstreamService->newEvent($event);
	}


	/**
	 * @param $circleName
	 *
	 * @return Circle|null
	 * @throws CircleDoesNotExistException
	 */
	public function infoCircleByName($circleName) {
		return $this->circlesRequest->forceGetCircleByName($circleName);
	}


	/**
	 * When a user is removed.
	 * Before deleting a user from the cloud, we assign a new owner to his Circles.
	 * Remove the Circle if it has no admin.
	 *
	 * @param string $userId
	 */
	public function onUserRemoved($userId) {
		$circles = $this->circlesRequest->getCircles($userId, 0, '', Member::LEVEL_OWNER);

		foreach ($circles as $circle) {

			$members =
				$this->membersRequest->forceGetMembers($circle->getUniqueId(), Member::LEVEL_ADMIN);

			if (sizeof($members) === 1) {
				$this->circlesRequest->destroyCircle($circle->getUniqueId());
				continue;
			}

			$this->switchOlderAdminToOwner($circle, $members);
		}
	}


	/**
	 * switchOlderAdminToOwner();
	 *
	 * @param Circle $circle
	 * @param Member[] $members
	 */
	private function switchOlderAdminToOwner(Circle $circle, $members) {

		foreach ($members as $member) {
			if ($member->getLevel() === Member::LEVEL_ADMIN) {
				$member->setLevel(Member::LEVEL_OWNER);
				$this->membersRequest->updateMember($member);
				$this->eventsService->onMemberOwner($circle, $member);

				return;
			}
		}

	}


	/**
	 * Convert a Type in String to its Bit Value
	 *
	 * @param string $type
	 *
	 * @return int|mixed
	 */
	public function convertTypeStringToBitValue($type) {
		$strings = [
			'personal' => Circle::CIRCLES_PERSONAL,
			'secret'   => Circle::CIRCLES_SECRET,
			'closed'   => Circle::CIRCLES_CLOSED,
			'public'   => Circle::CIRCLES_PUBLIC,
			'all'      => Circle::CIRCLES_ALL
		];

		if (!key_exists(strtolower($type), $strings)) {
			return $type;
		}

		return $strings[strtolower($type)];
	}


	/**
	 * getCircleIcon()
	 *
	 * Return the right imagePath for a type of circle.
	 *
	 * @param string $type
	 * @param bool $png
	 *
	 * @return string
	 */
	public static function getCircleIcon($type, $png = false) {

		$ext = '.svg';
		if ($png === true) {
			$ext = '.png';
		}

		$urlGen = OC::$server->getURLGenerator();
		switch ($type) {
			case Circle::CIRCLES_PERSONAL:
				return $urlGen->getAbsoluteURL(
					$urlGen->imagePath(Application::APP_NAME, 'personal' . $ext)
				);
			case Circle::CIRCLES_CLOSED:
				return $urlGen->getAbsoluteURL(
					$urlGen->imagePath(Application::APP_NAME, 'closed' . $ext)
				);
			case Circle::CIRCLES_SECRET:
				return $urlGen->getAbsoluteURL(
					$urlGen->imagePath(Application::APP_NAME, 'secret' . $ext)
				);
			case Circle::CIRCLES_PUBLIC:
				return $urlGen->getAbsoluteURL(
					$urlGen->imagePath(Application::APP_NAME, 'black_circle' . $ext)
				);
		}

		return $urlGen->getAbsoluteURL(
			$urlGen->imagePath(Application::APP_NAME, 'black_circle' . $ext)
		);
	}


	/**
	 * @param string $circleUniqueIds
	 * @param int $limit
	 * @param int $offset
	 *
	 * @return array
	 */
	public function getFilesForCircles($circleUniqueIds, $limit = -1, $offset = 0) {
		if (!is_array($circleUniqueIds)) {
			$circleUniqueIds = [$circleUniqueIds];
		}

		$objectIds = $this->circleProviderRequest->getFilesForCircles(
			$this->userId, $circleUniqueIds, $limit, $offset
		);

		return $objectIds;
	}


	/**
	 * @param Circle $circle
	 *
	 * @throws MembersLimitException
	 */
	public function checkThatCircleIsNotFull(Circle $circle) {
		$members = $this->membersRequest->forceGetMembers(
			$circle->getUniqueId(), Member::LEVEL_MEMBER, true
		);

		$limit = $circle->getSetting('members_limit');
		if ($limit === -1) {
			return;
		}
		if ($limit === 0 || $limit === '' || $limit === null) {
			$limit = $this->configService->getAppValue(ConfigService::CIRCLES_MEMBERS_LIMIT);
		}

		if (sizeof($members) >= $limit) {
			throw new MembersLimitException(
				'This circle already reach its limit on the number of members'
			);
		}

	}

	/**
	 * @return bool
	 */
	public function viewerIsAdmin(): bool {
		if ($this->userId === '') {
			return false;
		}

		return ($this->groupManager->isAdmin($this->userId));
	}


	/**
	 * should be moved.
	 *
	 * @param Member $member
	 *
	 * @throws MemberIsNotOwnerException
	 */
	public function hasToBeOwner(Member $member) {

		if (!$this->groupManager->isAdmin($this->userId)
			&& $member->getLevel() < Member::LEVEL_OWNER) {
			throw new MemberIsNotOwnerException(
				$this->l10n->t('This member is not the owner of the circle')
			);
		}
	}


	/**
	 * should be moved.
	 *
	 * @param Member $member
	 *
	 * @throws MemberIsNotOwnerException
	 */
	public function hasToBeAdmin(Member $member) {

		if (!$this->groupManager->isAdmin($member->getUserId())
			&& $member->getLevel() < Member::LEVEL_ADMIN) {
			throw new MemberIsNotOwnerException(
				$this->l10n->t('This member is not an admin of the circle')
			);
		}
	}
}


1		<?php
2		/**
3		* Circles - Bring cloud-users closer together.
4		*
5		* This file is licensed under the Affero General Public License version 3 or
6		* later. See the COPYING file.
7		*
8		* @author Maxence Lange <[email protected]>
9		* @author Vinicius Cubas Brand <[email protected]>
10		* @author Daniel Tygel <[email protected]>
11		*
12		* @copyright 2017
13		* @license GNU AGPL version 3 or any later version
14		*
15		* This program is free software: you can redistribute it and/or modify
16		* it under the terms of the GNU Affero General Public License as
17		* published by the Free Software Foundation, either version 3 of the
18		* License, or (at your option) any later version.
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
26		* along with this program. If not, see <http://www.gnu.org/licenses/>.
27		*
28		*/
29
30		namespace OCA\Circles\Service;
31
32
33		use Exception;
34		use OC;
35		use OCA\Circles\AppInfo\Application;
36		use OCA\Circles\Db\CircleProviderRequest;
37		use OCA\Circles\Db\CirclesRequest;
38		use OCA\Circles\Db\FederatedLinksRequest;
39		use OCA\Circles\Db\MembersRequest;
40		use OCA\Circles\Db\SharesRequest;
41		use OCA\Circles\Exceptions\CircleAlreadyExistsException;
42		use OCA\Circles\Exceptions\CircleDoesNotExistException;
43		use OCA\Circles\Exceptions\CircleTypeDisabledException;
44		use OCA\Circles\Exceptions\ConfigNoCircleAvailableException;
45		use OCA\Circles\Exceptions\FederatedCircleNotAllowedException;
46		use OCA\Circles\Exceptions\MemberAlreadyExistsException;
47		use OCA\Circles\Exceptions\MemberDoesNotExistException;
48		use OCA\Circles\Exceptions\MemberIsNotOwnerException;
49		use OCA\Circles\Exceptions\MembersLimitException;
50		use OCA\Circles\Model\Circle;
51		use OCA\Circles\Model\GlobalScale\GSEvent;
52		use OCA\Circles\Model\Member;
53		use OCP\IGroupManager;
54		use OCP\IL10N;
55
56		class CirclesService {
57
58		/** @var string */
59		private $userId;
60
61		/** @var IL10N */
62		private $l10n;
63
64		/** @var IGroupManager */
65		private $groupManager;
66
67		/** @var ConfigService */
68		private $configService;
69
70		/** @var CirclesRequest */
71		private $circlesRequest;
72
73		/** @var MembersRequest */
74		private $membersRequest;
75
76		/** @var SharesRequest */
77		private $sharesRequest;
78
79		/** @var FederatedLinksRequest */
80		private $federatedLinksRequest;
81
82		/** @var GSUpstreamService */
83		private $gsUpstreamService;
84
85		/** @var EventsService */
86		private $eventsService;
87
88		/** @var CircleProviderRequest */
89		private $circleProviderRequest;
90
91		/** @var MiscService */
92		private $miscService;
93
94
95		/**
96		* CirclesService constructor.
97		*
98		* @param string $userId
99		* @param IL10N $l10n
100		* @param IGroupManager $groupManager
101		* @param ConfigService $configService
102		* @param CirclesRequest $circlesRequest
103		* @param MembersRequest $membersRequest
104		* @param SharesRequest $sharesRequest
105		* @param FederatedLinksRequest $federatedLinksRequest
106		* @param GSUpstreamService $gsUpstreamService
107		* @param EventsService $eventsService
108		* @param CircleProviderRequest $circleProviderRequest
109		* @param MiscService $miscService
110		*/
111	View Code Duplication	public function __construct(
112		$userId,
113		IL10N $l10n,
114		IGroupManager $groupManager,
115		ConfigService $configService,
116		CirclesRequest $circlesRequest,
117		MembersRequest $membersRequest,
118		SharesRequest $sharesRequest,
119		FederatedLinksRequest $federatedLinksRequest,
120		GSUpstreamService $gsUpstreamService,
121		EventsService $eventsService,
122		CircleProviderRequest $circleProviderRequest,
123		MiscService $miscService
124		) {
125		$this->userId = $userId;
126		$this->l10n = $l10n;
127		$this->groupManager = $groupManager;
128		$this->configService = $configService;
129		$this->circlesRequest = $circlesRequest;
130		$this->membersRequest = $membersRequest;
131		$this->sharesRequest = $sharesRequest;
132		$this->federatedLinksRequest = $federatedLinksRequest;
133		$this->gsUpstreamService = $gsUpstreamService;
134		$this->eventsService = $eventsService;
135		$this->circleProviderRequest = $circleProviderRequest;
136		$this->miscService = $miscService;
137		}
138
139
140		/**
141		* Create circle using this->userId as owner
142		*
143		* @param int\|string $type
144		* @param string $name
145		*
146		* @param string $ownerId
147		*
148		* @return Circle
149		* @throws CircleAlreadyExistsException
150		* @throws CircleTypeDisabledException
151		* @throws MemberAlreadyExistsException
152		* @throws Exception
153		*/
154		public function createCircle($type, $name, string $ownerId = '') {
155		$type = $this->convertTypeStringToBitValue($type);
156		$type = (int)$type;
157
158		if ($type === '') {
		0 ignored issues – show Unused Code Bug introduced 2017-07-28 02:28 UTC by Report Bug Copy Issue Report The strict comparison `===` seems to always evaluate to `false` as the types of `$type` (`integer`) and `''` (`string`) can never be identical. Maybe you want to use a loose comparison `==` instead? Loading history...
159		throw new CircleTypeDisabledException(
160		$this->l10n->t('You need a specify a type of circle')
161		);
162		}
163
164		if (!$this->configService->isCircleAllowed($type)) {
165		throw new CircleTypeDisabledException(
166		$this->l10n->t('You cannot create this type of circle')
167		);
168		}
169
170		$circle = new Circle($type, $name);
171
172		if ($ownerId === '') {
173		$ownerId = $this->userId;
174		}
175
176		if (!$this->circlesRequest->isCircleUnique($circle, $ownerId)) {
177		throw new CircleAlreadyExistsException(
178		$this->l10n->t('A circle with that name exists')
179		);
180		}
181
182		$circle->generateUniqueId();
183
184		$owner = new Member($ownerId, Member::TYPE_USER);
185		$owner->setCircleId($circle->getUniqueId())
186		->setLevel(Member::LEVEL_OWNER)
187		->setStatus(Member::STATUS_MEMBER);
188		$circle->setOwner($owner)
189		->setViewer($owner);
190
191		$event = new GSEvent(GSEvent::CIRCLE_CREATE, true);
192		$event->setCircle($circle);
193		$this->gsUpstreamService->newEvent($event);
194
195		return $circle;
196		}
197
198
199		/**
200		* list Circles depends on type (or all) and name (parts) and minimum level.
201		*
202		* @param string $userId
203		* @param mixed $type
204		* @param string $name
205		* @param int $level
206		*
207		* @param bool $forceAll
208		*
209		* @return Circle[]
210		* @throws CircleTypeDisabledException
211		* @throws Exception
212		*/
213		public function listCircles($userId, $type, $name = '', $level = 0, $forceAll = false) {
214		$type = $this->convertTypeStringToBitValue($type);
215
216		if ($userId === '') {
217		throw new Exception('UserID cannot be null');
218		}
219
220		if (!$this->configService->isCircleAllowed((int)$type)) {
221		throw new CircleTypeDisabledException(
222		$this->l10n->t('You cannot display this type of circle')
223		);
224		}
225
226		$data = [];
227		$result = $this->circlesRequest->getCircles($userId, $type, $name, $level, $forceAll);
228		foreach ($result as $item) {
229		$data[] = $item;
230		}
231
232		return $data;
233		}
234
235
236		/**
237		* returns details on circle and its members if this->userId is a member itself.
238		*
239		* @param string $circleUniqueId
240		* @param bool $forceAll
241		*
242		* @return Circle
243		* @throws Exception
244		*/
245		public function detailsCircle($circleUniqueId, $forceAll = false) {
246
247		try {
248		$circle = $this->circlesRequest->getCircle($circleUniqueId, $this->userId, '', $forceAll);
249		if ($this->viewerIsAdmin()
250		\|\| $circle->getHigherViewer()
251		->isLevel(Member::LEVEL_MEMBER)
252		\|\| $forceAll === true
253		) {
254		$this->detailsCircleMembers($circle);
255		$this->detailsCircleLinkedGroups($circle);
256		$this->detailsCircleFederatedCircles($circle);
257		}
258		} catch (Exception $e) {
259		throw $e;
260		}
261
262		return $circle;
263		}
264
265
266		/**
267		* get the Members list and add the result to the Circle.
268		*
269		* @param Circle $circle
270		*
271		* @throws Exception
272		*/
273		private function detailsCircleMembers(Circle &$circle) {
274		if ($this->viewerIsAdmin()) {
275		$members = $this->membersRequest->forceGetMembers($circle->getUniqueId(), 0);
276		} else {
277		$members = $this->membersRequest->getMembers(
278		$circle->getUniqueId(), $circle->getHigherViewer()
279		);
280		}
281
282		$circle->setMembers($members);
283		}
284
285
286		/**
287		* get the Linked Group list and add the result to the Circle.
288		*
289		* @param Circle $circle
290		*
291		* @throws MemberDoesNotExistException
292		*/
293		private function detailsCircleLinkedGroups(Circle &$circle) {
294		$groups = [];
295		if ($this->configService->isLinkedGroupsAllowed()) {
296		$groups =
297		$this->membersRequest->getGroupsFromCircle(
298		$circle->getUniqueId(), $circle->getHigherViewer()
299		);
300		}
301
302		$circle->setGroups($groups);
303		}
304
305
306		/**
307		* get the Federated Circles list and add the result to the Circle.
308		*
309		* @param Circle $circle
310		*/
311		private function detailsCircleFederatedCircles(Circle &$circle) {
312		$links = [];
313
314		try {
315		if ($this->configService->isFederatedCirclesAllowed()) {
316		$circle->hasToBeFederated();
317		$links = $this->federatedLinksRequest->getLinksFromCircle($circle->getUniqueId());
318		}
319		} catch (FederatedCircleNotAllowedException $e) {
		0 ignored issues – show Coding Style Comprehensibility introduced 2017-07-05 22:18 UTC by Report Bug Copy Issue Report Consider adding a comment why this CATCH block is empty. Loading history...
320		}
321
322		$circle->setLinks($links);
323		}
324
325
326		/**
327		* save new settings if current user is admin.
328		*
329		* @param string $circleUniqueId
330		* @param array $settings
331		*
332		* @return Circle
333		* @throws Exception
334		*/
335		public function settingsCircle(string $circleUniqueId, array $settings) {
336		$circle = $this->circlesRequest->getCircle($circleUniqueId, $this->userId);
337		$this->hasToBeOwner($circle->getHigherViewer());
338
339		if (!$this->viewerIsAdmin()) {
340		$settings['members_limit'] = $circle->getSetting('members_limit');
341		}
342
343		// can only be run from the instance of the circle's owner.
344		$event = new GSEvent(GSEvent::CIRCLE_UPDATE);
345		$event->setCircle($circle);
346		$event->getData()
347		->sBool('local_admin', $this->viewerIsAdmin())
348		->sArray('settings', $settings);
349
350		$this->gsUpstreamService->newEvent($event);
351
352		return $circle;
353		}
354
355
356		/**
357		* Join a circle.
358		*
359		* @param string $circleUniqueId
360		*
361		* @return null\|Member
362		* @throws Exception
363		*/
364		public function joinCircle($circleUniqueId) {
365		try {
366		$circle = $this->circlesRequest->getCircle($circleUniqueId, $this->userId);
367		$member = $this->membersRequest->getFreshNewMember(
368		$circleUniqueId, $this->userId, Member::TYPE_USER, ''
369		);
370
371		$event = new GSEvent(GSEvent::MEMBER_JOIN);
372		$event->setCircle($circle);
373		$event->setMember($member);
374		$this->gsUpstreamService->newEvent($event);
375		} catch (Exception $e) {
376		throw $e;
377		}
378
379		return $member;
380		}
381
382
383		/**
384		* Leave a circle.
385		*
386		* @param string $circleUniqueId
387		*
388		* @return null\|Member
389		* @throws Exception
390		*/
391		public function leaveCircle($circleUniqueId) {
392		$circle = $this->circlesRequest->getCircle($circleUniqueId, $this->userId);
393		$member = $circle->getViewer();
394
395		$event = new GSEvent(GSEvent::MEMBER_LEAVE);
396		$event->setCircle($circle);
397		$event->setMember($member);
398		$this->gsUpstreamService->newEvent($event);
399
400		return $member;
401		}
402
403
404		/**
405		* destroy a circle.
406		*
407		* @param string $circleUniqueId
408		*
409		* @param bool $force
410		*
411		* @throws CircleDoesNotExistException
412		* @throws MemberIsNotOwnerException
413		* @throws ConfigNoCircleAvailableException
414		* @throws Exception
415		*/
416		public function removeCircle($circleUniqueId, bool $force = false) {
417	View Code Duplication	if ($force) {
		0 ignored issues – show Duplication introduced 2020-03-16 12:28 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
418		$circle = $this->circlesRequest->forceGetCircle($circleUniqueId);
419		} else {
420		$circle = $this->circlesRequest->getCircle($circleUniqueId, $this->userId);
421		$this->hasToBeOwner($circle->getHigherViewer());
422		}
423
424		// removing a Circle is done only by owner, so can already be done by local user, or admin, or occ
425		// at this point, we already know that all condition are filled. we can force it.
426		$event = new GSEvent(GSEvent::CIRCLE_DESTROY, false, true);
427		$event->setCircle($circle);
428
429		$this->gsUpstreamService->newEvent($event);
430		}
431
432
433		/**
434		* @param $circleName
435		*
436		* @return Circle\|null
437		* @throws CircleDoesNotExistException
438		*/
439		public function infoCircleByName($circleName) {
440		return $this->circlesRequest->forceGetCircleByName($circleName);
441		}
442
443
444		/**
445		* When a user is removed.
446		* Before deleting a user from the cloud, we assign a new owner to his Circles.
447		* Remove the Circle if it has no admin.
448		*
449		* @param string $userId
450		*/
451		public function onUserRemoved($userId) {
452		$circles = $this->circlesRequest->getCircles($userId, 0, '', Member::LEVEL_OWNER);
453
454		foreach ($circles as $circle) {
455
456		$members =
457		$this->membersRequest->forceGetMembers($circle->getUniqueId(), Member::LEVEL_ADMIN);
458
459		if (sizeof($members) === 1) {
460		$this->circlesRequest->destroyCircle($circle->getUniqueId());
461		continue;
462		}
463
464		$this->switchOlderAdminToOwner($circle, $members);
465		}
466		}
467
468
469		/**
470		* switchOlderAdminToOwner();
471		*
472		* @param Circle $circle
473		* @param Member[] $members
474		*/
475		private function switchOlderAdminToOwner(Circle $circle, $members) {
476
477		foreach ($members as $member) {
478		if ($member->getLevel() === Member::LEVEL_ADMIN) {
479		$member->setLevel(Member::LEVEL_OWNER);
480		$this->membersRequest->updateMember($member);
481		$this->eventsService->onMemberOwner($circle, $member);
482
483		return;
484		}
485		}
486
487		}
488
489
490		/**
491		* Convert a Type in String to its Bit Value
492		*
493		* @param string $type
494		*
495		* @return int\|mixed
496		*/
497		public function convertTypeStringToBitValue($type) {
498		$strings = [
499		'personal' => Circle::CIRCLES_PERSONAL,
500		'secret' => Circle::CIRCLES_SECRET,
501		'closed' => Circle::CIRCLES_CLOSED,
502		'public' => Circle::CIRCLES_PUBLIC,
503		'all' => Circle::CIRCLES_ALL
504		];
505
506		if (!key_exists(strtolower($type), $strings)) {
507		return $type;
508		}
509
510		return $strings[strtolower($type)];
511		}
512
513
514		/**
515		* getCircleIcon()
516		*
517		* Return the right imagePath for a type of circle.
518		*
519		* @param string $type
520		* @param bool $png
521		*
522		* @return string
523		*/
524		public static function getCircleIcon($type, $png = false) {
525
526		$ext = '.svg';
527		if ($png === true) {
528		$ext = '.png';
529		}
530
531		$urlGen = OC::$server->getURLGenerator();
532		switch ($type) {
533		case Circle::CIRCLES_PERSONAL:
534		return $urlGen->getAbsoluteURL(
535		$urlGen->imagePath(Application::APP_NAME, 'personal' . $ext)
536		);
537		case Circle::CIRCLES_CLOSED:
538		return $urlGen->getAbsoluteURL(
539		$urlGen->imagePath(Application::APP_NAME, 'closed' . $ext)
540		);
541		case Circle::CIRCLES_SECRET:
542		return $urlGen->getAbsoluteURL(
543		$urlGen->imagePath(Application::APP_NAME, 'secret' . $ext)
544		);
545		case Circle::CIRCLES_PUBLIC:
546		return $urlGen->getAbsoluteURL(
547		$urlGen->imagePath(Application::APP_NAME, 'black_circle' . $ext)
548		);
549		}
550
551		return $urlGen->getAbsoluteURL(
552		$urlGen->imagePath(Application::APP_NAME, 'black_circle' . $ext)
553		);
554		}
555
556
557		/**
558		* @param string $circleUniqueIds
559		* @param int $limit
560		* @param int $offset
561		*
562		* @return array
563		*/
564		public function getFilesForCircles($circleUniqueIds, $limit = -1, $offset = 0) {
565		if (!is_array($circleUniqueIds)) {
566		$circleUniqueIds = [$circleUniqueIds];
567		}
568
569		$objectIds = $this->circleProviderRequest->getFilesForCircles(
570		$this->userId, $circleUniqueIds, $limit, $offset
571		);
572
573		return $objectIds;
574		}
575
576
577		/**
578		* @param Circle $circle
579		*
580		* @throws MembersLimitException
581		*/
582		public function checkThatCircleIsNotFull(Circle $circle) {
583		$members = $this->membersRequest->forceGetMembers(
584		$circle->getUniqueId(), Member::LEVEL_MEMBER, true
585		);
586
587		$limit = $circle->getSetting('members_limit');
588		if ($limit === -1) {
589		return;
590		}
591		if ($limit === 0 \|\| $limit === '' \|\| $limit === null) {
592		$limit = $this->configService->getAppValue(ConfigService::CIRCLES_MEMBERS_LIMIT);
593		}
594
595		if (sizeof($members) >= $limit) {
596		throw new MembersLimitException(
597		'This circle already reach its limit on the number of members'
598		);
599		}
600
601		}
602
603		/**
604		* @return bool
605		*/
606		public function viewerIsAdmin(): bool {
607		if ($this->userId === '') {
608		return false;
609		}
610
611		return ($this->groupManager->isAdmin($this->userId));
612		}
613
614
615		/**
616		* should be moved.
617		*
618		* @param Member $member
619		*
620		* @throws MemberIsNotOwnerException
621		*/
622	View Code Duplication	public function hasToBeOwner(Member $member) {
		0 ignored issues – show Duplication introduced 2018-08-01 10:01 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
623		if (!$this->groupManager->isAdmin($this->userId)
624		&& $member->getLevel() < Member::LEVEL_OWNER) {
625		throw new MemberIsNotOwnerException(
626		$this->l10n->t('This member is not the owner of the circle')
627		);
628		}
629		}
630
631
632		/**
633		* should be moved.
634		*
635		* @param Member $member
636		*
637		* @throws MemberIsNotOwnerException
638		*/
639	View Code Duplication	public function hasToBeAdmin(Member $member) {
		0 ignored issues – show Duplication introduced 2018-08-01 10:01 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
640		if (!$this->groupManager->isAdmin($member->getUserId())
641		&& $member->getLevel() < Member::LEVEL_ADMIN) {
642		throw new MemberIsNotOwnerException(
643		$this->l10n->t('This member is not an admin of the circle')
644		);
645		}
646		}
647		}
648

nextcloud / circles

Pull Request — master (#362)

CirclesService::createCircle() B

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like