Skip to content

Commit

Permalink
feat(settings): add big file upload setup checks
Browse files Browse the repository at this point in the history
Signed-off-by: skjnldsv <[email protected]>
  • Loading branch information
skjnldsv committed Nov 19, 2024
1 parent bb2e8e0 commit 96daddb
Show file tree
Hide file tree
Showing 4 changed files with 86 additions and 0 deletions.
1 change: 1 addition & 0 deletions apps/settings/composer/composer/autoload_classmap.php
Original file line number Diff line number Diff line change
Expand Up @@ -115,6 +115,7 @@
'OCA\\Settings\\SetupChecks\\PhpDisabledFunctions' => $baseDir . '/../lib/SetupChecks/PhpDisabledFunctions.php',
'OCA\\Settings\\SetupChecks\\PhpFreetypeSupport' => $baseDir . '/../lib/SetupChecks/PhpFreetypeSupport.php',
'OCA\\Settings\\SetupChecks\\PhpGetEnv' => $baseDir . '/../lib/SetupChecks/PhpGetEnv.php',
'OCA\\Settings\\SetupChecks\\PhpMaxFileSize' => $baseDir . '/../lib/SetupChecks/PhpMaxFileSize.php',
'OCA\\Settings\\SetupChecks\\PhpMemoryLimit' => $baseDir . '/../lib/SetupChecks/PhpMemoryLimit.php',
'OCA\\Settings\\SetupChecks\\PhpModules' => $baseDir . '/../lib/SetupChecks/PhpModules.php',
'OCA\\Settings\\SetupChecks\\PhpOpcacheSetup' => $baseDir . '/../lib/SetupChecks/PhpOpcacheSetup.php',
Expand Down
1 change: 1 addition & 0 deletions apps/settings/composer/composer/autoload_static.php
Original file line number Diff line number Diff line change
Expand Up @@ -130,6 +130,7 @@ class ComposerStaticInitSettings
'OCA\\Settings\\SetupChecks\\PhpDisabledFunctions' => __DIR__ . '/..' . '/../lib/SetupChecks/PhpDisabledFunctions.php',
'OCA\\Settings\\SetupChecks\\PhpFreetypeSupport' => __DIR__ . '/..' . '/../lib/SetupChecks/PhpFreetypeSupport.php',
'OCA\\Settings\\SetupChecks\\PhpGetEnv' => __DIR__ . '/..' . '/../lib/SetupChecks/PhpGetEnv.php',
'OCA\\Settings\\SetupChecks\\PhpMaxFileSize' => __DIR__ . '/..' . '/../lib/SetupChecks/PhpMaxFileSize.php',
'OCA\\Settings\\SetupChecks\\PhpMemoryLimit' => __DIR__ . '/..' . '/../lib/SetupChecks/PhpMemoryLimit.php',
'OCA\\Settings\\SetupChecks\\PhpModules' => __DIR__ . '/..' . '/../lib/SetupChecks/PhpModules.php',
'OCA\\Settings\\SetupChecks\\PhpOpcacheSetup' => __DIR__ . '/..' . '/../lib/SetupChecks/PhpOpcacheSetup.php',
Expand Down
2 changes: 2 additions & 0 deletions apps/settings/lib/AppInfo/Application.php
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,7 @@
use OCA\Settings\SetupChecks\PhpDisabledFunctions;
use OCA\Settings\SetupChecks\PhpFreetypeSupport;
use OCA\Settings\SetupChecks\PhpGetEnv;
use OCA\Settings\SetupChecks\PhpMaxFileSize;
use OCA\Settings\SetupChecks\PhpMemoryLimit;
use OCA\Settings\SetupChecks\PhpModules;
use OCA\Settings\SetupChecks\PhpOpcacheSetup;
Expand Down Expand Up @@ -203,6 +204,7 @@ public function register(IRegistrationContext $context): void {
$context->registerSetupCheck(PhpFreetypeSupport::class);
$context->registerSetupCheck(PhpApcuConfig::class);
$context->registerSetupCheck(PhpGetEnv::class);
$context->registerSetupCheck(PhpMaxFileSize::class);
$context->registerSetupCheck(PhpMemoryLimit::class);
$context->registerSetupCheck(PhpModules::class);
$context->registerSetupCheck(PhpOpcacheSetup::class);
Expand Down
82 changes: 82 additions & 0 deletions apps/settings/lib/SetupChecks/PhpMaxFileSize.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,82 @@
<?php

declare(strict_types=1);

/**
* SPDX-FileCopyrightText: 2024 Nextcloud GmbH and Nextcloud contributors
* SPDX-License-Identifier: AGPL-3.0-or-later
*/

namespace OCA\Settings\SetupChecks;

use bantu\IniGetWrapper\IniGetWrapper;
use OCP\IL10N;
use OCP\IURLGenerator;
use OCP\SetupCheck\ISetupCheck;
use OCP\SetupCheck\SetupResult;
use OCP\Util;

class PhpMaxFileSize implements ISetupCheck {
public function __construct(
private IL10N $l10n,
private IURLGenerator $urlGenerator,
private IniGetWrapper $iniGetWrapper,
) {
}

public function getCategory(): string {
return 'php';
}

public function getName(): string {
return $this->l10n->t('PHP file size upload limit');
}

public function run(): SetupResult {
$upload_max_filesize = Util::computerFileSize((string)$this->iniGetWrapper->getString('upload_max_filesize'));
$post_max_size = Util::computerFileSize((string)$this->iniGetWrapper->getString('post_max_size'));
$max_input_time = (int)$this->iniGetWrapper->getString('max_input_time');
$max_execution_time = (int)$this->iniGetWrapper->getString('max_execution_time');

$warnings = [];
$recommendedSize = 16 * 1024 * 1024 * 1024;
$recommendedTime = 3600;

// Check if the PHP upload limit is too low
if ($upload_max_filesize < $recommendedSize) {
$warnings[] = $this->l10n->t('The PHP upload_max_filesize is too low. A file size of at least %1$s is recommended. Current value: %2$s.', [
Util::humanFileSize($recommendedSize),
Util::humanFileSize($upload_max_filesize),
]);
}
if ($post_max_size < $recommendedSize) {
$warnings[] = $this->l10n->t('The PHP post_max_size is too low. A file size of at least %1$s is recommended. Current value: %2$s.', [
Util::humanFileSize($recommendedSize),
Util::humanFileSize($post_max_size),
]);
}

// Check if the PHP execution time is too low
if ($max_input_time !== -1 && $max_execution_time !== -1) {
if ($max_input_time < $recommendedTime) {
$warnings[] = $this->l10n->t('The PHP max_input_time is too low. A time of at least %1$s is recommended. Current value: %2$s.', [
$recommendedTime,
$max_input_time,
]);
}

if ($max_execution_time < $recommendedTime) {
$warnings[] = $this->l10n->t('The PHP max_execution_time is too low. A time of at least %1$s is recommended. Current value: %2$s.', [
$recommendedTime,
$max_execution_time,
]);
}
}

if (!empty($warnings)) {
return SetupResult::warning(join(' ', $warnings), $this->urlGenerator->linkToDocs('admin-big-file-upload'));
}

return SetupResult::success();
}
}

0 comments on commit 96daddb

Please sign in to comment.