upstream/nextcloud
1
0
Fork 0
mirror of https://github.com/nextcloud/server.git synced 2026-05-28 04:32:30 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions 54

chore: Add server version to default crawler user agent

Browse source 
Signed-off-by: Marcel Müller <marcel-mueller@gmx.de>
This commit is contained in:
Marcel Müller 2025-11-06 23:00:47 +01:00
parent 52f99e6f6c
commit b91034b3cf
4 changed files with 35 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

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

@ -18,6 +18,7 @@ use OCP\Http\Client\LocalServerException;
use OCP\ICertificateManager;
use OCP\IConfig;
use OCP\Security\IRemoteHostValidator;
use OCP\ServerVersion;
use Psr\Log\LoggerInterface;
use function parse_url;
@ -41,6 +42,7 @@ class Client implements IClient {
GuzzleClient $client,
IRemoteHostValidator $remoteHostValidator,
protected LoggerInterface $logger,
protected ServerVersion $serverVersion,
) {
$this->config = $config;
$this->client = $client;
@ -81,7 +83,8 @@ class Client implements IClient {
$options = array_merge($defaults, $options);
if (!isset($options[RequestOptions::HEADERS]['User-Agent'])) {
$options[RequestOptions::HEADERS]['User-Agent'] = 'Nextcloud Server Crawler';
$userAgent = 'Nextcloud-Server-Crawler/' . $this->serverVersion->getVersionString();
$options[RequestOptions::HEADERS]['User-Agent'] = $userAgent;
}
if (!isset($options[RequestOptions::HEADERS]['Accept-Encoding'])) {

3
lib/private/Http/Client/ClientService.php
View file

@ -18,6 +18,7 @@ use OCP\Http\Client\IClientService;
use OCP\ICertificateManager;
use OCP\IConfig;
use OCP\Security\IRemoteHostValidator;
use OCP\ServerVersion;
use Psr\Http\Message\RequestInterface;
use Psr\Log\LoggerInterface;
@ -43,6 +44,7 @@ class ClientService implements IClientService {
IRemoteHostValidator $remoteHostValidator,
IEventLogger $eventLogger,
protected LoggerInterface $logger,
protected ServerVersion $serverVersion,
) {
$this->config = $config;
$this->certificateManager = $certificateManager;
@ -74,6 +76,7 @@ class ClientService implements IClientService {
$client,
$this->remoteHostValidator,
$this->logger,
$this->serverVersion,
);
}
}

7
tests/lib/Http/Client/ClientServiceTest.php
View file

@ -21,6 +21,7 @@ use OCP\Diagnostics\IEventLogger;
use OCP\ICertificateManager;
use OCP\IConfig;
use OCP\Security\IRemoteHostValidator;
use OCP\ServerVersion;
use Psr\Http\Message\RequestInterface;
use Psr\Log\LoggerInterface;
@ -45,6 +46,7 @@ class ClientServiceTest extends \Test\TestCase {
$remoteHostValidator = $this->createMock(IRemoteHostValidator::class);
$eventLogger = $this->createMock(IEventLogger::class);
$logger = $this->createMock(LoggerInterface::class);
$serverVersion = $this->createMock(ServerVersion::class);
$clientService = new ClientService(
$config,
@ -53,6 +55,7 @@ class ClientServiceTest extends \Test\TestCase {
$remoteHostValidator,
$eventLogger,
$logger,
$serverVersion,
);
$handler = new CurlHandler();
@ -72,6 +75,7 @@ class ClientServiceTest extends \Test\TestCase {
$guzzleClient,
$remoteHostValidator,
$logger,
$serverVersion,
),
$clientService->newClient()
);
@ -94,6 +98,7 @@ class ClientServiceTest extends \Test\TestCase {
$remoteHostValidator = $this->createMock(IRemoteHostValidator::class);
$eventLogger = $this->createMock(IEventLogger::class);
$logger = $this->createMock(LoggerInterface::class);
$serverVersion = $this->createMock(ServerVersion::class);
$clientService = new ClientService(
$config,
@ -102,6 +107,7 @@ class ClientServiceTest extends \Test\TestCase {
$remoteHostValidator,
$eventLogger,
$logger,
$serverVersion,
);
$handler = new CurlHandler();
@ -120,6 +126,7 @@ class ClientServiceTest extends \Test\TestCase {
$guzzleClient,
$remoteHostValidator,
$logger,
$serverVersion,
),
$clientService->newClient()
);

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

@ -17,6 +17,7 @@ use OCP\Http\Client\LocalServerException;
use OCP\ICertificateManager;
use OCP\IConfig;
use OCP\Security\IRemoteHostValidator;
use OCP\ServerVersion;
use PHPUnit\Framework\MockObject\MockObject;
use Psr\Log\LoggerInterface;
use function parse_url;
@ -36,6 +37,7 @@ class ClientTest extends \Test\TestCase {
/** @var IRemoteHostValidator|MockObject */
private IRemoteHostValidator $remoteHostValidator;
private LoggerInterface $logger;
private ServerVersion $serverVersion;
/** @var array */
private $defaultRequestOptions;
@ -46,12 +48,15 @@ class ClientTest extends \Test\TestCase {
$this->certificateManager = $this->createMock(ICertificateManager::class);
$this->remoteHostValidator = $this->createMock(IRemoteHostValidator::class);
$this->logger = $this->createMock(LoggerInterface::class);
$this->serverVersion = $this->createMock(ServerVersion::class);
$this->client = new Client(
$this->config,
$this->certificateManager,
$this->guzzleClient,
$this->remoteHostValidator,
$this->logger,
$this->serverVersion,
);
}
@ -276,6 +281,9 @@ class ClientTest extends \Test\TestCase {
->with()
->willReturn('/my/path.crt');
$this->serverVersion->method('getVersionString')
->willReturn('123.45.6');
$this->defaultRequestOptions = [
'verify' => '/my/path.crt',
'proxy' => [
@ -283,7 +291,7 @@ class ClientTest extends \Test\TestCase {
'https' => 'foo'
],
'headers' => [
'User-Agent' => 'Nextcloud Server Crawler',
'User-Agent' => 'Nextcloud-Server-Crawler/123.45.6',
'Accept-Encoding' => 'gzip',
],
'timeout' => 30,
@ -466,10 +474,13 @@ class ClientTest extends \Test\TestCase {
->expects($this->never())
->method('listCertificates');
$this->serverVersion->method('getVersionString')
->willReturn('123.45.6');
$this->assertEquals([
'verify' => \OC::$SERVERROOT . '/resources/config/ca-bundle.crt',
'headers' => [
'User-Agent' => 'Nextcloud Server Crawler',
'User-Agent' => 'Nextcloud-Server-Crawler/123.45.6',
'Accept-Encoding' => 'gzip',
],
'timeout' => 30,
@ -513,6 +524,9 @@ class ClientTest extends \Test\TestCase {
->with()
->willReturn('/my/path.crt');
$this->serverVersion->method('getVersionString')
->willReturn('123.45.6');
$this->assertEquals([
'verify' => '/my/path.crt',
'proxy' => [
@ -520,7 +534,7 @@ class ClientTest extends \Test\TestCase {
'https' => 'foo'
],
'headers' => [
'User-Agent' => 'Nextcloud Server Crawler',
'User-Agent' => 'Nextcloud-Server-Crawler/123.45.6',
'Accept-Encoding' => 'gzip',
],
'timeout' => 30,
@ -564,6 +578,9 @@ class ClientTest extends \Test\TestCase {
->with()
->willReturn('/my/path.crt');
$this->serverVersion->method('getVersionString')
->willReturn('123.45.6');
$this->assertEquals([
'verify' => '/my/path.crt',
'proxy' => [
@ -572,7 +589,7 @@ class ClientTest extends \Test\TestCase {
'no' => ['bar']
],
'headers' => [
'User-Agent' => 'Nextcloud Server Crawler',
'User-Agent' => 'Nextcloud-Server-Crawler/123.45.6',
'Accept-Encoding' => 'gzip',
],
'timeout' => 30,