aboutsummaryrefslogtreecommitdiffstats
path: root/lib/private/Federation/CloudIdManager.php
diff options
context:
space:
mode:
Diffstat (limited to 'lib/private/Federation/CloudIdManager.php')
-rw-r--r--lib/private/Federation/CloudIdManager.php121
1 files changed, 72 insertions, 49 deletions
diff --git a/lib/private/Federation/CloudIdManager.php b/lib/private/Federation/CloudIdManager.php
index 86b5ed621ba..c599d9046a6 100644
--- a/lib/private/Federation/CloudIdManager.php
+++ b/lib/private/Federation/CloudIdManager.php
@@ -3,30 +3,8 @@
declare(strict_types=1);
/**
- * @copyright Copyright (c) 2017, Robin Appelman <robin@icewind.nl>
- *
- * @author Arthur Schiwon <blizzz@arthur-schiwon.de>
- * @author Christoph Wurst <christoph@winzerhof-wurst.at>
- * @author Guillaume Virlet <github@virlet.org>
- * @author Joas Schilling <coding@schilljs.com>
- * @author Robin Appelman <robin@icewind.nl>
- * @author Roeland Jago Douma <roeland@famdouma.nl>
- *
- * @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/>.
- *
+ * SPDX-FileCopyrightText: 2017 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
*/
namespace OC\Federation;
@@ -36,6 +14,7 @@ use OCP\EventDispatcher\Event;
use OCP\EventDispatcher\IEventDispatcher;
use OCP\Federation\ICloudId;
use OCP\Federation\ICloudIdManager;
+use OCP\Federation\ICloudIdResolver;
use OCP\ICache;
use OCP\ICacheFactory;
use OCP\IURLGenerator;
@@ -43,27 +22,21 @@ use OCP\IUserManager;
use OCP\User\Events\UserChangedEvent;
class CloudIdManager implements ICloudIdManager {
- /** @var IManager */
- private $contactsManager;
- /** @var IURLGenerator */
- private $urlGenerator;
- /** @var IUserManager */
- private $userManager;
private ICache $memCache;
- /** @var array[] */
+ private ICache $displayNameCache;
private array $cache = [];
+ /** @var ICloudIdResolver[] */
+ private array $cloudIdResolvers = [];
public function __construct(
- IManager $contactsManager,
- IURLGenerator $urlGenerator,
- IUserManager $userManager,
ICacheFactory $cacheFactory,
- IEventDispatcher $eventDispatcher
+ IEventDispatcher $eventDispatcher,
+ private IManager $contactsManager,
+ private IURLGenerator $urlGenerator,
+ private IUserManager $userManager,
) {
- $this->contactsManager = $contactsManager;
- $this->urlGenerator = $urlGenerator;
- $this->userManager = $userManager;
$this->memCache = $cacheFactory->createDistributed('cloud_id_');
+ $this->displayNameCache = $cacheFactory->createDistributed('cloudid_name_');
$eventDispatcher->addListener(UserChangedEvent::class, [$this, 'handleUserEvent']);
$eventDispatcher->addListener(CardUpdatedEvent::class, [$this, 'handleCardEvent']);
}
@@ -81,7 +54,7 @@ class CloudIdManager implements ICloudIdManager {
if ($event instanceof CardUpdatedEvent) {
$data = $event->getCardData()['carddata'];
foreach (explode("\r\n", $data) as $line) {
- if (str_starts_with($line, "CLOUD;")) {
+ if (str_starts_with($line, 'CLOUD;')) {
$parts = explode(':', $line, 2);
if (isset($parts[1])) {
$key = $parts[1];
@@ -101,12 +74,18 @@ class CloudIdManager implements ICloudIdManager {
public function resolveCloudId(string $cloudId): ICloudId {
// TODO magic here to get the url and user instead of just splitting on @
+ foreach ($this->cloudIdResolvers as $resolver) {
+ if ($resolver->isValidCloudId($cloudId)) {
+ return $resolver->resolveCloudId($cloudId);
+ }
+ }
+
if (!$this->isValidCloudId($cloudId)) {
throw new \InvalidArgumentException('Invalid cloud id');
}
// Find the first character that is not allowed in user names
- $id = $this->fixRemoteURL($cloudId);
+ $id = $this->stripShareLinkFragments($cloudId);
$posSlash = strpos($id, '/');
$posColon = strpos($id, ':');
@@ -126,16 +105,28 @@ class CloudIdManager implements ICloudIdManager {
$user = substr($id, 0, $lastValidAtPos);
$remote = substr($id, $lastValidAtPos + 1);
- $this->userManager->validateUserId($user);
+ // We accept slightly more chars when working with federationId than with a local userId.
+ // We remove those eventual chars from the UserId before using
+ // the IUserManager API to confirm its format.
+ $this->userManager->validateUserId(str_replace('=', '-', $user));
if (!empty($user) && !empty($remote)) {
- return new CloudId($id, $user, $remote, $this->getDisplayNameFromContact($id));
+ $remote = $this->ensureDefaultProtocol($remote);
+ return new CloudId($id, $user, $remote, null);
}
}
throw new \InvalidArgumentException('Invalid cloud id');
}
- protected function getDisplayNameFromContact(string $cloudId): ?string {
+ public function getDisplayNameFromContact(string $cloudId): ?string {
+ $cachedName = $this->displayNameCache->get($cloudId);
+ if ($cachedName !== null) {
+ if ($cachedName === $cloudId) {
+ return null;
+ }
+ return $cachedName;
+ }
+
$addressBookEntries = $this->contactsManager->search($cloudId, ['CLOUD'], [
'limit' => 1,
'enumeration' => false,
@@ -146,17 +137,20 @@ class CloudIdManager implements ICloudIdManager {
if (isset($entry['CLOUD'])) {
foreach ($entry['CLOUD'] as $cloudID) {
if ($cloudID === $cloudId) {
- // Warning, if user decides to make his full name local only,
+ // Warning, if user decides to make their full name local only,
// no FN is found on federated servers
if (isset($entry['FN'])) {
+ $this->displayNameCache->set($cloudId, $entry['FN'], 15 * 60);
return $entry['FN'];
} else {
- return $cloudID;
+ $this->displayNameCache->set($cloudId, $cloudId, 15 * 60);
+ return null;
}
}
}
}
}
+ $this->displayNameCache->set($cloudId, $cloudId, 15 * 60);
return null;
}
@@ -174,8 +168,9 @@ class CloudIdManager implements ICloudIdManager {
// note that for remote id's we don't strip the protocol for the remote we use to construct the CloudId
// this way if a user has an explicit non-https cloud id this will be preserved
// we do still use the version without protocol for looking up the display name
- $remote = $this->fixRemoteURL($remote);
+ $remote = $this->stripShareLinkFragments($remote);
$host = $this->removeProtocolFromUrl($remote);
+ $remote = $this->ensureDefaultProtocol($remote);
$key = $user . '@' . ($isLocal ? 'local' : $host);
$cached = $this->cache[$key] ?? $this->memCache->get($key);
@@ -188,7 +183,7 @@ class CloudIdManager implements ICloudIdManager {
$localUser = $this->userManager->get($user);
$displayName = $localUser ? $localUser->getDisplayName() : '';
} else {
- $displayName = $this->getDisplayNameFromContact($user . '@' . $host);
+ $displayName = null;
}
// For the visible cloudID we only strip away https
@@ -220,6 +215,14 @@ class CloudIdManager implements ICloudIdManager {
return $url;
}
+ protected function ensureDefaultProtocol(string $remote): string {
+ if (!str_contains($remote, '://')) {
+ $remote = 'https://' . $remote;
+ }
+
+ return $remote;
+ }
+
/**
* Strips away a potential file names and trailing slashes:
* - http://localhost
@@ -232,7 +235,7 @@ class CloudIdManager implements ICloudIdManager {
* @param string $remote
* @return string
*/
- protected function fixRemoteURL(string $remote): string {
+ protected function stripShareLinkFragments(string $remote): string {
$remote = str_replace('\\', '/', $remote);
if ($fileNamePosition = strpos($remote, '/index.php')) {
$remote = substr($remote, 0, $fileNamePosition);
@@ -247,6 +250,26 @@ class CloudIdManager implements ICloudIdManager {
* @return bool
*/
public function isValidCloudId(string $cloudId): bool {
- return str_contains($cloudId, '@');
+ foreach ($this->cloudIdResolvers as $resolver) {
+ if ($resolver->isValidCloudId($cloudId)) {
+ return true;
+ }
+ }
+
+ return strpos($cloudId, '@') !== false;
+ }
+
+ public function createCloudId(string $id, string $user, string $remote, ?string $displayName = null): ICloudId {
+ return new CloudId($id, $user, $remote, $displayName);
+ }
+
+ public function registerCloudIdResolver(ICloudIdResolver $resolver): void {
+ array_unshift($this->cloudIdResolvers, $resolver);
+ }
+
+ public function unregisterCloudIdResolver(ICloudIdResolver $resolver): void {
+ if (($key = array_search($resolver, $this->cloudIdResolvers)) !== false) {
+ array_splice($this->cloudIdResolvers, $key, 1);
+ }
}
}
generated by cgit v1.2.3 (git 2.39.1) at 2025-08-15 12:00:45 +0000