Skip to content

Commit

Permalink
chore: remove legacy action to test remote endpoint
Browse files Browse the repository at this point in the history
Signed-off-by: Benjamin Gaussorgues <benjamin.gaussorgues@nextcloud.com>
  • Loading branch information
Altahrim committed Nov 29, 2024
1 parent a4c3e0c commit 6737e2c
Show file tree
Hide file tree
Showing 4 changed files with 3 additions and 169 deletions.
6 changes: 0 additions & 6 deletions apps/files_sharing/appinfo/routes.php
Original file line number Diff line number Diff line change
Expand Up @@ -40,12 +40,6 @@
'verb' => 'GET',
'root' => '',
],

[
'name' => 'externalShares#testRemote',
'url' => '/testremote',
'verb' => 'GET'
],
[
'name' => 'PublicPreview#getPreview',
'url' => '/publicpreview/{token}',
Expand Down
66 changes: 0 additions & 66 deletions apps/files_sharing/lib/Controller/ExternalSharesController.php
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,7 @@

use OCP\AppFramework\Controller;
use OCP\AppFramework\Http\Attribute\NoAdminRequired;
use OCP\AppFramework\Http\Attribute\PublicPage;
use OCP\AppFramework\Http\DataResponse;
use OCP\AppFramework\Http\JSONResponse;
use OCP\Http\Client\IClientService;
use OCP\IConfig;
use OCP\IRequest;

/**
Expand All @@ -25,8 +21,6 @@ public function __construct(
string $appName,
IRequest $request,
private \OCA\Files_Sharing\External\Manager $externalManager,
private IClientService $clientService,
private IConfig $config,
) {
parent::__construct($appName, $request);
}
Expand Down Expand Up @@ -64,64 +58,4 @@ public function destroy($id) {
$this->externalManager->declineShare($id);
return new JSONResponse();
}

/**
* Test whether the specified remote is accessible
*
* @param string $remote
* @param bool $checkVersion
* @return bool
*/
protected function testUrl($remote, $checkVersion = false) {
try {
$client = $this->clientService->newClient();
$response = json_decode($client->get(
$remote,
[
'timeout' => 3,
'connect_timeout' => 3,
'verify' => !$this->config->getSystemValueBool('sharing.federation.allowSelfSignedCertificates', false),
]
)->getBody());

if ($checkVersion) {
return !empty($response->version) && version_compare($response->version, '7.0.0', '>=');
} else {
return is_object($response);
}
} catch (\Exception $e) {
return false;
}
}

/**
* @NoOutgoingFederatedSharingRequired
* @NoIncomingFederatedSharingRequired
*
* @param string $remote
* @return DataResponse
* @AnonRateThrottle(limit=5, period=120)
*/
#[PublicPage]
public function testRemote($remote) {
if (preg_match('%[!#$&\'()*+,;=?@[\]]%', $remote)) {
return new DataResponse(false);
}

if (
$this->testUrl('https://' . $remote . '/ocm-provider/') ||
$this->testUrl('https://' . $remote . '/ocm-provider/index.php') ||
$this->testUrl('https://' . $remote . '/status.php', true)
) {
return new DataResponse('https');
} elseif (
$this->testUrl('http://' . $remote . '/ocm-provider/') ||
$this->testUrl('http://' . $remote . '/ocm-provider/index.php') ||
$this->testUrl('http://' . $remote . '/status.php', true)
) {
return new DataResponse('http');
} else {
return new DataResponse(false);
}
}
}
11 changes: 3 additions & 8 deletions apps/files_sharing/openapi.json
Original file line number Diff line number Diff line change
Expand Up @@ -1763,7 +1763,7 @@
"expireDate": {
"type": "string",
"nullable": true,
"description": "The expiry date of the share in the user's timezone at 00:00. If $expireDate is not supplied or set to `null`, the system default will be used."
"description": "The expiry date of the share in the user's timezone at 00:00.\n If $expireDate is not supplied or set to `null`, the system default will be used."
},
"note": {
"type": "string",
Expand Down Expand Up @@ -2282,7 +2282,7 @@
"sendMail": {
"type": "string",
"nullable": true,
"description": "if the share should be send by mail. Considering the share already exists, no mail will be send after the share is updated. You will have to use the sendMail action to send the mail."
"description": "if the share should be send by mail.\n Considering the share already exists, no mail will be send after the share is updated.\n You will have to use the sendMail action to send the mail."
}
}
}
Expand Down Expand Up @@ -3805,10 +3805,5 @@
}
}
},
"tags": [
{
"name": "external_shares",
"description": "Class ExternalSharesController"
}
]
"tags": []
}
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,8 @@

