Special Characters in Image File Name

Fix PHPOffice#2415. Fix PHPOffice#1470. If path name of image contains anything other than ASCII, or if it contains # or space or probably other exceptions, PhpSpreadsheet creates a file that Excel cannot, for whatever reason, read (it is valid xml). When adding an image to a spreadsheet, Excel does not retain the original path name; PhpSpreadsheet does, but probably shouldn't. It is changed to save the image file in the zip as the MD5 hash of the original path name. This produces a file that Excel can read. In addition, it ensures that, if the image is used in multiple places, it is saved in the Excel file only once. Because this error becomes evident only when opening the file in Excel, it is difficult to write a test case. I have instead duplicated sample Basic/05... using image files whose names match the reported error conditions.
oleibman · Nov 27, 2021 · cfe5cc1 · cfe5cc1
1 parent 290c18e
commit cfe5cc1
Show file tree

Hide file tree

Showing 7 changed files with 395 additions and 4 deletions.
diff --git a/samples/Basic/05_UnexpectedCharacters.php b/samples/Basic/05_UnexpectedCharacters.php
@@ -0,0 +1,7 @@
+<?php
+
+require __DIR__ . '/../Header.php';
+$spreadsheet = require __DIR__ . '/../templates/sampleSpreadsheet2.php';
+
+// Save
+$helper->write($spreadsheet, __FILE__);
diff --git a/samples/images/terms con#ditions.jpg b/samples/images/terms con#ditions.jpg
diff --git a/samples/images/サンプル.png b/samples/images/サンプル.png
diff --git a/samples/templates/sampleSpreadsheet2.php b/samples/templates/sampleSpreadsheet2.php
diff --git a/src/PhpSpreadsheet/Worksheet/Drawing.php b/src/PhpSpreadsheet/Worksheet/Drawing.php
@@ -51,7 +51,7 @@ public function getIndexedFilename(): string
         $fileName = $this->getFilename();
         $fileName = str_replace(' ', '_', $fileName);
 
-        return str_replace('.' . $this->getExtension(), '', $fileName) . $this->getImageIndex() . '.' . $this->getExtension();
+        return md5($this->path) . '.' . $this->getExtension();
     }
 
     /**

diff --git a/src/PhpSpreadsheet/Writer/Xlsx.php b/src/PhpSpreadsheet/Writer/Xlsx.php
@@ -486,7 +486,7 @@ public function save($filename, int $flags = 0): void
                     $imageContents = file_get_contents($imagePath);
                 }
 
-                $zipContent['xl/media/' . str_replace(' ', '_', $this->getDrawingHashTable()->getByIndex($i)->getIndexedFilename())] = $imageContents;
+                $zipContent['xl/media/' . $this->getDrawingHashTable()->getByIndex($i)->getIndexedFilename()] = $imageContents;
             } elseif ($this->getDrawingHashTable()->getByIndex($i) instanceof MemoryDrawing) {
                 ob_start();
                 call_user_func(
@@ -496,7 +496,7 @@ public function save($filename, int $flags = 0): void
                 $imageContents = ob_get_contents();
                 ob_end_clean();
 
-                $zipContent['xl/media/' . str_replace(' ', '_', $this->getDrawingHashTable()->getByIndex($i)->getIndexedFilename())] = $imageContents;
+                $zipContent['xl/media/' . $this->getDrawingHashTable()->getByIndex($i)->getIndexedFilename()] = $imageContents;
             }
         }
 

diff --git a/src/PhpSpreadsheet/Writer/Xlsx/Rels.php b/src/PhpSpreadsheet/Writer/Xlsx/Rels.php
@@ -328,7 +328,7 @@ public function writeDrawingRelationships(\PhpOffice\PhpSpreadsheet\Worksheet\Wo
                     $objWriter,
                     $i,
                     'http://schemas.openxmlformats.org/officeDocument/2006/relationships/image',
-                    '../media/' . str_replace(' ', '', $drawing->getIndexedFilename())
+                    '../media/' . $drawing->getIndexedFilename()
                 );
 
                 $i = $this->writeDrawingHyperLink($objWriter, $drawing, $i);