Skip to content

feat(sharing): allow email-based labels for lookup results #60375

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

Open
n-iv wants to merge 4 commits into
base: master
Choose a base branch
from
Open

feat(sharing): allow email-based labels for lookup results #60375

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
bc32a95
feat(sharing): allow email-based labels for lookup results
n-iv May 14, 2026
ebe93dd
added comments
n-iv May 14, 2026
58b293d
test(sharing): address review comments on lookup label
n-iv May 14, 2026
a29083c
Update lib/private/Collaboration/Collaborators/LookupPlugin.php
n-iv May 19, 2026
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
13 changes: 12 additions & 1 deletion lib/private/Collaboration/Collaborators/LookupPlugin.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,11 @@ public function search($search, $limit, $offset, ISearchResult $searchResult): b
$isGlobalScaleEnabled = $this->config->getSystemValueBool('gs.enabled', false);
$isLookupServerEnabled = $this->config->getAppValue('files_sharing', 'lookupServerEnabled', 'no') === 'yes';
$hasInternetConnection = $this->config->getSystemValueBool('has_internet_connection', true);
Comment thread
n-iv marked this conversation as resolved.
// System config flag: shareapi_lookup_label_show_email
// Controls whether email addresses from federated lookup results are shown in share dialog labels.
// Defaults to false to avoid exposing email addresses unnecessarily. Enabling this may reveal
// users' email addresses to people using the share dialog and should therefore be considered carefully.
$showEmailInLabel = $this->config->getSystemValueBool('shareapi_lookup_label_show_email', false);
Comment on lines +41 to +45
Copy link
Copy Markdown
Contributor

@susnux susnux May 19, 2026

Choose a reason for hiding this comment

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

Similar to the other configs we have for shareapi_ this should reside in the app config of core instead.


// If case of Global Scale we always search the lookup server
// TODO: Reconsider using the lookup server for non-global scale
Expand Down Expand Up @@ -78,7 +83,13 @@ public function search($search, $limit, $offset, ISearchResult $searchResult): b
continue;
}
$name = $lookup['name']['value'] ?? '';
$label = empty($name) ? $lookup['federationId'] : $name . ' (' . $lookup['federationId'] . ')';
$email = $lookup['email']['value'] ?? '';

