* @author Christoph Wurst * @author Cthulhux * @author Daniel Kesselberg * @author Derek * @author Georg Ehrke * @author J0WI * @author Joas Schilling * @author Julius Härtl * @author Ko- * @author Lauris Binde * @author Lukas Reschke * @author Michael Weimann * @author Morris Jobke * @author nhirokinet * @author Robin Appelman * @author Robin McCorkell * @author Roeland Jago Douma * @author Sven Strickroth * @author Sylvia van Os * @author timm2k * @author Timo Förster * @author Valdnet <47037905+Valdnet@users.noreply.github.com> * @author MichaIng * @author Kate Döen * * @license AGPL-3.0 * * This code is free software: you can redistribute it and/or modify * it under the terms of the GNU Affero General Public License, version 3, * as published by the Free Software Foundation. * * 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, version 3, * along with this program. If not, see * */ namespace OCA\Settings\Controller; use OC\AppFramework\Http; use OC\IntegrityCheck\Checker; use OCP\AppFramework\Controller; use OCP\AppFramework\Http\Attribute\OpenAPI; use OCP\AppFramework\Http\DataDisplayResponse; use OCP\AppFramework\Http\DataResponse; use OCP\AppFramework\Http\RedirectResponse; use OCP\IConfig; use OCP\IL10N; use OCP\IRequest; use OCP\IURLGenerator; use OCP\SetupCheck\ISetupCheckManager; use Psr\Log\LoggerInterface; #[OpenAPI(scope: OpenAPI::SCOPE_IGNORE)] class CheckSetupController extends Controller { /** @var IConfig */ private $config; /** @var IURLGenerator */ private $urlGenerator; /** @var IL10N */ private $l10n; /** @var Checker */ private $checker; /** @var LoggerInterface */ private $logger; private ISetupCheckManager $setupCheckManager; public function __construct($AppName, IRequest $request, IConfig $config, IURLGenerator $urlGenerator, IL10N $l10n, Checker $checker, LoggerInterface $logger, ISetupCheckManager $setupCheckManager, ) { parent::__construct($AppName, $request); $this->config = $config; $this->urlGenerator = $urlGenerator; $this->l10n = $l10n; $this->checker = $checker; $this->logger = $logger; $this->setupCheckManager = $setupCheckManager; } /** * @NoAdminRequired * @NoCSRFRequired * @return DataResponse */ public function setupCheckManager(): DataResponse { return new DataResponse($this->setupCheckManager->runAll()); } /** * @NoCSRFRequired * @return RedirectResponse * @AuthorizedAdminSetting(settings=OCA\Settings\Settings\Admin\Overview) */ public function rescanFailedIntegrityCheck(): RedirectResponse { $this->checker->runInstanceVerification(); return new RedirectResponse( $this->urlGenerator->linkToRoute('settings.AdminSettings.index', ['section' => 'overview']) ); } /** * @NoCSRFRequired * @AuthorizedAdminSetting(settings=OCA\Settings\Settings\Admin\Overview) */ public function getFailedIntegrityCheckFiles(): DataDisplayResponse { if (!$this->checker->isCodeCheckEnforced()) { return new DataDisplayResponse('Integrity checker has been disabled. Integrity cannot be verified.'); } $completeResults = $this->checker->getResults(); if ($completeResults === null) { return new DataDisplayResponse('Integrity checker has not been run. Integrity information not available.'); } if (!empty($completeResults)) { $formattedTextResponse = 'Technical information ===================== The following list covers which files have failed the integrity check. Please read the previous linked documentation to learn more about the errors and how to fix them. Results ======= '; foreach ($completeResults as $context => $contextResult) { $formattedTextResponse .= "- $context\n"; foreach ($contextResult as $category => $result) { $formattedTextResponse .= "\t- $category\n"; if ($category !== 'EXCEPTION') { foreach ($result as $key => $results) { $formattedTextResponse .= "\t\t- $key\n"; } } else { foreach ($result as $key => $results) { $formattedTextResponse .= "\t\t- $results\n"; } } } } $formattedTextResponse .= ' Raw output ========== '; $formattedTextResponse .= print_r($completeResults, true); } else { $formattedTextResponse = 'No errors have been found.'; } return new DataDisplayResponse( $formattedTextResponse, Http::STATUS_OK, [ 'Content-Type' => 'text/plain', ] ); } /** * @return DataResponse * @AuthorizedAdminSetting(settings=OCA\Settings\Settings\Admin\Overview) */ public function check() { return new DataResponse( [ 'generic' => $this->setupCheckManager->runAll(), ] ); } }