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 2 commits into
base: master
Choose a base branch
from
+121 −13
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
2 commits
Select commit Hold shift + click to select a range
d2bf30b
feat(sharing): allow email-based labels for lookup results
n-iv Jun 11, 2026
ecac665
Merge branch 'master' into feat/lookup-label-show-email
n-iv Jun 12, 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
15 changes: 14 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 @@ -39,6 +39,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.
// App config flag (core app config): shareapi_lookup_label_show_email
// Controls whether email addresses from federated lookup results are shown in share dialog labels.
// Defaults to 'no' 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->getAppValue('core', 'shareapi_lookup_label_show_email', 'no') === 'yes';

// 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 @@ -79,7 +84,15 @@ 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 !== '') {
$id = $email;
} else {
$id = $lookup['federationId'];
}
Comment on lines +87 to +93
$label = $name === '' ? $id : $name . ' (' . $id . ')';

$result[] = [
'label' => $label,
'value' => [
Expand Down
119 changes: 107 additions & 12 deletions tests/lib/Collaboration/Collaborators/LookupPluginTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,10 +76,12 @@ protected function setUp(): void {
}

public function testSearchNoLookupServerURI(): void {
$this->config->expects($this->once())
$this->config->expects($this->exactly(2))
->method('getAppValue')
->with('files_sharing', 'lookupServerEnabled', 'no')
->willReturn('yes');
->willReturnMap([
['files_sharing', 'lookupServerEnabled', 'no', 'yes'],
['core', 'shareapi_lookup_label_show_email', 'no', 'no'],
]);
$this->config->expects($this->exactly(2))
->method('getSystemValueBool')
->willReturnMap([
Expand All @@ -102,10 +104,12 @@ public function testSearchNoLookupServerURI(): void {
}

public function testSearchNoInternet(): void {
$this->config->expects($this->once())
$this->config->expects($this->exactly(2))
->method('getAppValue')
->with('files_sharing', 'lookupServerEnabled', 'no')
->willReturn('yes');
->willReturnMap([
['files_sharing', 'lookupServerEnabled', 'no', 'yes'],
['core', 'shareapi_lookup_label_show_email', 'no', 'no'],
]);
$this->config->expects($this->exactly(2))
->method('getSystemValueBool')
->willReturnMap([
Expand Down Expand Up @@ -135,10 +139,12 @@ public function testSearch(array $searchParams): void {
->method('addResultSet')
->with($type, $searchParams['expectedResult'], []);

$this->config->expects($this->once())
$this->config->expects($this->exactly(2))
->method('getAppValue')
->with('files_sharing', 'lookupServerEnabled', 'no')
->willReturn('yes');
->willReturnMap([
['files_sharing', 'lookupServerEnabled', 'no', 'yes'],
['core', 'shareapi_lookup_label_show_email', 'no', 'no'],
]);
$this->config->expects($this->exactly(2))
->method('getSystemValueBool')
->willReturnMap([
Expand Down Expand Up @@ -179,6 +185,93 @@ public function testSearch(array $searchParams): void {
$this->assertFalse($moreResults);
}

#[\PHPUnit\Framework\Attributes\DataProvider('dataSearchEmailLabel')]
public function testSearchEmailLabel(string $showEmailFlag, array $lookupEntry, string $expectedLabel): void {
$type = new SearchResultType('lookup');
$expectedResult = [
[
'label' => $expectedLabel,
'value' => [
'shareType' => IShare::TYPE_REMOTE,
'globalScale' => true,
'shareWith' => $lookupEntry['federationId'],
'server' => 'enceladus.moon',
'isTrustedServer' => false,
],
'extra' => $lookupEntry,
],
];

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

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

$response = $this->createMock(IResponse::class);
$response->expects($this->once())
->method('getBody')
->willReturn(json_encode([$lookupEntry]));

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

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

public static function dataSearchEmailLabel(): array {
$fedId = 'foo@enceladus.moon';
$email = 'foo.bar@example.org';
return [
'flag disabled, email present: federation id label' => [
'no',
['federationId' => $fedId, 'name' => ['value' => 'Foo Bar'], 'email' => ['value' => $email]],
'Foo Bar (foo@enceladus.moon)',
],
'flag enabled, email present: email label' => [
'yes',
['federationId' => $fedId, 'name' => ['value' => 'Foo Bar'], 'email' => ['value' => $email]],
'Foo Bar (foo.bar@example.org)',
],
'flag enabled, email missing: fallback to federation id' => [
'yes',
['federationId' => $fedId, 'name' => ['value' => 'Foo Bar']],
'Foo Bar (foo@enceladus.moon)',
],
'flag enabled, no name: bare email' => [
'yes',
['federationId' => $fedId, 'email' => ['value' => $email]],
'foo.bar@example.org',
],
];
}

/**
* @param array $searchParams
* @param bool $GSEnabled
Expand All @@ -191,10 +284,12 @@ public function testSearchEnableDisableLookupServer(array $searchParams, $GSEnab
/** @var ISearchResult|MockObject $searchResult */
$searchResult = $this->createMock(ISearchResult::class);

$this->config->expects($this->once())
$this->config->expects($this->exactly(2))
->method('getAppValue')
->with('files_sharing', 'lookupServerEnabled', 'no')
->willReturn($LookupEnabled ? 'yes' : 'no');
->willReturnMap([
['files_sharing', 'lookupServerEnabled', 'no', $LookupEnabled ? 'yes' : 'no'],
['core', 'shareapi_lookup_label_show_email', 'no', 'no'],
]);
if ($GSEnabled) {
$searchResult->expects($this->once())
->method('addResultSet')
Expand Down