Only enable Zip64 if it is required to maximize compatibility (#269)

Author: maennchen

src/File.php

@@ -66,7 +66,7 @@ public function __construct(
             $this->generalPurposeBitFlag |= GeneralPurposeBitFlag::ZERO_HEADER;
         }
 
-        $this->selectVersion();
+        $this->version = $this->compressionMethod === CompressionMethod::DEFLATE ? Version::DEFLATE : Version::STORE;
     }
 
     public function cloneSimulationExecution(): self
@@ -178,25 +178,32 @@ private function forecastSize(): ?int
      */
     private function addFileHeader(): void
     {
-        $footer = $this->buildZip64ExtraBlock($this->enableZeroHeader && $this->enableZip64);
+        $forceEnableZip64 = $this->enableZeroHeader && $this->enableZip64;
+
+        $footer = $this->buildZip64ExtraBlock($forceEnableZip64);
+
+        $zip64Enabled = $footer !== '';
+
+        if($zip64Enabled) {
+            $this->version = Version::ZIP64;
+        }
 
         if ($this->generalPurposeBitFlag & GeneralPurposeBitFlag::EFS) {
             // Put the tricky entry to
             // force Linux unzip to lookup EFS flag.
             $footer .= Zs\ExtendedInformationExtraField::generate();
         }
 
-
         $data = LocalFileHeader::generate(
             versionNeededToExtract: $this->version->value,
             generalPurposeBitFlag: $this->generalPurposeBitFlag,
             compressionMethod: $this->compressionMethod,
             lastModificationDateTime: $this->lastModificationDateTime,
             crc32UncompressedData: $this->crc,
-            compressedSize: ($this->enableZip64 || $this->enableZeroHeader || $this->compressedSize > 0xFFFFFFFF)
+            compressedSize: $zip64Enabled
                 ? 0xFFFFFFFF
                 : $this->compressedSize,
-            uncompressedSize: ($this->enableZip64 || $this->enableZeroHeader || $this->uncompressedSize > 0xFFFFFFFF)
+            uncompressedSize: $zip64Enabled
                 ? 0xFFFFFFFF
                 : $this->uncompressedSize,
             fileName: $this->fileName,
@@ -235,20 +242,6 @@ private function checkEncoding(): void
         }
     }
 
-    private function selectVersion(): void
-    {
-        if ($this->enableZip64) {
-            $this->version = Version::ZIP64;
-            return;
-        }
-        if ($this->compressionMethod === CompressionMethod::DEFLATE) {
-            $this->version = Version::DEFLATE;
-            return;
-        }
-
-        $this->version = Version::STORE;
-    }
-
     private function buildZip64ExtraBlock(bool $force = false): string
     {
         $outputZip64ExtraBlock = false;
@@ -278,7 +271,7 @@ private function buildZip64ExtraBlock(bool $force = false): string
             return '';
         }
 
-        if ($this->version !== Version::ZIP64) {
+        if (!$this->enableZip64) {
             throw new OverflowException();
         }
 

test/Assertions.php

@@ -0,0 +1,49 @@
+<?php
+
+declare(strict_types=1);
+
+namespace ZipStream\Test;
+
+trait Assertions
+{
+    protected function assertFileContains(string $filePath, string $needle): void
+    {
+        $last = '';
+
+        $handle = fopen($filePath, 'r');
+        while (!feof($handle)) {
+            $line = fgets($handle, 1024);
+
+            if(str_contains($last . $line, $needle)) {
+                fclose($handle);
+                return;
+            }
+
+            $last = $line;
+        }
+
+        fclose($handle);
+
+        $this->fail("File {$filePath} must contain {$needle}");
+    }
+
+    protected function assertFileDoesNotContain(string $filePath, string $needle): void
+    {
+        $last = '';
+
+        $handle = fopen($filePath, 'r');
+        while (!feof($handle)) {
+            $line = fgets($handle, 1024);
+
+            if(str_contains($last . $line, $needle)) {
+                fclose($handle);
+
+                $this->fail("File {$filePath} must not contain {$needle}");
+            }
+
+            $last = $line;
+        }
+
+        fclose($handle);
+    }
+}

test/ZipStreamTest.php

@@ -22,11 +22,13 @@
 use ZipStream\Exception\StreamNotReadableException;
 use ZipStream\Exception\StreamNotSeekableException;
 use ZipStream\OperationMode;
+use ZipStream\PackField;
 use ZipStream\ZipStream;
 
 class ZipStreamTest extends TestCase
 {
     use Util;
+    use Assertions;
 
     public function testAddFile(): void
     {
@@ -638,6 +640,72 @@ public function testAddLargeFileWithoutZip64WithZeroHeader(): void
         );
     }
 
+    /**
+     * @group slow
+     */
+    public function testAddsZip64HeaderWhenNeeded(): void
+    {
+        [$tmp, $stream] = $this->getTmpFileStream();
+
+        $zip = new ZipStream(
+            outputStream: $stream,
+            sendHttpHeaders: false,
+            enableZip64: true,
+            defaultEnableZeroHeader: false,
+        );
+
+        $zip->addFileFromPsr7Stream(
+            fileName: 'sample.json',
+            stream: new EndlessCycleStream('0'),
+            maxSize: 0x100000000,
+            compressionMethod: CompressionMethod::STORE,
+            lastModificationDateTime: new DateTimeImmutable('2022-01-01 01:01:01Z'),
+        );
+
+        $zip->finish();
+
+        $tmpDir = $this->validateAndExtractZip($tmp);
+        $files = $this->getRecursiveFileList($tmpDir);
+
+        $this->assertSame(['sample.json'], $files);
+        $this->assertFileContains($tmp, PackField::pack(
+            new PackField(format: 'V', value: 0x06064b50)
+        ));
+    }
+
+    /**
+     * @group slow
+     */
+    public function testDoesNotAddZip64HeaderWhenNotNeeded(): void
+    {
+        [$tmp, $stream] = $this->getTmpFileStream();
+
+        $zip = new ZipStream(
+            outputStream: $stream,
+            sendHttpHeaders: false,
+            enableZip64: true,
+            defaultEnableZeroHeader: false,
+        );
+
+        $zip->addFileFromPsr7Stream(
+            fileName: 'sample.json',
+            stream: new EndlessCycleStream('0'),
+            maxSize: 0x10,
+            compressionMethod: CompressionMethod::STORE,
+            lastModificationDateTime: new DateTimeImmutable('2022-01-01 01:01:01Z'),
+        );
+
+        $zip->finish();
+
+        $tmpDir = $this->validateAndExtractZip($tmp);
+        $files = $this->getRecursiveFileList($tmpDir);
+
+        $this->assertSame(['sample.json'], $files);
+        $this->assertFileDoesNotContain($tmp, PackField::pack(
+            new PackField(format: 'V', value: 0x06064b50)
+        ));
+    }
+
     /**
      * @group slow
      */