UserPlugin::__construct() - Code Metrics - Inspection of "Merge pull request #26031 from nextcloud/feature/n..." - nextcloud/server - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 31cc07...56b08c )

by Joas

created 2021-03-11 07:29 UTC

UserPlugin::__construct() A

↳ Parent: UserPlugin

Complexity

Conditions	3
Paths	4

Size

Total Lines	19
Code Lines	11

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	3
eloc	11
nc	4
nop	6
dl	0
loc	19
rs	9.9
c	0
b	0
f	0

<?php
/**
 * @copyright Copyright (c) 2017 Arthur Schiwon <[email protected]>
 *
 * @author Arthur Schiwon <[email protected]>
 * @author Christoph Wurst <[email protected]>
 * @author Georg Ehrke <[email protected]>
 * @author Joas Schilling <[email protected]>
 * @author John Molakvoæ (skjnldsv) <[email protected]>
 * @author Julius Härtl <[email protected]>
 * @author Morris Jobke <[email protected]>
 * @author Robin Appelman <[email protected]>
 * @author Roeland Jago Douma <[email protected]>
 * @author Thomas Citharel <[email protected]>
 *
 * @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 OC\Collaboration\Collaborators;

use OC\KnownUser\KnownUserService;
use OCP\Collaboration\Collaborators\ISearchPlugin;
use OCP\Collaboration\Collaborators\ISearchResult;
use OCP\Collaboration\Collaborators\SearchResultType;
use OCP\IConfig;
use OCP\IGroupManager;
use OCP\IUser;
use OCP\IUserManager;
use OCP\IUserSession;
use OCP\Share\IShare;
use OCP\UserStatus\IManager as IUserStatusManager;

class UserPlugin implements ISearchPlugin {
	/* @var bool */
	protected $shareWithGroupOnly;
	/* @var bool */
	protected $shareeEnumeration;
	/* @var bool */
	protected $shareeEnumerationInGroupOnly;
	/* @var bool */
	protected $shareeEnumerationPhone;
	/* @var bool */
	protected $shareeEnumerationFullMatch;

	/** @var IConfig */
	private $config;
	/** @var IGroupManager */
	private $groupManager;
	/** @var IUserSession */
	private $userSession;
	/** @var IUserManager */
	private $userManager;
	/** @var KnownUserService */
	private $knownUserService;
	/** @var IUserStatusManager */
	private $userStatusManager;

	public function __construct(IConfig $config,
								IUserManager $userManager,
								IGroupManager $groupManager,
								IUserSession $userSession,
								KnownUserService $knownUserService,
								IUserStatusManager $userStatusManager) {
		$this->config = $config;

		$this->groupManager = $groupManager;
		$this->userSession = $userSession;
		$this->userManager = $userManager;
		$this->knownUserService = $knownUserService;
		$this->userStatusManager = $userStatusManager;

		$this->shareWithGroupOnly = $this->config->getAppValue('core', 'shareapi_only_share_with_group_members', 'no') === 'yes';
		$this->shareeEnumeration = $this->config->getAppValue('core', 'shareapi_allow_share_dialog_user_enumeration', 'yes') === 'yes';
		$this->shareeEnumerationInGroupOnly = $this->shareeEnumeration && $this->config->getAppValue('core', 'shareapi_restrict_user_enumeration_to_group', 'no') === 'yes';
		$this->shareeEnumerationPhone = $this->shareeEnumeration && $this->config->getAppValue('core', 'shareapi_restrict_user_enumeration_to_phone', 'no') === 'yes';
		$this->shareeEnumerationFullMatch = $this->config->getAppValue('core', 'shareapi_restrict_user_enumeration_full_match', 'yes') === 'yes';
	}

	public function search($search, $limit, $offset, ISearchResult $searchResult) {
		$result = ['wide' => [], 'exact' => []];
		$users = [];
		$hasMoreResults = false;

		$currentUserId = $this->userSession->getUser()->getUID();
		$currentUserGroups = $this->groupManager->getUserGroupIds($this->userSession->getUser());
		if ($this->shareWithGroupOnly) {
			// Search in all the groups this user is part of
			foreach ($currentUserGroups as $userGroupId) {
				$usersInGroup = $this->groupManager->displayNamesInGroup($userGroupId, $search, $limit, $offset);
				foreach ($usersInGroup as $userId => $displayName) {
					$userId = (string) $userId;
					$user = $this->userManager->get($userId);
					if (!$user->isEnabled()) {
						// Ignore disabled users
						continue;
					}
					$users[$userId] = $user;
				}
				if (count($usersInGroup) >= $limit) {
					$hasMoreResults = true;
				}
			}
		} else {
			// Search in all users
			$usersTmp = $this->userManager->searchDisplayName($search, $limit, $offset);
			foreach ($usersTmp as $user) {
				if ($user->isEnabled()) { // Don't keep deactivated users
					$users[$user->getUID()] = $user;
				}
			}
		}

		$this->takeOutCurrentUser($users);

		if (!$this->shareeEnumeration || count($users) < $limit) {
			$hasMoreResults = true;
		}

		$foundUserById = false;
		$lowerSearch = strtolower($search);
		$userStatuses = $this->userStatusManager->getUserStatuses(array_keys($users));
		foreach ($users as $uid => $user) {
			$userDisplayName = $user->getDisplayName();
			$userEmail = $user->getEMailAddress();
			$uid = (string) $uid;

			$status = [];
			if (array_key_exists($uid, $userStatuses)) {
				$userStatus = $userStatuses[$uid];
				$status = [
					'status' => $userStatus->getStatus(),
					'message' => $userStatus->getMessage(),
					'icon' => $userStatus->getIcon(),
					'clearAt' => $userStatus->getClearAt()
						? (int)$userStatus->getClearAt()->format('U')
						: null,
				];
			}


			if (
				$this->shareeEnumerationFullMatch &&
				$lowerSearch !== '' && (strtolower($uid) === $lowerSearch ||
				strtolower($userDisplayName) === $lowerSearch ||
				strtolower($userEmail) === $lowerSearch)
			) {
				if (strtolower($uid) === $lowerSearch) {
					$foundUserById = true;
				}
				$result['exact'][] = [
					'label' => $userDisplayName,
					'subline' => $status['message'] ?? '',
					'icon' => 'icon-user',
					'value' => [
						'shareType' => IShare::TYPE_USER,
						'shareWith' => $uid,
					],
					'shareWithDisplayNameUnique' => !empty($userEmail) ? $userEmail : $uid,
					'status' => $status,
				];
			} else {
				$addToWideResults = false;
				if ($this->shareeEnumeration &&
					!($this->shareeEnumerationInGroupOnly || $this->shareeEnumerationPhone)) {
					$addToWideResults = true;
				}

				if ($this->shareeEnumerationPhone && $this->knownUserService->isKnownToUser($currentUserId, $user->getUID())) {
					$addToWideResults = true;
				}

				if (!$addToWideResults && $this->shareeEnumerationInGroupOnly) {
					$commonGroups = array_intersect($currentUserGroups, $this->groupManager->getUserGroupIds($user));
					if (!empty($commonGroups)) {
						$addToWideResults = true;
					}
				}

				if ($addToWideResults) {
					$result['wide'][] = [
						'label' => $userDisplayName,
						'subline' => $status['message'] ?? '',
						'icon' => 'icon-user',
						'value' => [
							'shareType' => IShare::TYPE_USER,
							'shareWith' => $uid,
						],
						'shareWithDisplayNameUnique' => !empty($userEmail) ? $userEmail : $uid,
						'status' => $status,
					];
				}
			}
		}

		if ($this->shareeEnumerationFullMatch && $offset === 0 && !$foundUserById) {
			// On page one we try if the search result has a direct hit on the
			// user id and if so, we add that to the exact match list
			$user = $this->userManager->get($search);
			if ($user instanceof IUser) {
				$addUser = true;

				if ($this->shareWithGroupOnly) {
					// Only add, if we have a common group
					$commonGroups = array_intersect($currentUserGroups, $this->groupManager->getUserGroupIds($user));
					$addUser = !empty($commonGroups);
				}

				if ($addUser) {
					$status = [];
					$uid = $user->getUID();
					$userEmail = $user->getEMailAddress();
					if (array_key_exists($user->getUID(), $userStatuses)) {
						$userStatus = $userStatuses[$user->getUID()];
						$status = [
							'status' => $userStatus->getStatus(),
							'message' => $userStatus->getMessage(),
							'icon' => $userStatus->getIcon(),
							'clearAt' => $userStatus->getClearAt()
								? (int)$userStatus->getClearAt()->format('U')
								: null,
						];
					}

					$result['exact'][] = [
						'label' => $user->getDisplayName(),
						'icon' => 'icon-user',
						'subline' => $status['message'] ?? '',
						'value' => [
							'shareType' => IShare::TYPE_USER,
							'shareWith' => $user->getUID(),
						],
						'shareWithDisplayNameUnique' => $userEmail !== null && $userEmail !== '' ? $userEmail : $uid,
						'status' => $status,
					];
				}
			}
		}



		$type = new SearchResultType('users');
		$searchResult->addResultSet($type, $result['wide'], $result['exact']);
		if (count($result['exact'])) {
			$searchResult->markExactIdMatch($type);
		}

		return $hasMoreResults;
	}

	public function takeOutCurrentUser(array &$users) {
		$currentUser = $this->userSession->getUser();
		if (!is_null($currentUser)) {
			if (isset($users[$currentUser->getUID()])) {
				unset($users[$currentUser->getUID()]);
			}
		}
	}
}


