MailPlugin::__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

MailPlugin::__construct() A

↳ Parent: MailPlugin

Complexity

Conditions	3
Paths	4

Size

Total Lines	18
Code Lines	11

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	3
eloc	11
nc	4
nop	6
dl	0
loc	18
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 Joas Schilling <[email protected]>
 * @author Julius Härtl <[email protected]>
 * @author Tobia De Koninck <[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\Contacts\IManager;
use OCP\Federation\ICloudId;
use OCP\Federation\ICloudIdManager;
use OCP\IConfig;
use OCP\IGroupManager;
use OCP\IUser;
use OCP\IUserSession;
use OCP\Share\IShare;

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

	/** @var IManager */
	private $contactsManager;
	/** @var ICloudIdManager */
	private $cloudIdManager;
	/** @var IConfig */
	private $config;

	/** @var IGroupManager */
	private $groupManager;
	/** @var KnownUserService */
	private $knownUserService;
	/** @var IUserSession */
	private $userSession;

	public function __construct(IManager $contactsManager,
								ICloudIdManager $cloudIdManager,
								IConfig $config,
								IGroupManager $groupManager,
								KnownUserService $knownUserService,
								IUserSession $userSession) {
		$this->contactsManager = $contactsManager;
		$this->cloudIdManager = $cloudIdManager;
		$this->config = $config;
		$this->groupManager = $groupManager;
		$this->knownUserService = $knownUserService;
		$this->userSession = $userSession;

		$this->shareeEnumeration = $this->config->getAppValue('core', 'shareapi_allow_share_dialog_user_enumeration', 'yes') === 'yes';
		$this->shareWithGroupOnly = $this->config->getAppValue('core', 'shareapi_only_share_with_group_members', 'no') === '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';
	}

	/**
	 * @param $search
	 * @param $limit
	 * @param $offset
	 * @param ISearchResult $searchResult
	 * @return bool
	 * @since 13.0.0
	 */
	public function search($search, $limit, $offset, ISearchResult $searchResult) {
		$currentUserId = $this->userSession->getUser()->getUID();

		$result = $userResults = ['wide' => [], 'exact' => []];
		$userType = new SearchResultType('users');
		$emailType = new SearchResultType('emails');

		// Search in contacts
		$addressBookContacts = $this->contactsManager->search($search, ['EMAIL', 'FN'], ['limit' => $limit, 'offset' => $offset]);
		$lowerSearch = strtolower($search);
		foreach ($addressBookContacts as $contact) {
			if (isset($contact['EMAIL'])) {
				$emailAddresses = $contact['EMAIL'];
				if (\is_string($emailAddresses)) {
					$emailAddresses = [$emailAddresses];
				}
				foreach ($emailAddresses as $type => $emailAddress) {
					$displayName = $emailAddress;
					$emailAddressType = null;
					if (\is_array($emailAddress)) {
						$emailAddressData = $emailAddress;
						$emailAddress = $emailAddressData['value'];
						$emailAddressType = $emailAddressData['type'];
					}
					if (isset($contact['FN'])) {
						$displayName = $contact['FN'] . ' (' . $emailAddress . ')';
					}
					$exactEmailMatch = strtolower($emailAddress) === $lowerSearch;

					if (isset($contact['isLocalSystemBook'])) {
						if ($this->shareWithGroupOnly) {
							/*
							 * Check if the user may share with the user associated with the e-mail of the just found contact
							 */
							$userGroups = $this->groupManager->getUserGroupIds($this->userSession->getUser());
							$found = false;
							foreach ($userGroups as $userGroup) {
								if ($this->groupManager->isInGroup($contact['UID'], $userGroup)) {
									$found = true;
									break;
								}
							}
							if (!$found) {
								continue;
							}
						}
						if ($exactEmailMatch && $this->shareeEnumerationFullMatch) {
							try {
								$cloud = $this->cloudIdManager->resolveCloudId($contact['CLOUD'][0]);
							} catch (\InvalidArgumentException $e) {
								continue;
							}

							if (!$this->isCurrentUser($cloud) && !$searchResult->hasResult($userType, $cloud->getUser())) {
								$singleResult = [[
									'label' => $displayName,
									'uuid' => $contact['UID'],
									'name' => $contact['FN'],
									'value' => [
										'shareType' => IShare::TYPE_USER,
										'shareWith' => $cloud->getUser(),
									],
									'shareWithDisplayNameUnique' => !empty($emailAddress) ? $emailAddress : $cloud->getUser()

								]];
								$searchResult->addResultSet($userType, [], $singleResult);
								$searchResult->markExactIdMatch($emailType);
							}
							return false;
						}

						if ($this->shareeEnumeration) {
							try {
								$cloud = $this->cloudIdManager->resolveCloudId($contact['CLOUD'][0]);
							} catch (\InvalidArgumentException $e) {
								continue;
							}

							$addToWide = !($this->shareeEnumerationInGroupOnly || $this->shareeEnumerationPhone);
							if (!$addToWide && $this->shareeEnumerationPhone && $this->knownUserService->isKnownToUser($currentUserId, $contact['UID'])) {
								$addToWide = true;
							}

							if (!$addToWide && $this->shareeEnumerationInGroupOnly) {
								$addToWide = false;
								$userGroups = $this->groupManager->getUserGroupIds($this->userSession->getUser());
								foreach ($userGroups as $userGroup) {
									if ($this->groupManager->isInGroup($contact['UID'], $userGroup)) {
										$addToWide = true;
										break;
									}
								}
							}
							if ($addToWide && !$this->isCurrentUser($cloud) && !$searchResult->hasResult($userType, $cloud->getUser())) {
								$userResults['wide'][] = [
									'label' => $displayName,
									'uuid' => $contact['UID'],
									'name' => $contact['FN'],
									'value' => [
										'shareType' => IShare::TYPE_USER,
										'shareWith' => $cloud->getUser(),
									],
									'shareWithDisplayNameUnique' => !empty($emailAddress) ? $emailAddress : $cloud->getUser()
								];
								continue;
							}
						}
						continue;
					}

					if ($exactEmailMatch
						|| (isset($contact['FN']) && strtolower($contact['FN']) === $lowerSearch)) {
						if ($exactEmailMatch) {
							$searchResult->markExactIdMatch($emailType);
						}
						$result['exact'][] = [
							'label' => $displayName,
							'uuid' => $contact['UID'],
							'name' => $contact['FN'],
							'type' => $emailAddressType ?? '',
							'value' => [
								'shareType' => IShare::TYPE_EMAIL,
								'shareWith' => $emailAddress,
							],
						];
					} else {
						$result['wide'][] = [
							'label' => $displayName,
							'uuid' => $contact['UID'],
							'name' => $contact['FN'],
							'type' => $emailAddressType ?? '',
							'value' => [
								'shareType' => IShare::TYPE_EMAIL,
								'shareWith' => $emailAddress,
							],
						];
					}
				}
			}
		}

		$reachedEnd = true;
		if (!$this->shareeEnumeration) {
			$result['wide'] = [];
			$userResults['wide'] = [];
		} else {
			$reachedEnd = (count($result['wide']) < $offset + $limit) &&
				(count($userResults['wide']) < $offset + $limit);

			$result['wide'] = array_slice($result['wide'], $offset, $limit);
			$userResults['wide'] = array_slice($userResults['wide'], $offset, $limit);
		}


		if (!$searchResult->hasExactIdMatch($emailType) && filter_var($search, FILTER_VALIDATE_EMAIL)) {
			$result['exact'][] = [
				'label' => $search,
				'uuid' => $search,
				'value' => [
					'shareType' => IShare::TYPE_EMAIL,
					'shareWith' => $search,
				],
			];
		}

		if (!empty($userResults['wide'])) {
			$searchResult->addResultSet($userType, $userResults['wide'], []);
		}
		$searchResult->addResultSet($emailType, $result['wide'], $result['exact']);

		return !$reachedEnd;
	}

	public function isCurrentUser(ICloudId $cloud): bool {
		$currentUser = $this->userSession->getUser();
		return $currentUser instanceof IUser ? $currentUser->getUID() === $cloud->getUser() : false;
	}
}


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 Joas Schilling <[email protected]>
8			* @author Julius Härtl <[email protected]>
9			* @author Tobia De Koninck <[email protected]>
10			*
11			* @license GNU AGPL version 3 or any later version
12			*
13			* This program is free software: you can redistribute it and/or modify
14			* it under the terms of the GNU Affero General Public License as
15			* published by the Free Software Foundation, either version 3 of the
16			* License, or (at your option) any later version.
17			*
18			* This program is distributed in the hope that it will be useful,
19			* but WITHOUT ANY WARRANTY; without even the implied warranty of
20			* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21			* GNU Affero General Public License for more details.
22			*
23			* You should have received a copy of the GNU Affero General Public License
24			* along with this program. If not, see <http://www.gnu.org/licenses/>.
25			*
26			*/
27
28			namespace OC\Collaboration\Collaborators;
29
30			use OC\KnownUser\KnownUserService;
31			use OCP\Collaboration\Collaborators\ISearchPlugin;
32			use OCP\Collaboration\Collaborators\ISearchResult;
33			use OCP\Collaboration\Collaborators\SearchResultType;
34			use OCP\Contacts\IManager;
35			use OCP\Federation\ICloudId;
36			use OCP\Federation\ICloudIdManager;
37			use OCP\IConfig;
38			use OCP\IGroupManager;
39			use OCP\IUser;
40			use OCP\IUserSession;
41			use OCP\Share\IShare;
42
43			class MailPlugin implements ISearchPlugin {
44			/* @var bool */
45			protected $shareWithGroupOnly;
46			/* @var bool */
47			protected $shareeEnumeration;
48			/* @var bool */
49			protected $shareeEnumerationInGroupOnly;
50			/* @var bool */
51			protected $shareeEnumerationPhone;
52			/* @var bool */
53			protected $shareeEnumerationFullMatch;
54
55			/** @var IManager */
56			private $contactsManager;
57			/** @var ICloudIdManager */
58			private $cloudIdManager;
59			/** @var IConfig */
60			private $config;
61
62			/** @var IGroupManager */
63			private $groupManager;
64			/** @var KnownUserService */
65			private $knownUserService;
66			/** @var IUserSession */
67			private $userSession;
68
69			public function __construct(IManager $contactsManager,
70			ICloudIdManager $cloudIdManager,
71			IConfig $config,
72			IGroupManager $groupManager,
73			KnownUserService $knownUserService,
74			IUserSession $userSession) {
75			$this->contactsManager = $contactsManager;
76			$this->cloudIdManager = $cloudIdManager;
77			$this->config = $config;
78			$this->groupManager = $groupManager;
79			$this->knownUserService = $knownUserService;
80			$this->userSession = $userSession;
81
82			$this->shareeEnumeration = $this->config->getAppValue('core', 'shareapi_allow_share_dialog_user_enumeration', 'yes') === 'yes';
83			$this->shareWithGroupOnly = $this->config->getAppValue('core', 'shareapi_only_share_with_group_members', 'no') === 'yes';
84			$this->shareeEnumerationInGroupOnly = $this->shareeEnumeration && $this->config->getAppValue('core', 'shareapi_restrict_user_enumeration_to_group', 'no') === 'yes';
85			$this->shareeEnumerationPhone = $this->shareeEnumeration && $this->config->getAppValue('core', 'shareapi_restrict_user_enumeration_to_phone', 'no') === 'yes';
86			$this->shareeEnumerationFullMatch = $this->config->getAppValue('core', 'shareapi_restrict_user_enumeration_full_match', 'yes') === 'yes';
87			}
88
89			/**
90			* @param $search
91			* @param $limit
92			* @param $offset
93			* @param ISearchResult $searchResult
94			* @return bool
95			* @since 13.0.0
96			*/
97			public function search($search, $limit, $offset, ISearchResult $searchResult) {
98			$currentUserId = $this->userSession->getUser()->getUID();
99
100			$result = $userResults = ['wide' => [], 'exact' => []];
101			$userType = new SearchResultType('users');
102			$emailType = new SearchResultType('emails');
103
104			// Search in contacts
105			$addressBookContacts = $this->contactsManager->search($search, ['EMAIL', 'FN'], ['limit' => $limit, 'offset' => $offset]);
106			$lowerSearch = strtolower($search);
107			foreach ($addressBookContacts as $contact) {
108			if (isset($contact['EMAIL'])) {
109			$emailAddresses = $contact['EMAIL'];
110			if (\is_string($emailAddresses)) {
111			$emailAddresses = [$emailAddresses];
112			}
113			foreach ($emailAddresses as $type => $emailAddress) {
114			$displayName = $emailAddress;
115			$emailAddressType = null;
116			if (\is_array($emailAddress)) {
117			$emailAddressData = $emailAddress;
118			$emailAddress = $emailAddressData['value'];
119			$emailAddressType = $emailAddressData['type'];
120			}
121			if (isset($contact['FN'])) {
122			$displayName = $contact['FN'] . ' (' . $emailAddress . ')';
123			}
124			$exactEmailMatch = strtolower($emailAddress) === $lowerSearch;
125
126			if (isset($contact['isLocalSystemBook'])) {
127			if ($this->shareWithGroupOnly) {
128			/*
129			* Check if the user may share with the user associated with the e-mail of the just found contact
130			*/
131			$userGroups = $this->groupManager->getUserGroupIds($this->userSession->getUser());
132			$found = false;
133			foreach ($userGroups as $userGroup) {
134			if ($this->groupManager->isInGroup($contact['UID'], $userGroup)) {
135			$found = true;
136			break;
137			}
138			}
139			if (!$found) {
140			continue;
141			}
142			}
143			if ($exactEmailMatch && $this->shareeEnumerationFullMatch) {
144			try {
145			$cloud = $this->cloudIdManager->resolveCloudId($contact['CLOUD'][0]);
146			} catch (\InvalidArgumentException $e) {
147			continue;
148			}
149
150			if (!$this->isCurrentUser($cloud) && !$searchResult->hasResult($userType, $cloud->getUser())) {
151			$singleResult = [[
152			'label' => $displayName,
153			'uuid' => $contact['UID'],
154			'name' => $contact['FN'],
155			'value' => [
156			'shareType' => IShare::TYPE_USER,
157			'shareWith' => $cloud->getUser(),
158			],
159			'shareWithDisplayNameUnique' => !empty($emailAddress) ? $emailAddress : $cloud->getUser()
160
161			]];
162			$searchResult->addResultSet($userType, [], $singleResult);
163			$searchResult->markExactIdMatch($emailType);
164			}
165			return false;
166			}
167
168			if ($this->shareeEnumeration) {
169			try {
170			$cloud = $this->cloudIdManager->resolveCloudId($contact['CLOUD'][0]);
171			} catch (\InvalidArgumentException $e) {
172			continue;
173			}
174
175			$addToWide = !($this->shareeEnumerationInGroupOnly \|\| $this->shareeEnumerationPhone);
176			if (!$addToWide && $this->shareeEnumerationPhone && $this->knownUserService->isKnownToUser($currentUserId, $contact['UID'])) {
177			$addToWide = true;
178			}
179
180			if (!$addToWide && $this->shareeEnumerationInGroupOnly) {
181			$addToWide = false;
182			$userGroups = $this->groupManager->getUserGroupIds($this->userSession->getUser());
183			foreach ($userGroups as $userGroup) {
184			if ($this->groupManager->isInGroup($contact['UID'], $userGroup)) {
185			$addToWide = true;
186			break;
187			}
188			}
189			}
190			if ($addToWide && !$this->isCurrentUser($cloud) && !$searchResult->hasResult($userType, $cloud->getUser())) {
191			$userResults['wide'][] = [
192			'label' => $displayName,
193			'uuid' => $contact['UID'],
194			'name' => $contact['FN'],
195			'value' => [
196			'shareType' => IShare::TYPE_USER,
197			'shareWith' => $cloud->getUser(),
198			],
199			'shareWithDisplayNameUnique' => !empty($emailAddress) ? $emailAddress : $cloud->getUser()
200			];
201			continue;
202			}
203			}
204			continue;
205			}
206
207			if ($exactEmailMatch
208			\|\| (isset($contact['FN']) && strtolower($contact['FN']) === $lowerSearch)) {
209			if ($exactEmailMatch) {
210			$searchResult->markExactIdMatch($emailType);
211			}
212			$result['exact'][] = [
213			'label' => $displayName,
214			'uuid' => $contact['UID'],
215			'name' => $contact['FN'],
216			'type' => $emailAddressType ?? '',
217			'value' => [
218			'shareType' => IShare::TYPE_EMAIL,
219			'shareWith' => $emailAddress,
220			],
221			];
222			} else {
223			$result['wide'][] = [
224			'label' => $displayName,
225			'uuid' => $contact['UID'],
226			'name' => $contact['FN'],
227			'type' => $emailAddressType ?? '',
228			'value' => [
229			'shareType' => IShare::TYPE_EMAIL,
230			'shareWith' => $emailAddress,
231			],
232			];
233			}
234			}
235			}
236			}
237
238			$reachedEnd = true;
239			if (!$this->shareeEnumeration) {
240			$result['wide'] = [];
241			$userResults['wide'] = [];
242			} else {
243			$reachedEnd = (count($result['wide']) < $offset + $limit) &&
244			(count($userResults['wide']) < $offset + $limit);
245
246			$result['wide'] = array_slice($result['wide'], $offset, $limit);
247			$userResults['wide'] = array_slice($userResults['wide'], $offset, $limit);
248			}
249
250
251			if (!$searchResult->hasExactIdMatch($emailType) && filter_var($search, FILTER_VALIDATE_EMAIL)) {
252			$result['exact'][] = [
253			'label' => $search,
254			'uuid' => $search,
255			'value' => [
256			'shareType' => IShare::TYPE_EMAIL,
257			'shareWith' => $search,
258			],
259			];
260			}
261
262			if (!empty($userResults['wide'])) {
263			$searchResult->addResultSet($userType, $userResults['wide'], []);
264			}
265			$searchResult->addResultSet($emailType, $result['wide'], $result['exact']);
266
267			return !$reachedEnd;
268			}
269
270			public function isCurrentUser(ICloudId $cloud): bool {
271			$currentUser = $this->userSession->getUser();
272			return $currentUser instanceof IUser ? $currentUser->getUID() === $cloud->getUser() : false;
273			}
274			}
275

nextcloud / server

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

MailPlugin::__construct() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like