1
0
mirror of https://github.com/BookStackApp/BookStack.git synced 2026-01-03 23:42:28 +03:00

LDAP: Review and testing of mulitple-display-name attr support

Review of #5295
Added test to cover functionality.
Moved splitting from config to service.
This commit is contained in:
Dan Brown
2024-12-01 18:42:54 +00:00
parent 87242ce6cb
commit 90341e0e00
3 changed files with 45 additions and 20 deletions

View File

@@ -72,25 +72,23 @@ class LdapService
}
/**
* Calculate the display name.
* Build the user display name from the (potentially multiple) attributes defined by the configuration.
*/
protected function getUserDisplayName(array $displayNameAttr, array $userDetails, string $defaultValue): string
protected function getUserDisplayName(array $userDetails, array $displayNameAttrs, string $defaultValue): string
{
$displayName = [];
foreach ($displayNameAttr as $dnAttr) {
$displayNameParts = [];
foreach ($displayNameAttrs as $dnAttr) {
$dnComponent = $this->getUserResponseProperty($userDetails, $dnAttr, null);
if ($dnComponent !== null) {
$displayName[] = $dnComponent;
if ($dnComponent) {
$displayNameParts[] = $dnComponent;
}
}
if (count($displayName) == 0) {
$displayName = $defaultValue;
} else {
$displayName = implode(' ', $displayName);
if (empty($displayNameParts)) {
return $defaultValue;
}
return $displayName;
return implode(' ', $displayNameParts);
}
/**
@@ -103,12 +101,12 @@ class LdapService
{
$idAttr = $this->config['id_attribute'];
$emailAttr = $this->config['email_attribute'];
$displayNameAttr = $this->config['display_name_attribute'];
$displayNameAttrs = explode('|', $this->config['display_name_attribute']);
$thumbnailAttr = $this->config['thumbnail_attribute'];
$user = $this->getUserWithAttributes($userName, array_filter(array_merge($displayNameAttr, [
'cn', 'dn', $idAttr, $emailAttr, $thumbnailAttr,
])));
$user = $this->getUserWithAttributes($userName, array_filter([
'cn', 'dn', $idAttr, $emailAttr, ...$displayNameAttrs, $thumbnailAttr,
]));
if (is_null($user)) {
return null;
@@ -117,7 +115,7 @@ class LdapService
$userCn = $this->getUserResponseProperty($user, 'cn', null);
$formatted = [
'uid' => $this->getUserResponseProperty($user, $idAttr, $user['dn']),
'name' => $this->getUserDisplayName($displayNameAttr, $user, $userCn),
'name' => $this->getUserDisplayName($user, $displayNameAttrs, $userCn),
'dn' => $user['dn'],
'email' => $this->getUserResponseProperty($user, $emailAttr, null),
'avatar' => $thumbnailAttr ? $this->getUserResponseProperty($user, $thumbnailAttr, null) : null,