nextcloud / server

lib/private/Contacts/ContactsMenu/ContactsStore.php

Indentation +280 added lines, -280 removed lines

@@ -44,284 +44,284 @@
 use OCP\L10N\IFactory as IL10NFactory;
 
 class ContactsStore implements IContactsStore {
-	private IManager $contactsManager;
-	private IConfig $config;
-	private ProfileManager $profileManager;
-	private IUserManager $userManager;
-	private IURLGenerator $urlGenerator;
-	private IGroupManager $groupManager;
-	private KnownUserService $knownUserService;
-	private IL10NFactory $l10nFactory;
-
-	public function __construct(
-		IManager $contactsManager,
-		IConfig $config,
-		ProfileManager $profileManager,
-		IUserManager $userManager,
-		IURLGenerator $urlGenerator,
-		IGroupManager $groupManager,
-		KnownUserService $knownUserService,
-		IL10NFactory $l10nFactory
-	) {
-		$this->contactsManager = $contactsManager;
-		$this->config = $config;
-		$this->profileManager = $profileManager;
-		$this->userManager = $userManager;
-		$this->urlGenerator = $urlGenerator;
-		$this->groupManager = $groupManager;
-		$this->knownUserService = $knownUserService;
-		$this->l10nFactory = $l10nFactory;
-	}
-
-	/**
-	 * @return IEntry[]
-	 */
-	public function getContacts(IUser $user, ?string $filter, ?int $limit = null, ?int $offset = null): array {
-		$options = [
-			'enumeration' => $this->config->getAppValue('core', 'shareapi_allow_share_dialog_user_enumeration', 'yes') === 'yes',
-			'fullmatch' => $this->config->getAppValue('core', 'shareapi_restrict_user_enumeration_full_match', 'yes') === 'yes',
-		];
-		if ($limit !== null) {
-			$options['limit'] = $limit;
-		}
-		if ($offset !== null) {
-			$options['offset'] = $offset;
-		}
-
-		$allContacts = $this->contactsManager->search(
-			$filter ?? '',
-			[
-				'FN',
-				'EMAIL'
-			],
-			$options
-		);
-
-		$userId = $user->getUID();
-		$contacts = array_filter($allContacts, function ($contact) use ($userId) {
-			// When searching for multiple results, we strip out the current user
-			if (array_key_exists('UID', $contact)) {
-				return $contact['UID'] !== $userId;
-			}
-			return true;
-		});
-
-		$entries = array_map(function (array $contact) {
-			return $this->contactArrayToEntry($contact);
-		}, $contacts);
-		return $this->filterContacts(
-			$user,
-			$entries,
-			$filter
-		);
-	}
-
-	/**
-	 * Filters the contacts. Applied filters:
-	 *  1. if the `shareapi_allow_share_dialog_user_enumeration` config option is
-	 * enabled it will filter all local users
-	 *  2. if the `shareapi_exclude_groups` config option is enabled and the
-	 * current user is in an excluded group it will filter all local users.
-	 *  3. if the `shareapi_only_share_with_group_members` config option is
-	 * enabled it will filter all users which doesn't have a common group
-	 * with the current user.
-	 *
-	 * @param IUser $self
-	 * @param Entry[] $entries
-	 * @param string|null $filter
-	 * @return Entry[] the filtered contacts
-	 */
-	private function filterContacts(
-		IUser $self,
-		array $entries,
-		?string $filter
-	): array {
-		$disallowEnumeration = $this->config->getAppValue('core', 'shareapi_allow_share_dialog_user_enumeration', 'yes') !== 'yes';
-		$restrictEnumerationGroup = $this->config->getAppValue('core', 'shareapi_restrict_user_enumeration_to_group', 'no') === 'yes';
-		$restrictEnumerationPhone = $this->config->getAppValue('core', 'shareapi_restrict_user_enumeration_to_phone', 'no') === 'yes';
-		$allowEnumerationFullMatch = $this->config->getAppValue('core', 'shareapi_restrict_user_enumeration_full_match', 'yes') === 'yes';
-		$excludedGroups = $this->config->getAppValue('core', 'shareapi_exclude_groups', 'no') === 'yes';
-
-		// whether to filter out local users
-		$skipLocal = false;
-		// whether to filter out all users which don't have a common group as the current user
-		$ownGroupsOnly = $this->config->getAppValue('core', 'shareapi_only_share_with_group_members', 'no') === 'yes';
-
-		$selfGroups = $this->groupManager->getUserGroupIds($self);
-
-		if ($excludedGroups) {
-			$excludedGroups = $this->config->getAppValue('core', 'shareapi_exclude_groups_list', '');
-			$decodedExcludeGroups = json_decode($excludedGroups, true);
-			$excludeGroupsList = $decodedExcludeGroups ?? [];
-
-			if (count(array_intersect($excludeGroupsList, $selfGroups)) !== 0) {
-				// a group of the current user is excluded -> filter all local users
-				$skipLocal = true;
-			}
-		}
-
-		$selfUID = $self->getUID();
-
-		return array_values(array_filter($entries, function (IEntry $entry) use ($skipLocal, $ownGroupsOnly, $selfGroups, $selfUID, $disallowEnumeration, $restrictEnumerationGroup, $restrictEnumerationPhone, $allowEnumerationFullMatch, $filter) {
-			if ($entry->getProperty('isLocalSystemBook')) {
-				if ($skipLocal) {
-					return false;
-				}
-
-				$checkedCommonGroupAlready = false;
-
-				// Prevent enumerating local users
-				if ($disallowEnumeration) {
-					if (!$allowEnumerationFullMatch) {
-						return false;
-					}
-
-					$filterOutUser = true;
-
-					$mailAddresses = $entry->getEMailAddresses();
-					foreach ($mailAddresses as $mailAddress) {
-						if ($mailAddress === $filter) {
-							$filterOutUser = false;
-							break;
-						}
-					}
-
-					if ($entry->getProperty('UID') && $entry->getProperty('UID') === $filter) {
-						$filterOutUser = false;
-					}
-
-					if ($filterOutUser) {
-						return false;
-					}
-				} elseif ($restrictEnumerationPhone || $restrictEnumerationGroup) {
-					$canEnumerate = false;
-					if ($restrictEnumerationPhone) {
-						$canEnumerate = $this->knownUserService->isKnownToUser($selfUID, $entry->getProperty('UID'));
-					}
-
-					if (!$canEnumerate && $restrictEnumerationGroup) {
-						$user = $this->userManager->get($entry->getProperty('UID'));
-
-						if ($user === null) {
-							return false;
-						}
-
-						$contactGroups = $this->groupManager->getUserGroupIds($user);
-						$canEnumerate = !empty(array_intersect($contactGroups, $selfGroups));
-						$checkedCommonGroupAlready = true;
-					}
-
-					if (!$canEnumerate) {
-						return false;
-					}
-				}
-
-				if ($ownGroupsOnly && !$checkedCommonGroupAlready) {
-					$user = $this->userManager->get($entry->getProperty('UID'));
-
-					if (!$user instanceof IUser) {
-						return false;
-					}
-
-					$contactGroups = $this->groupManager->getUserGroupIds($user);
-					if (empty(array_intersect($contactGroups, $selfGroups))) {
-						// no groups in common, so shouldn't see the contact
-						return false;
-					}
-				}
-			}
-
-			return true;
-		}));
-	}
-
-	public function findOne(IUser $user, int $shareType, string $shareWith): ?IEntry {
-		switch ($shareType) {
-			case 0:
-			case 6:
-				$filter = ['UID'];
-				break;
-			case 4:
-				$filter = ['EMAIL'];
-				break;
-			default:
-				return null;
-		}
-
-		$contacts = $this->contactsManager->search($shareWith, $filter, [
-			'strict_search' => true,
-		]);
-		$match = null;
-
-		foreach ($contacts as $contact) {
-			if ($shareType === 4 && isset($contact['EMAIL'])) {
-				if (in_array($shareWith, $contact['EMAIL'])) {
-					$match = $contact;
-					break;
-				}
-			}
-			if ($shareType === 0 || $shareType === 6) {
-				$isLocal = $contact['isLocalSystemBook'] ?? false;
-				if ($contact['UID'] === $shareWith && $isLocal === true) {
-					$match = $contact;
-					break;
-				}
-			}
-		}
-
-		if ($match) {
-			$match = $this->filterContacts($user, [$this->contactArrayToEntry($match)], $shareWith);
-			if (count($match) === 1) {
-				$match = $match[0];
-			} else {
-				$match = null;
-			}
-		}
-
-		return $match;
-	}
-
-	private function contactArrayToEntry(array $contact): Entry {
-		$entry = new Entry();
-
-		if (isset($contact['UID'])) {
-			$uid = $contact['UID'];
-			$entry->setId($uid);
-			$avatar = $this->urlGenerator->linkToRouteAbsolute('core.avatar.getAvatar', ['userId' => $uid, 'size' => 64]);
-			$entry->setAvatar($avatar);
-		}
-
-		if (isset($contact['FN'])) {
-			$entry->setFullName($contact['FN']);
-		}
-
-		$avatarPrefix = "VALUE=uri:";
-		if (isset($contact['PHOTO']) && strpos($contact['PHOTO'], $avatarPrefix) === 0) {
-			$entry->setAvatar(substr($contact['PHOTO'], strlen($avatarPrefix)));
-		}
-
-		if (isset($contact['EMAIL'])) {
-			foreach ($contact['EMAIL'] as $email) {
-				$entry->addEMailAddress($email);
-			}
-		}
-
-		// Provide profile parameters for core/src/OC/contactsmenu/contact.handlebars template
-		if (isset($contact['UID']) && isset($contact['FN'])) {
-			$targetUserId = $contact['UID'];
-			$targetUser = $this->userManager->get($targetUserId);
-			if (!empty($targetUser)) {
-				if ($this->profileManager->isProfileEnabled($targetUser)) {
-					$entry->setProfileTitle($this->l10nFactory->get('lib')->t('View profile'));
-					$entry->setProfileUrl($this->urlGenerator->linkToRouteAbsolute('core.ProfilePage.index', ['targetUserId' => $targetUserId]));
-				}
-			}
-		}
-
-		// Attach all other properties to the entry too because some
-		// providers might make use of it.
-		$entry->setProperties($contact);
-
-		return $entry;
-	}
+    private IManager $contactsManager;
+    private IConfig $config;
+    private ProfileManager $profileManager;
+    private IUserManager $userManager;
+    private IURLGenerator $urlGenerator;
+    private IGroupManager $groupManager;
+    private KnownUserService $knownUserService;
+    private IL10NFactory $l10nFactory;
+
+    public function __construct(
+        IManager $contactsManager,
+        IConfig $config,
+        ProfileManager $profileManager,
+        IUserManager $userManager,
+        IURLGenerator $urlGenerator,
+        IGroupManager $groupManager,
+        KnownUserService $knownUserService,
+        IL10NFactory $l10nFactory
+    ) {
+        $this->contactsManager = $contactsManager;
+        $this->config = $config;
+        $this->profileManager = $profileManager;
+        $this->userManager = $userManager;
+        $this->urlGenerator = $urlGenerator;
+        $this->groupManager = $groupManager;
+        $this->knownUserService = $knownUserService;
+        $this->l10nFactory = $l10nFactory;
+    }
+
+    /**
+     * @return IEntry[]
+     */
+    public function getContacts(IUser $user, ?string $filter, ?int $limit = null, ?int $offset = null): array {
+        $options = [
+            'enumeration' => $this->config->getAppValue('core', 'shareapi_allow_share_dialog_user_enumeration', 'yes') === 'yes',
+            'fullmatch' => $this->config->getAppValue('core', 'shareapi_restrict_user_enumeration_full_match', 'yes') === 'yes',
+        ];
+        if ($limit !== null) {
+            $options['limit'] = $limit;
+        }
+        if ($offset !== null) {
+            $options['offset'] = $offset;
+        }
+
+        $allContacts = $this->contactsManager->search(
+            $filter ?? '',
+            [
+                'FN',
+                'EMAIL'
+            ],
+            $options
+        );
+
+        $userId = $user->getUID();
+        $contacts = array_filter($allContacts, function ($contact) use ($userId) {
+            // When searching for multiple results, we strip out the current user
+            if (array_key_exists('UID', $contact)) {
+                return $contact['UID'] !== $userId;
+            }
+            return true;
+        });
+
+        $entries = array_map(function (array $contact) {
+            return $this->contactArrayToEntry($contact);
+        }, $contacts);
+        return $this->filterContacts(
+            $user,
+            $entries,
+            $filter
+        );
+    }
+
+    /**
+     * Filters the contacts. Applied filters:
+     *  1. if the `shareapi_allow_share_dialog_user_enumeration` config option is
+     * enabled it will filter all local users
+     *  2. if the `shareapi_exclude_groups` config option is enabled and the
+     * current user is in an excluded group it will filter all local users.
+     *  3. if the `shareapi_only_share_with_group_members` config option is
+     * enabled it will filter all users which doesn't have a common group
+     * with the current user.
+     *
+     * @param IUser $self
+     * @param Entry[] $entries
+     * @param string|null $filter
+     * @return Entry[] the filtered contacts
+     */
+    private function filterContacts(
+        IUser $self,
+        array $entries,
+        ?string $filter
+    ): array {
+        $disallowEnumeration = $this->config->getAppValue('core', 'shareapi_allow_share_dialog_user_enumeration', 'yes') !== 'yes';
+        $restrictEnumerationGroup = $this->config->getAppValue('core', 'shareapi_restrict_user_enumeration_to_group', 'no') === 'yes';
+        $restrictEnumerationPhone = $this->config->getAppValue('core', 'shareapi_restrict_user_enumeration_to_phone', 'no') === 'yes';
+        $allowEnumerationFullMatch = $this->config->getAppValue('core', 'shareapi_restrict_user_enumeration_full_match', 'yes') === 'yes';
+        $excludedGroups = $this->config->getAppValue('core', 'shareapi_exclude_groups', 'no') === 'yes';
+
+        // whether to filter out local users
+        $skipLocal = false;
+        // whether to filter out all users which don't have a common group as the current user
+        $ownGroupsOnly = $this->config->getAppValue('core', 'shareapi_only_share_with_group_members', 'no') === 'yes';
+
+        $selfGroups = $this->groupManager->getUserGroupIds($self);
+
+        if ($excludedGroups) {
+            $excludedGroups = $this->config->getAppValue('core', 'shareapi_exclude_groups_list', '');
+            $decodedExcludeGroups = json_decode($excludedGroups, true);
+            $excludeGroupsList = $decodedExcludeGroups ?? [];
+
+            if (count(array_intersect($excludeGroupsList, $selfGroups)) !== 0) {
+                // a group of the current user is excluded -> filter all local users
+                $skipLocal = true;
+            }
+        }
+
+        $selfUID = $self->getUID();
+
+        return array_values(array_filter($entries, function (IEntry $entry) use ($skipLocal, $ownGroupsOnly, $selfGroups, $selfUID, $disallowEnumeration, $restrictEnumerationGroup, $restrictEnumerationPhone, $allowEnumerationFullMatch, $filter) {
+            if ($entry->getProperty('isLocalSystemBook')) {
+                if ($skipLocal) {
+                    return false;
+                }
+
+                $checkedCommonGroupAlready = false;
+
+                // Prevent enumerating local users
+                if ($disallowEnumeration) {
+                    if (!$allowEnumerationFullMatch) {
+                        return false;
+                    }
+
+                    $filterOutUser = true;
+
+                    $mailAddresses = $entry->getEMailAddresses();
+                    foreach ($mailAddresses as $mailAddress) {
+                        if ($mailAddress === $filter) {
+                            $filterOutUser = false;
+                            break;
+                        }
+                    }
+
+                    if ($entry->getProperty('UID') && $entry->getProperty('UID') === $filter) {
+                        $filterOutUser = false;
+                    }
+
+                    if ($filterOutUser) {
+                        return false;
+                    }
+                } elseif ($restrictEnumerationPhone || $restrictEnumerationGroup) {
+                    $canEnumerate = false;
+                    if ($restrictEnumerationPhone) {
+                        $canEnumerate = $this->knownUserService->isKnownToUser($selfUID, $entry->getProperty('UID'));
+                    }
+
+                    if (!$canEnumerate && $restrictEnumerationGroup) {
+                        $user = $this->userManager->get($entry->getProperty('UID'));
+
+                        if ($user === null) {
+                            return false;
+                        }
+
+                        $contactGroups = $this->groupManager->getUserGroupIds($user);
+                        $canEnumerate = !empty(array_intersect($contactGroups, $selfGroups));
+                        $checkedCommonGroupAlready = true;
+                    }
+
+                    if (!$canEnumerate) {
+                        return false;
+                    }
+                }
+
+                if ($ownGroupsOnly && !$checkedCommonGroupAlready) {
+                    $user = $this->userManager->get($entry->getProperty('UID'));
+
+                    if (!$user instanceof IUser) {
+                        return false;
+                    }
+
+                    $contactGroups = $this->groupManager->getUserGroupIds($user);
+                    if (empty(array_intersect($contactGroups, $selfGroups))) {
+                        // no groups in common, so shouldn't see the contact
+                        return false;
+                    }
+                }
+            }
+
+            return true;
+        }));
+    }
+
+    public function findOne(IUser $user, int $shareType, string $shareWith): ?IEntry {
+        switch ($shareType) {
+            case 0:
+            case 6:
+                $filter = ['UID'];
+                break;
+            case 4:
+                $filter = ['EMAIL'];
+                break;
+            default:
+                return null;
+        }
+
+        $contacts = $this->contactsManager->search($shareWith, $filter, [
+            'strict_search' => true,
+        ]);
+        $match = null;
+
+        foreach ($contacts as $contact) {
+            if ($shareType === 4 && isset($contact['EMAIL'])) {
+                if (in_array($shareWith, $contact['EMAIL'])) {
+                    $match = $contact;
+                    break;
+                }
+            }
+            if ($shareType === 0 || $shareType === 6) {
+                $isLocal = $contact['isLocalSystemBook'] ?? false;
+                if ($contact['UID'] === $shareWith && $isLocal === true) {
+                    $match = $contact;
+                    break;
+                }
+            }
+        }
+
+        if ($match) {
+            $match = $this->filterContacts($user, [$this->contactArrayToEntry($match)], $shareWith);
+            if (count($match) === 1) {
+                $match = $match[0];
+            } else {
+                $match = null;
+            }
+        }
+
+        return $match;
+    }
+
+    private function contactArrayToEntry(array $contact): Entry {
+        $entry = new Entry();
+
+        if (isset($contact['UID'])) {
+            $uid = $contact['UID'];
+            $entry->setId($uid);
+            $avatar = $this->urlGenerator->linkToRouteAbsolute('core.avatar.getAvatar', ['userId' => $uid, 'size' => 64]);
+            $entry->setAvatar($avatar);
+        }
+
+        if (isset($contact['FN'])) {
+            $entry->setFullName($contact['FN']);
+        }
+
+        $avatarPrefix = "VALUE=uri:";
+        if (isset($contact['PHOTO']) && strpos($contact['PHOTO'], $avatarPrefix) === 0) {
+            $entry->setAvatar(substr($contact['PHOTO'], strlen($avatarPrefix)));
+        }
+
+        if (isset($contact['EMAIL'])) {
+            foreach ($contact['EMAIL'] as $email) {
+                $entry->addEMailAddress($email);
+            }
+        }
+
+        // Provide profile parameters for core/src/OC/contactsmenu/contact.handlebars template
+        if (isset($contact['UID']) && isset($contact['FN'])) {
+            $targetUserId = $contact['UID'];
+            $targetUser = $this->userManager->get($targetUserId);
+            if (!empty($targetUser)) {
+                if ($this->profileManager->isProfileEnabled($targetUser)) {
+                    $entry->setProfileTitle($this->l10nFactory->get('lib')->t('View profile'));
+                    $entry->setProfileUrl($this->urlGenerator->linkToRouteAbsolute('core.ProfilePage.index', ['targetUserId' => $targetUserId]));
+                }
+            }
+        }
+
+        // Attach all other properties to the entry too because some
+        // providers might make use of it.
+        $entry->setProperties($contact);
+
+        return $entry;
+    }
 }