ODT Writer: Basic image writing support

Author: ivanlanin

CHANGELOG.md

@@ -36,6 +36,7 @@ This release marked heavy refactorings on internal code structure with the creat
 - PDF Writer: Basic PDF writer using DomPDF: All HTML element except image - @ivanlanin GH-68
 - DOCX Writer: Change `docProps/app.xml` `Application` to `PHPWord` - @ivanlanin
 - DOCX Writer: Create `word/settings.xml` and `word/webSettings.xml` dynamically - @ivanlanin
+- ODT Writer: Basic image writing - @ivanlanin
 
 ### Bugfixes
 

docs/intro.rst

@@ -89,7 +89,7 @@ Writers
 +                         +-----------------------+--------+-------+-------+-------+-------+
 |                         | Table                 | ✓      | ✓     |       | ✓     | ✓     |
 +                         +-----------------------+--------+-------+-------+-------+-------+
-|                         | Image                 | ✓      |       |       | ✓     |       |
+|                         | Image                 | ✓      | ✓     |       | ✓     |       |
 +                         +-----------------------+--------+-------+-------+-------+-------+
 |                         | Object                | ✓      |       |       |       |       |
 +                         +-----------------------+--------+-------+-------+-------+-------+

src/PhpWord/Element/Image.php

@@ -89,6 +89,20 @@ class Image extends AbstractElement
      */
     private $isMemImage;
 
+    /**
+     * Image target file name
+     *
+     * @var string
+     */
+    private $target;
+
+    /**
+     * Image media index
+     *
+     * @var integer
+     */
+    private $mediaIndex;
+
     /**
      * Create new image element
      *
@@ -217,6 +231,46 @@ public function getIsMemImage()
         return $this->isMemImage;
     }
 
+    /**
+     * Get target file name
+     *
+     * @return string
+     */
+    public function getTarget()
+    {
+        return $this->target;
+    }
+
+    /**
+     * Set target file name
+     *
+     * @param string $value
+     */
+    public function setTarget($value)
+    {
+        $this->target = $value;
+    }
+
+    /**
+     * Get media index
+     *
+     * @return integer
+     */
+    public function getMediaIndex()
+    {
+        return $this->mediaIndex;
+    }
+
+    /**
+     * Set media index
+     *
+     * @param integer $value
+     */
+    public function setMediaIndex($value)
+    {
+        $this->mediaIndex = $value;
+    }
+
     /**
      * Check memory image, supported type, image functions, and proportional width/height
      *

src/PhpWord/Media.php

@@ -36,7 +36,7 @@ class Media
      * @since 0.9.2
      * @since 0.10.0
      */