use OCA\Files_Sharing\Controller\ExternalSharesController;
use OCA\Files_Sharing\External\Manager;
use OCP\AppFramework\Http\DataResponse;
use OCP\AppFramework\Http\JSONResponse;
use OCP\Http\Client\IClient;
use OCP\Http\Client\IClientService;
use OCP\Http\Client\IResponse;
use OCP\IConfig;
use OCP\IRequest;
use PHPUnit\Framework\MockObject\MockObject;
Expand Down Expand Up @@ -79,90 +76,4 @@ public function testDestroy(): void {

$this->assertEquals(new JSONResponse(), $this->getExternalShareController()->destroy(4));
}

public function testRemoteWithValidHttps(): void {
$client = $this->createMock(IClient::class);
$response = $this->createMock(IResponse::class);
$response
->expects($this->exactly(2))
->method('getBody')
->willReturnOnConsecutiveCalls(
'Certainly not a JSON string',
'{"installed":true,"maintenance":false,"version":"8.1.0.8","versionstring":"8.1.0","edition":""}'
);
$client
->expects($this->any())
->method('get')
->willReturn($response);

$this->clientService
->expects($this->exactly(2))
->method('newClient')
->willReturn($client);

$this->assertEquals(new DataResponse('https'), $this->getExternalShareController()->testRemote('nextcloud.com'));
}

public function testRemoteWithWorkingHttp(): void {
$client = $this->createMock(IClient::class);
$response = $this->createMock(IResponse::class);
$client
->method('get')
->willReturn($response);
$response
->expects($this->exactly(5))
->method('getBody')
->willReturnOnConsecutiveCalls(
'Certainly not a JSON string',
'Certainly not a JSON string',
'Certainly not a JSON string',
'Certainly not a JSON string',
'{"installed":true,"maintenance":false,"version":"8.1.0.8","versionstring":"8.1.0","edition":""}'
);
$this->clientService
->expects($this->exactly(5))
->method('newClient')
->willReturn($client);

$this->assertEquals(new DataResponse('http'), $this->getExternalShareController()->testRemote('nextcloud.com'));
}

public function testRemoteWithInvalidRemote(): void {
$client = $this->createMock(IClient::class);
$response = $this->createMock(IResponse::class);
$client
->expects($this->exactly(6))
->method('get')
->willReturn($response);
$response
->expects($this->exactly(6))
->method('getBody')
->willReturn('Certainly not a JSON string');
$this->clientService
->expects($this->exactly(6))
->method('newClient')
->willReturn($client);

$this->assertEquals(new DataResponse(false), $this->getExternalShareController()->testRemote('nextcloud.com'));
}

public function dataRemoteWithInvalidRemoteURLs(): array {
return [
['nextcloud.com?query'],
['nextcloud.com/#anchor'],
['nextcloud.com/;tomcat'],
];
}

/**
* @dataProvider dataRemoteWithInvalidRemoteURLs
* @param string $remote
*/
public function testRemoteWithInvalidRemoteURLs(string $remote): void {
$this->clientService
->expects($this->never())
->method('newClient');

$this->assertEquals(new DataResponse(false), $this->getExternalShareController()->testRemote($remote));
}
}

0 comments on commit 6737e2c

Please sign in to comment.