aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
Diffstat
-rw-r--r--build/psalm-baseline.xml3
-rw-r--r--lib/composer/composer/autoload_classmap.php3
-rw-r--r--lib/composer/composer/autoload_static.php3
-rw-r--r--lib/private/Accounts/Account.php62
-rw-r--r--lib/private/Accounts/AccountManager.php138
-rw-r--r--lib/private/Accounts/AccountPropertyCollection.php90
-rw-r--r--lib/private/Accounts/TAccountsHelper.php40
-rw-r--r--lib/public/Accounts/IAccount.php37
-rw-r--r--lib/public/Accounts/IAccountManager.php7
-rw-r--r--lib/public/Accounts/IAccountPropertyCollection.php84
-rw-r--r--tests/lib/Accounts/AccountManagerTest.php187
-rw-r--r--tests/lib/Accounts/AccountPropertyCollectionTest.php209
-rw-r--r--tests/lib/Accounts/AccountTest.php27
13 files changed, 808 insertions, 82 deletions
diff --git a/build/psalm-baseline.xml b/build/psalm-baseline.xml
index 09ed87524d2..2ab0ad69363 100644
--- a/build/psalm-baseline.xml
+++ b/build/psalm-baseline.xml
@@ -1769,9 +1769,6 @@
</TooManyArguments>
</file>
<file src="apps/lookup_server_connector/lib/BackgroundJobs/RetryJob.php">
- <InvalidArrayOffset occurrences="1">
- <code>$publicData[IAccountManager::PROPERTY_DISPLAYNAME]['value']</code>
- </InvalidArrayOffset>
<InvalidScalarArgument occurrences="1">
<code>$this-&gt;retries + 1</code>
</InvalidScalarArgument>
diff --git a/lib/composer/composer/autoload_classmap.php b/lib/composer/composer/autoload_classmap.php
index f63d74b5600..ef7085cd5ed 100644
--- a/lib/composer/composer/autoload_classmap.php
+++ b/lib/composer/composer/autoload_classmap.php
@@ -10,6 +10,7 @@ return array(
'OCP\\Accounts\\IAccount' => $baseDir . '/lib/public/Accounts/IAccount.php',
'OCP\\Accounts\\IAccountManager' => $baseDir . '/lib/public/Accounts/IAccountManager.php',
'OCP\\Accounts\\IAccountProperty' => $baseDir . '/lib/public/Accounts/IAccountProperty.php',
+ 'OCP\\Accounts\\IAccountPropertyCollection' => $baseDir . '/lib/public/Accounts/IAccountPropertyCollection.php',
'OCP\\Accounts\\PropertyDoesNotExistException' => $baseDir . '/lib/public/Accounts/PropertyDoesNotExistException.php',
'OCP\\Activity\\ActivitySettings' => $baseDir . '/lib/public/Activity/ActivitySettings.php',
'OCP\\Activity\\IConsumer' => $baseDir . '/lib/public/Activity/IConsumer.php',
@@ -581,7 +582,9 @@ return array(
'OC\\Accounts\\Account' => $baseDir . '/lib/private/Accounts/Account.php',
'OC\\Accounts\\AccountManager' => $baseDir . '/lib/private/Accounts/AccountManager.php',
'OC\\Accounts\\AccountProperty' => $baseDir . '/lib/private/Accounts/AccountProperty.php',
+ 'OC\\Accounts\\AccountPropertyCollection' => $baseDir . '/lib/private/Accounts/AccountPropertyCollection.php',
'OC\\Accounts\\Hooks' => $baseDir . '/lib/private/Accounts/Hooks.php',
+ 'OC\\Accounts\\TAccountsHelper' => $baseDir . '/lib/private/Accounts/TAccountsHelper.php',
'OC\\Activity\\ActivitySettingsAdapter' => $baseDir . '/lib/private/Activity/ActivitySettingsAdapter.php',
'OC\\Activity\\Event' => $baseDir . '/lib/private/Activity/Event.php',
'OC\\Activity\\EventMerger' => $baseDir . '/lib/private/Activity/EventMerger.php',
diff --git a/lib/composer/composer/autoload_static.php b/lib/composer/composer/autoload_static.php
index 9c861fd3277..b89068acbeb 100644
--- a/lib/composer/composer/autoload_static.php
+++ b/lib/composer/composer/autoload_static.php
@@ -39,6 +39,7 @@ class ComposerStaticInit53792487c5a8370acc0b06b1a864ff4c
'OCP\\Accounts\\IAccount' => __DIR__ . '/../../..' . '/lib/public/Accounts/IAccount.php',
'OCP\\Accounts\\IAccountManager' => __DIR__ . '/../../..' . '/lib/public/Accounts/IAccountManager.php',
'OCP\\Accounts\\IAccountProperty' => __DIR__ . '/../../..' . '/lib/public/Accounts/IAccountProperty.php',
+ 'OCP\\Accounts\\IAccountPropertyCollection' => __DIR__ . '/../../..' . '/lib/public/Accounts/IAccountPropertyCollection.php',
'OCP\\Accounts\\PropertyDoesNotExistException' => __DIR__ . '/../../..' . '/lib/public/Accounts/PropertyDoesNotExistException.php',
'OCP\\Activity\\ActivitySettings' => __DIR__ . '/../../..' . '/lib/public/Activity/ActivitySettings.php',
'OCP\\Activity\\IConsumer' => __DIR__ . '/../../..' . '/lib/public/Activity/IConsumer.php',
@@ -610,7 +611,9 @@ class ComposerStaticInit53792487c5a8370acc0b06b1a864ff4c
'OC\\Accounts\\Account' => __DIR__ . '/../../..' . '/lib/private/Accounts/Account.php',
'OC\\Accounts\\AccountManager' => __DIR__ . '/../../..' . '/lib/private/Accounts/AccountManager.php',
'OC\\Accounts\\AccountProperty' => __DIR__ . '/../../..' . '/lib/private/Accounts/AccountProperty.php',
+ 'OC\\Accounts\\AccountPropertyCollection' => __DIR__ . '/../../..' . '/lib/private/Accounts/AccountPropertyCollection.php',
'OC\\Accounts\\Hooks' => __DIR__ . '/../../..' . '/lib/private/Accounts/Hooks.php',
+ 'OC\\Accounts\\TAccountsHelper' => __DIR__ . '/../../..' . '/lib/private/Accounts/TAccountsHelper.php',
'OC\\Activity\\ActivitySettingsAdapter' => __DIR__ . '/../../..' . '/lib/private/Activity/ActivitySettingsAdapter.php',
'OC\\Activity\\Event' => __DIR__ . '/../../..' . '/lib/private/Activity/Event.php',
'OC\\Activity\\EventMerger' => __DIR__ . '/../../..' . '/lib/private/Activity/EventMerger.php',
diff --git a/lib/private/Accounts/Account.php b/lib/private/Accounts/Account.php
index f7094f14cd9..7d2a51c7d4e 100644
--- a/lib/private/Accounts/Account.php
+++ b/lib/private/Accounts/Account.php
@@ -27,14 +27,17 @@ declare(strict_types=1);
*/
namespace OC\Accounts;
+use Generator;
use OCP\Accounts\IAccount;
use OCP\Accounts\IAccountProperty;
+use OCP\Accounts\IAccountPropertyCollection;
use OCP\Accounts\PropertyDoesNotExistException;
use OCP\IUser;
class Account implements IAccount {
+ use TAccountsHelper;
- /** @var IAccountProperty[] */
+ /** @var IAccountPropertyCollection[]|IAccountProperty[] */
private $properties = [];
/** @var IUser */
@@ -45,31 +48,59 @@ class Account implements IAccount {
}
public function setProperty(string $property, string $value, string $scope, string $verified, string $verificationData = ''): IAccount {
+ if ($this->isCollection($property)) {
+ throw new \InvalidArgumentException('setProperty cannot set an IAccountsPropertyCollection');
+ }
$this->properties[$property] = new AccountProperty($property, $value, $scope, $verified, $verificationData);
return $this;
}
public function getProperty(string $property): IAccountProperty {
- if (!array_key_exists($property, $this->properties)) {
+ if ($this->isCollection($property)) {
+ throw new \InvalidArgumentException('getProperty cannot retrieve an IAccountsPropertyCollection');
+ }
+ if (!array_key_exists($property, $this->properties) || !$this->properties[$property] instanceof IAccountProperty) {
throw new PropertyDoesNotExistException($property);
}
return $this->properties[$property];
}
public function getProperties(): array {
- return $this->properties;
+ return array_filter($this->properties, function ($obj) {
+ return $obj instanceof IAccountProperty;
+ });
+ }
+
+ public function getAllProperties(): Generator {
+ foreach ($this->properties as $propertyObject) {
+ if ($propertyObject instanceof IAccountProperty) {
+ yield $propertyObject;
+ } elseif ($propertyObject instanceof IAccountPropertyCollection) {
+ foreach ($propertyObject->getProperties() as $property) {
+ yield $property;
+ }
+ }
+ }
}
public function getFilteredProperties(string $scope = null, string $verified = null): array {
- return \array_filter($this->properties, function (IAccountProperty $obj) use ($scope, $verified) {
+ $result = $incrementals = [];
+ /** @var IAccountProperty $obj */
+ foreach ($this->getAllProperties() as $obj) {
if ($scope !== null && $scope !== $obj->getScope()) {
- return false;
+ continue;
}
if ($verified !== null && $verified !== $obj->getVerified()) {
- return false;
+ continue;
}
- return true;
- });
+ $index = $obj->getName();
+ if ($this->isCollection($index)) {
+ $incrementals[$index] = ($incrementals[$index] ?? -1) + 1;
+ $index .= '#' . $incrementals[$index];
+ }
+ $result[$index] = $obj;
+ }
+ return $result;
}
public function jsonSerialize() {
@@ -79,4 +110,19 @@ class Account implements IAccount {
public function getUser(): IUser {
return $this->user;
}
+
+ public function setPropertyCollection(IAccountPropertyCollection $propertyCollection): IAccount {
+ $this->properties[$propertyCollection->getName()] = $propertyCollection;
+ return $this;
+ }
+
+ public function getPropertyCollection(string $propertyCollection): IAccountPropertyCollection {
+ if (!array_key_exists($propertyCollection, $this->properties)) {
+ throw new PropertyDoesNotExistException($propertyCollection);
+ }
+ if (!$this->properties[$propertyCollection] instanceof IAccountPropertyCollection) {
+ throw new \RuntimeException('Requested collection is not an IAccountPropertyCollection');
+ }
+ return $this->properties[$propertyCollection];
+ }
}
diff --git a/lib/private/Accounts/AccountManager.php b/lib/private/Accounts/AccountManager.php
index 62fe4b6e5c6..4d75c94346b 100644
--- a/lib/private/Accounts/AccountManager.php
+++ b/lib/private/Accounts/AccountManager.php
@@ -47,6 +47,7 @@ use OCP\IUser;
use Psr\Log\LoggerInterface;
use Symfony\Component\EventDispatcher\EventDispatcherInterface;
use Symfony\Component\EventDispatcher\GenericEvent;
+use function array_flip;
use function json_decode;
use function json_last_error;
@@ -59,6 +60,7 @@ use function json_last_error;
* @package OC\Accounts
*/
class AccountManager implements IAccountManager {
+ use TAccountsHelper;
/** @var IDBConnection database connection */
private $connection;
@@ -141,6 +143,61 @@ class AccountManager implements IAccountManager {
return $input;
}
+ protected function sanitizeLength(array &$propertyData, bool $throwOnData = false): void {
+ if (isset($propertyData['value']) && strlen($propertyData['value']) > 2048) {
+ if ($throwOnData) {
+ throw new \InvalidArgumentException();
+ } else {
+ $propertyData['value'] = '';
+ }
+ }
+ }
+
+ protected function testValueLengths(array &$data, bool $throwOnData = false): void {
+ try {
+ foreach ($data as $propertyName => &$propertyData) {
+ if ($this->isCollection($propertyName)) {
+ $this->testValueLengths($propertyData, $throwOnData);
+ } else {
+ $this->sanitizeLength($propertyData, $throwOnData);
+ }
+ }
+ } catch (\InvalidArgumentException $e) {
+ throw new \InvalidArgumentException($propertyName);
+ }
+ }
+
+ protected function testPropertyScopes(array &$data, array $allowedScopes, bool $throwOnData = false, string $parentPropertyName = null): void {
+ foreach ($data as $propertyNameOrIndex => &$propertyData) {
+ if ($this->isCollection($propertyNameOrIndex)) {
+ $this->testPropertyScopes($propertyData, $allowedScopes, $throwOnData);
+ } elseif (isset($propertyData['scope'])) {
+ $effectivePropertyName = $parentPropertyName ?? $propertyNameOrIndex;
+
+ if ($throwOnData && !in_array($propertyData['scope'], $allowedScopes, true)) {
+ throw new \InvalidArgumentException('scope');
+ }
+
+ if (
+ $propertyData['scope'] === self::SCOPE_PRIVATE
+ && ($effectivePropertyName === self::PROPERTY_DISPLAYNAME || $effectivePropertyName === self::PROPERTY_EMAIL)
+ ) {
+ if ($throwOnData) {
+ // v2-private is not available for these fields
+ throw new \InvalidArgumentException('scope');
+ } else {
+ // default to local
+ $data[$propertyNameOrIndex]['scope'] = self::SCOPE_LOCAL;
+ }
+ } else {
+ // migrate scope values to the new format
+ // invalid scopes are mapped to a default value
+ $data[$propertyNameOrIndex]['scope'] = AccountProperty::mapScopeToV2($propertyData['scope']);
+ }
+ }
+ }
+ }
+
/**
* update user record
*
@@ -168,16 +225,7 @@ class AccountManager implements IAccountManager {
}
}
- // set a max length
- foreach ($data as $propertyName => $propertyData) {
- if (isset($data[$propertyName]) && isset($data[$propertyName]['value']) && strlen($data[$propertyName]['value']) > 2048) {
- if ($throwOnData) {
- throw new \InvalidArgumentException($propertyName);
- } else {
- $data[$propertyName]['value'] = '';
- }
- }
- }
+ $this->testValueLengths($data);
if (isset($data[self::PROPERTY_WEBSITE]) && $data[self::PROPERTY_WEBSITE]['value'] !== '') {
try {
@@ -200,31 +248,7 @@ class AccountManager implements IAccountManager {
self::VISIBILITY_PUBLIC,
];
- // validate and convert scope values
- foreach ($data as $propertyName => $propertyData) {
- if (isset($propertyData['scope'])) {
- if ($throwOnData && !in_array($propertyData['scope'], $allowedScopes, true)) {
- throw new \InvalidArgumentException('scope');
- }
-
- if (
- $propertyData['scope'] === self::SCOPE_PRIVATE
- && ($propertyName === self::PROPERTY_DISPLAYNAME || $propertyName === self::PROPERTY_EMAIL)
- ) {
- if ($throwOnData) {
- // v2-private is not available for these fields
- throw new \InvalidArgumentException('scope');
- } else {
- // default to local
- $data[$propertyName]['scope'] = self::SCOPE_LOCAL;
- }
- } else {
- // migrate scope values to the new format
- // invalid scopes are mapped to a default value
- $data[$propertyName]['scope'] = AccountProperty::mapScopeToV2($propertyData['scope']);
- }
- }
- }
+ $this->testPropertyScopes($data, $allowedScopes, $throwOnData);
if (empty($userData)) {
$this->insertNewUser($user, $data);
@@ -278,12 +302,9 @@ class AccountManager implements IAccountManager {
/**
* get stored data from a given user
*
- * @param IUser $user
- * @return array
- *
* @deprecated use getAccount instead to make sure migrated properties work correctly
*/
- public function getUser(IUser $user) {
+ public function getUser(IUser $user, bool $insertIfNotExists = true): array {
$uid = $user->getUID();
$query = $this->connection->getQueryBuilder();
$query->select('data')
@@ -296,7 +317,9 @@ class AccountManager implements IAccountManager {
if (empty($accountData)) {
$userData = $this->buildDefaultUserRecord($user);
- $this->insertNewUser($user, $userData);
+ if ($insertIfNotExists) {
+ $this->insertNewUser($user, $userData);
+ }
return $userData;
}
@@ -307,9 +330,7 @@ class AccountManager implements IAccountManager {
return $this->buildDefaultUserRecord($user);
}
- $userDataArray = $this->addMissingDefaultValues($userDataArray);
-
- return $userDataArray;
+ return $this->addMissingDefaultValues($userDataArray);
}
public function searchUsers(string $property, array $values): array {
@@ -326,12 +347,23 @@ class AccountManager implements IAccountManager {
$result = $query->execute();
while ($row = $result->fetch()) {
- $matches[$row['value']] = $row['uid'];
+ $matches[$row['uid']] = $row['value'];
}
$result->closeCursor();
}
- return $matches;
+ $result = array_merge($matches, $this->searchUsersForRelatedCollection($property, $values));
+
+ return array_flip($result);
+ }
+
+ protected function searchUsersForRelatedCollection(string $property, array $values): array {
+ switch ($property) {
+ case IAccountManager::PROPERTY_EMAIL:
+ return array_flip($this->searchUsers(IAccountManager::COLLECTION_EMAIL, $values));
+ default:
+ return [];
+ }
}
/**
@@ -342,7 +374,7 @@ class AccountManager implements IAccountManager {
* @param IUser $user
* @return array
*/
- protected function checkEmailVerification($oldData, $newData, IUser $user) {
+ protected function checkEmailVerification($oldData, $newData, IUser $user): array {
if ($oldData[self::PROPERTY_EMAIL]['value'] !== $newData[self::PROPERTY_EMAIL]['value']) {
$this->jobList->add(VerifyUserData::class,
[
@@ -383,7 +415,7 @@ class AccountManager implements IAccountManager {
* @param array $newData
* @return array
*/
- protected function updateVerifyStatus($oldData, $newData) {
+ protected function updateVerifyStatus(array $oldData, array $newData): array {
// which account was already verified successfully?
$twitterVerified = isset($oldData[self::PROPERTY_TWITTER]['verified']) && $oldData[self::PROPERTY_TWITTER]['verified'] === self::VERIFIED;
@@ -483,12 +515,20 @@ class AccountManager implements IAccountManager {
'value' => $query->createParameter('value'),
]
);
+ $this->writeUserDataProperties($query, $data);
+ }
+
+ protected function writeUserDataProperties(IQueryBuilder $query, array $data, string $parentPropertyName = null): void {
foreach ($data as $propertyName => $property) {
- if ($propertyName === self::PROPERTY_AVATAR) {
+ if ($this->isCollection($propertyName)) {
+ $this->writeUserDataProperties($query, $property, $propertyName);
+ continue;
+ }
+ if (($parentPropertyName ?? $propertyName) === self::PROPERTY_AVATAR) {
continue;
}
- $query->setParameter('name', $propertyName)
+ $query->setParameter('name', $parentPropertyName ?? $propertyName)
->setParameter('value', $property['value'] ?? '');
$query->execute();
}
diff --git a/lib/private/Accounts/AccountPropertyCollection.php b/lib/private/Accounts/AccountPropertyCollection.php
new file mode 100644
index 00000000000..84e10e6a507
--- /dev/null
+++ b/lib/private/Accounts/AccountPropertyCollection.php
@@ -0,0 +1,90 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * @copyright Copyright (c) 2021 Arthur Schiwon <blizzz@arthur-schiwon.de>
+ *
+ * @author Arthur Schiwon <blizzz@arthur-schiwon.de>
+ *
+ * @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 <https://www.gnu.org/licenses/>.
+ *
+ */
+
+namespace OC\Accounts;
+
+use InvalidArgumentException;
+use OCP\Accounts\IAccountProperty;
+use OCP\Accounts\IAccountPropertyCollection;
+
+class AccountPropertyCollection implements IAccountPropertyCollection {
+
+ /** @var string */
+ protected $collectionName = '';
+
+ /** @var IAccountProperty[] */
+ protected $properties = [];
+
+ public function __construct(string $collectionName) {
+ $this->collectionName = $collectionName;
+ }
+
+ public function setProperties(array $properties): IAccountPropertyCollection {
+ /** @var IAccountProperty $property */
+ $this->properties = [];
+ foreach ($properties as $property) {
+ $this->addProperty($property);
+ }
+ return $this;
+ }
+
+ public function getProperties(): array {
+ return $this->properties;
+ }
+
+ public function addProperty(IAccountProperty $property): IAccountPropertyCollection {
+ if ($property->getName() !== $this->collectionName) {
+ throw new InvalidArgumentException('Provided property does not match collection name');
+ }
+ $this->properties[] = $property;
+ return $this;
+ }
+
+ public function removeProperty(IAccountProperty $property): IAccountPropertyCollection {
+ $ref = array_search($property, $this->properties, true);
+ if ($ref !== false) {
+ unset($this->properties[$ref]);
+ }
+ return $this;
+ }
+
+ public function removePropertyByValue(string $value): IAccountPropertyCollection {
+ foreach ($this->properties as $i => $property) {
+ if ($property->getValue() === $value) {
+ unset($this->properties[$i]);
+ }
+ }
+ return $this;
+ }
+
+ public function jsonSerialize() {
+ return [$this->collectionName => $this->properties];
+ }
+
+ public function getName(): string {
+ return $this->collectionName;
+ }
+}
diff --git a/lib/private/Accounts/TAccountsHelper.php b/lib/private/Accounts/TAccountsHelper.php
new file mode 100644
index 00000000000..530204b451f
--- /dev/null
+++ b/lib/private/Accounts/TAccountsHelper.php
@@ -0,0 +1,40 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * @copyright Copyright (c) 2021 Arthur Schiwon <blizzz@arthur-schiwon.de>
+ *
+ * @author Arthur Schiwon <blizzz@arthur-schiwon.de>
+ *
+ * @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 <https://www.gnu.org/licenses/>.
+ *
+ */
+
+namespace OC\Accounts;
+
+use OCP\Accounts\IAccountManager;
+
+trait TAccountsHelper {
+ protected function isCollection(string $propertyName): bool {
+ return in_array($propertyName,
+ [
+ IAccountManager::COLLECTION_EMAIL,
+ ],
+ true
+ );
+ }
+}
diff --git a/lib/public/Accounts/IAccount.php b/lib/public/Accounts/IAccount.php
index 02c50259b13..72c207537dc 100644
--- a/lib/public/Accounts/IAccount.php
+++ b/lib/public/Accounts/IAccount.php
@@ -26,6 +26,7 @@ declare(strict_types=1);
*/
namespace OCP\Accounts;
+use Generator;
use OCP\IUser;
/**
@@ -62,16 +63,48 @@ interface IAccount extends \JsonSerializable {
/**
* Get all properties of an account. Array indices are property names.
+ * Values from IAccountPropertyCollections are not included in the return
+ * array.
*
* @since 15.0.0
- *
- * @return IAccountProperty[]
+ * @deprecated 22.0.0 use getAllProperties()
*/
public function getProperties(): array;
/**
+ * Get all properties of an account. Array indices are numeric. To get
+ * the property name, call getName() against the value.
+ *
+ * IAccountPropertyCollections are being flattened into an IAccountProperty
+ * for each value.
+ *
+ * @since 22.0.0
+ *
+ * @return Generator<int, IAccountProperty>
+ */
+ public function getAllProperties(): Generator;
+
+ /**
+ * Set a property collection (multi-value properties)
+ *
+ * @since 22.0.0
+ */
+ public function setPropertyCollection(IAccountPropertyCollection $propertyCollection): IAccount;
+
+ /**
+ * Returns the requestes propery collection (multi-value properties)
+ *
+ * @since 22.0.0
+ */
+ public function getPropertyCollection(string $propertyCollection): IAccountPropertyCollection;
+
+ /**
* Get all properties that match the provided filters for scope and verification status
*
+ * Since 22.0.0 values from IAccountPropertyCollection are included, but also
+ * as IAccountProperty instances. They for properties of IAccountPropertyCollection are
+ * suffixed incrementally, i.e. #0, #1 ... #n – the numbers have no further meaning.
+ *
* @since 15.0.0
*
* @param string $scope Must be one of the VISIBILITY_ prefixed constants of \OCP\Accounts\IAccountManager
diff --git a/lib/public/Accounts/IAccountManager.php b/lib/public/Accounts/IAccountManager.php
index dc085b44b84..9418e07ec97 100644
--- a/lib/public/Accounts/IAccountManager.php
+++ b/lib/public/Accounts/IAccountManager.php
@@ -96,6 +96,8 @@ interface IAccountManager {
public const PROPERTY_ADDRESS = 'address';
public const PROPERTY_TWITTER = 'twitter';
+ public const COLLECTION_EMAIL = 'additional_mail';
+
public const NOT_VERIFIED = '0';
public const VERIFICATION_IN_PROGRESS = '1';
public const VERIFIED = '2';
@@ -123,7 +125,10 @@ interface IAccountManager {
/**
* Search for users based on account data
*
- * @param string $property
+ * @param string $property - property or property collection name – since
+ * NC 22 the implementation MAY add a fitting property collection into the
+ * search even if a property name was given e.g. email property and email
+ * collection)
* @param string[] $values
* @return array
*
diff --git a/lib/public/Accounts/IAccountPropertyCollection.php b/lib/public/Accounts/IAccountPropertyCollection.php
new file mode 100644
index 00000000000..9e026f4ce5b
--- /dev/null
+++ b/lib/public/Accounts/IAccountPropertyCollection.php
@@ -0,0 +1,84 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * @copyright Copyright (c) 2021 Arthur Schiwon <blizzz@arthur-schiwon.de>
+ *
+ * @author Arthur Schiwon <blizzz@arthur-schiwon.de>
+ *
+ * @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 <https://www.gnu.org/licenses/>.
+ *
+ */
+
+namespace OCP\Accounts;
+
+use InvalidArgumentException;
+use JsonSerializable;
+
+/**
+ * Interface IAccountPropertyCollection
+ *
+ * @package OCP\Accounts
+ *
+ * @since 22.0.0
+ */
+interface IAccountPropertyCollection extends JsonSerializable {
+
+ /**
+ * retuns the collection name
+ *
+ * @since 22.0.0
+ */
+ public function getName(): string;
+
+ /**
+ * set properties of this collection
+ *
+ * @param IAccountProperty[] $properties
+ * @throws InvalidArgumentException
+ * @since 22.0.0
+ */
+ public function setProperties(array $properties): IAccountPropertyCollection;
+
+ /**
+ * @return IAccountProperty[]
+ * @since 22.0.0
+ */
+ public function getProperties(): array;
+
+ /**
+ * adds a property to this collection
+ *
+ * @throws InvalidArgumentException
+ * @since 22.0.0
+ */
+ public function addProperty(IAccountProperty $property): IAccountPropertyCollection;
+
+ /**
+ * removes a property of this collection
+ *
+ * @since 22.0.0
+ */
+ public function removeProperty(IAccountProperty $property): IAccountPropertyCollection;
+
+ /**
+ * removes a property identified by its value
+ *
+ * @since 22.0.0
+ */
+ public function removePropertyByValue(string $value): IAccountPropertyCollection;
+}
diff --git a/tests/lib/Accounts/AccountManagerTest.php b/tests/lib/Accounts/AccountManagerTest.php
index 9bce92716ac..ea82bd04f3f 100644
--- a/tests/lib/Accounts/AccountManagerTest.php
+++ b/tests/lib/Accounts/AccountManagerTest.php
@@ -26,6 +26,7 @@ use OC\Accounts\AccountManager;
use OCP\Accounts\IAccountManager;
use OCP\BackgroundJob\IJobList;
use OCP\IConfig;
+use OCP\IDBConnection;
use OCP\IUser;
use PHPUnit\Framework\MockObject\MockObject;
use Psr\Log\LoggerInterface;
@@ -59,13 +60,24 @@ class AccountManagerTest extends TestCase {
/** @var LoggerInterface|MockObject */
private $logger;
+ /** @var AccountManager */
+ private $accountManager;
+
protected function setUp(): void {
parent::setUp();
$this->eventDispatcher = $this->createMock(EventDispatcherInterface::class);
- $this->connection = \OC::$server->getDatabaseConnection();
+ $this->connection = \OC::$server->get(IDBConnection::class);
$this->config = $this->createMock(IConfig::class);
$this->jobList = $this->createMock(IJobList::class);
$this->logger = $this->createMock(LoggerInterface::class);
+
+ $this->accountManager = new AccountManager(
+ $this->connection,
+ $this->config,
+ $this->eventDispatcher,
+ $this->jobList,
+ $this->logger,
+ );
}
protected function tearDown(): void {
@@ -74,6 +86,90 @@ class AccountManagerTest extends TestCase {
$query->delete($this->table)->execute();
}
+ protected function makeUser(string $uid, string $name, string $email = null): IUser {
+ $user = $this->createMock(IUser::class);
+ $user->expects($this->any())
+ ->method('getUid')
+ ->willReturn($uid);
+ $user->expects($this->any())
+ ->method('getDisplayName')
+ ->willReturn($name);
+ if ($email !== null) {
+ $user->expects($this->any())
+ ->method('getEMailAddress')
+ ->willReturn($email);
+ }
+
+ return $user;
+ }
+
+ protected function populateOrUpdate(): void {
+ $users = [
+ [
+ 'user' => $this->makeUser('j.doe', 'Jane Doe', 'jane.doe@acme.com'),
+ 'data' => [
+ IAccountManager::PROPERTY_DISPLAYNAME => ['value' => 'Jane Doe', 'scope' => IAccountManager::SCOPE_PUBLISHED],
+ IAccountManager::PROPERTY_EMAIL => ['value' => 'jane.doe@acme.com', 'scope' => IAccountManager::SCOPE_LOCAL],
+ IAccountManager::PROPERTY_TWITTER => ['value' => '@sometwitter', 'scope' => IAccountManager::SCOPE_PUBLISHED],
+ IAccountManager::PROPERTY_PHONE => ['value' => '+491601231212', 'scope' => IAccountManager::SCOPE_FEDERATED],
+ IAccountManager::PROPERTY_ADDRESS => ['value' => 'some street', 'scope' => IAccountManager::SCOPE_LOCAL],
+ IAccountManager::PROPERTY_WEBSITE => ['value' => 'https://acme.com', 'scope' => IAccountManager::SCOPE_PRIVATE],
+ ],
+ ],
+ [
+ 'user' => $this->makeUser('a.allison', 'Alice Allison', 'a.allison@example.org'),
+ 'data' => [
+ IAccountManager::PROPERTY_DISPLAYNAME => ['value' => 'Alice Allison', 'scope' => IAccountManager::SCOPE_LOCAL],
+ IAccountManager::PROPERTY_EMAIL => ['value' => 'a.allison@example.org', 'scope' => IAccountManager::SCOPE_LOCAL],
+ IAccountManager::PROPERTY_TWITTER => ['value' => '@a_alice', 'scope' => IAccountManager::SCOPE_FEDERATED],
+ IAccountManager::PROPERTY_PHONE => ['value' => '+491602312121', 'scope' => IAccountManager::SCOPE_LOCAL],
+ IAccountManager::PROPERTY_ADDRESS => ['value' => 'Dundee Road 45', 'scope' => IAccountManager::SCOPE_LOCAL],
+ IAccountManager::PROPERTY_WEBSITE => ['value' => 'https://example.org', 'scope' => IAccountManager::SCOPE_LOCAL],
+ ],
+ ],
+ [
+ 'user' => $this->makeUser('b32c5a5b-1084-4380-8856-e5223b16de9f', 'Armel Oliseh', 'oliseh@example.com'),
+ 'data' => [
+ IAccountManager::PROPERTY_DISPLAYNAME => ['value' => 'Armel Oliseh', 'scope' => IAccountManager::SCOPE_PUBLISHED],
+ IAccountManager::PROPERTY_EMAIL => ['value' => 'oliseh@example.com', 'scope' => IAccountManager::SCOPE_PUBLISHED],
+ IAccountManager::PROPERTY_TWITTER => ['value' => '', 'scope' => IAccountManager::SCOPE_LOCAL],
+ IAccountManager::PROPERTY_PHONE => ['value' => '+491603121212', 'scope' => IAccountManager::SCOPE_PUBLISHED],
+ IAccountManager::PROPERTY_ADDRESS => ['value' => 'Sunflower Blvd. 77', 'scope' => IAccountManager::SCOPE_PUBLISHED],
+ IAccountManager::PROPERTY_WEBSITE => ['value' => 'https://example.com', 'scope' => IAccountManager::SCOPE_PUBLISHED],
+ ],
+ ],
+ [
+ 'user' => $this->makeUser('31b5316a-9b57-4b17-970a-315a4cbe73eb', 'K. Cheng', 'cheng@emca.com'),
+ 'data' => [
+ IAccountManager::PROPERTY_DISPLAYNAME => ['value' => 'K. Cheng', 'scope' => IAccountManager::SCOPE_FEDERATED],
+ IAccountManager::PROPERTY_EMAIL => ['value' => 'cheng@emca.com', 'scope' => IAccountManager::SCOPE_FEDERATED],
+ IAccountManager::PROPERTY_TWITTER => ['value' => '', 'scope' => IAccountManager::SCOPE_LOCAL],
+ IAccountManager::PROPERTY_PHONE => ['value' => '+71601212123', 'scope' => IAccountManager::SCOPE_LOCAL],
+ IAccountManager::PROPERTY_ADDRESS => ['value' => 'Pinapple Street 22', 'scope' => IAccountManager::SCOPE_LOCAL],
+ IAccountManager::PROPERTY_WEBSITE => ['value' => 'https://emca.com', 'scope' => IAccountManager::SCOPE_FEDERATED],
+ IAccountManager::COLLECTION_EMAIL => [
+ ['value' => 'k.cheng@emca.com', 'scope' => IAccountManager::SCOPE_LOCAL],
+ ['value' => 'kai.cheng@emca.com', 'scope' => IAccountManager::SCOPE_LOCAL],
+ ],
+ ],
+ ],
+ [
+ 'user' => $this->makeUser('goodpal@elpmaxe.org', 'Goodpal, Kim', 'goodpal@elpmaxe.org'),
+ 'data' => [
+ IAccountManager::PROPERTY_DISPLAYNAME => ['value' => 'Goodpal, Kim', 'scope' => IAccountManager::SCOPE_PUBLISHED],
+ IAccountManager::PROPERTY_EMAIL => ['value' => 'goodpal@elpmaxe.org', 'scope' => IAccountManager::SCOPE_PUBLISHED],
+ IAccountManager::PROPERTY_TWITTER => ['value' => '', 'scope' => IAccountManager::SCOPE_LOCAL],
+ IAccountManager::PROPERTY_PHONE => ['value' => '+71602121231', 'scope' => IAccountManager::SCOPE_FEDERATED],
+ IAccountManager::PROPERTY_ADDRESS => ['value' => 'Octopus Ave 17', 'scope' => IAccountManager::SCOPE_FEDERATED],
+ IAccountManager::PROPERTY_WEBSITE => ['value' => 'https://elpmaxe.org', 'scope' => IAccountManager::SCOPE_PUBLISHED],
+ ],
+ ],
+ ];
+ foreach ($users as $userInfo) {
+ $this->accountManager->updateUser($userInfo['user'], $userInfo['data'], false);
+ }
+ }
+
/**
* get a instance of the accountManager
*
@@ -340,9 +436,8 @@ class AccountManagerTest extends TestCase {
$oldData = ['key' => ['value' => 'value']];
$newData = ['newKey' => ['value' => 'newValue']];
- $accountManager = $this->getInstance();
$this->addDummyValuesToTable('uid', $oldData);
- $this->invokePrivate($accountManager, 'updateExistingUser', [$user, $newData]);
+ $this->invokePrivate($this->accountManager, 'updateExistingUser', [$user, $newData]);
$newDataFromTable = $this->getDataFromTable('uid');
$this->assertEquals($newData, $newDataFromTable);
}
@@ -352,18 +447,15 @@ class AccountManagerTest extends TestCase {
$uid = 'uid';
$data = ['key' => ['value' => 'value']];
- $accountManager = $this->getInstance();
$user->expects($this->atLeastOnce())->method('getUID')->willReturn($uid);
$this->assertNull($this->getDataFromTable($uid));
- $this->invokePrivate($accountManager, 'insertNewUser', [$user, $data]);
+ $this->invokePrivate($this->accountManager, 'insertNewUser', [$user, $data]);
$dataFromDb = $this->getDataFromTable($uid);
$this->assertEquals($data, $dataFromDb);
}
public function testAddMissingDefaultValues() {
- $accountManager = $this->getInstance();
-
$input = [
'key1' => ['value' => 'value1', 'verified' => '0'],
'key2' => ['value' => 'value1'],
@@ -374,7 +466,7 @@ class AccountManagerTest extends TestCase {
'key2' => ['value' => 'value1', 'verified' => '0'],
];
- $result = $this->invokePrivate($accountManager, 'addMissingDefaultValues', [$input]);
+ $result = $this->invokePrivate($this->accountManager, 'addMissingDefaultValues', [$input]);
$this->assertSame($expected, $result);
}
@@ -461,13 +553,11 @@ class AccountManagerTest extends TestCase {
$this->config->method('getSystemValueString')
->willReturn($defaultRegion);
- $instance = $this->getInstance();
-
if ($phoneNumber === null) {
$this->expectException(\InvalidArgumentException::class);
- self::invokePrivate($instance, 'parsePhoneNumber', [$phoneInput]);
+ self::invokePrivate($this->accountManager, 'parsePhoneNumber', [$phoneInput]);
} else {
- self::assertEquals($phoneNumber, self::invokePrivate($instance, 'parsePhoneNumber', [$phoneInput]));
+ self::assertEquals($phoneNumber, self::invokePrivate($this->accountManager, 'parsePhoneNumber', [$phoneInput]));
}
}
@@ -487,13 +577,78 @@ class AccountManagerTest extends TestCase {
* @param string|null $websiteOutput
*/
public function testParseWebsite(string $websiteInput, ?string $websiteOutput): void {
- $instance = $this->getInstance();
-
if ($websiteOutput === null) {
$this->expectException(\InvalidArgumentException::class);
- self::invokePrivate($instance, 'parseWebsite', [$websiteInput]);
+ self::invokePrivate($this->accountManager, 'parseWebsite', [$websiteInput]);
} else {
- self::assertEquals($websiteOutput, self::invokePrivate($instance, 'parseWebsite', [$websiteInput]));
+ self::assertEquals($websiteOutput, self::invokePrivate($this->accountManager, 'parseWebsite', [$websiteInput]));
+ }
+ }
+
+ /**
+ * @dataProvider searchDataProvider
+ */
+ public function testSearchUsers(string $property, array $values, array $expected): void {
+ $this->populateOrUpdate();
+
+ $matchedUsers = $this->accountManager->searchUsers($property, $values);
+ foreach ($expected as $expectedEntry) {
+ $this->assertContains($expectedEntry, $matchedUsers);
+ }
+ if (empty($expected)) {
+ $this->assertEmpty($matchedUsers);
}
}
+
+ public function searchDataProvider(): array {
+ return [
+ [ #0 Search for an existing name
+ IAccountManager::PROPERTY_DISPLAYNAME,
+ ['Jane Doe'],
+ ['Jane Doe' => 'j.doe']
+ ],
+ [ #1 Search for part of a name (no result)
+ IAccountManager::PROPERTY_DISPLAYNAME,
+ ['Jane'],
+ []
+ ],
+ [ #2 Search for part of a name (no result, test wildcard)
+ IAccountManager::PROPERTY_DISPLAYNAME,
+ ['Jane%'],
+ []
+ ],
+ [ #3 Search for phone
+ IAccountManager::PROPERTY_PHONE,
+ ['+491603121212'],
+ ['+491603121212' => 'b32c5a5b-1084-4380-8856-e5223b16de9f'],
+ ],
+ [ #4 Search for twitter handles
+ IAccountManager::PROPERTY_TWITTER,
+ ['@sometwitter', '@a_alice', '@unseen'],
+ ['@sometwitter' => 'j.doe', '@a_alice' => 'a.allison'],
+ ],
+ [ #5 Search for email
+ IAccountManager::PROPERTY_EMAIL,
+ ['cheng@emca.com'],
+ ['cheng@emca.com' => '31b5316a-9b57-4b17-970a-315a4cbe73eb'],
+ ],
+ [ #6 Search for email by additional email
+ IAccountManager::PROPERTY_EMAIL,
+ ['kai.cheng@emca.com'],
+ ['kai.cheng@emca.com' => '31b5316a-9b57-4b17-970a-315a4cbe73eb'],
+ ],
+ [ #7 Search for additional email
+ IAccountManager::COLLECTION_EMAIL,
+ ['kai.cheng@emca.com', 'cheng@emca.com'],
+ ['kai.cheng@emca.com' => '31b5316a-9b57-4b17-970a-315a4cbe73eb'],
+ ],
+ [ #8 Search for email by additional email (two valid search values, but the same user)
+ IAccountManager::PROPERTY_EMAIL,
+ ['kai.cheng@emca.com', 'cheng@emca.com'],
+ [
+ 'kai.cheng@emca.com' => '31b5316a-9b57-4b17-970a-315a4cbe73eb',
+ ],
+ ],
+ ];
+ }
}
diff --git a/tests/lib/Accounts/AccountPropertyCollectionTest.php b/tests/lib/Accounts/AccountPropertyCollectionTest.php
new file mode 100644
index 00000000000..d8a6bafd24b
--- /dev/null
+++ b/tests/lib/Accounts/AccountPropertyCollectionTest.php
@@ -0,0 +1,209 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * @copyright Copyright (c) 2021 Arthur Schiwon <blizzz@arthur-schiwon.de>
+ *
+ * @author Arthur Schiwon <blizzz@arthur-schiwon.de>
+ *
+ * @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 <https://www.gnu.org/licenses/>.
+ *
+ */
+
+namespace lib\Accounts;
+
+use InvalidArgumentException;
+use OC\Accounts\AccountPropertyCollection;
+use OCP\Accounts\IAccountProperty;
+use OCP\Accounts\IAccountPropertyCollection;
+use PHPUnit\Framework\MockObject\MockObject;
+use Test\TestCase;
+
+class AccountPropertyCollectionTest extends TestCase {
+ /** @var IAccountPropertyCollection */
+ protected $collection;
+
+ protected const COLLECTION_NAME = 'my_multivalue_property';
+
+ public function setUp(): void {
+ parent::setUp();
+
+ $this->collection = new AccountPropertyCollection(self::COLLECTION_NAME);
+ }
+
+ /**
+ * @return IAccountProperty|MockObject
+ */
+ protected function makePropertyMock(string $propertyName): MockObject {
+ $mock = $this->createMock(IAccountProperty::class);
+ $mock->expects($this->any())
+ ->method('getName')
+ ->willReturn($propertyName);
+
+ return $mock;
+ }
+
+ public function testSetAndGetProperties() {
+ $propsBefore = $this->collection->getProperties();
+ $this->assertIsArray($propsBefore);
+ $this->assertEmpty($propsBefore);
+
+ $props = [
+ $this->makePropertyMock(self::COLLECTION_NAME),
+ $this->makePropertyMock(self::COLLECTION_NAME),
+ $this->makePropertyMock(self::COLLECTION_NAME),
+ ];
+
+ $this->collection->setProperties($props);
+ $propsAfter = $this->collection->getProperties();
+ $this->assertIsArray($propsAfter);
+ $this->assertCount(count($props), $propsAfter);
+ }
+
+ public function testSetPropertiesMixedInvalid() {
+ $props = [
+ $this->makePropertyMock(self::COLLECTION_NAME),
+ $this->makePropertyMock('sneaky_property'),
+ $this->makePropertyMock(self::COLLECTION_NAME),
+ ];
+
+ $this->expectException(InvalidArgumentException::class);
+ $this->collection->setProperties($props);
+ }
+
+ public function testAddProperty() {
+ $props = [
+ $this->makePropertyMock(self::COLLECTION_NAME),
+ $this->makePropertyMock(self::COLLECTION_NAME),
+ $this->makePropertyMock(self::COLLECTION_NAME),
+ ];
+ $this->collection->setProperties($props);
+
+ $additionalProperty = $this->makePropertyMock(self::COLLECTION_NAME);
+ $this->collection->addProperty($additionalProperty);
+
+ $propsAfter = $this->collection->getProperties();
+ $this->assertCount(count($props) + 1, $propsAfter);
+ $this->assertNotFalse(array_search($additionalProperty, $propsAfter, true));
+ }
+
+ public function testAddPropertyInvalid() {
+ $props = [
+ $this->makePropertyMock(self::COLLECTION_NAME),
+ $this->makePropertyMock(self::COLLECTION_NAME),
+ $this->makePropertyMock(self::COLLECTION_NAME),
+ ];
+ $this->collection->setProperties($props);
+
+ $additionalProperty = $this->makePropertyMock('sneaky_property');
+ $exceptionThrown = false;
+ try {
+ $this->collection->addProperty($additionalProperty);
+ } catch (\InvalidArgumentException $e) {
+ $exceptionThrown = true;
+ } finally {
+ $propsAfter = $this->collection->getProperties();
+ $this->assertCount(count($props), $propsAfter);
+ $this->assertFalse(array_search($additionalProperty, $propsAfter, true));
+ $this->assertTrue($exceptionThrown);
+ }
+ }
+
+ public function testRemoveProperty() {
+ $additionalProperty = $this->makePropertyMock(self::COLLECTION_NAME);
+ $props = [
+ $this->makePropertyMock(self::COLLECTION_NAME),
+ $this->makePropertyMock(self::COLLECTION_NAME),
+ $additionalProperty,
+ $this->makePropertyMock(self::COLLECTION_NAME),
+ ];
+ $this->collection->setProperties($props);
+
+ $propsBefore = $this->collection->getProperties();
+ $this->collection->removeProperty($additionalProperty);
+ $propsAfter = $this->collection->getProperties();
+
+ $this->assertTrue(count($propsBefore) > count($propsAfter));
+ $this->assertCount(count($propsBefore) - 1, $propsAfter);
+ $this->assertFalse(array_search($additionalProperty, $propsAfter, true));
+ }
+
+ public function testRemovePropertyNotFound() {
+ $additionalProperty = $this->makePropertyMock(self::COLLECTION_NAME);
+ $props = [
+ $this->makePropertyMock(self::COLLECTION_NAME),
+ $this->makePropertyMock(self::COLLECTION_NAME),
+ $this->makePropertyMock(self::COLLECTION_NAME),
+ ];
+ $this->collection->setProperties($props);
+
+ $propsBefore = $this->collection->getProperties();
+ $this->collection->removeProperty($additionalProperty);
+ $propsAfter = $this->collection->getProperties();
+
+ // no errors, gently
+ $this->assertCount(count($propsBefore), $propsAfter);
+ }
+
+ public function testRemovePropertyByValue() {
+ $additionalProperty = $this->makePropertyMock(self::COLLECTION_NAME);
+ $additionalProperty->expects($this->any())
+ ->method('getValue')
+ ->willReturn('Lorem ipsum');
+
+ $additionalPropertyTwo = clone $additionalProperty;
+
+ $props = [
+ $this->makePropertyMock(self::COLLECTION_NAME),
+ $this->makePropertyMock(self::COLLECTION_NAME),
+ $additionalProperty,
+ $this->makePropertyMock(self::COLLECTION_NAME),
+ $additionalPropertyTwo
+ ];
+ $this->collection->setProperties($props);
+
+ $propsBefore = $this->collection->getProperties();
+ $this->collection->removePropertyByValue('Lorem ipsum');
+ $propsAfter = $this->collection->getProperties();
+
+ $this->assertTrue(count($propsBefore) > count($propsAfter));
+ $this->assertCount(count($propsBefore) - 2, $propsAfter);
+ $this->assertFalse(array_search($additionalProperty, $propsAfter, true));
+ $this->assertFalse(array_search($additionalPropertyTwo, $propsAfter, true));
+ }
+
+ public function testRemovePropertyByValueNotFound() {
+ $additionalProperty = $this->makePropertyMock(self::COLLECTION_NAME);
+ $additionalProperty->expects($this->any())
+ ->method('getValue')
+ ->willReturn('Lorem ipsum');
+
+ $props = [
+ $this->makePropertyMock(self::COLLECTION_NAME),
+ $this->makePropertyMock(self::COLLECTION_NAME),
+ $this->makePropertyMock(self::COLLECTION_NAME),
+ ];
+ $this->collection->setProperties($props);
+
+ $propsBefore = $this->collection->getProperties();
+ $this->collection->removePropertyByValue('Lorem ipsum');
+ $propsAfter = $this->collection->getProperties();
+
+ // no errors, gently
+ $this->assertCount(count($propsBefore), $propsAfter);
+ }
+}
diff --git a/tests/lib/Accounts/AccountTest.php b/tests/lib/Accounts/AccountTest.php
index 9c2a5333d20..0e0c42804e4 100644
--- a/tests/lib/Accounts/AccountTest.php
+++ b/tests/lib/Accounts/AccountTest.php
@@ -25,6 +25,7 @@ namespace Test\Accounts;
use OC\Accounts\Account;
use OC\Accounts\AccountProperty;
+use OC\Accounts\AccountPropertyCollection;
use OCP\Accounts\IAccountManager;
use OCP\IUser;
use Test\TestCase;
@@ -49,7 +50,7 @@ class AccountTest extends TestCase {
$this->assertEquals($property, $account->getProperty(IAccountManager::PROPERTY_WEBSITE));
}
- public function testGetProperties() {
+ public function testGetAndGetAllProperties() {
$user = $this->createMock(IUser::class);
$properties = [
IAccountManager::PROPERTY_WEBSITE => new AccountProperty(IAccountManager::PROPERTY_WEBSITE, 'https://example.com', IAccountManager::SCOPE_PUBLISHED, IAccountManager::NOT_VERIFIED, ''),
@@ -59,7 +60,14 @@ class AccountTest extends TestCase {
$account->setProperty(IAccountManager::PROPERTY_WEBSITE, 'https://example.com', IAccountManager::SCOPE_PUBLISHED, IAccountManager::NOT_VERIFIED);
$account->setProperty(IAccountManager::PROPERTY_EMAIL, 'user@example.com', IAccountManager::SCOPE_LOCAL, IAccountManager::VERIFIED);
+ $col = new AccountPropertyCollection(IAccountManager::COLLECTION_EMAIL);
+ $additionalProperty = new AccountProperty($col->getName(), 'second@example.org', IAccountManager::SCOPE_PUBLISHED, IAccountManager::NOT_VERIFIED, '');
+ $col->addProperty($additionalProperty);
+ $account->setPropertyCollection($col);
+
$this->assertEquals($properties, $account->getProperties());
+ $properties[] = $additionalProperty;
+ $this->assertEquals(array_values($properties), \iterator_to_array($account->getAllProperties()));
}
public function testGetFilteredProperties() {
@@ -74,11 +82,20 @@ class AccountTest extends TestCase {
$account->setProperty(IAccountManager::PROPERTY_EMAIL, 'user@example.com', IAccountManager::SCOPE_LOCAL, IAccountManager::VERIFIED);
$account->setProperty(IAccountManager::PROPERTY_PHONE, '123456', IAccountManager::SCOPE_PUBLISHED, IAccountManager::VERIFIED);
+ $col = new AccountPropertyCollection(IAccountManager::COLLECTION_EMAIL);
+ $additionalProperty1 = new AccountProperty($col->getName(), 'second@example.org', IAccountManager::SCOPE_PUBLISHED, IAccountManager::NOT_VERIFIED, '');
+ $additionalProperty2 = new AccountProperty($col->getName(), 'third@example.org', IAccountManager::SCOPE_PUBLISHED, IAccountManager::VERIFIED, '');
+ $col->addProperty($additionalProperty1);
+ $col->addProperty($additionalProperty2);
+ $account->setPropertyCollection($col);
+
$this->assertEquals(
[
IAccountManager::PROPERTY_WEBSITE => $properties[IAccountManager::PROPERTY_WEBSITE],
IAccountManager::PROPERTY_PHONE => $properties[IAccountManager::PROPERTY_PHONE],
+ IAccountManager::COLLECTION_EMAIL . '#0' => $additionalProperty1,
+ IAccountManager::COLLECTION_EMAIL . '#1' => $additionalProperty2,
],
$account->getFilteredProperties(IAccountManager::SCOPE_PUBLISHED)
);
@@ -86,12 +103,16 @@ class AccountTest extends TestCase {
[
IAccountManager::PROPERTY_EMAIL => $properties[IAccountManager::PROPERTY_EMAIL],
IAccountManager::PROPERTY_PHONE => $properties[IAccountManager::PROPERTY_PHONE],
+ IAccountManager::COLLECTION_EMAIL . '#0' => $additionalProperty2,
],
$account->getFilteredProperties(null, IAccountManager::VERIFIED)
);
$this->assertEquals(
- [IAccountManager::PROPERTY_PHONE => $properties[IAccountManager::PROPERTY_PHONE]],
- $account->getFilteredProperties(IAccountManager::SCOPE_PUBLISHED, IAccountManager::VERIFIED)
+ [
+ IAccountManager::PROPERTY_PHONE => $properties[IAccountManager::PROPERTY_PHONE],
+ IAccountManager::COLLECTION_EMAIL . '#0' => $additionalProperty2,
+ ],
+ $account->getFilteredProperties(IAccountManager::SCOPE_PUBLISHED, IAccountManager::VERIFIED),
);
}
generated by cgit v1.2.3 (git 2.39.1) at 2025-01-21 01:51:30 +0000