improve restoring process with test & better confirmation step

Signed-off-by: Maxence Lange <maxence@artificial-owl.com>

Author: ArtificialOwl

lib/Command/PointRestore.php

@@ -46,6 +46,7 @@
 use OCA\Backup\Exceptions\RestoringPointNotInitiatedException;
 use OCA\Backup\Exceptions\SqlDumpException;
 use OCA\Backup\Exceptions\SqlImportException;
+use OCA\Backup\Exceptions\SqlParamsException;
 use OCA\Backup\ISqlDump;
 use OCA\Backup\Model\ChangedFile;
 use OCA\Backup\Model\RestoringData;
@@ -147,6 +148,8 @@ protected function configure() {
 			 ->setDescription('Restore a restoring point')
 			 ->addArgument('pointId', InputArgument::REQUIRED, 'Id of the restoring point')
 			 ->addOption('force', '', InputOption::VALUE_NONE, 'Force the restoring process')
+			 ->addOption('do-not-ask-data', '', InputOption::VALUE_NONE, 'Do not ask for path on data')
+			 ->addOption('do-not-ask-sql', '', InputOption::VALUE_NONE, 'Do not ask for params on sqldump')
 			 ->addOption('file', '', InputOption::VALUE_REQUIRED, 'restore only a specific file')
 			 ->addOption('chunk', '', InputOption::VALUE_REQUIRED, 'location of the file')
 			 ->addOption('data', '', InputOption::VALUE_REQUIRED, 'location of the file');
@@ -261,8 +264,6 @@ protected function execute(InputInterface $input, OutputInterface $output): int
 		$output->writeln('> <info>maintenance mode</info> disabled');
 		$this->restoreService->finalizeFullRestore();
 
-//		$this->configService->maintenanceMode(false);
-
 		$this->activityService->newActivity(
 			ActivityService::RESTORE,
 			[
@@ -291,7 +292,7 @@ public function restorePointComplete(RestoringPoint $point): void {
 			$this->output->writeln(' > Found data pack: <info>' . $data->getName() . '</info>');
 
 			if ($data->getType() === RestoringData::INTERNAL_DATA) {
-				$this->output->writeln('  * ignoring');
+				$this->output->writeln('   * ignoring');
 				continue;
 			}
 
@@ -312,7 +313,13 @@ public function restorePointComplete(RestoringPoint $point): void {
 	 * @throws RestoringPointNotInitiatedException
 	 */
 	private function restorePointData(RestoringPoint $point, RestoringData $data): void {
-		$root = $this->requestDataRoot($data);
+		try {
+			$root = $this->requestDataRoot($data);
+		} catch (RestoringDataNotFoundException $e) {
+			$this->output->writeln('   * ignoring data pack');
+
+			return;
+		}
 
 		$this->output->writeln('   > extracting data to <info>' . $root . '</info>');
 		foreach ($data->getChunks() as $chunk) {
@@ -345,16 +352,29 @@ private function restorePointData(RestoringPoint $point, RestoringData $data): v
 	 * @throws SqlDumpException
 	 */
 	private function restorePointSqlDump(RestoringPoint $point, RestoringData $data): void {
-		$sqlParams = $this->requestSqlParams();
+		while (true) {
+			try {
+				$sqlParams = $this->requestSqlParams();
+			} catch (RestoringDataNotFoundException $e) {
+				$this->output->writeln('   * ignoring sqldump');
 
-		$this->output->write(
-			'   > importing sqldump in <info>' . $this->displaySqlParams($sqlParams, true) . '</info>: '
-		);
-		try {
-			$this->importSqlDump($point, $data, $sqlParams);
-			$this->output->writeln('<info>ok</info>');
-		} catch (SqlImportException $e) {
-			$this->output->writeln('<error>' . $e->getMessage() . '</error>');
+				return;
+			}
+
+			$this->output->write(
+				'   > importing sqldump in <info>' . $this->displaySqlParams($sqlParams, true) . '</info>: '
+			);
+			try {
+				$this->importSqlDump($point, $data, $sqlParams);
+				$this->output->writeln('<info>ok</info>');
+			} catch (SqlParamsException $e) {
+				$this->output->writeln('<error>' . $e->getMessage() . '</error>');
+				continue;
+			} catch (SqlImportException $e) {
+				$this->output->writeln('<error>' . $e->getMessage() . '</error>');
+			}
+
+			break;
 		}
 
 		$data->setRestoredRoot(json_encode($sqlParams));
@@ -365,18 +385,37 @@ private function restorePointSqlDump(RestoringPoint $point, RestoringData $data)
 	 * @param RestoringData $data
 	 *
 	 * @return string
+	 * @throws RestoringDataNotFoundException
 	 */
 	private function requestDataRoot(RestoringData $data): string {
 		$root = $data->getAbsolutePath();
+		if ($this->input->getOption('do-not-ask-data')) {
+			return $root;
+		}
+
 		while (true) {
 			$this->output->writeln('   > will be extracted in <info>' . $root . '</info>');
 			$helper = $this->getHelper('question');
 			$question = new Question(
-				'    - <comment>enter a new absolute path</comment> or press \'<info>enter</info>\' to use this location: ',
-				$root
+				'    - <comment>enter a new absolute path</comment>, or type <info>yes</info> to confirm '
+				. 'this location or <info>no</info> to ignore this part of the backup: ',
+				''
 			);
-			$question->setAutocompleterValues([$data->getAbsolutePath()]);
+			$question->setAutocompleterValues([$data->getAbsolutePath(), 'yes', 'no']);
 			$newRoot = trim($helper->ask($this->input, $this->output, $question));
+
+			if ($newRoot === '') {
+				continue;
+			}
+
+			if ($newRoot === 'yes') {
+				break;
+			}
+
+			if ($newRoot === 'no') {
+				throw new  RestoringDataNotFoundException('ignoring');
+			}
+
 			$newRoot = rtrim($newRoot, '/') . '/';
 			if ($newRoot === $root) {
 				break;
@@ -391,38 +430,51 @@ private function requestDataRoot(RestoringData $data): string {
 
 	/**
 	 * @return array
+	 * @throws RestoringDataNotFoundException
 	 */
 	private function requestSqlParams(): array {
 		$sqlParams = $this->pointService->getSqlParams();
+		if ($this->input->getOption('do-not-ask-sql')) {
+			return $sqlParams;
+		}
 
 		while (true) {
 			$this->output->writeln('   > will be imported in ' . $this->displaySqlParams($sqlParams, true));
 
 			$helper = $this->getHelper('question');
-			$question = new ConfirmationQuestion(
-				'<comment>    - Do you want to import the dump in another SQL server or database ?</comment> (y/N) ',
-				false,
-				'/^(y|Y)/i'
+			$question = new Question(
+				'<comment>    - Do you want to import the dump in the current database, or cancel the import ?</comment> (yes/No/cancel) ',
+				'no',
 			);
+			$question->setAutocompleterValues(['cancel', 'yes', 'no']);
 
-			if (!$helper->ask($this->input, $this->output, $question)) {
-				return $sqlParams;
+			switch (strtolower($helper->ask($this->input, $this->output, $question))) {
+				case 'yes':
+					return $sqlParams;
+				case 'cancel':
+					throw new RestoringDataNotFoundException();
 			}
 
 			$this->output->writeln('    - current configuration:');
 			$this->displaySqlParams($sqlParams);
 
-			$this->output->writeln('    - edit configuration:');
+			$this->output->writeln('    - edit configuration:  (enter \'.\' to skip this step)');
 			while (true) {
 				$question = new Question('      . Host: ', '');
 				$newHost = trim($helper->ask($this->input, $this->output, $question));
 				if ($newHost !== '') {
 					break;
 				}
 			}
+			if ($newHost === '.') {
+				continue;
+			}
 
 			$question = new Question('      . Port: ', '');
 			$newPort = trim($helper->ask($this->input, $this->output, $question));
+			if ($newPort === '.') {
+				continue;
+			}
 
 			while (true) {
 				$question = new Question('      . Database: ', '');
@@ -431,6 +483,9 @@ private function requestSqlParams(): array {
 					break;
 				}
 			}
+			if ($newName === '.') {
+				continue;
+			}
 
 			while (true) {
 				$question = new Question('      . Username: ', '');
@@ -439,6 +494,9 @@ private function requestSqlParams(): array {
 					break;
 				}
 			}
+			if ($newUser === '.') {
+				continue;
+			}
 
 			while (true) {
 				$question = new Question('      . Password: ', '');
@@ -448,6 +506,9 @@ private function requestSqlParams(): array {
 					break;
 				}
 			}
+			if ($newPass === '.') {
+				continue;
+			}
 
 			$newParams = [
 				ISqlDump::DB_NAME => $newName,
@@ -483,14 +544,28 @@ private function updateConfig(RestoringPoint $point): void {
 		$dataRoot = $configRoot = '';
 		foreach ($point->getRestoringData() as $data) {
 			if ($data->getType() === RestoringData::ROOT_DATA) {
+				if ($data->getRestoredRoot() === '') {
+					continue;
+				}
 				$dataRoot = $data->getRestoredRoot();
 			}
 
 			if ($data->getType() === RestoringData::FILE_CONFIG) {
+				if ($data->getRestoredRoot() === '') {
+					$this->output->writeln(
+						'  * do not refresh as <info>config/config.php</info> were not restored'
+					);
+					$this->configService->maintenanceMode(false);
+
+					return;
+				}
 				$configRoot = $data->getRestoredRoot();
 			}
 
 			if ($data->getType() === RestoringData::FILE_SQL_DUMP) {
+				if ($data->getRestoredRoot() === '') {
+					continue;
+				}
 				$sqlParams = json_decode($data->getRestoredRoot(), true);
 				if (!is_array($sqlParams)) {
 					$sqlParams = [];
@@ -502,17 +577,23 @@ private function updateConfig(RestoringPoint $point): void {
 		$configFile = rtrim($configRoot, '/') . '/config.php';
 		include $configFile;
 
-		$this->compareConfigDataRoot($CONFIG, $dataRoot);
-		$this->compareConfigSqlParams($sqlParams, $CONFIG, ISqlDump::DB_HOST);
-		$this->compareConfigSqlParams($sqlParams, $CONFIG, ISqlDump::DB_PORT);
-		$this->compareConfigSqlParams($sqlParams, $CONFIG, ISqlDump::DB_NAME);
-		$this->compareConfigSqlParams($sqlParams, $CONFIG, ISqlDump::DB_USER);
-		$this->compareConfigSqlParams($sqlParams, $CONFIG, ISqlDump::DB_PASS);
+		if ($dataRoot !== '') {
+			$this->compareConfigDataRoot($CONFIG, $dataRoot);
+		}
+		if (!empty($sqlParams)) {
+			$this->compareConfigSqlParams($sqlParams, $CONFIG, ISqlDump::DB_HOST);
+			$this->compareConfigSqlParams($sqlParams, $CONFIG, ISqlDump::DB_PORT);
+			$this->compareConfigSqlParams($sqlParams, $CONFIG, ISqlDump::DB_NAME);
+			$this->compareConfigSqlParams($sqlParams, $CONFIG, ISqlDump::DB_USER);
+			$this->compareConfigSqlParams($sqlParams, $CONFIG, ISqlDump::DB_PASS);
+		}
 
 		$CONFIG['maintenance'] = false;
 		$this->output->writeln('  > Updating <info>config.php</info>');
 		$this->output->writeln('');
-		file_put_contents($configFile, '<?php' . "\n" . '$CONFIG = ' . var_export($CONFIG, true) . ';' . "\n");
+		file_put_contents(
+			$configFile, '<?php' . "\n" . '$CONFIG = ' . var_export($CONFIG, true) . ';' . "\n"
+		);
 	}
 
 
@@ -593,6 +674,7 @@ private function compareConfigSqlParams(array $sqlParams, array &$CONFIG, string
 	 *
 	 * @throws SqlDumpException
 	 * @throws SqlImportException
+	 * @throws SqlParamsException
 	 */
 	private function importSqlDump(RestoringPoint $point, RestoringData $data, array $sqlParams): void {
 		$chunks = $data->getChunks();
@@ -617,6 +699,8 @@ private function importSqlDump(RestoringPoint $point, RestoringData $data, array
 
 //		$config = $this->extractDatabaseConfig();
 		$sqlDump = $this->pointService->getSqlDump();
+		$sqlDump->setup($sqlParams);
+
 		$sqlDump->import($sqlParams, $read);
 	}
 

lib/Exceptions/SqlParamsException.php

@@ -0,0 +1,42 @@
+<?php
+
+declare(strict_types=1);
+
+
+/**
+ * Nextcloud - Backup now. Restore later.
+ *
+ * This file is licensed under the Affero General Public License version 3 or
+ * later. See the COPYING file.
+ *
+ * @author Maxence Lange <maxence@artificial-owl.com>
+ * @copyright 2021, Maxence Lange <maxence@artificial-owl.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\Backup\Exceptions;
+
+use Exception;
+
+/**
+ * Class SqlParamsException
+ *
+ * @package OCA\Backup\Exceptions
+ */
+class SqlParamsException extends Exception {
+}

lib/ISqlDump.php

@@ -31,6 +31,8 @@
 
 namespace OCA\Backup;
 
+use OCA\Backup\Exceptions\SqlParamsException;
+
 interface ISqlDump {
 	public const MYSQL = 'mysql';
 	public const PGSQL = 'pgsql';
@@ -44,19 +46,25 @@ interface ISqlDump {
 
 
 	/**
-	 * @param array $data
+	 * @param array $params
 	 * @param string $filename
+	 */
+	public function export(array $params, string $filename): void;
+
+
+	/**
+	 * @param array $params
 	 *
-	 * @return string
+	 * @throws SqlParamsException
 	 */
-	public function export(array $data, string $filename): void;
+	public function setup(array $params): void;
 
 
 	/**
-	 * @param array $data
+	 * @param array $params
 	 * @param resource $read
 	 *
 	 * @return bool
 	 */
-	public function import(array $data, $read): bool;
+	public function import(array $params, $read): bool;
 }