Application.php 7.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235
  1. <?php
  2. /**
  3. * @copyright Copyright (c) 2016, ownCloud, Inc.
  4. *
  5. * @author Christoph Wurst <christoph@winzerhof-wurst.at>
  6. * @author Joas Schilling <coding@schilljs.com>
  7. * @author Jörn Friedrich Dreyer <jfd@butonic.de>
  8. * @author Lukas Reschke <lukas@statuscode.ch>
  9. * @author Michael Weimann <mail@michael-weimann.eu>
  10. * @author Morris Jobke <hey@morrisjobke.de>
  11. * @author Robin Appelman <robin@icewind.nl>
  12. * @author Roeland Jago Douma <roeland@famdouma.nl>
  13. * @author Thomas Müller <thomas.mueller@tmit.eu>
  14. * @author Victor Dubiniuk <dubiniuk@owncloud.com>
  15. *
  16. * @license AGPL-3.0
  17. *
  18. * This code is free software: you can redistribute it and/or modify
  19. * it under the terms of the GNU Affero General Public License, version 3,
  20. * as published by the Free Software Foundation.
  21. *
  22. * This program is distributed in the hope that it will be useful,
  23. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  24. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  25. * GNU Affero General Public License for more details.
  26. *
  27. * You should have received a copy of the GNU Affero General Public License, version 3,
  28. * along with this program. If not, see <http://www.gnu.org/licenses/>
  29. *
  30. */
  31. namespace OC\Console;
  32. use OC\MemoryInfo;
  33. use OC\NeedsUpdateException;
  34. use OC_App;
  35. use OCP\App\IAppManager;
  36. use OCP\Console\ConsoleEvent;
  37. use OCP\EventDispatcher\IEventDispatcher;
  38. use OCP\IConfig;
  39. use OCP\IRequest;
  40. use Psr\Container\ContainerExceptionInterface;
  41. use Psr\Log\LoggerInterface;
  42. use Symfony\Component\Console\Application as SymfonyApplication;
  43. use Symfony\Component\Console\Input\InputInterface;
  44. use Symfony\Component\Console\Input\InputOption;
  45. use Symfony\Component\Console\Output\ConsoleOutputInterface;
  46. use Symfony\Component\Console\Output\OutputInterface;
  47. class Application {
  48. private IConfig $config;
  49. private SymfonyApplication $application;
  50. private IEventDispatcher $dispatcher;
  51. private IRequest $request;
  52. private LoggerInterface $logger;
  53. private MemoryInfo $memoryInfo;
  54. public function __construct(IConfig $config,
  55. IEventDispatcher $dispatcher,
  56. IRequest $request,
  57. LoggerInterface $logger,
  58. MemoryInfo $memoryInfo) {
  59. $defaults = \OC::$server->get('ThemingDefaults');
  60. $this->config = $config;
  61. $this->application = new SymfonyApplication($defaults->getName(), \OC_Util::getVersionString());
  62. $this->dispatcher = $dispatcher;
  63. $this->request = $request;
  64. $this->logger = $logger;
  65. $this->memoryInfo = $memoryInfo;
  66. }
  67. /**
  68. * @throws \Exception
  69. */
  70. public function loadCommands(
  71. InputInterface $input,
  72. ConsoleOutputInterface $output
  73. ) {
  74. // $application is required to be defined in the register_command scripts
  75. $application = $this->application;
  76. $inputDefinition = $application->getDefinition();
  77. $inputDefinition->addOption(
  78. new InputOption(
  79. 'no-warnings',
  80. null,
  81. InputOption::VALUE_NONE,
  82. 'Skip global warnings, show command output only',
  83. null
  84. )
  85. );
  86. try {
  87. $input->bind($inputDefinition);
  88. } catch (\RuntimeException $e) {
  89. //expected if there are extra options
  90. }
  91. if ($input->getOption('no-warnings')) {
  92. $output->setVerbosity(OutputInterface::VERBOSITY_QUIET);
  93. }
  94. if ($this->memoryInfo->isMemoryLimitSufficient() === false) {
  95. $output->getErrorOutput()->writeln(
  96. '<comment>The current PHP memory limit ' .
  97. 'is below the recommended value of 512MB.</comment>'
  98. );
  99. }
  100. try {
  101. require_once __DIR__ . '/../../../core/register_command.php';
  102. if ($this->config->getSystemValueBool('installed', false)) {
  103. if (\OCP\Util::needUpgrade()) {
  104. throw new NeedsUpdateException();
  105. } elseif ($this->config->getSystemValueBool('maintenance')) {
  106. $this->writeMaintenanceModeInfo($input, $output);
  107. } else {
  108. OC_App::loadApps();
  109. $appManager = \OCP\Server::get(IAppManager::class);
  110. foreach ($appManager->getInstalledApps() as $app) {
  111. $appPath = \OC_App::getAppPath($app);
  112. if ($appPath === false) {
  113. continue;
  114. }
  115. // load commands using info.xml
  116. $info = $appManager->getAppInfo($app);
  117. if (isset($info['commands'])) {
  118. try {
  119. $this->loadCommandsFromInfoXml($info['commands']);
  120. } catch (\Throwable $e) {
  121. $output->writeln("<error>" . $e->getMessage() . "</error>");
  122. $this->logger->error($e->getMessage(), [
  123. 'exception' => $e,
  124. ]);
  125. }
  126. }
  127. // load from register_command.php
  128. \OC_App::registerAutoloading($app, $appPath);
  129. $file = $appPath . '/appinfo/register_command.php';
  130. if (file_exists($file)) {
  131. try {
  132. require $file;
  133. } catch (\Exception $e) {
  134. $this->logger->error($e->getMessage(), [
  135. 'exception' => $e,
  136. ]);
  137. }
  138. }
  139. }
  140. }
  141. } elseif ($input->getArgument('command') !== '_completion' && $input->getArgument('command') !== 'maintenance:install') {
  142. $errorOutput = $output->getErrorOutput();
  143. $errorOutput->writeln("Nextcloud is not installed - only a limited number of commands are available");
  144. }
  145. } catch (NeedsUpdateException $e) {
  146. if ($input->getArgument('command') !== '_completion') {
  147. $errorOutput = $output->getErrorOutput();
  148. $errorOutput->writeln("Nextcloud or one of the apps require upgrade - only a limited number of commands are available");
  149. $errorOutput->writeln("You may use your browser or the occ upgrade command to do the upgrade");
  150. }
  151. }
  152. if ($input->getFirstArgument() !== 'check') {
  153. $errors = \OC_Util::checkServer(\OC::$server->getSystemConfig());
  154. if (!empty($errors)) {
  155. foreach ($errors as $error) {
  156. $output->writeln((string)$error['error']);
  157. $output->writeln((string)$error['hint']);
  158. $output->writeln('');
  159. }
  160. throw new \Exception("Environment not properly prepared.");
  161. }
  162. }
  163. }
  164. /**
  165. * Write a maintenance mode info.
  166. * The commands "_completion" and "maintenance:mode" are excluded.
  167. *
  168. * @param InputInterface $input The input implementation for reading inputs.
  169. * @param ConsoleOutputInterface $output The output implementation
  170. * for writing outputs.
  171. * @return void
  172. */
  173. private function writeMaintenanceModeInfo(InputInterface $input, ConsoleOutputInterface $output): void {
  174. if ($input->getArgument('command') !== '_completion'
  175. && $input->getArgument('command') !== 'maintenance:mode'
  176. && $input->getArgument('command') !== 'status') {
  177. $errOutput = $output->getErrorOutput();
  178. $errOutput->writeln('<comment>Nextcloud is in maintenance mode, no apps are loaded.</comment>');
  179. $errOutput->writeln('<comment>Commands provided by apps are unavailable.</comment>');
  180. }
  181. }
  182. /**
  183. * Sets whether to automatically exit after a command execution or not.
  184. *
  185. * @param bool $boolean Whether to automatically exit after a command execution or not
  186. */
  187. public function setAutoExit($boolean) {
  188. $this->application->setAutoExit($boolean);
  189. }
  190. /**
  191. * @param InputInterface $input
  192. * @param OutputInterface $output
  193. * @return int
  194. * @throws \Exception
  195. */
  196. public function run(InputInterface $input = null, OutputInterface $output = null) {
  197. $event = new ConsoleEvent(
  198. ConsoleEvent::EVENT_RUN,
  199. $this->request->server['argv']
  200. );
  201. $this->dispatcher->dispatchTyped($event);
  202. $this->dispatcher->dispatch(ConsoleEvent::EVENT_RUN, $event);
  203. return $this->application->run($input, $output);
  204. }
  205. private function loadCommandsFromInfoXml($commands) {
  206. foreach ($commands as $command) {
  207. try {
  208. $c = \OCP\Server::get($command);
  209. } catch (ContainerExceptionInterface $e) {
  210. if (class_exists($command)) {
  211. try {
  212. $c = new $command();
  213. } catch (\ArgumentCountError $e2) {
  214. throw new \Exception("Failed to construct console command '$command': " . $e->getMessage(), 0, $e);
  215. }
  216. } else {
  217. throw new \Exception("Console command '$command' is unknown and could not be loaded");
  218. }
  219. }
  220. $this->application->add($c);
  221. }
  222. }
  223. }