Merge pull request #11627 from nextcloud/feature/noid/cli-remove-app

Add occ app:remove CLI command

core/Command/App/Remove.php

@@ -0,0 +1,149 @@
+<?php
+/**
+ * @copyright Copyright (c) 2018, Patrik Kernstock <info@pkern.at>
+ *
+ * @author Patrik Kernstock <info@pkern.at>
+ *
+ * @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/>
+ *
+ */
+
+namespace OC\Core\Command\App;
+
+use Throwable;
+use OC\Installer;
+use OCP\App\IAppManager;
+use OCP\ILogger;
+use Stecman\Component\Symfony\Console\BashCompletion\Completion\CompletionAwareInterface;
+use Stecman\Component\Symfony\Console\BashCompletion\CompletionContext;
+use Symfony\Component\Console\Command\Command;
+use Symfony\Component\Console\Input\InputArgument;
+use Symfony\Component\Console\Input\InputOption;
+use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Output\OutputInterface;
+
+class Remove extends Command implements CompletionAwareInterface {
+
+	/** @var IAppManager */
+	protected $manager;
+	/** @var Installer */
+	private $installer;
+	/** @var ILogger */
+	private $logger;
+
+	/**
+	 * @param IAppManager $manager
+	 * @param Installer $installer
+	 * @param ILogger $logger
+	 */
+	public function __construct(IAppManager $manager, Installer $installer, ILogger $logger) {
+		parent::__construct();
+		$this->manager = $manager;
+		$this->installer = $installer;
+		$this->logger = $logger;
+	}
+
+	protected function configure() {
+		$this
+			->setName('app:remove')
+			->setDescription('remove an app')
+			->addArgument(
+				'app-id',
+				InputArgument::REQUIRED,
+				'remove the specified app'
+			)
+			->addOption(
+				'keep-data',
+				null,
+				InputOption::VALUE_NONE,
+				'keep app data and do not remove them'
+			);
+	}
+
+	protected function execute(InputInterface $input, OutputInterface $output) {
+		$appId = $input->getArgument('app-id');
+
+		// Check if the app is installed
+		if (!\OC_App::getAppPath($appId)) {
+			$output->writeln($appId . ' is not installed');
+			return 1;
+		}
+
+		// Removing shipped apps is not possible, therefore we pre-check that
+		// before trying to remove it
+		if ($this->manager->isShipped($appId)) {
+			$output->writeln($appId . ' could not be removed as it is a shipped app');
+			return 1;
+		}
+
+		// If we want to keep the data of the app, we simply don't disable it here.
+		// App uninstall tasks are being executed when disabled. More info: PR #11627.
+		if (!$input->getOption('keep-data')) {
+			try {
+				$this->manager->disableApp($appId);
+				$output->writeln($appId . ' disabled');
+			} catch(Throwable $e) {
+				$output->writeln('<error>Error: ' . $e->getMessage() . '</error>');
+				$this->logger->logException($e, [
+					'app' => 'CLI',
+					'level' => ILogger::ERROR
+				]);
+				return 1;
+			}
+		}
+
+		// Let's try to remove the app...
+		try {
+			$result = $this->installer->removeApp($appId);
+		} catch(Throwable $e) {
+			$output->writeln('<error>Error: ' . $e->getMessage() . '</error>');
+			$this->logger->logException($e, [
+				'app' => 'CLI',
+				'level' => ILogger::ERROR
+			]);
+			return 1;
+		}
+
+		if($result === false) {
+			$output->writeln($appId . ' could not be removed');
+			return 1;
+		}
+
+		$output->writeln($appId . ' removed');
+
+		return 0;
+	}
+
+	/**
+	 * @param string $optionName
+	 * @param CompletionContext $context
+	 * @return string[]
+	 */
+	public function completeOptionValues($optionName, CompletionContext $context) {
+		return [];
+	}
+
+	/**
+	 * @param string $argumentName
+	 * @param CompletionContext $context
+	 * @return string[]
+	 */
+	public function completeArgumentValues($argumentName, CompletionContext $context) {
+		if ($argumentName === 'app-id') {
+			return \OC_App::getAllApps();
+		}
+		return [];
+	}
+}

core/register_command.php

@@ -65,6 +65,7 @@ if (\OC::$server->getConfig()->getSystemValue('installed', false)) {
 	$application->add(new OC\Core\Command\App\Install());
 	$application->add(new OC\Core\Command\App\GetPath());
 	$application->add(new OC\Core\Command\App\ListApps(\OC::$server->getAppManager()));
+	$application->add(new OC\Core\Command\App\Remove(\OC::$server->getAppManager(), \OC::$server->query(\OC\Installer::class), \OC::$server->getLogger()));
 
 	$application->add(\OC::$server->query(\OC\Core\Command\TwoFactorAuth\Cleanup::class));
 	$application->add(\OC::$server->query(\OC\Core\Command\TwoFactorAuth\Enforce::class));

lib/composer/composer/autoload_classmap.php

@@ -539,6 +539,7 @@ return array(
     'OC\\Core\\Command\\App\\GetPath' => $baseDir . '/core/Command/App/GetPath.php',
     'OC\\Core\\Command\\App\\Install' => $baseDir . '/core/Command/App/Install.php',
     'OC\\Core\\Command\\App\\ListApps' => $baseDir . '/core/Command/App/ListApps.php',
+    'OC\\Core\\Command\\App\\Remove' => $baseDir . '/core/Command/App/Remove.php',
     'OC\\Core\\Command\\Background\\Ajax' => $baseDir . '/core/Command/Background/Ajax.php',
     'OC\\Core\\Command\\Background\\Base' => $baseDir . '/core/Command/Background/Base.php',
     'OC\\Core\\Command\\Background\\Cron' => $baseDir . '/core/Command/Background/Cron.php',

lib/composer/composer/autoload_static.php

@@ -569,6 +569,7 @@ class ComposerStaticInit53792487c5a8370acc0b06b1a864ff4c
         'OC\\Core\\Command\\App\\GetPath' => __DIR__ . '/../../..' . '/core/Command/App/GetPath.php',
         'OC\\Core\\Command\\App\\Install' => __DIR__ . '/../../..' . '/core/Command/App/Install.php',
         'OC\\Core\\Command\\App\\ListApps' => __DIR__ . '/../../..' . '/core/Command/App/ListApps.php',
+        'OC\\Core\\Command\\App\\Remove' => __DIR__ . '/../../..' . '/core/Command/App/Remove.php',
         'OC\\Core\\Command\\Background\\Ajax' => __DIR__ . '/../../..' . '/core/Command/Background/Ajax.php',
         'OC\\Core\\Command\\Background\\Base' => __DIR__ . '/../../..' . '/core/Command/Background/Base.php',
         'OC\\Core\\Command\\Background\\Cron' => __DIR__ . '/../../..' . '/core/Command/Background/Cron.php',