if ($showEmailInLabel && $email !== '') {
$label = empty($name) ? $email : $name . ' (' . $email . ')';
} else {
$label = empty($name) ? $lookup['federationId'] : $name . ' (' . $lookup['federationId'] . ')';
}
Comment on lines +86 to +92
$result[] = [
'label' => $label,
'value' => [
Expand Down
151 changes: 146 additions & 5 deletions tests/lib/Collaboration/Collaborators/LookupPluginTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,11 +81,12 @@ public function testSearchNoLookupServerURI(): void {
->method('getAppValue')
->with('files_sharing', 'lookupServerEnabled', 'no')
->willReturn('yes');
$this->config->expects($this->exactly(2))
$this->config->expects($this->exactly(3))
->method('getSystemValueBool')
->willReturnMap([
['gs.enabled', false, true],
['has_internet_connection', true, true],
['shareapi_lookup_label_show_email', false, false],
]);

$this->config->expects($this->once())
Expand All @@ -107,11 +108,12 @@ public function testSearchNoInternet(): void {
->method('getAppValue')
->with('files_sharing', 'lookupServerEnabled', 'no')
->willReturn('yes');
$this->config->expects($this->exactly(2))
$this->config->expects($this->exactly(3))
->method('getSystemValueBool')
->willReturnMap([
['gs.enabled', false, false],
['has_internet_connection', true, false],
['shareapi_lookup_label_show_email', false, false],
]);

$this->clientService->expects($this->never())
Expand Down Expand Up @@ -140,11 +142,12 @@ public function testSearch(array $searchParams): void {
->method('getAppValue')
->with('files_sharing', 'lookupServerEnabled', 'no')
->willReturn('yes');
$this->config->expects($this->exactly(2))
$this->config->expects($this->exactly(3))
->method('getSystemValueBool')
->willReturnMap([
['gs.enabled', false, true],
['has_internet_connection', true, true],
['shareapi_lookup_label_show_email', false, false],
]);

$this->config->expects($this->once())
Expand Down Expand Up @@ -180,6 +183,142 @@ public function testSearch(array $searchParams): void {
$this->assertFalse($moreResults);
}

public function testSearchWithEmailLabel(): void {
Copy link
Copy Markdown
Member

@provokateurin provokateurin May 19, 2026

Choose a reason for hiding this comment

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

Please collapse the tests into a single one and use a data provider to change the flag value and the expected outcome.

$type = new SearchResultType('lookup');
$fedId = 'foo@enceladus.moon';
$email = 'foo@bar.example';
$server = 'https://lookup.example.io';
$resultBody = [
[
'federationId' => $fedId,
'name' => ['value' => 'Foo Bar', 'verified' => 0],
'email' => ['value' => $email, 'verified' => 0],
],
];
$expectedResult = [
[
'label' => 'Foo Bar (' . $email . ')',
'value' => [
'shareType' => IShare::TYPE_REMOTE,
'globalScale' => true,
'shareWith' => $fedId,
'server' => 'enceladus.moon',
'isTrustedServer' => false,
],
'extra' => [
'federationId' => $fedId,
'name' => ['value' => 'Foo Bar', 'verified' => 0],
'email' => ['value' => $email, 'verified' => 0],
],
],
];

/** @var ISearchResult|MockObject $searchResult */
$searchResult = $this->createMock(ISearchResult::class);
$searchResult->expects($this->once())
->method('addResultSet')
->with($type, $expectedResult, []);

$this->config->expects($this->once())
->method('getAppValue')
->with('files_sharing', 'lookupServerEnabled', 'no')
->willReturn('yes');
$this->config->expects($this->exactly(3))
->method('getSystemValueBool')
->willReturnMap([
['gs.enabled', false, true],
['has_internet_connection', true, true],
['shareapi_lookup_label_show_email', false, true],
]);
$this->config->expects($this->once())
->method('getSystemValueString')
->with('lookup_server', 'https://lookup.nextcloud.com')
->willReturn($server);

$response = $this->createMock(IResponse::class);
$response->expects($this->once())
->method('getBody')
->willReturn(json_encode($resultBody));
$client = $this->createMock(IClient::class);
$client->expects($this->once())
->method('get')
->willReturnCallback(function ($url) use ($server, $response) {
$this->assertSame(strpos($url, $server . '/users?search='), 0);
$this->assertNotFalse(strpos($url, urlencode('foo')));
return $response;
});
$this->clientService->expects($this->once())
->method('newClient')
->willReturn($client);

$moreResults = $this->plugin->search('foo', 10, 0, $searchResult);
$this->assertFalse($moreResults);
}

public function testSearchWithEmailLabelFallbackWhenEmailMissing(): void {
$type = new SearchResultType('lookup');
$fedId = 'foo@enceladus.moon';
$server = 'https://lookup.example.io';
$resultBody = [
[
'federationId' => $fedId,
'name' => ['value' => 'Foo Bar', 'verified' => 0],
],
];
$expectedResult = [
[
'label' => 'Foo Bar (' . $fedId . ')',
'value' => [
'shareType' => IShare::TYPE_REMOTE,
'globalScale' => true,
'shareWith' => $fedId,
'server' => 'enceladus.moon',
'isTrustedServer' => false,
],
'extra' => [
'federationId' => $fedId,
'name' => ['value' => 'Foo Bar', 'verified' => 0],
],
],
];

/** @var ISearchResult|MockObject $searchResult */
$searchResult = $this->createMock(ISearchResult::class);
$searchResult->expects($this->once())
->method('addResultSet')
->with($type, $expectedResult, []);

$this->config->expects($this->once())
->method('getAppValue')
->with('files_sharing', 'lookupServerEnabled', 'no')
->willReturn('yes');
$this->config->expects($this->exactly(3))
->method('getSystemValueBool')
->willReturnMap([
['gs.enabled', false, true],
['has_internet_connection', true, true],
['shareapi_lookup_label_show_email', false, true],
]);
$this->config->expects($this->once())
->method('getSystemValueString')
->with('lookup_server', 'https://lookup.nextcloud.com')
->willReturn($server);

$response = $this->createMock(IResponse::class);
$response->expects($this->once())
->method('getBody')
->willReturn(json_encode($resultBody));
$client = $this->createMock(IClient::class);
$client->expects($this->once())
->method('get')
->willReturn($response);
$this->clientService->expects($this->once())
->method('newClient')
->willReturn($client);

$moreResults = $this->plugin->search('foo', 10, 0, $searchResult);
$this->assertFalse($moreResults);
}

/**
* @param array $searchParams
Expand All @@ -202,11 +341,12 @@ public function testSearchEnableDisableLookupServer(array $searchParams, $GSEnab
->method('addResultSet')
->with($type, $searchParams['expectedResult'], []);

$this->config->expects($this->exactly(2))
$this->config->expects($this->exactly(3))
->method('getSystemValueBool')
->willReturnMap([
['gs.enabled', false, $GSEnabled],
['has_internet_connection', true, true],
['shareapi_lookup_label_show_email', false, false],
]);
$this->config->expects($this->once())
->method('getSystemValueString')
Expand All @@ -232,11 +372,12 @@ public function testSearchEnableDisableLookupServer(array $searchParams, $GSEnab
->willReturn($client);
} else {
$searchResult->expects($this->never())->method('addResultSet');
$this->config->expects($this->exactly(2))
$this->config->expects($this->exactly(3))
->method('getSystemValueBool')
->willReturnMap([
['gs.enabled', false, $GSEnabled],
['has_internet_connection', true, true],
['shareapi_lookup_label_show_email', false, false],
]);
}
$moreResults = $this->plugin->search(
Expand Down