Implemented the ability to override the instance of ZipContainer.

ZipContainer will be cloned before writing the zip file.
Tested custom ZipWriter, ZipReader, ZipContainer and ZipFile.

tests/CustomZipFormatTest.php

@@ -0,0 +1,60 @@
+<?php
+
+namespace PhpZip\Tests;
+
+use PhpZip\Exception\ZipEntryNotFoundException;
+use PhpZip\Exception\ZipException;
+use PhpZip\Tests\Internal\Epub\EpubFile;
+
+/**
+ * Checks the ability to create own file-type class, reader, writer and container.
+ *
+ * @see http://www.epubtest.org/test-books source epub files
+ *
+ * @internal
+ *
+ * @small
+ */
+final class CustomZipFormatTest extends ZipTestCase
+{
+    /**
+     * @throws ZipException
+     */
+    public function testEpub()
+    {
+        $epubFile = new EpubFile();
+        $epubFile->openFile(__DIR__ . '/resources/Advanced-v1.0.0.epub');
+        self::assertSame($epubFile->getRootFile(), 'EPUB/package.opf');
+        self::assertSame($epubFile->getMimeType(), 'application/epub+zip');
+        $epubInfo = $epubFile->getEpubInfo();
+        self::assertSame($epubInfo->toArray(), [
+            'title' => 'Advanced Accessibility Tests: Extended Descriptions',
+            'creator' => 'DAISY Consortium Transition to EPUB 3 and DIAGRAM Standards WG',
+            'language' => 'en-US',
+            'publisher' => 'DAISY Consortium and DIAGRAM Center',
+            'description' => 'Tests for accessible extended descriptions of images in EPUBs',
+            'rights' => 'This work is licensed under a Creative Commons Attribution-Noncommercial-Share Alike (CC BY-NC-SA) license.',
+            'date' => '2019-01-03',
+            'subject' => 'extended-descriptions',
+        ]);
+        $epubFile->deleteFromName('mimetype');
+        self::assertFalse($epubFile->hasEntry('mimetype'));
+
+        try {
+            $epubFile->getMimeType();
+            self::fail('deleted mimetype');
+        } catch (ZipEntryNotFoundException $e) {
+            self::assertSame('Zip Entry "mimetype" was not found in the archive.', $e->getMessage());
+        }
+        $epubFile->saveAsFile($this->outputFilename);
+        self::assertFalse($epubFile->hasEntry('mimetype'));
+        $epubFile->close();
+
+        self::assertCorrectZipArchive($this->outputFilename);
+
+        $epubFile->openFile($this->outputFilename);
+        // file appended in EpubWriter before write
+        self::assertTrue($epubFile->hasEntry('mimetype'));
+        $epubFile->close();
+    }
+}

tests/Internal/Epub/EpubFile.php

@@ -0,0 +1,98 @@
+<?php
+
+/** @noinspection PhpComposerExtensionStubsInspection */
+
+namespace PhpZip\Tests\Internal\Epub;
+
+use PhpZip\Constants\ZipPlatform;
+use PhpZip\Exception\ZipEntryNotFoundException;
+use PhpZip\Exception\ZipException;
+use PhpZip\IO\ZipReader;
+use PhpZip\IO\ZipWriter;
+use PhpZip\Model\ImmutableZipContainer;
+use PhpZip\Model\ZipContainer;
+use PhpZip\Model\ZipEntry;
+use PhpZip\ZipFile;
+
+/**
+ * Class EpubFile.
+ *
+ * @property EpubZipContainer $zipContainer
+ */
+class EpubFile extends ZipFile
+{
+    /**
+     * @return ZipWriter
+     */
+    protected function createZipWriter()
+    {
+        return new EpubWriter($this->zipContainer);
+    }
+
+    /**
+     * @param resource $inputStream
+     * @param array    $options
+     *
+     * @return ZipReader
+     */
+    protected function createZipReader($inputStream, array $options = [])
+    {
+        return new EpubReader($inputStream, $options);
+    }
+
+    /**
+     * @param ImmutableZipContainer|null $sourceContainer
+     *
+     * @return ZipContainer
+     */
+    protected function createZipContainer(ImmutableZipContainer $sourceContainer = null)
+    {
+        return new EpubZipContainer($sourceContainer);
+    }
+
+    /**
+     * @param ZipEntry $zipEntry
+     */
+    protected function addZipEntry(ZipEntry $zipEntry)
+    {
+        $zipEntry->setCreatedOS(ZipPlatform::OS_DOS);
+        $zipEntry->setExtractedOS(ZipPlatform::OS_UNIX);
+        parent::addZipEntry($zipEntry);
+    }
+
+    /**
+     * @throws ZipEntryNotFoundException
+     *
+     * @return string
+     */
+    public function getMimeType()
+    {
+        return $this->zipContainer->getMimeType();
+    }
+
+    public function getEpubInfo()
+    {
+        return new EpubInfo($this->getEntryContents($this->getRootFile()));
+    }
+
+    /**
+     * @throws ZipException
+     *
+     * @return string
+     */
+    public function getRootFile()
+    {
+        $entryName = 'META-INF/container.xml';
+        $contents = $this->getEntryContents($entryName);
+        $doc = new \DOMDocument();
+        $doc->loadXML($contents);
+        $xpath = new \DOMXPath($doc);
+        $rootFile = $xpath->evaluate('string(//@full-path)');
+
+        if ($rootFile === '') {
+            throw new ZipException('Incorrect ' . $entryName . ' file format');
+        }
+
+        return $rootFile;
+    }
+}