-    public static function addElement($container, $mediaType, $source, Image $image = null)
+    public static function addElement($container, $mediaType, $source, Image &$image = null)
     {
         // Assign unique media Id and initiate media container if none exists
         $mediaId = md5($container . $source);
@@ -48,10 +48,10 @@ public static function addElement($container, $mediaType, $source, Image $image
         if (!array_key_exists($mediaId, self::$elements[$container])) {
             $mediaCount = self::countElements($container);
             $mediaTypeCount = self::countElements($container, $mediaType);
-            $mediaData = array();
+            $mediaTypeCount++;
             $rId = ++$mediaCount;
             $target = null;
-            $mediaTypeCount++;
+            $mediaData = array('mediaIndex' => $mediaTypeCount);
 
             switch ($mediaType) {
                 // Images
@@ -68,12 +68,14 @@ public static function addElement($container, $mediaType, $source, Image $image
                         $mediaData['createFunction'] = $image->getImageCreateFunction();
                         $mediaData['imageFunction'] = $image->getImageFunction();
                     }
-                    $target = "media/{$container}_image{$mediaTypeCount}.{$extension}";
+                    $target = "{$container}_image{$mediaTypeCount}.{$extension}";
+                    $image->setTarget($target);
+                    $image->setMediaIndex($mediaTypeCount);
                     break;
 
                 // Objects
                 case 'object':
-                    $target = "embeddings/{$container}_oleObject{$mediaTypeCount}.bin";
+                    $target = "{$container}_oleObject{$mediaTypeCount}.bin";
                     break;
 
                 // Links
@@ -89,7 +91,12 @@ public static function addElement($container, $mediaType, $source, Image $image
             self::$elements[$container][$mediaId] = $mediaData;
             return $rId;
         } else {
-            return self::$elements[$container][$mediaId]['rID'];
+            $mediaData = self::$elements[$container][$mediaId];
+            if (!is_null($image)) {
+                $image->setTarget($mediaData['target']);
+                $image->setMediaIndex($mediaData['mediaIndex']);
+            }
+            return $mediaData['rID'];
         }
     }
 

src/PhpWord/Writer/AbstractWriter.php

@@ -30,10 +30,17 @@ abstract class AbstractWriter implements WriterInterface
     /**
      * Individual writers
      *
-     * @var mixed
+     * @var array
      */
     protected $writerParts = array();
 
+    /**
+     * Paths to store media files
+     *
+     * @var array
+     */
+    protected $mediaPaths = array('image' => '', 'object' => '');
+
     /**
      * Use disk caching
      *
@@ -263,6 +270,73 @@ protected function getZipArchive($filename)
         return $objZip;
     }
 
+    /**
+     * Add files to package
+     *
+     * @param mixed $objZip
+     * @param mixed $elements
+     */
+    protected function addFilesToPackage($objZip, $elements)
+    {
+        foreach ($elements as $element) {
+            $type = $element['type']; // image|object|link
+
+            // Skip nonregistered types and set target
+            if (!array_key_exists($type, $this->mediaPaths)) {
+                continue;
+            }
+            $target = $this->mediaPaths[$type] . $element['target'];
+
+            // Retrive GD image content or get local media
+            if (isset($element['isMemImage']) && $element['isMemImage']) {
+                $image = call_user_func($element['createFunction'], $element['source']);
+                ob_start();
+                call_user_func($element['imageFunction'], $image);
+                $imageContents = ob_get_contents();
+                ob_end_clean();
+                $objZip->addFromString($target, $imageContents);
+                imagedestroy($image);
+            } else {
+                $this->addFileToPackage($objZip, $element['source'], $target);
+            }
+        }
+    }
+
+    /**
+     * Add file to package
+     *
+     * Get the actual source from an archive image
+     *
+     * @param mixed $objZip
+     * @param string $source
+     * @param string $target
+     */
+    protected function addFileToPackage($objZip, $source, $target)
+    {
+        $isArchive = strpos($source, 'zip://') !== false;
+        $actualSource = null;
+        if ($isArchive) {
+            $source = substr($source, 6);
+            list($zipFilename, $imageFilename) = explode('#', $source);
+
+            $zipClass = \PhpOffice\PhpWord\Settings::getZipClass();
+            $zip = new $zipClass();
+            if ($zip->open($zipFilename) !== false) {
+                if ($zip->locateName($imageFilename)) {
+                    $zip->extractTo($this->getTempDir(), $imageFilename);
+                    $actualSource = $this->getTempDir() . DIRECTORY_SEPARATOR . $imageFilename;
+                }
+            }
+            $zip->close();
+        } else {
+            $actualSource = $source;
+        }
+
+        if (!is_null($actualSource)) {
+            $objZip->addFile($actualSource, $target);
+        }
+    }
+
     /**
      * Delete directory
      *

src/PhpWord/Writer/ODText.php

@@ -9,8 +9,9 @@
 
 namespace PhpOffice\PhpWord\Writer;
 
-use PhpOffice\PhpWord\Exception\Exception;
+use PhpOffice\PhpWord\Media;
 use PhpOffice\PhpWord\PhpWord;
+use PhpOffice\PhpWord\Exception\Exception;
 use PhpOffice\PhpWord\Writer\ODText\Content;
 use PhpOffice\PhpWord\Writer\ODText\Manifest;
 use PhpOffice\PhpWord\Writer\ODText\Meta;
@@ -43,6 +44,9 @@ public function __construct(PhpWord $phpWord = null)
         foreach ($this->writerParts as $writer) {
             $writer->setParentWriter($this);
         }
+
+        // Set package paths
+        $this->mediaPaths = array('image' => 'Pictures/');
     }
 
     /**
@@ -57,7 +61,13 @@ public function save($filename = null)
             $filename = $this->getTempFile($filename);
             $objZip = $this->getZipArchive($filename);
 
-            // Add mimetype to ZIP file
+            // Add section media files
+            $sectionMedia = Media::getElements('section');
+            if (!empty($sectionMedia)) {
+                $this->addFilesToPackage($objZip, $sectionMedia);
+            }
+
+            // Add parts
             $objZip->addFromString('mimetype', $this->getWriterPart('mimetype')->writeMimetype());
             $objZip->addFromString('content.xml', $this->getWriterPart('content')->writeContent($this->phpWord));
             $objZip->addFromString('meta.xml', $this->getWriterPart('meta')->writeMeta($this->phpWord));