Skip to content

fix: add option to remove the webroot for setup checks and don't chec… #46255

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

Merged
sorbaugh merged 2 commits into from
Sep 5, 2024
Merged

fix: add option to remove the webroot for setup checks and don't chec… #46255

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4ce4d7b
fix: add option to remove the webroot for setup checks and don't chec…
kesselb Jul 2, 2024
c224b8c
fix(setupchecks): Test overwrite.cli url first, then generated one, and
come-nc Sep 5, 2024
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
Next Next commit
fix: add option to remove the webroot for setup checks and don't chec… 
…k trusted_domains.

1) The checks for well-known urls should always run against the root domain and therefore the option to remove the webroot.

2) For trusted domains, the available protocol is unknown, and thus some guesswork would be needed to make that work. I've decided for now to not consider them anymore to reduce false-positives.

Signed-off-by: Daniel Kesselberg <[email protected]>
  • Loading branch information
@kesselb @come-nc
kesselb authored and come-nc committed Sep 5, 2024
commit 4ce4d7b9b31268f3b9242eaa73be6390890ef761
47 changes: 36 additions & 11 deletions apps/settings/lib/SetupChecks/CheckServerResponseTrait.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,26 +35,51 @@ protected function serverConfigHelp(): string {

/**
* Get all possible URLs that need to be checked for a local request test.
* This takes all `trusted_domains` and the CLI overwrite URL into account.
*
* @param string $url The relative URL to test
* @return string[] List of possible absolute URLs
*/
protected function getTestUrls(string $url): array {
$hosts = $this->config->getSystemValue('trusted_domains', []);
$cliUrl = $this->config->getSystemValue('overwrite.cli.url', '');
if ($cliUrl !== '') {
$hosts[] = $cliUrl;
protected function getTestUrls(string $url, bool $removeWebroot): array {
$testUrls = [];

$webroot = $this->urlGenerator->getWebroot();

$baseUrl = $this->normalizeUrl(
$this->urlGenerator->getBaseUrl(),
$webroot,
$removeWebroot
);

$testUrls[] = $baseUrl . $url;

$cliUrl = $this->config->getSystemValueString('overwrite.cli.url', '');
if ($cliUrl === '') {
return $testUrls;
}

$testUrls = array_merge(
[$this->urlGenerator->getAbsoluteURL($url)],
array_map(fn (string $host): string => $host . $url, $hosts),
$cliUrl = $this->normalizeUrl(
$cliUrl,
$webroot,
$removeWebroot
);

if ($cliUrl !== $baseUrl) {
$testUrls[] = $cliUrl . $url;
}

return $testUrls;
}

/**
* Strip a trailing slash and remove the webroot if requested.
*/
protected function normalizeUrl(string $url, string $webroot, bool $removeWebroot): string {
if ($removeWebroot && str_contains($url, $webroot)) {
$url = substr($url, -strlen($webroot));
}
return rtrim($url, '/');
}

/**
* Run a HTTP request to check header
* @param string $method The HTTP method to use
Expand All @@ -69,14 +94,14 @@ protected function getTestUrls(string $url): array {
*
* @return Generator<int, IResponse>
*/
protected function runRequest(string $method, string $url, array $options = []): Generator {
protected function runRequest(string $method, string $url, array $options = [], bool $removeWebroot = false): 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) {
foreach ($this->getTestUrls($url, $removeWebroot) as $testURL) {
try {
yield $client->request($method, $testURL, $requestOptions);
} catch (\Throwable $e) {
Expand Down
2 changes: 1 addition & 1 deletion apps/settings/lib/SetupChecks/OcxProviders.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ public function run(): SetupResult {
];

foreach ($providers as $provider) {
foreach ($this->runRequest('HEAD', $this->urlGenerator->getWebroot() . $provider, ['httpErrors' => false]) as $response) {
foreach ($this->runRequest('HEAD', $provider, ['httpErrors' => false]) as $response) {
$testedProviders[$provider] = true;
if ($response->getStatusCode() === 200) {
$workingProviders[] = $provider;
Expand Down
2 changes: 1 addition & 1 deletion apps/settings/lib/SetupChecks/WellKnownUrls.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ public function run(): SetupResult {

foreach ($urls as [$verb,$url,$validStatuses,$checkCustomHeader]) {
$works = null;
foreach ($this->runRequest($verb, $url, ['httpErrors' => false, 'options' => ['allow_redirects' => ['track_redirects' => true]]]) as $response) {
foreach ($this->runRequest($verb, $url, ['httpErrors' => false, 'options' => ['allow_redirects' => ['track_redirects' => true]]], removeWebroot: true) as $response) {
// Check that the response status matches
$works = in_array($response->getStatusCode(), $validStatuses);
// and (if needed) the custom Nextcloud header is set
Expand Down