1			<?php
2			/**
3			* @copyright Copyright (c) 2017 Arthur Schiwon <[email protected]>
4			*
5			* @author Arthur Schiwon <[email protected]>
6			* @author Christoph Wurst <[email protected]>
7			* @author Georg Ehrke <[email protected]>
8			* @author Joas Schilling <[email protected]>
9			* @author John Molakvoæ (skjnldsv) <[email protected]>
10			* @author Julius Härtl <[email protected]>
11			* @author Morris Jobke <[email protected]>
12			* @author Robin Appelman <[email protected]>
13			* @author Roeland Jago Douma <[email protected]>
14			* @author Thomas Citharel <[email protected]>
15			*
16			* @license GNU AGPL version 3 or any later version
17			*
18			* This program is free software: you can redistribute it and/or modify
19			* it under the terms of the GNU Affero General Public License as
20			* published by the Free Software Foundation, either version 3 of the
21			* License, or (at your option) any later version.
22			*
23			* This program is distributed in the hope that it will be useful,
24			* but WITHOUT ANY WARRANTY; without even the implied warranty of
25			* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
26			* GNU Affero General Public License for more details.
27			*
28			* You should have received a copy of the GNU Affero General Public License
29			* along with this program. If not, see <http://www.gnu.org/licenses/>.
30			*
31			*/
32
33			namespace OC\Collaboration\Collaborators;
34
35			use OC\KnownUser\KnownUserService;
36			use OCP\Collaboration\Collaborators\ISearchPlugin;
37			use OCP\Collaboration\Collaborators\ISearchResult;
38			use OCP\Collaboration\Collaborators\SearchResultType;
39			use OCP\IConfig;
40			use OCP\IGroupManager;
41			use OCP\IUser;
42			use OCP\IUserManager;
43			use OCP\IUserSession;
44			use OCP\Share\IShare;
45			use OCP\UserStatus\IManager as IUserStatusManager;
46
47			class UserPlugin implements ISearchPlugin {
48			/* @var bool */
49			protected $shareWithGroupOnly;
50			/* @var bool */
51			protected $shareeEnumeration;
52			/* @var bool */
53			protected $shareeEnumerationInGroupOnly;
54			/* @var bool */
55			protected $shareeEnumerationPhone;
56			/* @var bool */
57			protected $shareeEnumerationFullMatch;
58
59			/** @var IConfig */
60			private $config;
61			/** @var IGroupManager */
62			private $groupManager;
63			/** @var IUserSession */
64			private $userSession;
65			/** @var IUserManager */
66			private $userManager;
67			/** @var KnownUserService */
68			private $knownUserService;
69			/** @var IUserStatusManager */
70			private $userStatusManager;
71
72			public function __construct(IConfig $config,
73			IUserManager $userManager,
74			IGroupManager $groupManager,
75			IUserSession $userSession,
76			KnownUserService $knownUserService,
77			IUserStatusManager $userStatusManager) {
78			$this->config = $config;
79
80			$this->groupManager = $groupManager;
81			$this->userSession = $userSession;
82			$this->userManager = $userManager;
83			$this->knownUserService = $knownUserService;
84			$this->userStatusManager = $userStatusManager;
85
86			$this->shareWithGroupOnly = $this->config->getAppValue('core', 'shareapi_only_share_with_group_members', 'no') === 'yes';
87			$this->shareeEnumeration = $this->config->getAppValue('core', 'shareapi_allow_share_dialog_user_enumeration', 'yes') === 'yes';
88			$this->shareeEnumerationInGroupOnly = $this->shareeEnumeration && $this->config->getAppValue('core', 'shareapi_restrict_user_enumeration_to_group', 'no') === 'yes';
89			$this->shareeEnumerationPhone = $this->shareeEnumeration && $this->config->getAppValue('core', 'shareapi_restrict_user_enumeration_to_phone', 'no') === 'yes';
90			$this->shareeEnumerationFullMatch = $this->config->getAppValue('core', 'shareapi_restrict_user_enumeration_full_match', 'yes') === 'yes';
91			}
92
93			public function search($search, $limit, $offset, ISearchResult $searchResult) {
94			$result = ['wide' => [], 'exact' => []];
95			$users = [];
96			$hasMoreResults = false;
97
98			$currentUserId = $this->userSession->getUser()->getUID();
99			$currentUserGroups = $this->groupManager->getUserGroupIds($this->userSession->getUser());
100			if ($this->shareWithGroupOnly) {
101			// Search in all the groups this user is part of
102			foreach ($currentUserGroups as $userGroupId) {
103			$usersInGroup = $this->groupManager->displayNamesInGroup($userGroupId, $search, $limit, $offset);
104			foreach ($usersInGroup as $userId => $displayName) {
105			$userId = (string) $userId;
106			$user = $this->userManager->get($userId);
107			if (!$user->isEnabled()) {
108			// Ignore disabled users
109			continue;
110			}
111			$users[$userId] = $user;
112			}
113			if (count($usersInGroup) >= $limit) {
114			$hasMoreResults = true;
115			}
116			}
117			} else {
118			// Search in all users
119			$usersTmp = $this->userManager->searchDisplayName($search, $limit, $offset);
120			foreach ($usersTmp as $user) {
121			if ($user->isEnabled()) { // Don't keep deactivated users
122			$users[$user->getUID()] = $user;
123			}
124			}
125			}
126
127			$this->takeOutCurrentUser($users);
128
129			if (!$this->shareeEnumeration \|\| count($users) < $limit) {
130			$hasMoreResults = true;
131			}
132
133			$foundUserById = false;
134			$lowerSearch = strtolower($search);
135			$userStatuses = $this->userStatusManager->getUserStatuses(array_keys($users));
136			foreach ($users as $uid => $user) {
137			$userDisplayName = $user->getDisplayName();
138			$userEmail = $user->getEMailAddress();
139			$uid = (string) $uid;
140
141			$status = [];
142			if (array_key_exists($uid, $userStatuses)) {
143			$userStatus = $userStatuses[$uid];
144			$status = [
145			'status' => $userStatus->getStatus(),
146			'message' => $userStatus->getMessage(),
147			'icon' => $userStatus->getIcon(),
148			'clearAt' => $userStatus->getClearAt()
149			? (int)$userStatus->getClearAt()->format('U')
150			: null,
151			];
152			}
153
154
155			if (
156			$this->shareeEnumerationFullMatch &&
157			$lowerSearch !== '' && (strtolower($uid) === $lowerSearch \|\|
158			strtolower($userDisplayName) === $lowerSearch \|\|
159			strtolower($userEmail) === $lowerSearch)
160			) {
161			if (strtolower($uid) === $lowerSearch) {
162			$foundUserById = true;
163			}
164			$result['exact'][] = [
165			'label' => $userDisplayName,
166			'subline' => $status['message'] ?? '',
167			'icon' => 'icon-user',
168			'value' => [
169			'shareType' => IShare::TYPE_USER,
170			'shareWith' => $uid,
171			],
172			'shareWithDisplayNameUnique' => !empty($userEmail) ? $userEmail : $uid,
173			'status' => $status,
174			];
175			} else {
176			$addToWideResults = false;
177			if ($this->shareeEnumeration &&
178			!($this->shareeEnumerationInGroupOnly \|\| $this->shareeEnumerationPhone)) {
179			$addToWideResults = true;
180			}
181
182			if ($this->shareeEnumerationPhone && $this->knownUserService->isKnownToUser($currentUserId, $user->getUID())) {
183			$addToWideResults = true;
184			}
185
186			if (!$addToWideResults && $this->shareeEnumerationInGroupOnly) {
187			$commonGroups = array_intersect($currentUserGroups, $this->groupManager->getUserGroupIds($user));
188			if (!empty($commonGroups)) {
189			$addToWideResults = true;
190			}
191			}
192
193			if ($addToWideResults) {
194			$result['wide'][] = [
195			'label' => $userDisplayName,
196			'subline' => $status['message'] ?? '',
197			'icon' => 'icon-user',
198			'value' => [
199			'shareType' => IShare::TYPE_USER,
200			'shareWith' => $uid,
201			],
202			'shareWithDisplayNameUnique' => !empty($userEmail) ? $userEmail : $uid,
203			'status' => $status,
204			];
205			}
206			}
207			}
208
209			if ($this->shareeEnumerationFullMatch && $offset === 0 && !$foundUserById) {
210			// On page one we try if the search result has a direct hit on the
211			// user id and if so, we add that to the exact match list
212			$user = $this->userManager->get($search);
213			if ($user instanceof IUser) {
214			$addUser = true;
215
216			if ($this->shareWithGroupOnly) {
217			// Only add, if we have a common group
218			$commonGroups = array_intersect($currentUserGroups, $this->groupManager->getUserGroupIds($user));
219			$addUser = !empty($commonGroups);
220			}
221
222			if ($addUser) {
223			$status = [];
224			$uid = $user->getUID();
225			$userEmail = $user->getEMailAddress();
226			if (array_key_exists($user->getUID(), $userStatuses)) {
227			$userStatus = $userStatuses[$user->getUID()];
228			$status = [
229			'status' => $userStatus->getStatus(),
230			'message' => $userStatus->getMessage(),
231			'icon' => $userStatus->getIcon(),
232			'clearAt' => $userStatus->getClearAt()
233			? (int)$userStatus->getClearAt()->format('U')
234			: null,
235			];
236			}
237
238			$result['exact'][] = [
239			'label' => $user->getDisplayName(),
240			'icon' => 'icon-user',
241			'subline' => $status['message'] ?? '',
242			'value' => [
243			'shareType' => IShare::TYPE_USER,
244			'shareWith' => $user->getUID(),
245			],
246			'shareWithDisplayNameUnique' => $userEmail !== null && $userEmail !== '' ? $userEmail : $uid,
247			'status' => $status,
248			];
249			}
250			}
251			}
252
253
254
255			$type = new SearchResultType('users');
256			$searchResult->addResultSet($type, $result['wide'], $result['exact']);
257			if (count($result['exact'])) {
258			$searchResult->markExactIdMatch($type);
259			}
260
261			return $hasMoreResults;
262			}
263
264			public function takeOutCurrentUser(array &$users) {
265			$currentUser = $this->userSession->getUser();
266			if (!is_null($currentUser)) {
267			if (isset($users[$currentUser->getUID()])) {
268			unset($users[$currentUser->getUID()]);
269			}
270			}
271			}
272			}
273

nextcloud / server

Push — master ( 31cc07...56b08c )

UserPlugin::__construct() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like