]> source.dussan.org Git - nextcloud-server.git/commitdiff
Migrate Cron checks to new SetupCheck API
authorCôme Chilliet <come.chilliet@nextcloud.com>
Mon, 15 Jan 2024 14:05:14 +0000 (15:05 +0100)
committerCôme Chilliet <91878298+come-nc@users.noreply.github.com>
Tue, 16 Jan 2024 09:49:19 +0000 (10:49 +0100)
Signed-off-by: Côme Chilliet <come.chilliet@nextcloud.com>
apps/settings/composer/composer/autoload_classmap.php
apps/settings/composer/composer/autoload_static.php
apps/settings/lib/AppInfo/Application.php
apps/settings/lib/Controller/CheckSetupController.php
apps/settings/lib/SetupChecks/CronErrors.php [new file with mode: 0644]
apps/settings/lib/SetupChecks/CronInfo.php [new file with mode: 0644]
core/js/setupchecks.js

index bfd2901fed54e67a70dd3dffa84977d92846c22f..f00a2aad146d3e069f6f4769c5bb2ed18c6ac71e 100644 (file)
@@ -80,6 +80,8 @@ return array(
     'OCA\\Settings\\SetupChecks\\BruteForceThrottler' => $baseDir . '/../lib/SetupChecks/BruteForceThrottler.php',
     'OCA\\Settings\\SetupChecks\\CheckUserCertificates' => $baseDir . '/../lib/SetupChecks/CheckUserCertificates.php',
     'OCA\\Settings\\SetupChecks\\CodeIntegrity' => $baseDir . '/../lib/SetupChecks/CodeIntegrity.php',
+    'OCA\\Settings\\SetupChecks\\CronErrors' => $baseDir . '/../lib/SetupChecks/CronErrors.php',
+    'OCA\\Settings\\SetupChecks\\CronInfo' => $baseDir . '/../lib/SetupChecks/CronInfo.php',
     'OCA\\Settings\\SetupChecks\\DatabaseHasMissingColumns' => $baseDir . '/../lib/SetupChecks/DatabaseHasMissingColumns.php',
     'OCA\\Settings\\SetupChecks\\DatabaseHasMissingIndices' => $baseDir . '/../lib/SetupChecks/DatabaseHasMissingIndices.php',
     'OCA\\Settings\\SetupChecks\\DatabaseHasMissingPrimaryKeys' => $baseDir . '/../lib/SetupChecks/DatabaseHasMissingPrimaryKeys.php',
index 51c5bb04be9e0faae5b1cb3a0308b7b325fac2e1..d1aa4e3ea96265a51186dfe86817e7e846035d1a 100644 (file)
@@ -95,6 +95,8 @@ class ComposerStaticInitSettings
         'OCA\\Settings\\SetupChecks\\BruteForceThrottler' => __DIR__ . '/..' . '/../lib/SetupChecks/BruteForceThrottler.php',
         'OCA\\Settings\\SetupChecks\\CheckUserCertificates' => __DIR__ . '/..' . '/../lib/SetupChecks/CheckUserCertificates.php',
         'OCA\\Settings\\SetupChecks\\CodeIntegrity' => __DIR__ . '/..' . '/../lib/SetupChecks/CodeIntegrity.php',
+        'OCA\\Settings\\SetupChecks\\CronErrors' => __DIR__ . '/..' . '/../lib/SetupChecks/CronErrors.php',
+        'OCA\\Settings\\SetupChecks\\CronInfo' => __DIR__ . '/..' . '/../lib/SetupChecks/CronInfo.php',
         'OCA\\Settings\\SetupChecks\\DatabaseHasMissingColumns' => __DIR__ . '/..' . '/../lib/SetupChecks/DatabaseHasMissingColumns.php',
         'OCA\\Settings\\SetupChecks\\DatabaseHasMissingIndices' => __DIR__ . '/..' . '/../lib/SetupChecks/DatabaseHasMissingIndices.php',
         'OCA\\Settings\\SetupChecks\\DatabaseHasMissingPrimaryKeys' => __DIR__ . '/..' . '/../lib/SetupChecks/DatabaseHasMissingPrimaryKeys.php',
index 8b2e9e12a1eedea8744d131169ea725975f76c92..820ee4f98ac12cfa3d4f8bed82fdb60dc144bf0c 100644 (file)
@@ -52,6 +52,8 @@ use OCA\Settings\SetupChecks\AppDirsWithDifferentOwner;
 use OCA\Settings\SetupChecks\BruteForceThrottler;
 use OCA\Settings\SetupChecks\CheckUserCertificates;
 use OCA\Settings\SetupChecks\CodeIntegrity;
+use OCA\Settings\SetupChecks\CronErrors;
+use OCA\Settings\SetupChecks\CronInfo;
 use OCA\Settings\SetupChecks\DatabaseHasMissingColumns;
 use OCA\Settings\SetupChecks\DatabaseHasMissingIndices;
 use OCA\Settings\SetupChecks\DatabaseHasMissingPrimaryKeys;
@@ -172,6 +174,8 @@ class Application extends App implements IBootstrap {
                $context->registerSetupCheck(BruteForceThrottler::class);
                $context->registerSetupCheck(CheckUserCertificates::class);
                $context->registerSetupCheck(CodeIntegrity::class);
+               $context->registerSetupCheck(CronErrors::class);
+               $context->registerSetupCheck(CronInfo::class);
                $context->registerSetupCheck(DatabaseHasMissingColumns::class);
                $context->registerSetupCheck(DatabaseHasMissingIndices::class);
                $context->registerSetupCheck(DatabaseHasMissingPrimaryKeys::class);
index c7f1f59ba7d888c7114886af36bf359296cb4207..00883a0d51eedca8eba4a41d1ffbfd5b41ef92dd 100644 (file)
@@ -55,7 +55,6 @@ use OCP\AppFramework\Http\DataResponse;
 use OCP\AppFramework\Http\RedirectResponse;
 use OCP\Http\Client\IClientService;
 use OCP\IConfig;
-use OCP\IDateTimeFormatter;
 use OCP\IL10N;
 use OCP\IRequest;
 use OCP\ITempManager;
@@ -78,8 +77,6 @@ class CheckSetupController extends Controller {
        private $checker;
        /** @var LoggerInterface */
        private $logger;
-       /** @var IDateTimeFormatter */
-       private $dateTimeFormatter;
        /** @var ITempManager */
        private $tempManager;
        /** @var IManager */
@@ -94,7 +91,6 @@ class CheckSetupController extends Controller {
                IL10N $l10n,
                Checker $checker,
                LoggerInterface $logger,
-               IDateTimeFormatter $dateTimeFormatter,
                ITempManager $tempManager,
                IManager $manager,
                ISetupCheckManager $setupCheckManager,
@@ -106,7 +102,6 @@ class CheckSetupController extends Controller {
                $this->l10n = $l10n;
                $this->checker = $checker;
                $this->logger = $logger;
-               $this->dateTimeFormatter = $dateTimeFormatter;
                $this->tempManager = $tempManager;
                $this->manager = $manager;
                $this->setupCheckManager = $setupCheckManager;
@@ -302,25 +297,6 @@ Raw output
                );
        }
 
-       protected function getLastCronInfo(): array {
-               $lastCronRun = (int)$this->config->getAppValue('core', 'lastcron', '0');
-               return [
-                       'diffInSeconds' => time() - $lastCronRun,
-                       'relativeTime' => $this->dateTimeFormatter->formatTimeSpan($lastCronRun),
-                       'backgroundJobsUrl' => $this->urlGenerator->linkToRoute('settings.AdminSettings.index', ['section' => 'server']) . '#backgroundjobs',
-               ];
-       }
-
-       protected function getCronErrors() {
-               $errors = json_decode($this->config->getAppValue('core', 'cronErrors', ''), true);
-
-               if (is_array($errors)) {
-                       return $errors;
-               }
-
-               return [];
-       }
-
        private function isTemporaryDirectoryWritable(): bool {
                try {
                        if (!empty($this->tempManager->getTempBaseDir())) {
@@ -388,8 +364,6 @@ Raw output
        public function check() {
                return new DataResponse(
                        [
-                               'cronInfo' => $this->getLastCronInfo(),
-                               'cronErrors' => $this->getCronErrors(),
                                'isFairUseOfFreePushService' => $this->isFairUseOfFreePushService(),
                                'isUsedTlsLibOutdated' => $this->isUsedTlsLibOutdated(),
                                'reverseProxyDocs' => $this->urlGenerator->linkToDocs('admin-reverse-proxy'),
diff --git a/apps/settings/lib/SetupChecks/CronErrors.php b/apps/settings/lib/SetupChecks/CronErrors.php
new file mode 100644 (file)
index 0000000..a2ebbf5
--- /dev/null
@@ -0,0 +1,62 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * @copyright Copyright (c) 2023 Côme Chilliet <come.chilliet@nextcloud.com>
+ *
+ * @author Côme Chilliet <come.chilliet@nextcloud.com>
+ *
+ * @license GNU AGPL version 3 or any later version
+ *
+ * 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\IConfig;
+use OCP\IL10N;
+use OCP\SetupCheck\ISetupCheck;
+use OCP\SetupCheck\SetupResult;
+
+class CronErrors implements ISetupCheck {
+       public function __construct(
+               private IL10N $l10n,
+               private IConfig $config,
+       ) {
+       }
+
+       public function getCategory(): string {
+               return 'system';
+       }
+
+       public function getName(): string {
+               return $this->l10n->t('Cron errors');
+       }
+
+       public function run(): SetupResult {
+               $errors = json_decode($this->config->getAppValue('core', 'cronErrors', ''), true);
+               if (is_array($errors) && count($errors) > 0) {
+                       return SetupResult::error(
+                               $this->l10n->t(
+                                       "It was not possible to execute the cron job via CLI. The following technical errors have appeared:\n%s",
+                                       implode("\n", array_map(fn (array $error) => '- '.$error['error'].' '.$error['hint'], $errors))
+                               )
+                       );
+               } else {
+                       return SetupResult::success($this->l10n->t('The last cron job ran without errors.'));
+               }
+       }
+}
diff --git a/apps/settings/lib/SetupChecks/CronInfo.php b/apps/settings/lib/SetupChecks/CronInfo.php
new file mode 100644 (file)
index 0000000..d08bb68
--- /dev/null
@@ -0,0 +1,81 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * @copyright Copyright (c) 2023 Côme Chilliet <come.chilliet@nextcloud.com>
+ *
+ * @author Côme Chilliet <come.chilliet@nextcloud.com>
+ *
+ * @license GNU AGPL version 3 or any later version
+ *
+ * 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\IConfig;
+use OCP\IDateTimeFormatter;
+use OCP\IL10N;
+use OCP\IURLGenerator;
+use OCP\SetupCheck\ISetupCheck;
+use OCP\SetupCheck\SetupResult;
+
+class CronInfo implements ISetupCheck {
+       public function __construct(
+               private IL10N $l10n,
+               private IConfig $config,
+               private IURLGenerator $urlGenerator,
+               private IDateTimeFormatter $dateTimeFormatter,
+       ) {
+       }
+
+       public function getCategory(): string {
+               return 'system';
+       }
+
+       public function getName(): string {
+               return $this->l10n->t('Cron last run');
+       }
+
+       public function run(): SetupResult {
+               $lastCronRun = (int)$this->config->getAppValue('core', 'lastcron', '0');
+               $relativeTime = $this->dateTimeFormatter->formatTimeSpan($lastCronRun);
+
+               if ((time() - $lastCronRun) > 3600) {
+                       return SetupResult::error(
+                               $this->l10n->t(
+                                       'Last background job execution ran %s. Something seems wrong. {link}.',
+                                       [$relativeTime]
+                               ),
+                               descriptionParameters:[
+                                       'link' => [
+                                               'type' => 'highlight',
+                                               'id' => 'backgroundjobs',
+                                               'name' => 'Check the background job settings',
+                                               'link' => $this->urlGenerator->linkToRoute('settings.AdminSettings.index', ['section' => 'server']) . '#backgroundjobs',
+                                       ],
+                               ],
+                       );
+               } else {
+                       return SetupResult::success(
+                               $this->l10n->t(
+                                       'Last background job execution ran %s.',
+                                       [$relativeTime]
+                               )
+                       );
+               }
+       }
+}
index 8a70b6b81073e59818e7c59204b53c4dd56e3a8f..653036ba1bcb561685c1c8caabd4879d54d7169d 100644 (file)
                        var afterCall = function(data, statusText, xhr) {
                                var messages = [];
                                if (xhr.status === 200 && data) {
-                                       if (data.cronErrors.length > 0) {
-                                               var listOfCronErrors = "";
-                                               data.cronErrors.forEach(function(element){
-                                                       listOfCronErrors += '<li>';
-                                                       listOfCronErrors += element.error;
-                                                       listOfCronErrors += ' ';
-                                                       listOfCronErrors += element.hint;
-                                                       listOfCronErrors += '</li>';
-                                               });
-                                               messages.push({
-                                                       msg: t('core', 'It was not possible to execute the cron job via CLI. The following technical errors have appeared:') + '<ul>' + listOfCronErrors + '</ul>',
-                                                       type: OC.SetupChecks.MESSAGE_TYPE_ERROR
-                                               })
-                                       }
-                                       if (data.cronInfo.diffInSeconds > 3600) {
-                                               messages.push({
-                                                       msg: t('core', 'Last background job execution ran {relativeTime}. Something seems wrong. {linkstart}Check the background job settings ↗{linkend}.', {relativeTime: data.cronInfo.relativeTime})
-                                                                       .replace('{linkstart}', '<a target="_blank" rel="noreferrer noopener" class="external" href="' + data.cronInfo.backgroundJobsUrl + '">')
-                                                                       .replace('{linkend}', '</a>'),
-                                                       type: OC.SetupChecks.MESSAGE_TYPE_ERROR
-                                               });
-                                       }
                                        if (!data.isFairUseOfFreePushService) {
                                                messages.push({
                                                        msg: t('core', 'This is the unsupported community build of Nextcloud. Given the size of this instance, performance, reliability and scalability cannot be guaranteed. Push notifications are limited to avoid overloading our free service. Learn more about the benefits of Nextcloud Enterprise at {linkstart}https://nextcloud.com/enterprise{linkend}.')