upstream/nextcloud
1
0
Fork 0
mirror of https://github.com/nextcloud/server.git synced 2026-05-28 04:32:30 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions 25

fix(LDAP): use displayname from DB, before reaching out to LDAP

Browse source 
As we do it with other information of the user, we now use the known value
of a users displayname, and leave the updating to the background job. This
improves performance of user facing actions where the display name is
required and reduces queries to the LDAP server that are typically more
expensive.

Signed-off-by: Arthur Schiwon <blizzz@arthur-schiwon.de>
This commit is contained in:
Arthur Schiwon 2026-03-18 10:49:57 +01:00
parent 1b504bf4ec
commit 1c01895796
No known key found for this signature in database
GPG key ID: 7424F1874854DF23
3 changed files with 58 additions and 41 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

20
apps/user_ldap/lib/Access.php
View file

@ -704,7 +704,7 @@ class Access extends LDAPUtility {
continue;
}
$sndName = $ldapObject[$sndAttribute][0] ?? '';
$this->cacheUserDisplayName($ncName, $nameByLDAP, $sndName);
$this->applyUserDisplayName($ncName, $nameByLDAP, $sndName);
} elseif ($nameByLDAP !== null) {
$this->cacheGroupDisplayName($ncName, $nameByLDAP);
}
@ -752,20 +752,16 @@ class Access extends LDAPUtility {
$this->connection->writeToCache('groupExists' . $gid, true);
}
/**
* caches the user display name
*
* @param string $ocName the internal Nextcloud username
* @param string $displayName the display name
* @param string $displayName2 the second display name
* @throws \Exception
*/
public function cacheUserDisplayName(string $ocName, string $displayName, string $displayName2 = ''): void {
$user = $this->userManager->get($ocName);
public function applyUserDisplayName(string $uid, string $displayName, string $displayName2 = ''): void {
$user = $this->userManager->get($uid);
if ($user === null) {
return;
}
$displayName = $user->composeAndStoreDisplayName($displayName, $displayName2);
$composedDisplayName = $user->composeAndStoreDisplayName($displayName, $displayName2);
$this->cacheUserDisplayName($uid, $composedDisplayName);
}
public function cacheUserDisplayName(string $ocName, string $displayName): void {
$cacheKeyTrunk = 'getDisplayName';
$this->connection->writeToCache($cacheKeyTrunk . $ocName, $displayName);
}

12
apps/user_ldap/lib/User/User.php
View file

@ -119,12 +119,8 @@ class User {
$displayName2 = (string)$ldapEntry[$attr][0];
}
if ($displayName !== '') {
$this->composeAndStoreDisplayName($displayName, $displayName2);
$this->access->cacheUserDisplayName(
$this->getUsername(),
$displayName,
$displayName2
);
$composedDisplayName = $this->composeAndStoreDisplayName($displayName, $displayName2);
$this->access->cacheUserDisplayName($this->getUsername(), $composedDisplayName);
}
unset($attr);
@ -457,6 +453,10 @@ class User {
return $displayName;
}
public function fetchStoredDisplayName(): string {
return $this->userConfig->getValueString($this->uid, 'user_ldap', 'displayName', '');
}
/**
* Stores the LDAP Username in the Database
*/

67
apps/user_ldap/lib/User_LDAP.php
View file

@ -262,7 +262,8 @@ class User_LDAP extends BackendUtility implements IUserBackend, UserInterface, I
/**
* checks whether a user is still available on LDAP
*
* @param string|User $user either the Nextcloud user id or an instance of that user
* @param string|User $user either the Nextcloud user id or an instance of
* that user
* @throws \Exception
* @throws ServerNotAvailableException
*/
@ -421,26 +422,21 @@ class User_LDAP extends BackendUtility implements IUserBackend, UserInterface, I
return $path;
}
/**
* get display name of the user
* @param string $uid user ID of the user
* @return string|false display name
*/
public function getDisplayName($uid) {
if ($this->userPluginManager->implementsActions(Backend::GET_DISPLAYNAME)) {
return $this->userPluginManager->getDisplayName($uid);
private function getDisplayNameFromDatabase(string $uid): ?string {
$user = $this->access->userManager->get($uid);
if ($user instanceof User) {
$displayName = $user->fetchStoredDisplayName();
if ($displayName !== '') {
return $displayName;
}
}
if (!$this->userExists($uid)) {
return false;
if ($user instanceof OfflineUser) {
return $user->getDisplayName();
}
return null;
}
$cacheKey = 'getDisplayName' . $uid;
if (!is_null($displayName = $this->access->connection->getFromCache($cacheKey))) {
return $displayName;
}
//Check whether the display name is configured to have a 2nd feature
private function getDisplayNameFromLdap(string $uid): string {
$additionalAttribute = $this->access->connection->ldapUserDisplayName2;
$displayName2 = '';
if ($additionalAttribute !== '') {
@ -462,16 +458,40 @@ class User_LDAP extends BackendUtility implements IUserBackend, UserInterface, I
$user = $this->access->userManager->get($uid);
if ($user instanceof User) {
$displayName = $user->composeAndStoreDisplayName($displayName, (string)$displayName2);
$this->access->connection->writeToCache($cacheKey, $displayName);
return $user->composeAndStoreDisplayName($displayName, (string)$displayName2);
}
if ($user instanceof OfflineUser) {
$displayName = $user->getDisplayName();
return $user->getDisplayName();
}
}
return '';
}
public function getDisplayName($uid): string {
if ($this->userPluginManager->implementsActions(Backend::GET_DISPLAYNAME)) {
return $this->userPluginManager->getDisplayName($uid);
}
if (!$this->userExists($uid)) {
return '';
}
$cacheKey = 'getDisplayName' . $uid;
if (!is_null($displayName = $this->access->connection->getFromCache($cacheKey))) {
return $displayName;
}
return null;
if ($displayName = $this->getDisplayNameFromDatabase($uid)) {
$this->access->connection->writeToCache($cacheKey, $displayName);
return $displayName;
}
if ($displayName = $this->getDisplayNameFromLdap($uid)) {
$this->access->connection->writeToCache($cacheKey, $displayName);
}
return $displayName;
}
/**
@ -495,7 +515,8 @@ class User_LDAP extends BackendUtility implements IUserBackend, UserInterface, I
* @param string $search
* @param int|null $limit
* @param int|null $offset
* @return array an array of all displayNames (value) and the corresponding uids (key)
* @return array an array of all displayNames (value) and the corresponding
* uids (key)
*/
public function getDisplayNames($search = '', $limit = null, $offset = null) {
$cacheKey = 'getDisplayNames-' . $search . '-' . $limit . '-' . $offset;