upstream/nextcloud
1
0
Fork 0
mirror of https://github.com/nextcloud/server.git synced 2026-02-03 20:41:22 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions 37

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

Browse source 
Signed-off-by: Thomas Citharel <tcit@tcit.fr>
This commit is contained in:
Thomas Citharel 2026-01-06 15:58:47 +01:00
parent 72ad2edcd7
commit b388e26dd0
No known key found for this signature in database
3 changed files with 77 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
config/config.sample.php
View file

@ -827,6 +827,17 @@ $CONFIG = [
*/
'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)
*

4
lib/private/Http/Client/Client.php
View file

@ -84,6 +84,10 @@ class Client implements IClient {
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;
}

65
tests/lib/Http/Client/ClientTest.php
View file

@ -18,6 +18,7 @@ use OCP\ICertificateManager;
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;
@ -459,11 +460,12 @@ class ClientTest extends \Test\TestCase {
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())
@ -504,11 +506,12 @@ class ClientTest extends \Test\TestCase {
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())
@ -558,11 +561,12 @@ class ClientTest extends \Test\TestCase {
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())
@ -610,4 +614,59 @@ class ClientTest extends \Test\TestCase {
],
], 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', [[]]));
}
}