tests/Internal/Epub/EpubInfo.php

@@ -0,0 +1,159 @@
+<?php
+
+/** @noinspection PhpComposerExtensionStubsInspection */
+
+namespace PhpZip\Tests\Internal\Epub;
+
+use PhpZip\Exception\ZipException;
+
+/**
+ * Class EpubInfo.
+ *
+ * @see http://idpf.org/epub/30/spec/epub30-publications.html
+ */
+class EpubInfo
+{
+    /** @var string|null */
+    private $title;
+
+    /** @var string|null */
+    private $creator;
+
+    /** @var string|null */
+    private $language;
+
+    /** @var string|null */
+    private $publisher;
+
+    /** @var string|null */
+    private $description;
+
+    /** @var string|null */
+    private $rights;
+
+    /** @var string|null */
+    private $date;
+
+    /** @var string|null */
+    private $subject;
+
+    /**
+     * EpubInfo constructor.
+     *
+     * @param $xmlContents
+     *
+     * @throws ZipException
+     */
+    public function __construct($xmlContents)
+    {
+        $doc = new \DOMDocument();
+        $doc->loadXML($xmlContents);
+        $xpath = new \DOMXpath($doc);
+        $xpath->registerNamespace('root', 'http://www.idpf.org/2007/opf');
+        $metaDataNodeList = $xpath->query('//root:metadata');
+
+        if (\count($metaDataNodeList) !== 1) {
+            throw new ZipException('Invalid .opf file format');
+        }
+        $metaDataNode = $metaDataNodeList->item(0);
+
+        $title = $xpath->evaluate('string(//dc:title)', $metaDataNode);
+        $creator = $xpath->evaluate('string(//dc:creator)', $metaDataNode);
+        $language = $xpath->evaluate('string(//dc:language)', $metaDataNode);
+        $publisher = $xpath->evaluate('string(//dc:publisher)', $metaDataNode);
+        $description = $xpath->evaluate('string(//dc:description)', $metaDataNode);
+        $rights = $xpath->evaluate('string(//dc:rights)', $metaDataNode);
+        $date = $xpath->evaluate('string(//dc:date)', $metaDataNode);
+        $subject = $xpath->evaluate('string(//dc:subject)', $metaDataNode);
+
+        $this->title = empty($title) ? null : $title;
+        $this->creator = empty($creator) ? null : $creator;
+        $this->language = empty($language) ? null : $language;
+        $this->publisher = empty($publisher) ? null : $publisher;
+        $this->description = empty($description) ? null : $description;
+        $this->rights = empty($rights) ? null : $rights;
+        $this->date = empty($date) ? null : $date;
+        $this->subject = empty($subject) ? null : $subject;
+    }
+
+    /**
+     * @return string|null
+     */
+    public function getTitle()
+    {
+        return $this->title;
+    }
+
+    /**
+     * @return string|null
+     */
+    public function getCreator()
+    {
+        return $this->creator;
+    }
+
+    /**
+     * @return string|null
+     */
+    public function getLanguage()
+    {
+        return $this->language;
+    }
+
+    /**
+     * @return string|null
+     */
+    public function getPublisher()
+    {
+        return $this->publisher;
+    }
+
+    /**
+     * @return string|null
+     */
+    public function getDescription()
+    {
+        return $this->description;
+    }
+
+    /**
+     * @return string|null
+     */
+    public function getRights()
+    {
+        return $this->rights;
+    }
+
+    /**
+     * @return string|null
+     */
+    public function getDate()
+    {
+        return $this->date;
+    }
+
+    /**
+     * @return string|null
+     */
+    public function getSubject()
+    {
+        return $this->subject;
+    }
+
+    /**
+     * @return array
+     */
+    public function toArray()
+    {
+        return [
+            'title' => $this->title,
+            'creator' => $this->creator,
+            'language' => $this->language,
+            'publisher' => $this->publisher,
+            'description' => $this->description,
+            'rights' => $this->rights,
+            'date' => $this->date,
+            'subject' => $this->subject,
+        ];
+    }
+}

