mirror of
https://github.com/nextcloud/server.git
synced 2026-02-20 00:12:30 -05:00
Merge pull request #43939 from nextcloud/enh/migrate-frontend-setupcheck-v2
feat(settings): Migrate `.well-known` tests to `SetupCheck`
This commit is contained in:
commit
bfcbffa288
13 changed files with 454 additions and 148 deletions
|
|
@ -119,6 +119,7 @@ return array(
|
|||
'OCA\\Settings\\SetupChecks\\SystemIs64bit' => $baseDir . '/../lib/SetupChecks/SystemIs64bit.php',
|
||||
'OCA\\Settings\\SetupChecks\\TempSpaceAvailable' => $baseDir . '/../lib/SetupChecks/TempSpaceAvailable.php',
|
||||
'OCA\\Settings\\SetupChecks\\TransactionIsolation' => $baseDir . '/../lib/SetupChecks/TransactionIsolation.php',
|
||||
'OCA\\Settings\\SetupChecks\\WellKnownUrls' => $baseDir . '/../lib/SetupChecks/WellKnownUrls.php',
|
||||
'OCA\\Settings\\SetupChecks\\Woff2Loading' => $baseDir . '/../lib/SetupChecks/Woff2Loading.php',
|
||||
'OCA\\Settings\\UserMigration\\AccountMigrator' => $baseDir . '/../lib/UserMigration/AccountMigrator.php',
|
||||
'OCA\\Settings\\UserMigration\\AccountMigratorException' => $baseDir . '/../lib/UserMigration/AccountMigratorException.php',
|
||||
|
|
|
|||
|
|
@ -134,6 +134,7 @@ class ComposerStaticInitSettings
|
|||
'OCA\\Settings\\SetupChecks\\SystemIs64bit' => __DIR__ . '/..' . '/../lib/SetupChecks/SystemIs64bit.php',
|
||||
'OCA\\Settings\\SetupChecks\\TempSpaceAvailable' => __DIR__ . '/..' . '/../lib/SetupChecks/TempSpaceAvailable.php',
|
||||
'OCA\\Settings\\SetupChecks\\TransactionIsolation' => __DIR__ . '/..' . '/../lib/SetupChecks/TransactionIsolation.php',
|
||||
'OCA\\Settings\\SetupChecks\\WellKnownUrls' => __DIR__ . '/..' . '/../lib/SetupChecks/WellKnownUrls.php',
|
||||
'OCA\\Settings\\SetupChecks\\Woff2Loading' => __DIR__ . '/..' . '/../lib/SetupChecks/Woff2Loading.php',
|
||||
'OCA\\Settings\\UserMigration\\AccountMigrator' => __DIR__ . '/..' . '/../lib/UserMigration/AccountMigrator.php',
|
||||
'OCA\\Settings\\UserMigration\\AccountMigratorException' => __DIR__ . '/..' . '/../lib/UserMigration/AccountMigratorException.php',
|
||||
|
|
|
|||
|
|
@ -90,6 +90,7 @@ use OCA\Settings\SetupChecks\SupportedDatabase;
|
|||
use OCA\Settings\SetupChecks\SystemIs64bit;
|
||||
use OCA\Settings\SetupChecks\TempSpaceAvailable;
|
||||
use OCA\Settings\SetupChecks\TransactionIsolation;
|
||||
use OCA\Settings\SetupChecks\WellKnownUrls;
|
||||
use OCA\Settings\SetupChecks\Woff2Loading;
|
||||
use OCA\Settings\UserMigration\AccountMigrator;
|
||||
use OCA\Settings\WellKnown\ChangePasswordHandler;
|
||||
|
|
@ -218,6 +219,7 @@ class Application extends App implements IBootstrap {
|
|||
$context->registerSetupCheck(TempSpaceAvailable::class);
|
||||
$context->registerSetupCheck(TransactionIsolation::class);
|
||||
$context->registerSetupCheck(PushService::class);
|
||||
$context->registerSetupCheck(WellKnownUrls::class);
|
||||
$context->registerSetupCheck(Woff2Loading::class);
|
||||
|
||||
$context->registerUserMigrator(AccountMigrator::class);
|
||||
|
|
|
|||
|
|
@ -31,6 +31,7 @@ use OCP\Http\Client\IResponse;
|
|||
use OCP\IConfig;
|
||||
use OCP\IL10N;
|
||||
use OCP\IURLGenerator;
|
||||
use Psr\Log\LoggerInterface;
|
||||
|
||||
/**
|
||||
* Common trait for setup checks that need to use requests to the same server and check the response
|
||||
|
|
@ -40,6 +41,7 @@ trait CheckServerResponseTrait {
|
|||
protected IURLGenerator $urlGenerator;
|
||||
protected IClientService $clientService;
|
||||
protected IL10N $l10n;
|
||||
protected LoggerInterface $logger;
|
||||
|
||||
/**
|
||||
* Common helper string in case a check could not fetch any results
|
||||
|
|
@ -70,6 +72,36 @@ trait CheckServerResponseTrait {
|
|||
return $testUrls;
|
||||
}
|
||||
|
||||
/**
|
||||
* Run a HTTP request to check header
|
||||
* @param string $url The relative URL to check
|
||||
* @param string $method The HTTP method to use
|
||||
* @param array{ignoreSSL?: bool, httpErrors?: bool, options?: array} $options Additional options, like
|
||||
* [
|
||||
* // Ignore invalid SSL certificates (e.g. self signed)
|
||||
* 'ignoreSSL' => true,
|
||||
* // Ignore requests with HTTP errors (will not yield if request has a 4xx or 5xx response)
|
||||
* 'httpErrors' => true,
|
||||
* ]
|
||||
*
|
||||
* @return Generator<int, IResponse>
|
||||
*/
|
||||
protected function runRequest(string $url, string $method, array $options = []): Generator {
|
||||
$options = array_merge(['ignoreSSL' => true, 'httpErrors' => true], $options);
|
||||
|
||||
$client = $this->clientService->newClient();
|
||||
$requestOptions = $this->getRequestOptions($options['ignoreSSL'], $options['httpErrors']);
|
||||
$requestOptions = array_merge($requestOptions, $options['options'] ?? []);
|
||||
|
||||
foreach ($this->getTestUrls($url) as $testURL) {
|
||||
try {
|
||||
yield $client->request($testURL, $method, $requestOptions);
|
||||
} catch (\Throwable $e) {
|
||||
$this->logger->debug('Can not connect to local server for running setup checks', ['exception' => $e, 'url' => $testURL]);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Run a HEAD request to check header
|
||||
* @param string $url The relative URL to check
|
||||
|
|
@ -78,16 +110,7 @@ trait CheckServerResponseTrait {
|
|||
* @return Generator<int, IResponse>
|
||||
*/
|
||||
protected function runHEAD(string $url, bool $ignoreSSL = true, bool $httpErrors = true): Generator {
|
||||
$client = $this->clientService->newClient();
|
||||
$requestOptions = $this->getRequestOptions($ignoreSSL, $httpErrors);
|
||||
|
||||
foreach ($this->getTestUrls($url) as $testURL) {
|
||||
try {
|
||||
yield $client->head($testURL, $requestOptions);
|
||||
} catch (\Throwable $e) {
|
||||
$this->logger->debug('Can not connect to local server for running setup checks', ['exception' => $e, 'url' => $testURL]);
|
||||
}
|
||||
}
|
||||
return $this->runRequest($url, 'HEAD', ['ignoreSSL' => $ignoreSSL, 'httpErrors' => $httpErrors]);
|
||||
}
|
||||
|
||||
protected function getRequestOptions(bool $ignoreSSL, bool $httpErrors): array {
|
||||
|
|
|
|||
111
apps/settings/lib/SetupChecks/WellKnownUrls.php
Normal file
111
apps/settings/lib/SetupChecks/WellKnownUrls.php
Normal file
|
|
@ -0,0 +1,111 @@
|
|||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
/**
|
||||
* @copyright Copyright (c) 2024 Côme Chilliet <come.chilliet@nextcloud.com>
|
||||
*
|
||||
* @author Côme Chilliet <come.chilliet@nextcloud.com>
|
||||
* @author Ferdinand Thiessen <opensource@fthiessen.de>
|
||||
*
|
||||
* @license AGPL-3.0-or-later
|
||||
*
|
||||
* This program is free software: you can redistribute it and/or modify
|
||||
* it under the terms of the GNU Affero General Public License as
|
||||
* published by the Free Software Foundation, either version 3 of the
|
||||
* License, or (at your option) any later version.
|
||||
*
|
||||
* This program is distributed in the hope that it will be useful,
|
||||
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
* GNU Affero General Public License for more details.
|
||||
*
|
||||
* You should have received a copy of the GNU Affero General Public License
|
||||
* along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
*
|
||||
*/
|
||||
|
||||
namespace OCA\Settings\SetupChecks;
|
||||
|
||||
use OCP\Http\Client\IClientService;
|
||||
use OCP\IConfig;
|
||||
use OCP\IL10N;
|
||||
use OCP\IURLGenerator;
|
||||
use OCP\SetupCheck\ISetupCheck;
|
||||
use OCP\SetupCheck\SetupResult;
|
||||
use Psr\Log\LoggerInterface;
|
||||
|
||||
class WellKnownUrls implements ISetupCheck {
|
||||
|
||||
use CheckServerResponseTrait;
|
||||
|
||||
public function __construct(
|
||||
protected IL10N $l10n,
|
||||
protected IConfig $config,
|
||||
protected IURLGenerator $urlGenerator,
|
||||
protected IClientService $clientService,
|
||||
protected LoggerInterface $logger,
|
||||
) {
|
||||
}
|
||||
|
||||
public function getCategory(): string {
|
||||
return 'network';
|
||||
}
|
||||
|
||||
public function getName(): string {
|
||||
return $this->l10n->t('.well-known URLs');
|
||||
}
|
||||
|
||||
public function run(): SetupResult {
|
||||
if (!$this->config->getSystemValueBool('check_for_working_wellknown_setup', true)) {
|
||||
return SetupResult::info($this->l10n->t('`check_for_working_wellknown_setup` is set to false in your configuration, so this check was skipped.'));
|
||||
}
|
||||
|
||||
$urls = [
|
||||
['get', '/.well-known/webfinger', [200, 404], true],
|
||||
['get', '/.well-known/nodeinfo', [200, 404], true],
|
||||
['propfind', '/.well-known/caldav', [207], false],
|
||||
['propfind', '/.well-known/carddav', [207], false],
|
||||
];
|
||||
|
||||
foreach ($urls as [$verb,$url,$validStatuses,$checkCustomHeader]) {
|
||||
$works = null;
|
||||
foreach ($this->runRequest($url, $verb, ['httpErrors' => false, 'options' => ['allow_redirects' => ['track_redirects' => true]]]) as $response) {
|
||||
// Check that the response status matches
|
||||
$works = in_array($response->getStatusCode(), $validStatuses);
|
||||
// and (if needed) the custom Nextcloud header is set
|
||||
if ($checkCustomHeader) {
|
||||
$works = $works && !empty($response->getHeader('X-NEXTCLOUD-WELL-KNOWN'));
|
||||
} else {
|
||||
// For default DAV endpoints we lack authorization, but we still can check that the redirect works as expected
|
||||
if (!$works && $response->getStatusCode() === 401) {
|
||||
$redirectHops = explode(',', $response->getHeader('X-Guzzle-Redirect-History'));
|
||||
$effectiveUri = end($redirectHops);
|
||||
$works = str_ends_with($effectiveUri, '/remote.php/dav/');
|
||||
}
|
||||
}
|
||||
// Skip the other requests if one works
|
||||
if ($works === true) {
|
||||
break;
|
||||
}
|
||||
}
|
||||
// If 'works' is null then we could not connect to the server
|
||||
if ($works === null) {
|
||||
return SetupResult::info(
|
||||
$this->l10n->t('Could not check that your web server serves `.well-known` correctly. Please check manually.') . "\n" . $this->serverConfigHelp(),
|
||||
$this->urlGenerator->linkToDocs('admin-setup-well-known-URL'),
|
||||
);
|
||||
}
|
||||
// Otherwise if we fail we can abort here
|
||||
if ($works === false) {
|
||||
return SetupResult::warning(
|
||||
$this->l10n->t("Your web server is not properly set up to resolve `.well-known` URLs, failed on:\n`%s`", [$url]),
|
||||
$this->urlGenerator->linkToDocs('admin-setup-well-known-URL'),
|
||||
);
|
||||
}
|
||||
}
|
||||
return SetupResult::success(
|
||||
$this->l10n->t('Your server is correctly configured to serve `.well-known` URLs.')
|
||||
);
|
||||
}
|
||||
}
|
||||
|
|
@ -102,14 +102,10 @@ window.addEventListener('DOMContentLoaded', () => {
|
|||
// run setup checks then gather error messages
|
||||
$.when(
|
||||
OC.SetupChecks.checkWebDAV(),
|
||||
OC.SetupChecks.checkWellKnownUrl('GET', '/.well-known/webfinger', OC.theme.docPlaceholderUrl, $('#postsetupchecks').data('check-wellknown') === true, [200, 404], true),
|
||||
OC.SetupChecks.checkWellKnownUrl('GET', '/.well-known/nodeinfo', OC.theme.docPlaceholderUrl, $('#postsetupchecks').data('check-wellknown') === true, [200, 404], true),
|
||||
OC.SetupChecks.checkWellKnownUrl('PROPFIND', '/.well-known/caldav', OC.theme.docPlaceholderUrl, $('#postsetupchecks').data('check-wellknown') === true),
|
||||
OC.SetupChecks.checkWellKnownUrl('PROPFIND', '/.well-known/carddav', OC.theme.docPlaceholderUrl, $('#postsetupchecks').data('check-wellknown') === true),
|
||||
OC.SetupChecks.checkSetup(),
|
||||
OC.SetupChecks.checkGeneric(),
|
||||
).then((check1, check2, check3, check4, check5, check6, check7) => {
|
||||
const messages = [].concat(check1, check2, check3, check4, check5, check6, check7)
|
||||
).then((check1, check2, check3) => {
|
||||
const messages = [].concat(check1, check2, check3)
|
||||
const $el = $('#postsetupchecks')
|
||||
$('#security-warning-state-loading').addClass('hidden')
|
||||
|
||||
|
|
|
|||
233
apps/settings/tests/SetupChecks/WellKnownUrlsTest.php
Normal file
233
apps/settings/tests/SetupChecks/WellKnownUrlsTest.php
Normal file
|
|
@ -0,0 +1,233 @@
|
|||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
/**
|
||||
* @copyright Copyright (c) 2024 Ferdinand Thiessen <opensource@fthiessen.de>
|
||||
*
|
||||
* @author Ferdinand Thiessen <opensource@fthiessen.de>
|
||||
*
|
||||
* @license AGPL-3.0-or-later
|
||||
*
|
||||
* This program is free software: you can redistribute it and/or modify
|
||||
* it under the terms of the GNU Affero General Public License as
|
||||
* published by the Free Software Foundation, either version 3 of the
|
||||
* License, or (at your option) any later version.
|
||||
*
|
||||
* This program is distributed in the hope that it will be useful,
|
||||
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
* GNU Affero General Public License for more details.
|
||||
*
|
||||
* You should have received a copy of the GNU Affero General Public License
|
||||
* along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
*
|
||||
*/
|
||||
namespace OCA\Settings\Tests;
|
||||
|
||||
use OCA\Settings\SetupChecks\WellKnownUrls;
|
||||
use OCP\Http\Client\IClientService;
|
||||
use OCP\Http\Client\IResponse;
|
||||
use OCP\IConfig;
|
||||
use OCP\IL10N;
|
||||
use OCP\IURLGenerator;
|
||||
use OCP\SetupCheck\SetupResult;
|
||||
use PHPUnit\Framework\MockObject\MockObject;
|
||||
use Psr\Log\LoggerInterface;
|
||||
use Test\TestCase;
|
||||
|
||||
class WellKnownUrlsTest extends TestCase {
|
||||
private IL10N|MockObject $l10n;
|
||||
private IConfig|MockObject $config;
|
||||
private IURLGenerator|MockObject $urlGenerator;
|
||||
private IClientService|MockObject $clientService;
|
||||
private LoggerInterface|MockObject $logger;
|
||||
private WellKnownUrls|MockObject $setupcheck;
|
||||
|
||||
protected function setUp(): void {
|
||||
parent::setUp();
|
||||
|
||||
/** @var IL10N|MockObject */
|
||||
$this->l10n = $this->getMockBuilder(IL10N::class)
|
||||
->disableOriginalConstructor()->getMock();
|
||||
$this->l10n->expects($this->any())
|
||||
->method('t')
|
||||
->willReturnCallback(function ($message, array $replace) {
|
||||
return vsprintf($message, $replace);
|
||||
});
|
||||
|
||||
$this->config = $this->createMock(IConfig::class);
|
||||
$this->urlGenerator = $this->createMock(IURLGenerator::class);
|
||||
$this->clientService = $this->createMock(IClientService::class);
|
||||
$this->logger = $this->createMock(LoggerInterface::class);
|
||||
|
||||
$this->setupcheck = $this->getMockBuilder(WellKnownUrls::class)
|
||||
->onlyMethods(['runRequest'])
|
||||
->setConstructorArgs([
|
||||
$this->l10n,
|
||||
$this->config,
|
||||
$this->urlGenerator,
|
||||
$this->clientService,
|
||||
$this->logger,
|
||||
])
|
||||
->getMock();
|
||||
}
|
||||
|
||||
/**
|
||||
* Test that the SetupCheck is skipped if the system config is set
|
||||
*/
|
||||
public function testDisabled(): void {
|
||||
$this->config
|
||||
->expects($this->once())
|
||||
->method('getSystemValueBool')
|
||||
->with('check_for_working_wellknown_setup')
|
||||
->willReturn(false);
|
||||
|
||||
$this->setupcheck
|
||||
->expects($this->never())
|
||||
->method('runRequest');
|
||||
|
||||
$result = $this->setupcheck->run();
|
||||
$this->assertEquals(SetupResult::INFO, $result->getSeverity());
|
||||
$this->assertMatchesRegularExpression('/check was skipped/', $result->getDescription());
|
||||
}
|
||||
|
||||
/**
|
||||
* Test what happens if the local server could not be reached (no response from the requests)
|
||||
*/
|
||||
public function testNoResponse(): void {
|
||||
$this->config
|
||||
->expects($this->once())
|
||||
->method('getSystemValueBool')
|
||||
->with('check_for_working_wellknown_setup')
|
||||
->willReturn(true);
|
||||
|
||||
$this->setupcheck
|
||||
->expects($this->once())
|
||||
->method('runRequest')
|
||||
->will($this->generate([]));
|
||||
|
||||
$result = $this->setupcheck->run();
|
||||
$this->assertEquals(SetupResult::INFO, $result->getSeverity());
|
||||
$this->assertMatchesRegularExpression('/^Could not check/', $result->getDescription());
|
||||
}
|
||||
|
||||
/**
|
||||
* Test responses
|
||||
* @dataProvider dataTestResponses
|
||||
*/
|
||||
public function testResponses($responses, string $expectedSeverity): void {
|
||||
$this->config
|
||||
->expects($this->once())
|
||||
->method('getSystemValueBool')
|
||||
->with('check_for_working_wellknown_setup')
|
||||
->willReturn(true);
|
||||
|
||||
$this->setupcheck
|
||||
->expects($this->atLeastOnce())
|
||||
->method('runRequest')
|
||||
->willReturnOnConsecutiveCalls(...$responses);
|
||||
|
||||
$result = $this->setupcheck->run();
|
||||
$this->assertEquals($expectedSeverity, $result->getSeverity());
|
||||
}
|
||||
|
||||
public function dataTestResponses(): array {
|
||||
$createResponse = function (int $statuscode, array $header = []): IResponse|MockObject {
|
||||
$response = $this->createMock(IResponse::class);
|
||||
$response->expects($this->any())
|
||||
->method('getStatusCode')
|
||||
->willReturn($statuscode);
|
||||
$response->expects($this->any())
|
||||
->method('getHeader')
|
||||
->willReturnCallback(fn ($name) => $header[$name] ?? '');
|
||||
return $response;
|
||||
};
|
||||
|
||||
$wellKnownHeader = ['X-NEXTCLOUD-WELL-KNOWN' => 'yes'];
|
||||
|
||||
return [
|
||||
'expected codes' => [
|
||||
[
|
||||
$this->generate([$createResponse(200, $wellKnownHeader)]),
|
||||
$this->generate([$createResponse(200, $wellKnownHeader)]),
|
||||
$this->generate([$createResponse(207)]),
|
||||
$this->generate([$createResponse(207)]),
|
||||
],
|
||||
SetupResult::SUCCESS,
|
||||
],
|
||||
'late response with expected codes' => [
|
||||
[
|
||||
$this->generate([$createResponse(404), $createResponse(200, $wellKnownHeader)]),
|
||||
$this->generate([$createResponse(404), $createResponse(200, $wellKnownHeader)]),
|
||||
$this->generate([$createResponse(404), $createResponse(207)]),
|
||||
$this->generate([$createResponse(404), $createResponse(207)]),
|
||||
],
|
||||
SetupResult::SUCCESS,
|
||||
],
|
||||
'working but disabled webfinger' => [
|
||||
[
|
||||
$this->generate([$createResponse(404, $wellKnownHeader)]),
|
||||
$this->generate([$createResponse(404, $wellKnownHeader)]),
|
||||
$this->generate([$createResponse(207)]),
|
||||
$this->generate([$createResponse(207)]),
|
||||
],
|
||||
SetupResult::SUCCESS,
|
||||
],
|
||||
'unauthorized webdav but with correct configured redirect' => [
|
||||
[
|
||||
$this->generate([$createResponse(404, $wellKnownHeader)]),
|
||||
$this->generate([$createResponse(404, $wellKnownHeader)]),
|
||||
$this->generate([$createResponse(401, ['X-Guzzle-Redirect-History' => 'https://example.com,https://example.com/remote.php/dav/'])]),
|
||||
$this->generate([$createResponse(401, ['X-Guzzle-Redirect-History' => 'https://example.com/remote.php/dav/'])]),
|
||||
],
|
||||
SetupResult::SUCCESS,
|
||||
],
|
||||
'not configured path' => [
|
||||
[
|
||||
$this->generate([$createResponse(404)]),
|
||||
$this->generate([$createResponse(404)]),
|
||||
$this->generate([$createResponse(404)]),
|
||||
$this->generate([$createResponse(404)]),
|
||||
],
|
||||
SetupResult::WARNING,
|
||||
],
|
||||
'Invalid webfinger' => [
|
||||
[
|
||||
$this->generate([$createResponse(404)]),
|
||||
$this->generate([$createResponse(404, $wellKnownHeader)]),
|
||||
$this->generate([$createResponse(207)]),
|
||||
$this->generate([$createResponse(207)]),
|
||||
],
|
||||
SetupResult::WARNING,
|
||||
],
|
||||
'Invalid nodeinfo' => [
|
||||
[
|
||||
$this->generate([$createResponse(404, $wellKnownHeader)]),
|
||||
$this->generate([$createResponse(404)]),
|
||||
$this->generate([$createResponse(207)]),
|
||||
$this->generate([$createResponse(207)]),
|
||||
],
|
||||
SetupResult::WARNING,
|
||||
],
|
||||
'Invalid caldav' => [
|
||||
[
|
||||
$this->generate([$createResponse(404, $wellKnownHeader)]),
|
||||
$this->generate([$createResponse(404, $wellKnownHeader)]),
|
||||
$this->generate([$createResponse(404)]),
|
||||
$this->generate([$createResponse(207)]),
|
||||
],
|
||||
SetupResult::WARNING,
|
||||
],
|
||||
];
|
||||
}
|
||||
|
||||
/**
|
||||
* Helper function creates a nicer interface for mocking Generator behavior
|
||||
*/
|
||||
protected function generate(array $yield_values) {
|
||||
return $this->returnCallback(function () use ($yield_values) {
|
||||
yield from $yield_values;
|
||||
});
|
||||
}
|
||||
}
|
||||
|
|
@ -47,54 +47,6 @@
|
|||
return deferred.promise();
|
||||
},
|
||||
|
||||
/**
|
||||
* Check whether the .well-known URLs works.
|
||||
*
|
||||
* @param url the URL to test
|
||||
* @param placeholderUrl the placeholder URL - can be found at OC.theme.docPlaceholderUrl
|
||||
* @param {boolean} runCheck if this is set to false the check is skipped and no error is returned
|
||||
* @param {int|int[]} expectedStatus the expected HTTP status to be returned by the URL, 207 by default
|
||||
* @return $.Deferred object resolved with an array of error messages
|
||||
*/
|
||||
checkWellKnownUrl: function(verb, url, placeholderUrl, runCheck, expectedStatus, checkCustomHeader) {
|
||||
if (expectedStatus === undefined) {
|
||||
expectedStatus = [207];
|
||||
}
|
||||
|
||||
if (!Array.isArray(expectedStatus)) {
|
||||
expectedStatus = [expectedStatus];
|
||||
}
|
||||
|
||||
var deferred = $.Deferred();
|
||||
|
||||
if(runCheck === false) {
|
||||
deferred.resolve([]);
|
||||
return deferred.promise();
|
||||
}
|
||||
var afterCall = function(xhr) {
|
||||
var messages = [];
|
||||
var customWellKnown = xhr.getResponseHeader('X-NEXTCLOUD-WELL-KNOWN')
|
||||
if (expectedStatus.indexOf(xhr.status) === -1 || (checkCustomHeader && !customWellKnown)) {
|
||||
var docUrl = placeholderUrl.replace('PLACEHOLDER', 'admin-setup-well-known-URL');
|
||||
messages.push({
|
||||
msg: t('core', 'Your web server is not properly set up to resolve "{url}". Further information can be found in the {linkstart}documentation ↗{linkend}.', { url: url })
|
||||
.replace('{linkstart}', '<a target="_blank" rel="noreferrer noopener" class="external" href="' + docUrl + '">')
|
||||
.replace('{linkend}', '</a>'),
|
||||
type: OC.SetupChecks.MESSAGE_TYPE_INFO
|
||||
});
|
||||
}
|
||||
deferred.resolve(messages);
|
||||
};
|
||||
|
||||
$.ajax({
|
||||
type: verb,
|
||||
url: url,
|
||||
complete: afterCall,
|
||||
allowAuthErrors: true
|
||||
});
|
||||
return deferred.promise();
|
||||
},
|
||||
|
||||
/**
|
||||
* Runs setup checks on the server side
|
||||
*
|
||||
|
|
|
|||
|
|
@ -60,53 +60,6 @@ describe('OC.SetupChecks tests', function() {
|
|||
});
|
||||
});
|
||||
|
||||
describe('checkWellKnownUrl', function() {
|
||||
it('should fail with another response status code than the expected one', function(done) {
|
||||
var async = OC.SetupChecks.checkWellKnownUrl('PROPFIND', '/.well-known/caldav', 'http://example.org/PLACEHOLDER', true, 207);
|
||||
|
||||
suite.server.requests[0].respond(200);
|
||||
|
||||
async.done(function( data, s, x ){
|
||||
expect(data).toEqual([{
|
||||
msg: 'Your web server is not properly set up to resolve "/.well-known/caldav". Further information can be found in the <a target="_blank" rel="noreferrer noopener" class="external" href="http://example.org/admin-setup-well-known-URL">documentation ↗</a>.',
|
||||
type: OC.SetupChecks.MESSAGE_TYPE_INFO
|
||||
}]);
|
||||
done();
|
||||
});
|
||||
});
|
||||
|
||||
it('should return no error with the expected response status code', function(done) {
|
||||
var async = OC.SetupChecks.checkWellKnownUrl('PROPFIND', '/.well-known/caldav', 'http://example.org/PLACEHOLDER', true, 207);
|
||||
|
||||
suite.server.requests[0].respond(207);
|
||||
|
||||
async.done(function( data, s, x ){
|
||||
expect(data).toEqual([]);
|
||||
done();
|
||||
});
|
||||
});
|
||||
|
||||
it('should return no error with the default expected response status code', function(done) {
|
||||
var async = OC.SetupChecks.checkWellKnownUrl('PROPFIND', '/.well-known/caldav', 'http://example.org/PLACEHOLDER', true);
|
||||
|
||||
suite.server.requests[0].respond(207);
|
||||
|
||||
async.done(function( data, s, x ){
|
||||
expect(data).toEqual([]);
|
||||
done();
|
||||
});
|
||||
});
|
||||
|
||||
it('should return no error when no check should be run', function(done) {
|
||||
var async = OC.SetupChecks.checkWellKnownUrl('PROPFIND', '/.well-known/caldav', 'http://example.org/PLACEHOLDER', false);
|
||||
|
||||
async.done(function( data, s, x ){
|
||||
expect(data).toEqual([]);
|
||||
done();
|
||||
});
|
||||
});
|
||||
});
|
||||
|
||||
describe('checkSetup', function() {
|
||||
it('should return an error if server has no internet connection', function(done) {
|
||||
var async = OC.SetupChecks.checkSetup();
|
||||
|
|
@ -303,40 +256,6 @@ describe('OC.SetupChecks tests', function() {
|
|||
});
|
||||
});
|
||||
|
||||
// THe following test is invalid as the code in core/js/setupchecks.js is calling
|
||||
// window.location.protocol which always return http during tests
|
||||
// if there is a way to trick window.location.protocol during test, then we could re-activate it
|
||||
/*
|
||||
it('should return an error if the protocol is https but the server generates http links', function(done) {
|
||||
var async = OC.SetupChecks.checkSetup();
|
||||
|
||||
suite.server.requests[0].respond(
|
||||
200,
|
||||
{
|
||||
'Content-Type': 'application/json',
|
||||
},
|
||||
JSON.stringify({
|
||||
generic: {
|
||||
network: {
|
||||
"Internet connectivity": {
|
||||
severity: "success",
|
||||
description: null,
|
||||
linkToDoc: null
|
||||
}
|
||||
},
|
||||
},
|
||||
})
|
||||
);
|
||||
|
||||
async.done(function( data, s, x ){
|
||||
expect(data).toEqual([{
|
||||
msg: 'You are accessing your instance over a secure connection, however your instance is generating insecure URLs. This most likely means that you are behind a reverse proxy and the overwrite config variables are not set correctly. Please read <a target="_blank" rel="noreferrer noopener" class="external" href="https://docs.nextcloud.com/foo/bar.html">the documentation page about this ↗</a>.',
|
||||
type: OC.SetupChecks.MESSAGE_TYPE_WARNING
|
||||
}]);
|
||||
done();
|
||||
});
|
||||
});
|
||||
*/
|
||||
it('should not return an error if the protocol is http and the server generates http links', function(done) {
|
||||
var async = OC.SetupChecks.checkSetup();
|
||||
|
||||
|
|
|
|||
4
dist/settings-legacy-admin.js
vendored
4
dist/settings-legacy-admin.js
vendored
|
|
@ -1,2 +1,2 @@
|
|||
({69129:function(){window.addEventListener("DOMContentLoaded",(()=>{$("#loglevel").change((function(){$.post(OC.generateUrl("/settings/admin/log/level"),{level:$(this).val()},(()=>{OC.Log.reload()}))})),$("#mail_smtpauth").change((function(){this.checked?$("#mail_credentials").removeClass("hidden"):$("#mail_credentials").addClass("hidden")})),$("#mail_smtpmode").change((function(){"smtp"!==$(this).val()?($("#setting_smtpauth").addClass("hidden"),$("#setting_smtphost").addClass("hidden"),$("#mail_smtpsecure_label").addClass("hidden"),$("#mail_smtpsecure").addClass("hidden"),$("#mail_credentials").addClass("hidden"),$("#mail_sendmailmode_label, #mail_sendmailmode").removeClass("hidden")):($("#setting_smtpauth").removeClass("hidden"),$("#setting_smtphost").removeClass("hidden"),$("#mail_smtpsecure_label").removeClass("hidden"),$("#mail_smtpsecure").removeClass("hidden"),$("#mail_smtpauth").is(":checked")&&$("#mail_credentials").removeClass("hidden"),$("#mail_sendmailmode_label, #mail_sendmailmode").addClass("hidden"))}));const e=function(){OC.PasswordConfirmation.requiresPasswordConfirmation()?OC.PasswordConfirmation.requirePasswordConfirmation(e):(OC.msg.startSaving("#mail_settings_msg"),$.ajax({url:OC.generateUrl("/settings/admin/mailsettings"),type:"POST",data:$("#mail_general_settings_form").serialize(),success:()=>{OC.msg.finishedSuccess("#mail_settings_msg",t("settings","Saved"))},error:e=>{OC.msg.finishedError("#mail_settings_msg",e.responseJSON)}}))},s=function(){OC.PasswordConfirmation.requiresPasswordConfirmation()?OC.PasswordConfirmation.requirePasswordConfirmation(s):(OC.msg.startSaving("#mail_settings_msg"),$.ajax({url:OC.generateUrl("/settings/admin/mailsettings/credentials"),type:"POST",data:$("#mail_credentials_settings").serialize(),success:()=>{OC.msg.finishedSuccess("#mail_settings_msg",t("settings","Saved"))},error:e=>{OC.msg.finishedError("#mail_settings_msg",e.responseJSON)}}))};$("#mail_general_settings_form").change(e),$("#mail_credentials_settings_submit").click(s),$("#mail_smtppassword").click((()=>{"text"===this.N&&"********"===this.U&&(this.N="password",this.U="")})),$("#sendtestemail").click((e=>{e.preventDefault(),OC.msg.startAction("#sendtestmail_msg",t("settings","Sending…")),$.ajax({url:OC.generateUrl("/settings/admin/mailtest"),type:"POST",success:()=>{OC.msg.finishedSuccess("#sendtestmail_msg",t("settings","Email sent"))},error:e=>{OC.msg.finishedError("#sendtestmail_msg",e.responseJSON)}})})),null!==document.getElementById("security-warning")&&$.when(OC.SetupChecks.checkWebDAV(),OC.SetupChecks.checkWellKnownUrl("GET","/.well-known/webfinger",OC.theme.docPlaceholderUrl,!0===$("#postsetupchecks").data("check-wellknown"),[200,404],!0),OC.SetupChecks.checkWellKnownUrl("GET","/.well-known/nodeinfo",OC.theme.docPlaceholderUrl,!0===$("#postsetupchecks").data("check-wellknown"),[200,404],!0),OC.SetupChecks.checkWellKnownUrl("PROPFIND","/.well-known/caldav",OC.theme.docPlaceholderUrl,!0===$("#postsetupchecks").data("check-wellknown")),OC.SetupChecks.checkWellKnownUrl("PROPFIND","/.well-known/carddav",OC.theme.docPlaceholderUrl,!0===$("#postsetupchecks").data("check-wellknown")),OC.SetupChecks.checkSetup(),OC.SetupChecks.checkGeneric()).then(((e,s,t,n,i,a,l)=>{const d=[].concat(e,s,t,n,i,a,l),r=$("#postsetupchecks");$("#security-warning-state-loading").addClass("hidden");let c=!1;const m=r.find(".errors"),o=r.find(".warnings"),h=r.find(".info");for(let e=0;e<d.length;e++)switch(d[e].type){case OC.SetupChecks.MESSAGE_TYPE_INFO:h.append("<li>"+d[e].msg+"</li>");break;case OC.SetupChecks.MESSAGE_TYPE_WARNING:o.append("<li>"+d[e].msg+"</li>");break;case OC.SetupChecks.MESSAGE_TYPE_ERROR:default:m.append("<li>"+d[e].msg+"</li>")}m.find("li").length>0&&(m.removeClass("hidden"),c=!0),o.find("li").length>0&&(o.removeClass("hidden"),c=!0),h.find("li").length>0&&(h.removeClass("hidden"),c=!0),c?($("#postsetupchecks-hint").removeClass("hidden"),m.find("li").length>0?$("#security-warning-state-failure").removeClass("hidden"):$("#security-warning-state-warning").removeClass("hidden")):0===$("#security-warning").children("ul").children().length?$("#security-warning-state-ok").removeClass("hidden"):$("#security-warning-state-failure").removeClass("hidden")}))}))}})[69129]();
|
||||
//# sourceMappingURL=settings-legacy-admin.js.map?v=aae3b9bd4aae206239f2
|
||||
({69129:function(){window.addEventListener("DOMContentLoaded",(()=>{$("#loglevel").change((function(){$.post(OC.generateUrl("/settings/admin/log/level"),{level:$(this).val()},(()=>{OC.Log.reload()}))})),$("#mail_smtpauth").change((function(){this.checked?$("#mail_credentials").removeClass("hidden"):$("#mail_credentials").addClass("hidden")})),$("#mail_smtpmode").change((function(){"smtp"!==$(this).val()?($("#setting_smtpauth").addClass("hidden"),$("#setting_smtphost").addClass("hidden"),$("#mail_smtpsecure_label").addClass("hidden"),$("#mail_smtpsecure").addClass("hidden"),$("#mail_credentials").addClass("hidden"),$("#mail_sendmailmode_label, #mail_sendmailmode").removeClass("hidden")):($("#setting_smtpauth").removeClass("hidden"),$("#setting_smtphost").removeClass("hidden"),$("#mail_smtpsecure_label").removeClass("hidden"),$("#mail_smtpsecure").removeClass("hidden"),$("#mail_smtpauth").is(":checked")&&$("#mail_credentials").removeClass("hidden"),$("#mail_sendmailmode_label, #mail_sendmailmode").addClass("hidden"))}));const e=function(){OC.PasswordConfirmation.requiresPasswordConfirmation()?OC.PasswordConfirmation.requirePasswordConfirmation(e):(OC.msg.startSaving("#mail_settings_msg"),$.ajax({url:OC.generateUrl("/settings/admin/mailsettings"),type:"POST",data:$("#mail_general_settings_form").serialize(),success:()=>{OC.msg.finishedSuccess("#mail_settings_msg",t("settings","Saved"))},error:e=>{OC.msg.finishedError("#mail_settings_msg",e.responseJSON)}}))},s=function(){OC.PasswordConfirmation.requiresPasswordConfirmation()?OC.PasswordConfirmation.requirePasswordConfirmation(s):(OC.msg.startSaving("#mail_settings_msg"),$.ajax({url:OC.generateUrl("/settings/admin/mailsettings/credentials"),type:"POST",data:$("#mail_credentials_settings").serialize(),success:()=>{OC.msg.finishedSuccess("#mail_settings_msg",t("settings","Saved"))},error:e=>{OC.msg.finishedError("#mail_settings_msg",e.responseJSON)}}))};$("#mail_general_settings_form").change(e),$("#mail_credentials_settings_submit").click(s),$("#mail_smtppassword").click((()=>{"text"===this.N&&"********"===this.U&&(this.N="password",this.U="")})),$("#sendtestemail").click((e=>{e.preventDefault(),OC.msg.startAction("#sendtestmail_msg",t("settings","Sending…")),$.ajax({url:OC.generateUrl("/settings/admin/mailtest"),type:"POST",success:()=>{OC.msg.finishedSuccess("#sendtestmail_msg",t("settings","Email sent"))},error:e=>{OC.msg.finishedError("#sendtestmail_msg",e.responseJSON)}})})),null!==document.getElementById("security-warning")&&$.when(OC.SetupChecks.checkWebDAV(),OC.SetupChecks.checkSetup(),OC.SetupChecks.checkGeneric()).then(((e,s,i)=>{const t=[].concat(e,s,i),n=$("#postsetupchecks");$("#security-warning-state-loading").addClass("hidden");let a=!1;const d=n.find(".errors"),l=n.find(".warnings"),r=n.find(".info");for(let e=0;e<t.length;e++)switch(t[e].type){case OC.SetupChecks.MESSAGE_TYPE_INFO:r.append("<li>"+t[e].msg+"</li>");break;case OC.SetupChecks.MESSAGE_TYPE_WARNING:l.append("<li>"+t[e].msg+"</li>");break;case OC.SetupChecks.MESSAGE_TYPE_ERROR:default:d.append("<li>"+t[e].msg+"</li>")}d.find("li").length>0&&(d.removeClass("hidden"),a=!0),l.find("li").length>0&&(l.removeClass("hidden"),a=!0),r.find("li").length>0&&(r.removeClass("hidden"),a=!0),a?($("#postsetupchecks-hint").removeClass("hidden"),d.find("li").length>0?$("#security-warning-state-failure").removeClass("hidden"):$("#security-warning-state-warning").removeClass("hidden")):0===$("#security-warning").children("ul").children().length?$("#security-warning-state-ok").removeClass("hidden"):$("#security-warning-state-failure").removeClass("hidden")}))}))}})[69129]();
|
||||
//# sourceMappingURL=settings-legacy-admin.js.map?v=934bbdbaeebd1d2b478c
|
||||
2
dist/settings-legacy-admin.js.map
vendored
2
dist/settings-legacy-admin.js.map
vendored
File diff suppressed because one or more lines are too long
|
|
@ -424,6 +424,43 @@ class Client implements IClient {
|
|||
throw $e;
|
||||
}
|
||||
|
||||
/**
|
||||
* Sends a HTTP request
|
||||
*
|
||||
* @param string $method The HTTP method to use
|
||||
* @param string $uri
|
||||
* @param array $options Array such as
|
||||
* 'query' => [
|
||||
* 'field' => 'abc',
|
||||
* 'other_field' => '123',
|
||||
* 'file_name' => fopen('/path/to/file', 'r'),
|
||||
* ],
|
||||
* 'headers' => [
|
||||
* 'foo' => 'bar',
|
||||
* ],
|
||||
* 'cookies' => [
|
||||
* 'foo' => 'bar',
|
||||
* ],
|
||||
* 'allow_redirects' => [
|
||||
* 'max' => 10, // allow at most 10 redirects.
|
||||
* 'strict' => true, // use "strict" RFC compliant redirects.
|
||||
* 'referer' => true, // add a Referer header
|
||||
* 'protocols' => ['https'] // only allow https URLs
|
||||
* ],
|
||||
* 'sink' => '/path/to/file', // save to a file or a stream
|
||||
* 'verify' => true, // bool or string to CA file
|
||||
* 'debug' => true,
|
||||
* 'timeout' => 5,
|
||||
* @return IResponse
|
||||
* @throws \Exception If the request could not get completed
|
||||
*/
|
||||
public function request(string $method, string $uri, array $options = []): IResponse {
|
||||
$this->preventLocalAddress($uri, $options);
|
||||
$response = $this->client->request($method, $uri, $this->buildRequestOptions($options));
|
||||
$isStream = isset($options['stream']) && $options['stream'];
|
||||
return new Response($response, $isStream);
|
||||
}
|
||||
|
||||
protected function wrapGuzzlePromise(PromiseInterface $promise): IPromise {
|
||||
return new GuzzlePromiseAdapter(
|
||||
$promise,
|
||||
|
|
|
|||
|
|
@ -217,6 +217,37 @@ interface IClient {
|
|||
*/
|
||||
public function getResponseFromThrowable(\Throwable $e): IResponse;
|
||||
|
||||
/**
|
||||
* Sends a HTTP request
|
||||
* @param string $method The HTTP method to use
|
||||
* @param string $uri
|
||||
* @param array $options Array such as
|
||||
* 'query' => [
|
||||
* 'field' => 'abc',
|
||||
* 'other_field' => '123',
|
||||
* 'file_name' => fopen('/path/to/file', 'r'),
|
||||
* ],
|
||||
* 'headers' => [
|
||||
* 'foo' => 'bar',
|
||||
* ],
|
||||
* 'cookies' => [
|
||||
* 'foo' => 'bar',
|
||||
* ],
|
||||
* 'allow_redirects' => [
|
||||
* 'max' => 10, // allow at most 10 redirects.
|
||||
* 'strict' => true, // use "strict" RFC compliant redirects.
|
||||
* 'referer' => true, // add a Referer header
|
||||
* 'protocols' => ['https'] // only allow https URLs
|
||||
* ],
|
||||
* 'sink' => '/path/to/file', // save to a file or a stream
|
||||
* 'verify' => true, // bool or string to CA file
|
||||
* 'debug' => true,
|
||||
* @return IResponse
|
||||
* @throws \Exception If the request could not get completed
|
||||
* @since 29.0.0
|
||||
*/
|
||||
public function request(string $method, string $uri, array $options = []): IResponse;
|
||||
|
||||
/**
|
||||
* Sends an asynchronous GET request
|
||||
* @param string $uri
|
||||
|
|
|
|||
Loading…
Reference in a new issue