Implement proper Zip64 estimation support

This commit is contained in:
Arno DUBOIS
2023-05-26 19:33:47 +00:00
parent 41d77394ad
commit 51a06b5cc0

View File

@@ -5,13 +5,11 @@ namespace App\Controllers;
use App\CallbackStream;
use App\Config;
use App\Support\Str;
use App\TemporaryFile;
use Psr\Http\Message\ResponseInterface;
use Slim\Psr7\Request;
use Slim\Psr7\Response;
use Symfony\Component\Finder\Finder;
use Symfony\Component\Finder\SplFileInfo;
use Symfony\Contracts\Cache\CacheInterface;
use Symfony\Contracts\Translation\TranslatorInterface;
use ZipStream\Option\Archive;
use ZipStream\Option\File;
@@ -23,7 +21,6 @@ class ZipController
/** Create a new ZipHandler object. */
public function __construct(
private Config $config,
private CacheInterface $cache,
private Finder $finder,
private TranslatorInterface $translator
) {}
@@ -44,9 +41,9 @@ class ZipController
$this->generateFileName($path)
))
->withHeader('X-Accel-Buffering', 'no');
$files = $this->finder->in($path)->files();
$response = $this->augmentHeadersWithEstimatedSize($response, $path, $files);
return $response->withBody(new CallbackStream(function () use ($path, $files) {
@@ -54,21 +51,31 @@ class ZipController
}));
}
/** Create a zip stream from a directory. */
/** Create a zip stream from a directory.
*
* @throws \ZipStream\Exception\FileNotFoundException
* @throws \ZipStream\Exception\FileNotReadableException
* @throws \ZipStream\Exception\OverflowException
*/
protected function createZip(string $path, Finder $files): void
{
$compressionMethod = $this->config->get('zip_compress') ? Method::DEFLATE() : Method::STORE();
$zipStreamOptions = new Archive();
$zipStreamOptions->setLargeFileMethod($compressionMethod);
$zipStreamOptions->setSendHttpHeaders(false);
$zipStreamOptions->setFlushOutput(true);
$zipStreamOptions->setEnableZip64(true);
$zip = new ZipStream(null, $zipStreamOptions);
$fileOption = new File();
$fileOption->setMethod($compressionMethod);
foreach ($files as $file) {
$fileOption = new File();
$fileOption->setMethod($compressionMethod);
$fileOption->setSize($file->getSize());
$creationTime = $file->getMTime();
$fileOption->setTime(new \DateTime("@$creationTime"));
$zip->addFileFromPath($this->stripPath($file, $path), (string) $file->getRealPath(), $fileOption);
}
@@ -77,16 +84,71 @@ class ZipController
protected function augmentHeadersWithEstimatedSize(Response $response, string $path, Finder $files): Response
{
$estimate = 22;
if (!$this->config->get('zip_compress')) {
if (! $this->config->get('zip_compress')) {
$totalSize = 0;
$filesMeta = [];
foreach ($files as $file) {
$estimate += 76 + 2 * strlen($this->stripPath($file, $path)) + $file->getSize();
$fileSize = $file->getSize();
$totalSize += $fileSize;
$filesMeta[] = [strlen($this->stripPath($file, $path)), $fileSize];
}
# If there is more than 4 GB or 2^16 files, it will be a ZIP64, changing the estimation method
if ($totalSize >= 2^32 || count($filesMeta) >= 0xFFFF) {
$estimate = $this->calculateZip64Size($filesMeta);
} else {
$estimate = $this->calculateZipSize($filesMeta);
}
$response = $response->withHeader('Content-Length', (string) $estimate);
}
return $response;
}
protected function calculateZipSize(Array $filesMeta): int
{
$estimate = 22;
foreach ($filesMeta as $fileMeta) {
$estimate += 76 + 2 * $fileMeta[0] + $fileMeta[1];
}
return $estimate;
}
protected function calculateZip64Size(Array $filesMeta): int
{
# Size of the CDR calculated by ZipStream is always 44 + 12 for signature and the size itself
$estimate = 56;
# Size of the CRD locator (always 20 according to the spec)
$estimate += 20;
foreach ($filesMeta as $fileMeta) {
# This is not different from standard Zip
$estimate += 76 + 2 * $fileMeta[0] + $fileMeta[1];
# This is where it gets funky
$zip64ExtraBlockSize = 0;
if ($fileMeta[1] >= 2^32) {
# If file size is more than 2^32, add it to the extra block
$zip64ExtraBlockSize += 16; // 8 for size + 8 for compressed size
}
# Offset
if ($estimate >= 2^32) {
$zip64ExtraBlockSize += 8; // if offset is more than 2^32, then we add it to the extra block
}
if ($zip64ExtraBlockSize != 0) {
$zip64ExtraBlockSize += 4; // 2 for header ID + 2 for the block size
}
# If the filename or path is in UTF-8, then ZipStream will add the two remaining fields with special values
if (mb_check_encoding($filesMeta[0], 'UTF-8')) {
$zip64ExtraBlockSize += 4;
}
$estimate += $zip64ExtraBlockSize;
}
return $estimate;
}
/** Return the path to a file with the preceding root path stripped. */
protected function stripPath(SplFileInfo $file, string $path): string
{