Skip to content

feat(http-client): add option to add instance URL to HTTP client user-agent #57376

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
tcitworld wants to merge 1 commit into
base: master
Choose a base branch
from
+77 −3
Open

feat(http-client): add option to add instance URL to HTTP client user-agent #57376

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
11 changes: 11 additions & 0 deletions config/config.sample.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -827,6 +827,17 @@
*/
'allow_local_remote_servers' => true,

/**
* Add the URL of the Nextcloud server in User-Agent headers HTTP calls.
*
* This helps service providers identifying calls from your server,
* which can be helpful for them, but can be a privacy issue on small
* Nextcloud servers.
*
* Defaults to ``false``
*/
'add_url_in_user_agent' => false,

/**
* Deleted Items (trash bin)
*
Expand Down
4 changes: 4 additions & 0 deletions lib/private/Http/Client/Client.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,10 @@ private function buildRequestOptions(array $options): array {

if (!isset($options[RequestOptions::HEADERS]['User-Agent'])) {
$userAgent = 'Nextcloud-Server-Crawler/' . $this->serverVersion->getVersionString();
$overwriteCliUrl = $this->config->getSystemValueString('overwrite.cli.url');
if ($this->config->getSystemValueBool('add_url_in_user_agent') && !empty($overwriteCliUrl)) {
$userAgent .= '; +' . rtrim($overwriteCliUrl, '/');
}
$options[RequestOptions::HEADERS]['User-Agent'] = $userAgent;
}

Expand Down
65 changes: 62 additions & 3 deletions tests/lib/Http/Client/ClientTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@
use OCP\IConfig;
use OCP\Security\IRemoteHostValidator;
use OCP\ServerVersion;
use PHPUnit\Framework\Attributes\DataProvider;
use PHPUnit\Framework\MockObject\MockObject;
use Psr\Log\LoggerInterface;
use function parse_url;
Expand Down Expand Up @@ -459,11 +460,12 @@ public function testHeadWithOptions(): void {

public function testSetDefaultOptionsWithNotInstalled(): void {
$this->config
->expects($this->exactly(2))
->expects($this->exactly(3))
->method('getSystemValueBool')
->willReturnMap([
['installed', false, false],
['allow_local_remote_servers', false, false],
['add_url_in_user_agent', false, false],
]);
$this->config
->expects($this->once())
Expand Down Expand Up @@ -504,11 +506,12 @@ public function testSetDefaultOptionsWithNotInstalled(): void {

public function testSetDefaultOptionsWithProxy(): void {
$this->config
->expects($this->exactly(2))
->expects($this->exactly(3))
->method('getSystemValueBool')
->willReturnMap([
['installed', false, true],
['allow_local_remote_servers', false, false],
['add_url_in_user_agent', false, false],
]);
$this->config
->expects($this->once())
Expand Down Expand Up @@ -558,11 +561,12 @@ public function testSetDefaultOptionsWithProxy(): void {

public function testSetDefaultOptionsWithProxyAndExclude(): void {
$this->config
->expects($this->exactly(2))
->expects($this->exactly(3))
->method('getSystemValueBool')
->willReturnMap([
['installed', false, true],
['allow_local_remote_servers', false, false],
['add_url_in_user_agent', false, false],
]);
$this->config
->expects($this->once())
Expand Down Expand Up @@ -610,4 +614,59 @@ public function testSetDefaultOptionsWithProxyAndExclude(): void {
],
], self::invokePrivate($this->client, 'buildRequestOptions', [[]]));
}

public static function dataForTestSetServerUrlInUserAgent(): array {
return [
['https://example.com/', 'Nextcloud-Server-Crawler/123.45.6; +https://example.com'],
['', 'Nextcloud-Server-Crawler/123.45.6'],
];
}

#[DataProvider('dataForTestSetServerUrlInUserAgent')]
public function testSetServerUrlInUserAgent(string $url, string $userAgent): void {
$this->config
->expects($this->exactly(3))
->method('getSystemValueBool')
->willReturnMap([
['installed', false, true],
['allow_local_remote_servers', false, false],
['add_url_in_user_agent', false, true],
]);
$this->config
->expects($this->exactly(3))
->method('getSystemValueString')
->willReturnMap([
['proxy', '', ''],
['proxyuserpwd', '', ''],
['overwrite.cli.url', null, $url],
]);
$this->certificateManager
->expects($this->once())
->method('getAbsoluteBundlePath')
->with()
->willReturn('/my/path.crt');

$this->serverVersion->method('getVersionString')
->willReturn('123.45.6');

$this->assertEquals([
'verify' => '/my/path.crt',
'headers' => [
'User-Agent' => $userAgent,
'Accept-Encoding' => 'gzip',
],
'timeout' => 30,
'nextcloud' => [
'allow_local_address' => false,
],
'allow_redirects' => [
'on_redirect' => function (
\Psr\Http\Message\RequestInterface $request,
\Psr\Http\Message\ResponseInterface $response,
\Psr\Http\Message\UriInterface $uri,
): void {
},
],
], self::invokePrivate($this->client, 'buildRequestOptions', [[]]));
}
}
Loading