tests/Internal/Epub/EpubReader.php

@@ -0,0 +1,21 @@
+<?php
+
+namespace PhpZip\Tests\Internal\Epub;
+
+use PhpZip\IO\ZipReader;
+
+/**
+ * Class EpubReader.
+ */
+class EpubReader extends ZipReader
+{
+    /**
+     * @return bool
+     *
+     * @see https://github.com/w3c/epubcheck/issues/334
+     */
+    protected function isZip64Support()
+    {
+        return false;
+    }
+}

tests/Internal/Epub/EpubWriter.php

@@ -0,0 +1,66 @@
+<?php
+
+namespace PhpZip\Tests\Internal\Epub;
+
+use PhpZip\Constants\ZipCompressionMethod;
+use PhpZip\Constants\ZipPlatform;
+use PhpZip\Exception\ZipUnsupportMethodException;
+use PhpZip\IO\ZipWriter;
+use PhpZip\Model\Data\ZipNewData;
+use PhpZip\Model\ZipEntry;
+
+/**
+ * Class EpubWriter.
+ *
+ * @property EpubZipContainer $zipContainer
+ */
+class EpubWriter extends ZipWriter
+{
+    /**
+     * @throws ZipUnsupportMethodException
+     */
+    protected function beforeWrite()
+    {
+        parent::beforeWrite();
+
+        if (!$this->zipContainer->hasEntry('mimetype')) {
+            $zipEntry = new ZipEntry('mimetype');
+            $zipEntry->setCreatedOS(ZipPlatform::OS_DOS);
+            $zipEntry->setExtractedOS(ZipPlatform::OS_DOS);
+            $zipEntry->setCompressionMethod(ZipCompressionMethod::STORED);
+            $zipEntry->setData(new ZipNewData($zipEntry, 'application/epub+zip'));
+            $this->zipContainer->addEntry($zipEntry);
+        }
+
+        $this->sortEntries();
+    }
+
+    private function sortEntries()
+    {
+        $this->zipContainer->sortByEntry(
+            static function (ZipEntry $a, ZipEntry $b) {
+                if (strcasecmp($a->getName(), 'mimetype') === 0) {
+                    return -1;
+                }
+
+                if (strcasecmp($b->getName(), 'mimetype') === 0) {
+                    return 1;
+                }
+
+                if ($a->isDirectory() && $b->isDirectory()) {
+                    return strcmp($a->getName(), $b->getName());
+                }
+
+                if ($a->isDirectory()) {
+                    return -1;
+                }
+
+                if ($b->isDirectory()) {
+                    return 1;
+                }
+
+                return strcmp($a->getName(), $b->getName());
+            }
+        );
+    }
+}

tests/Internal/Epub/EpubZipContainer.php

@@ -0,0 +1,22 @@
+<?php
+
+namespace PhpZip\Tests\Internal\Epub;
+
+use PhpZip\Exception\ZipEntryNotFoundException;
+use PhpZip\Model\ZipContainer;
+
+/**
+ * Class EpubZipContainer.
+ */
+class EpubZipContainer extends ZipContainer
+{
+    /**
+     * @throws ZipEntryNotFoundException
+     *
+     * @return string
+     */
+    public function getMimeType()
+    {
+        return $this->getEntry('mimetype')->getData()->getDataAsString();
+    }
+}

tests/ZipFileTest.php

@@ -2418,4 +2418,21 @@ class ZipFileTest extends ZipTestCase
         static::assertSame($zipFile->getEntry($newEntryName)->getCompressionMethod(), ZipCompressionMethod::STORED);
         $zipFile->close();
     }
+
+    /**
+     * @throws ZipEntryNotFoundException
+     * @throws ZipException
+     */
+    public function testCloneZipContainerInZipWriter()
+    {
+        $zipFile = new ZipFile();
+        $zipFile['file 1'] = 'contents';
+        $zipEntryBeforeWrite = $zipFile->getEntry('file 1');
+        $zipFile->saveAsFile($this->outputFilename);
+        $zipAfterBeforeWrite = $zipFile->getEntry('file 1');
+
+        static::assertEquals($zipAfterBeforeWrite, $zipEntryBeforeWrite);
+
+        $zipFile->close();
+    }
 }