fixup! feat: improve ZipFolderPlugin behaviour for different cases

Signed-off-by: Salvatore Martire <4652631+salmart-dev@users.noreply.github.com>

Author: salmart-dev

apps/dav/composer/composer/autoload_classmap.php

@@ -216,7 +216,6 @@
     'OCA\\DAV\\Connector\\Sabre\\Auth' => $baseDir . '/../lib/Connector/Sabre/Auth.php',
     'OCA\\DAV\\Connector\\Sabre\\BearerAuth' => $baseDir . '/../lib/Connector/Sabre/BearerAuth.php',
     'OCA\\DAV\\Connector\\Sabre\\BlockLegacyClientPlugin' => $baseDir . '/../lib/Connector/Sabre/BlockLegacyClientPlugin.php',
-    'OCA\\DAV\\Connector\\Sabre\\ByteCounterFilter' => $baseDir . '/../lib/Connector/Sabre/ByteCounterFilter.php',
     'OCA\\DAV\\Connector\\Sabre\\CachingTree' => $baseDir . '/../lib/Connector/Sabre/CachingTree.php',
     'OCA\\DAV\\Connector\\Sabre\\ChecksumList' => $baseDir . '/../lib/Connector/Sabre/ChecksumList.php',
     'OCA\\DAV\\Connector\\Sabre\\ChecksumUpdatePlugin' => $baseDir . '/../lib/Connector/Sabre/ChecksumUpdatePlugin.php',

apps/dav/composer/composer/autoload_static.php

@@ -231,7 +231,6 @@ class ComposerStaticInitDAV
         'OCA\\DAV\\Connector\\Sabre\\Auth' => __DIR__ . '/..' . '/../lib/Connector/Sabre/Auth.php',
         'OCA\\DAV\\Connector\\Sabre\\BearerAuth' => __DIR__ . '/..' . '/../lib/Connector/Sabre/BearerAuth.php',
         'OCA\\DAV\\Connector\\Sabre\\BlockLegacyClientPlugin' => __DIR__ . '/..' . '/../lib/Connector/Sabre/BlockLegacyClientPlugin.php',
-        'OCA\\DAV\\Connector\\Sabre\\ByteCounterFilter' => __DIR__ . '/..' . '/../lib/Connector/Sabre/ByteCounterFilter.php',
         'OCA\\DAV\\Connector\\Sabre\\CachingTree' => __DIR__ . '/..' . '/../lib/Connector/Sabre/CachingTree.php',
         'OCA\\DAV\\Connector\\Sabre\\ChecksumList' => __DIR__ . '/..' . '/../lib/Connector/Sabre/ChecksumList.php',
         'OCA\\DAV\\Connector\\Sabre\\ChecksumUpdatePlugin' => __DIR__ . '/..' . '/../lib/Connector/Sabre/ChecksumUpdatePlugin.php',

apps/dav/lib/Connector/Sabre/ByteCounterFilter.php

@@ -8,16 +8,19 @@
  */
 namespace OCA\DAV\Connector\Sabre;
 
+use Icewind\Streams\CountWrapper;
 use OC\Streamer;
 use OCA\DAV\Connector\Sabre\Exception\Forbidden;
 use OCP\EventDispatcher\IEventDispatcher;
 use OCP\Files\Events\BeforeZipCreatedEvent;
 use OCP\Files\File as NcFile;
 use OCP\Files\Folder as NcFolder;
 use OCP\Files\Node as NcNode;
+use OCP\Files\NotPermittedException;
 use OCP\IConfig;
 use OCP\IDateTimeZone;
 use OCP\IL10N;
+use OCP\Lock\LockedException;
 use Psr\Log\LoggerInterface;
 use Sabre\DAV\Server;
 use Sabre\DAV\ServerPlugin;
