aboutsummaryrefslogtreecommitdiffstats
path: root/lib/private/Console/Application.php
diff options
context:
space:
mode:
Diffstat (limited to 'lib/private/Console/Application.php')
-rw-r--r--lib/private/Console/Application.php161
1 files changed, 70 insertions, 91 deletions
diff --git a/lib/private/Console/Application.php b/lib/private/Console/Application.php
index 12d54b48fa9..4cf1e0da8ca 100644
--- a/lib/private/Console/Application.php
+++ b/lib/private/Console/Application.php
@@ -1,85 +1,56 @@
<?php
+
/**
- * @copyright Copyright (c) 2016, ownCloud, Inc.
- *
- * @author Christoph Wurst <christoph@winzerhof-wurst.at>
- * @author Joas Schilling <coding@schilljs.com>
- * @author Jörn Friedrich Dreyer <jfd@butonic.de>
- * @author Lukas Reschke <lukas@statuscode.ch>
- * @author Michael Weimann <mail@michael-weimann.eu>
- * @author Morris Jobke <hey@morrisjobke.de>
- * @author Robin Appelman <robin@icewind.nl>
- * @author Roeland Jago Douma <roeland@famdouma.nl>
- * @author Thomas Müller <thomas.mueller@tmit.eu>
- * @author Victor Dubiniuk <dubiniuk@owncloud.com>
- *
- * @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 <http://www.gnu.org/licenses/>
- *
+ * SPDX-FileCopyrightText: 2016-2024 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-FileCopyrightText: 2016 ownCloud, Inc.
+ * SPDX-License-Identifier: AGPL-3.0-only
*/
namespace OC\Console;
+use ArgumentCountError;
use OC\MemoryInfo;
use OC\NeedsUpdateException;
-use OC_App;
-use OCP\AppFramework\QueryException;
+use OC\SystemConfig;
+use OCP\App\AppPathNotFoundException;
+use OCP\App\IAppManager;
use OCP\Console\ConsoleEvent;
+use OCP\Defaults;
+use OCP\EventDispatcher\IEventDispatcher;
use OCP\IConfig;
use OCP\IRequest;
+use OCP\Server;
+use OCP\ServerVersion;
+use Psr\Container\ContainerExceptionInterface;
use Psr\Log\LoggerInterface;
use Symfony\Component\Console\Application as SymfonyApplication;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Input\InputOption;
use Symfony\Component\Console\Output\ConsoleOutputInterface;
use Symfony\Component\Console\Output\OutputInterface;
-use Symfony\Component\EventDispatcher\EventDispatcherInterface;
class Application {
- /** @var IConfig */
- private $config;
- /** @var EventDispatcherInterface */
- private $dispatcher;
- /** @var IRequest */
- private $request;
- /** @var LoggerInterface */
- private $logger;
- /** @var MemoryInfo */
- private $memoryInfo;
+ private SymfonyApplication $application;
- public function __construct(IConfig $config,
- EventDispatcherInterface $dispatcher,
- IRequest $request,
- LoggerInterface $logger,
- MemoryInfo $memoryInfo) {
- $defaults = \OC::$server->getThemingDefaults();
- $this->config = $config;
- $this->application = new SymfonyApplication($defaults->getName(), \OC_Util::getVersionString());
- $this->dispatcher = $dispatcher;
- $this->request = $request;
- $this->logger = $logger;
- $this->memoryInfo = $memoryInfo;
+ public function __construct(
+ ServerVersion $serverVersion,
+ private IConfig $config,
+ private IEventDispatcher $dispatcher,
+ private IRequest $request,
+ private LoggerInterface $logger,
+ private MemoryInfo $memoryInfo,
+ private IAppManager $appManager,
+ private Defaults $defaults,
+ ) {
+ $this->application = new SymfonyApplication($defaults->getName(), $serverVersion->getVersionString());
}
/**
- * @param InputInterface $input
- * @param ConsoleOutputInterface $output
* @throws \Exception
*/
public function loadCommands(
InputInterface $input,
- ConsoleOutputInterface $output
- ) {
+ ConsoleOutputInterface $output,
+ ): void {
// $application is required to be defined in the register_command scripts
$application = $this->application;
$inputDefinition = $application->getDefinition();
@@ -103,29 +74,37 @@ class Application {
if ($this->memoryInfo->isMemoryLimitSufficient() === false) {
$output->getErrorOutput()->writeln(
- '<comment>The current PHP memory limit ' .
- 'is below the recommended value of 512MB.</comment>'
+ '<comment>The current PHP memory limit '
+ . 'is below the recommended value of 512MB.</comment>'
);
}
try {
require_once __DIR__ . '/../../../core/register_command.php';
- if ($this->config->getSystemValue('installed', false)) {
+ if ($this->config->getSystemValueBool('installed', false)) {
if (\OCP\Util::needUpgrade()) {
throw new NeedsUpdateException();
} elseif ($this->config->getSystemValueBool('maintenance')) {
$this->writeMaintenanceModeInfo($input, $output);
} else {
- OC_App::loadApps();
- foreach (\OC::$server->getAppManager()->getInstalledApps() as $app) {
- $appPath = \OC_App::getAppPath($app);
- if ($appPath === false) {
+ $this->appManager->loadApps();
+ foreach ($this->appManager->getEnabledApps() as $app) {
+ try {
+ $appPath = $this->appManager->getAppPath($app);
+ } catch (AppPathNotFoundException) {
continue;
}
// load commands using info.xml
- $info = \OC_App::getAppInfo($app);
+ $info = $this->appManager->getAppInfo($app);
if (isset($info['commands'])) {
- $this->loadCommandsFromInfoXml($info['commands']);
+ try {
+ $this->loadCommandsFromInfoXml($info['commands']);
+ } catch (\Throwable $e) {
+ $output->writeln('<error>' . $e->getMessage() . '</error>');
+ $this->logger->error($e->getMessage(), [
+ 'exception' => $e,
+ ]);
+ }
}
// load from register_command.php
\OC_App::registerAutoloading($app, $appPath);
@@ -143,25 +122,25 @@ class Application {
}
} elseif ($input->getArgument('command') !== '_completion' && $input->getArgument('command') !== 'maintenance:install') {
$errorOutput = $output->getErrorOutput();
- $errorOutput->writeln("Nextcloud is not installed - only a limited number of commands are available");
+ $errorOutput->writeln('Nextcloud is not installed - only a limited number of commands are available');
}
- } catch (NeedsUpdateException $e) {
- if ($input->getArgument('command') !== '_completion') {
+ } catch (NeedsUpdateException) {
+ if ($input->getArgument('command') !== '_completion' && $input->getArgument('command') !== 'upgrade') {
$errorOutput = $output->getErrorOutput();
- $errorOutput->writeln("Nextcloud or one of the apps require upgrade - only a limited number of commands are available");
- $errorOutput->writeln("You may use your browser or the occ upgrade command to do the upgrade");
+ $errorOutput->writeln('Nextcloud or one of the apps require upgrade - only a limited number of commands are available');
+ $errorOutput->writeln('You may use your browser or the occ upgrade command to do the upgrade');
}
}
if ($input->getFirstArgument() !== 'check') {
- $errors = \OC_Util::checkServer(\OC::$server->getSystemConfig());
+ $errors = \OC_Util::checkServer(Server::get(SystemConfig::class));
if (!empty($errors)) {
foreach ($errors as $error) {
$output->writeln((string)$error['error']);
$output->writeln((string)$error['hint']);
$output->writeln('');
}
- throw new \Exception("Environment not properly prepared.");
+ throw new \Exception('Environment not properly prepared.');
}
}
}
@@ -172,19 +151,16 @@ class Application {
*
* @param InputInterface $input The input implementation for reading inputs.
* @param ConsoleOutputInterface $output The output implementation
- * for writing outputs.
+ * for writing outputs.
* @return void
*/
- private function writeMaintenanceModeInfo(
- InputInterface $input, ConsoleOutputInterface $output
- ) {
+ private function writeMaintenanceModeInfo(InputInterface $input, ConsoleOutputInterface $output): void {
if ($input->getArgument('command') !== '_completion'
- && $input->getArgument('command') !== 'maintenance:mode') {
+ && $input->getArgument('command') !== 'maintenance:mode'
+ && $input->getArgument('command') !== 'status') {
$errOutput = $output->getErrorOutput();
- $errOutput->writeln(
- '<comment>Nextcloud is in maintenance mode, hence the database isn\'t accessible.' . PHP_EOL .
- 'Cannot perform any command except \'maintenance:mode --off\'</comment>' . PHP_EOL
- );
+ $errOutput->writeln('<comment>Nextcloud is in maintenance mode, no apps are loaded.</comment>');
+ $errOutput->writeln('<comment>Commands provided by apps are unavailable.</comment>');
}
}
@@ -193,33 +169,36 @@ class Application {
*
* @param bool $boolean Whether to automatically exit after a command execution or not
*/
- public function setAutoExit($boolean) {
+ public function setAutoExit(bool $boolean): void {
$this->application->setAutoExit($boolean);
}
/**
- * @param InputInterface $input
- * @param OutputInterface $output
* @return int
* @throws \Exception
*/
- public function run(InputInterface $input = null, OutputInterface $output = null) {
- $this->dispatcher->dispatch(ConsoleEvent::EVENT_RUN, new ConsoleEvent(
+ public function run(?InputInterface $input = null, ?OutputInterface $output = null) {
+ $event = new ConsoleEvent(
ConsoleEvent::EVENT_RUN,
$this->request->server['argv']
- ));
+ );
+ $this->dispatcher->dispatchTyped($event);
+ $this->dispatcher->dispatch(ConsoleEvent::EVENT_RUN, $event);
return $this->application->run($input, $output);
}
- private function loadCommandsFromInfoXml($commands) {
+ /**
+ * @throws \Exception
+ */
+ private function loadCommandsFromInfoXml(iterable $commands): void {
foreach ($commands as $command) {
try {
- $c = \OC::$server->query($command);
- } catch (QueryException $e) {
+ $c = Server::get($command);
+ } catch (ContainerExceptionInterface $e) {
if (class_exists($command)) {
try {
$c = new $command();
- } catch (\ArgumentCountError $e2) {
+ } catch (ArgumentCountError) {
throw new \Exception("Failed to construct console command '$command': " . $e->getMessage(), 0, $e);
}
} else {
generated by cgit v1.2.3 (git 2.39.1) at 2025-08-15 03:12:41 +0000