Skip to content

Always set displayname and display-name for user data #36665

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
julien-nc merged 1 commit into from
Mar 22, 2023
Merged

Always set displayname and display-name for user data #36665

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions apps/provisioning_api/lib/Controller/AUserData.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
* @author John Molakvoæ <[email protected]>
* @author Roeland Jago Douma <[email protected]>
* @author Vincent Petry <[email protected]>
* @author Kate Döen <[email protected]>
*
* @license GNU AGPL version 3 or any later version
*
Expand Down Expand Up @@ -175,6 +176,7 @@ protected function getUserData(string $userId, bool $includeScopes = false): arr
}

$data[IAccountManager::PROPERTY_DISPLAYNAME] = $targetUserObject->getDisplayName();
$data[IAccountManager::PROPERTY_DISPLAYNAME_LEGACY] = $data[IAccountManager::PROPERTY_DISPLAYNAME];
if ($includeScopes) {
$data[IAccountManager::PROPERTY_DISPLAYNAME . self::SCOPE_SUFFIX] = $userAccount->getProperty(IAccountManager::PROPERTY_DISPLAYNAME)->getScope();
}
Expand Down
5 changes: 1 addition & 4 deletions apps/provisioning_api/lib/Controller/UsersController.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@
* @author Thomas Müller <[email protected]>
* @author Tom Needham <[email protected]>
* @author Vincent Petry <[email protected]>
* @author Kate Döen <[email protected]>
*
* @license AGPL-3.0
*
Expand Down Expand Up @@ -546,10 +547,6 @@ public function getCurrentUser(): DataResponse {
$user = $this->userSession->getUser();
if ($user) {
$data = $this->getUserData($user->getUID(), true);
// rename "displayname" to "display-name" only for this call to keep
// the API stable.
$data['display-name'] = $data['displayname'];
unset($data['displayname']);
return new DataResponse($data);
}

Expand Down
2 changes: 2 additions & 0 deletions lib/public/Accounts/IAccountManager.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@
* @author Julius Härtl <[email protected]>
* @author Thomas Citharel <[email protected]>
* @author Vincent Petry <[email protected]>
* @author Kate Döen <[email protected]>
*
* @license GNU AGPL version 3 or any later version
*
Expand Down Expand Up @@ -106,6 +107,7 @@ interface IAccountManager {

public const PROPERTY_AVATAR = 'avatar';
public const PROPERTY_DISPLAYNAME = 'displayname';
public const PROPERTY_DISPLAYNAME_LEGACY = 'display-name';
Copy link
Member

@nickvergessen nickvergessen Mar 26, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please document in #37039

Copy link
Member Author

@provokateurin provokateurin Mar 26, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's a non-breaking backwards compatible change, but it should still be documented?

Copy link
Member

@nickvergessen nickvergessen Mar 26, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Basically anything touching OCP should be documented, so people are aware it now exists.

Copy link
Member Author

@provokateurin provokateurin Mar 27, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you tell me how I should write it down? I'm not sure exactly what I should write

Copy link
Member

@nickvergessen nickvergessen Mar 27, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In the Backend section just write a new bullet point:

  • OCP\Accounts\IAccounManager::PROPERTY_DISPLAYNAME_LEGACY was added to be used for …

And then leave a comment with your changes, so that people that are subscribed to the ticket know that the list was modified.

public const PROPERTY_PHONE = 'phone';
public const PROPERTY_EMAIL = 'email';
public const PROPERTY_WEBSITE = 'website';
Expand Down