adding process progression during create,pack,unpack

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

Author: ArtificialOwl

lib/Command/PointCreate.php

@@ -38,6 +38,7 @@
 use OCA\Backup\Exceptions\BackupScriptNotFoundException;
 use OCA\Backup\Exceptions\RestoringPointException;
 use OCA\Backup\Exceptions\SqlDumpException;
+use OCA\Backup\Service\OutputService;
 use OCA\Backup\Service\PointService;
 use OCP\Files\NotFoundException;
 use OCP\Files\NotPermittedException;
@@ -57,16 +58,21 @@ class PointCreate extends Base {
 	/** @var PointService */
 	private $pointService;
 
+	/** @var OutputService */
+	private $outputService;
+
 
 	/**
 	 * PointCreate constructor.
 	 *
 	 * @param PointService $pointService
+	 * @param OutputService $outputService
 	 */
-	public function __construct(PointService $pointService) {
+	public function __construct(PointService $pointService, OutputService $outputService) {
 		parent::__construct();
 
 		$this->pointService = $pointService;
+		$this->outputService = $outputService;
 	}
 
 
@@ -98,19 +104,24 @@ protected function configure() {
 	 * @throws Throwable
 	 */
 	protected function execute(InputInterface $input, OutputInterface $output): int {
+		$o = $input->getOption('output');
+		if ($o !== 'none' && $o !== 'json') {
+			$this->outputService->setOutput($output);
+		}
+
 		$point = $this->pointService->create(!$input->getOption('incremental'));
 
-		if ($input->getOption('output') === 'none') {
+		if ($o === 'none') {
 			return 0;
 		}
 
-
-		if ($input->getOption('output') === 'json') {
+		if ($o === 'json') {
 			$output->writeln(json_encode($point, JSON_PRETTY_PRINT));
 
 			return 0;
 		}
 
+		$output->writeln('');
 		$output->writeln('Restoring Point ID: <info>' . $point->getId() . '</info>');
 
 		return 0;

lib/Command/PointPack.php

@@ -32,8 +32,10 @@
 namespace OCA\Backup\Command;
 
 use OC\Core\Command\Base;
-use OCA\Backup\Exceptions\RestoringPointPackException;
+use OCA\Backup\Exceptions\RestoringPointLockException;
 use OCA\Backup\Exceptions\RestoringPointNotFoundException;
+use OCA\Backup\Exceptions\RestoringPointPackException;
+use OCA\Backup\Service\OutputService;
 use OCA\Backup\Service\PackService;
 use OCA\Backup\Service\PointService;
 use OCP\Files\NotFoundException;
@@ -56,18 +58,27 @@ class PointPack extends Base {
 	/** @var PackService */
 	private $packService;
 
+	/** @var OutputService */
+	private $outputService;
+
 
 	/**
 	 * PointPack constructor.
 	 *
 	 * @param PointService $pointService
 	 * @param PackService $packService
+	 * @param OutputService $outputService
 	 */
-	public function __construct(PointService $pointService, PackService $packService) {
+	public function __construct(
+		PointService $pointService,
+		PackService $packService,
+		OutputService $outputService
+	) {
 		parent::__construct();
 
 		$this->pointService = $pointService;
 		$this->packService = $packService;
+		$this->outputService = $outputService;
 	}
 
 
@@ -92,10 +103,12 @@ protected function configure() {
 	 * @throws NotPermittedException
 	 * @throws RestoringPointPackException
 	 * @throws RestoringPointNotFoundException
+	 * @throws RestoringPointLockException
 	 */
 	protected function execute(InputInterface $input, OutputInterface $output): int {
 		$point = $this->pointService->getLocalRestoringPoint($input->getArgument('pointId'));
 		$this->pointService->initBaseFolder($point);
+		$this->outputService->setOutput($output);
 		$this->packService->packPoint($point, true);
 
 		return 0;

lib/Command/PointUnpack.php

@@ -34,6 +34,7 @@
 use ArtificialOwl\MySmallPhpTools\Exceptions\SignatoryException;
 use OC\Core\Command\Base;
 use OCA\Backup\Exceptions\RestoringPointNotFoundException;
+use OCA\Backup\Service\OutputService;
 use OCA\Backup\Service\PackService;
 use OCA\Backup\Service\PointService;
 use OCA\Backup\Service\RemoteStreamService;
@@ -61,24 +62,30 @@ class PointUnpack extends Base {
 	/** @var RemoteStreamService */
 	private $remoteStreamService;
 
+	/** @var OutputService */
+	private $outputService;
+
 
 	/**
 	 * PointUnpack constructor.
 	 *
 	 * @param PointService $pointService
 	 * @param PackService $packService
 	 * @param RemoteStreamService $remoteStreamService
+	 * @param OutputService $outputService
 	 */
 	public function __construct(
 		PointService $pointService,
 		PackService $packService,
-		RemoteStreamService $remoteStreamService
+		RemoteStreamService $remoteStreamService,
+		OutputService $outputService
 	) {
 		parent::__construct();
 
 		$this->pointService = $pointService;
 		$this->packService = $packService;
 		$this->remoteStreamService = $remoteStreamService;
+		$this->outputService = $outputService;
 	}
 
 
@@ -106,6 +113,7 @@ protected function configure() {
 	 * @throws Throwable
 	 */
 	protected function execute(InputInterface $input, OutputInterface $output): int {
+		$this->outputService->setOutput($output);
 		$point = $this->pointService->getLocalRestoringPoint($input->getArgument('pointId'));
 
 		$this->pointService->initBaseFolder($point);

lib/Service/ChunkService.php

@@ -80,6 +80,9 @@ class ChunkService {
 	/** @var EncryptService */
 	private $encryptService;
 
+	/** @var OutputService */
+	private $outputService;
+
 	/** @var ConfigService */
 	private $configService;
 
@@ -89,15 +92,18 @@ class ChunkService {
 	 *
 	 * @param FilesService $filesService
 	 * @param EncryptService $encryptService
+	 * @param OutputService $outputService
 	 * @param ConfigService $configService
 	 */
 	public function __construct(
 		FilesService $filesService,
 		EncryptService $encryptService,
+		OutputService $outputService,
 		ConfigService $configService
 	) {
 		$this->filesService = $filesService;
 		$this->encryptService = $encryptService;
+		$this->outputService = $outputService;
 		$this->configService = $configService;
 	}
 
@@ -115,10 +121,12 @@ public function createChunks(RestoringPoint $point): void {
 				continue;
 			}
 
+			$this->o('  * <info>' . $data->getName() . '</info>: ', false);
 			$this->filesService->initRestoringData($data);
 			if (!$data->isLocked()) {
 				$this->filesService->fillRestoringData($data, $data->getUniqueFile());
 			}
+			$this->o($data->getRoot() . $data->getPath() . ', ' . count($data->getFiles()) . ' files');
 			$data->setLocked(true);
 
 			$this->fillChunks($point, $data);
@@ -353,6 +361,7 @@ private function fillChunks(RestoringPoint $point, RestoringData $data) {
 		$files = $data->getFiles();
 		while (!empty($files)) {
 			$archive = $this->generateChunk($point, $data, $files);
+			$this->o('    - ' . $archive->getName());
 			$this->updateChecksum($point, $archive);
 
 			$data->addChunk($archive);
@@ -978,4 +987,14 @@ public function getChunkFolder(
 
 		return $folder;
 	}
+
+
+	/**
+	 * @param string $line
+	 * @param bool $ln
+	 */
+	private function o(string $line, bool $ln = true): void {
+		$this->outputService->o($line, $ln);
+	}
+
 }

lib/Service/EncryptService.php

@@ -148,6 +148,7 @@ public function decryptString(string $encrypted, string $key): string {
 	 *
 	 * @return string
 	 * @throws EncryptionKeyException
+	 * @throws PackEncryptException
 	 * @throws SodiumException
 	 */
 	public function encryptFile(string $input, string $output, string $name): string {