Merge pull request #6 from xp-framework/feature/list-without-password

Support listing entries without password

Author: thekid

src/main/php/io/archive/zip/AbstractZipReaderImpl.class.php

@@ -221,55 +221,61 @@ public function currentEntry() {
           $this->skip= $header['compressed'] + 16;
         }
 
+        $stream= new ZipFileInputStream($this, $this->position, $header['compressed']);
+
         // AES vs. traditional PKZIP cipher
         if (99 === $header['compression']) {
-          if (null === $this->password) {
-            throw new IllegalAccessException('No password set');
-          }
-
           $aes= unpack('vheader/vsize/vversion/a2vendor/cstrength/vcompression', $extra);
-          switch ($aes['strength']) {
-            case 1: $sl= 8; $dl= 16; break;
-            case 2: $sl= 12; $dl= 24; break;
-            case 3: $sl= 16; $dl= 32; break;
-            default: throw new IllegalArgumentException('Invalid AES strength '.$aes['strength']);
-          }
+          $header['compression']= $aes['compression'];
+          $is= function() use($header, $stream, $aes) {
+            if (null === $this->password) {
+              throw new IllegalAccessException('No password set');
+            }
 
-          // Verify password
-          $salt= $this->streamRead($sl);
-          $pvv= $this->streamRead(2);
-          $dk= hash_pbkdf2('sha1', $this->password->reveal(), $salt, 1000, 2 * $dl + 2, true);
-          if (0 !== substr_compare($dk, $pvv, 2 * $dl, 2)) {
-            throw new IllegalAccessException('The password did not match');
-          }
+            switch ($aes['strength']) {
+              case 1: $sl= 8; $dl= 16; break;
+              case 2: $sl= 12; $dl= 24; break;
+              case 3: $sl= 16; $dl= 32; break;
+              default: throw new IllegalArgumentException('Invalid AES strength '.$aes['strength']);
+            }
 
-          $this->skip-= $sl + 2;
-          $header['compression']= $aes['compression'];
-          $is= new AESInputStream(
-            new ZipFileInputStream($this, $this->position, $header['compressed'] - $sl - 2),
-            substr($dk, 0, $dl),
-            substr($dk, $dl, $dl)
-          );
+            // Verify password
+            $stream->seek(0);
+            $salt= $stream->read($sl);
+            $pvv= $stream->read(2);
+            $dk= hash_pbkdf2('sha1', $this->password->reveal(), $salt, 1000, 2 * $dl + 2, true);
+            if (0 !== substr_compare($dk, $pvv, 2 * $dl, 2)) {
+              throw new IllegalAccessException('The password did not match');
+            }
+
+            return new AESInputStream(
+              $stream,
+              substr($dk, 0, $dl),
+              substr($dk, $dl, $dl)
+            );
+          };
         } else if ($header['flags'] & 1) {
-          if (null === $this->password) {
-            throw new IllegalAccessException('No password set');
-          }
+          $is= function() use($header, $stream) {
+            if (null === $this->password) {
+              throw new IllegalAccessException('No password set');
+            }
 
-          // Verify password
-          $cipher= new ZipCipher();
-          $cipher->initialize(iconv(\xp::ENCODING, 'cp437', $this->password->reveal()));
-          $preamble= $cipher->decipher($this->streamRead(12));
-          if (ord($preamble[11]) !== (($header['crc'] >> 24) & 0xff)) {
-            throw new IllegalAccessException('The password did not match');
-          }
-          
-          $this->skip-= 12;
-          $is= new DecipheringInputStream(
-            new ZipFileInputStream($this, $this->position, $header['compressed'] - 12),
-            $cipher
-          );
+            // Verify password
+            $stream->seek(0);
+            $cipher= new ZipCipher();
+            $cipher->initialize(iconv(\xp::ENCODING, 'cp437', $this->password->reveal()));
+            $preamble= $cipher->decipher($stream->read(12));
+            if (ord($preamble[11]) !== (($header['crc'] >> 24) & 0xff)) {
+              throw new IllegalAccessException('The password did not match');
+            }
+
+            return new DecipheringInputStream($stream, $cipher);
+          };
         } else {
-          $is= new ZipFileInputStream($this, $this->position, $header['compressed']);
+          $is= function() use($stream) {
+            $stream->seek(0);
+            return $stream;
+          };
         }
 
         // Create ZipEntry object and return it