@@ -57,10 +60,6 @@ public function __construct(
 		private IL10N $l10n,
 	) {
 		$this->reportMissingFiles = $this->config->getSystemValueBool('archive_report_missing_files', false);
-
-		if ($this->reportMissingFiles) {
-			stream_filter_register('count.bytes', ByteCounterFilter::class);
-		}
 	}
 
 	/**
@@ -81,6 +80,7 @@ public function initialize(Server $server): void {
 	/**
 	 * Adding a node to the archive streamer.
 	 * @return ?string an error message if an error occurred and reporting is enabled, null otherwise
+	 * @throws NotPermittedException|LockedException
 	 */
 	protected function streamNode(Streamer $streamer, NcNode $node, string $rootPath): ?string {
 		// Remove the root path from the filename to make it relative to the requested folder
@@ -94,39 +94,27 @@ protected function streamNode(Streamer $streamer, NcNode $node, string $rootPath
 
 		if ($node instanceof NcFile) {
 			$nodeSize = $node->getSize();
-			try {
-				$stream = $node->fopen('rb');
-			} catch (\Exception $e) {
-				// opening failed, log the failure as reason for the missing file
-				if ($this->reportMissingFiles) {
-					$exceptionClass = get_class($e);
-					return $this->l10n->t('Error while opening the file: %s', [$exceptionClass]);
-				}
+			$stream = $node->fopen('rb');
 
-				throw $e;
+			if ($stream === false) {
+				return $this->l10n->t('File could not be opened (fopen). Please check the server logs for more information.');
 			}
 
-			if ($this->reportMissingFiles) {
-				if ($stream === false) {
-					return $this->l10n->t('File could not be opened (fopen). Please check the server logs for more information.');
-				}
+			$read = 0;
+			$stream = CountWrapper::wrap($stream, function (int $written) use (&$read) {
+				return $read += $written;
+			});
 
-				$byteCounter = new StreamByteCounter();
-				$wrapped = stream_filter_append($stream, 'count.bytes', STREAM_FILTER_READ, ['counter' => $byteCounter]);
-				if ($wrapped === false) {
-					return $this->l10n->t('Unable to check file for consistency check');
-				}
+			if ($stream === false) {
+				return $this->l10n->t('Unable to check file for consistency check');
 			}
 
 			$fileAddedToStream = $streamer->addFileFromStream($stream, $filename, $nodeSize, $mtime);
-			if ($this->reportMissingFiles) {
-				if (!$fileAddedToStream) {
-					return $this->l10n->t('The archive was already finalized');
-				}
-
-				return $this->logStreamErrors($stream, $filename, $nodeSize, $byteCounter->bytes);
+			if (!$fileAddedToStream) {
+				return $this->l10n->t('The archive was already finalized');
 			}
 
+			return $this->logStreamErrors($stream, $filename, $nodeSize, $read);
 		}
 
 		return null;
@@ -259,7 +247,20 @@ public function handleDownload(Request $request, Response $response): ?false {
 				continue;
 			}
 
-			$streamError = $this->streamNode($streamer, $node, $rootPath);
+			try {
+				$streamError = $this->streamNode($streamer, $node, $rootPath);
+			} catch (\Exception $e) {
+				if (!$this->reportMissingFiles) {
+					throw $e;
+				}
+
+				$logMessage = $this->l10n->t('Error while streaming the file');
+				$this->logger->error($logMessage, ['exception' => $e]);
+				$reason = $this->l10n->t('File could not be added to the archive. Please check the server logs for more information.');
+				$this->missingInfo[$filename] = $reason;
+				continue;
+			}
+
 			if ($this->reportMissingFiles && $streamError !== null) {
 				$this->missingInfo[$filename] = $streamError;
 			}

apps/dav/lib/Connector/Sabre/ZipFolderPlugin.php

@@ -153,7 +153,7 @@ public static function dataDownloadingAFolderWithMissingFilesReportingShouldSucc
 				'children' => ['allowed.txt' => 'allowed', 'blocked.txt' => 'blocked', 'error.txt' => new \RuntimeException('read error')],
 				'filesFilter' => [],
 				'downloadBlocked' => [ 'blocked.txt' ],
-				'expectedMissingFiles' => [ 'blocked.txt' => 'blocked', 'error.txt' => 'Error while opening the file: RuntimeException' ],
+				'expectedMissingFiles' => [ 'blocked.txt' => 'blocked', 'error.txt' => 'File could not be added to the archive. Please check the server logs for more information.' ],
 			],
 			// files filtered out should not be reported as missing
 			'filtering some files' => [