src/main/php/io/archive/zip/SequentialZipReaderImpl.class.php

@@ -1,7 +1,7 @@
 <?php namespace io\archive\zip;
 
 use io\streams\Seekable;
-use lang\{IllegalArgumentException, IllegalStateException};
+use lang\IllegalStateException;
 
 /** Zip archive reader that works on any input stream */
 class SequentialZipReaderImpl extends AbstractZipReaderImpl {
@@ -37,6 +37,6 @@ public function nextEntry() {
    * @param   int whence
    */
   protected function streamSeek($offset, $whence) {
-    throw new IllegalArgumentException('Stream not seekable');
+    throw new IllegalStateException('Stream not seekable');
   }
 }

src/main/php/io/archive/zip/ZipFileEntry.class.php

@@ -117,7 +117,7 @@ public function isDirectory() {
    * @return  io.streams.InputStream
    */
   public function in() {
-    return $this->compression[0]->getDecompressionStream($this->is);
+    return $this->compression[0]->getDecompressionStream(($this->is)());
   }
 
   /**

src/main/php/io/archive/zip/ZipFileInputStream.class.php

@@ -1,45 +1,55 @@
 <?php namespace io\archive\zip;
 
-use io\IOException;
-use io\streams\InputStream;
+use io\streams\{Seekable, InputStream};
 
 /**
  * Zip File input stream. Reads from the current position up until a
  * certain length.
  */
-class ZipFileInputStream implements InputStream {
-  protected 
-    $reader      = null,
-    $start       = 0,
-    $pos         = 0,
-    $length      = 0;
+class ZipFileInputStream implements InputStream, Seekable {
+  protected $reader, $start, $length;
+  protected $pos= 0;
 
   /**
    * Constructor
    *
-   * @param   io.archive.zip.AbstractZipReaderImpl reader
-   * @param   int start
-   * @param   int length
+   * @param  io.archive.zip.AbstractZipReaderImpl $reader
+   * @param  int $start
+   * @param  int $length
    */
   public function __construct(AbstractZipReaderImpl $reader, $start, $length) {
     $this->reader= $reader;
     $this->start= $start;
     $this->length= $length;
   }
 
+  /** @return int */
+  public function tell() { return $this->pos; }
+
+  /**
+   * Seek
+   *
+   * @param  int $offset
+   * @param  int $whence
+   * @return void
+   */
+  public function seek($offset, $whence= SEEK_SET) {
+    switch ($whence) {
+      case SEEK_SET: $this->pos= $offset; break;
+      case SEEK_END: $this->pos= $length + $offset; break;
+      case SEEK_CUR: $this->pos+= $offset; break;
+    }
+    $this->reader->streamPosition($this->start + $this->pos);
+  }
+
   /**
    * Read a string
    *
-   * @param   int limit default 8192
-   * @return  string
+   * @param  int $limit default 8192
+   * @return string
    */
   public function read($limit= 8192) {
-    if (0 === $this->pos) {
-      $this->reader->streamPosition($this->start);
-    } else if ($this->pos >= $this->length) {
-      throw new IOException('EOF');
-    }
-    $chunk= $this->reader->streamRead(min($limit, $this->length- $this->pos));
+    $chunk= $this->reader->streamRead(min($limit, $this->length - $this->pos));
     $l= strlen($chunk);
     $this->pos+= $l;
     $this->reader->skip-= $l;
@@ -50,6 +60,7 @@ public function read($limit= 8192) {
    * Returns the number of bytes that can be read from this stream 
    * without blocking.
    *
+   * @return int
    */
   public function available() {
     return $this->pos < $this->length ? $this->reader->streamAvailable() : 0;
@@ -58,6 +69,7 @@ public function available() {
   /**
    * Close this buffer
    *
+   * @return void
    */
   public function close() {
     // NOOP, leave underlying stream open

src/test/php/io/archive/zip/unittest/AbstractZipFileTest.class.php

@@ -1,7 +1,8 @@
 <?php namespace io\archive\zip\unittest;
 
-use io\archive\zip\{ZipArchiveReader, ZipEntry, ZipFile};
-use io\streams\Streams;
+use io\File;
+use io\archive\zip\{ZipArchiveReader, ZipEntry};
+use io\streams\{Streams, InputStream};
 use test\verify\Runtime;
 use util\Secret;
 
@@ -15,11 +16,45 @@
 abstract class AbstractZipFileTest {
 
   /** @return iterable */
-  private function passwords() {
+  protected function passwords() {
     yield ['secret'];
     yield [new Secret('secret')];
   }
 
+  /**
+   * Returns a random access input stream for a given zip file
+   *
+   * @param   string $package
+   * @param   string $name
+   * @return  io.streams.InputStream
+   */
+  protected function randomAccess($package, $name) {
+    return typeof($this)
+      ->getPackage()
+      ->getPackage($package)
+      ->getResourceAsStream($name.'.zip')
+      ->in()
+    ;
+  }
+
+  /**
+   * Returns a sequential access input stream for a given zip file
+   *
+   * @param   string $package
+   * @param   string $name
+   * @return  io.streams.InputStream
+   */
+  protected function sequentialAccess($package, $name) {
+    $resource= typeof($this)->getPackage()->getPackage($package)->getResourceAsStream($name.'.zip');
+    return newinstance(InputStream::class, [$resource], [
+      'file' => null,
+      '__construct' => function($file) { $this->file= $file->open(File::READ); },
+      'read'        => function($limit= 8192) { return $this->file->read($limit); },
+      'available'   => function() { return $this->file->eof() ? 0 : 1; },
+      'close'       => function() { $this->file->close(); },
+    ]);
+  }
+
   /**
    * Returns entry content; or NULL for directories
    *
@@ -42,12 +77,7 @@ protected function entryContent(ZipEntry $entry) {
    * @return  io.archive.zip.ZipArchiveReader
    */
   protected function archiveReaderFor($package, $name) {
-    return ZipFile::open(typeof($this)
-      ->getPackage()
-      ->getPackage($package)
-      ->getResourceAsStream($name.'.zip')
-      ->in()
-    );
+    return new ZipArchiveReader($this->randomAccess($package, $name));
   }
 
   /**

src/test/php/io/archive/zip/unittest/ZipFileContentsTest.class.php

@@ -1,15 +1,10 @@
 <?php namespace io\archive\zip\unittest;
 
 use io\archive\zip\ZipArchiveReader;
-use io\streams\Streams;
+use io\streams\InputStream;
+use lang\IllegalStateException;
 use test\{Assert, Test};
 
-/**
- * Base class for testing zip file contents
- *
- * @see   xp://net.xp_framework.unittest.io.archive.MalformedZipFileTest
- * @see   xp://net.xp_framework.unittest.io.archive.vendors.ZipFileVendorTest
- */
 abstract class ZipFileContentsTest extends AbstractZipFileTest {
 
   /**
@@ -53,9 +48,31 @@ public function twofiles() {
   }
 
   #[Test]
-  public function loadContentAfterIteration() {
-    $entries= $this->entriesIn($this->archiveReaderFor('fixtures', 'twofiles'));
+  public function load_content_after_iteration() {
+    $reader= new ZipArchiveReader($this->randomAccess('fixtures', 'twofiles'));
+    $entries= iterator_to_array($reader->entries());
+
     Assert::equals('Eins', $this->entryContent($entries[0]));
     Assert::equals('Zwei', $this->entryContent($entries[1]));
   }
+
+  #[Test]
+  public function load_content_twice_from_seekable() {
+    $reader= new ZipArchiveReader($this->randomAccess('fixtures', 'onefile'));
+    $entry= $reader->iterator()->next();
+
+    Assert::equals('World', $this->entryContent($entry));
+    Assert::equals('World', $this->entryContent($entry));
+  }
+
+  #[Test]
+  public function load_content_twice_from_unseekable() {
+    $reader= new ZipArchiveReader($this->sequentialAccess('fixtures', 'onefile'));
+    $entry= $reader->iterator()->next();
+
+    Assert::equals('World', $this->entryContent($entry));
+    Assert::throws(IllegalStateException::class, function() use($entry) {
+      $this->entryContent($entry);
+    });
+  }
 }