WIP Limited Support for Form Controls (ListBox, Button, etc.)

Fix PHPOffice#2396. Fix PHPOffice#1770.

I am starting this out in draft status, and will probably leave it that way for some time. I'm not sure where we want to go with this. It fixes some problems, but in a limited manner, and creates some others. I'm not sure the pain of the others is balanced considering the limitations of the fix. If enough interest is generated as a result of this ticket being out there, we can proceed; if not, it probably isn't worth it.

This fix allows form control elements to be read in and written out. It does not allow you to add such elements, nor even to locate them or determine their properties (so you can't modify or delete them). Although it handles reading and writing of sheets containing both form controls and comments, it will probably create a corrupt spreadsheet if you try adding a new comment to a sheet with form controls - probably quite difficult to solve. Cloning the sheet probably won't work either - probably easier than the other. It is conceivable that we want to add a new property to the Xlsx Reader which turns the reading of form elements on or off (default=off), so that negative effects will be limited to those who have explictly opted in. The change in its current form does not implement such a property.

Because of its limitations, the change isn't really testable. As in some other recent installs, I have added a sample to demonstrate that it works correctly.

Author: oleibman

samples/Reader/22_Reader_formscomments.php

@@ -0,0 +1,22 @@
+<?php
+
+use PhpOffice\PhpSpreadsheet\IOFactory;
+
+require __DIR__ . '/../Header.php';
+
+$helper->log('Start');
+
+$inputFileType = 'Xlsx';
+$inputFileName = __DIR__ . '/sampleData/formscomments.xlsx';
+
+$helper->log('Loading file ' . $inputFileName . ' using IOFactory with a defined reader type of ' . $inputFileType);
+$reader = IOFactory::createReader($inputFileType);
+$helper->log('Loading all WorkSheets');
+$reader->setLoadAllSheets();
+$spreadsheet = $reader->load($inputFileName);
+
+// Save
+$helper->write($spreadsheet, __FILE__, ['Xlsx']);
+$spreadsheet->disconnectWorksheets();
+
+$helper->log('end');

samples/Reader/22_Reader_issue1767.php

@@ -17,5 +17,6 @@
 
 // Save
 $helper->write($spreadsheet, __FILE__);
+$spreadsheet->disconnectWorksheets();
 
 $helper->log('end');

samples/Reader/sampleData/formscomments.xlsx

@@ -969,6 +969,7 @@ public function load(string $filename, int $flags = 0): Spreadsheet
 
                                 // later we will remove from it real vmlComments
                                 $unparsedVmlDrawings = $vmlComments;
+                                $vmlDrawingContents = [];
 
                                 // Loop through VML comments
                                 foreach ($vmlComments as $relName => $relPath) {
@@ -987,6 +988,7 @@ public function load(string $filename, int $flags = 0): Spreadsheet
                                     // Locate VML drawings image relations
                                     $drowingImages = [];
                                     $VMLDrawingsRelations = dirname($relPath) . '/_rels/' . basename($relPath) . '.rels';
+                                    $vmlDrawingContents[$relName] = $this->securityScanner->scan($this->getFromZipArchive($zip, $relPath));
                                     if ($zip->locateName($VMLDrawingsRelations)) {
                                         $relsVMLDrawing = $this->loadZip($VMLDrawingsRelations, Namespaces::RELATIONSHIPS);
                                         foreach ($relsVMLDrawing->Relationship as $elex) {
@@ -1391,6 +1393,14 @@ public function load(string $filename, int $flags = 0): Spreadsheet
                                             }
                                         }
                                     }
+                                    if ($xmlSheet->legacyDrawing && !$this->readDataOnly) {
+                                        foreach ($xmlSheet->legacyDrawing as $drawing) {
+                                            $drawingRelId = (string) self::getArrayItem(self::getAttributes($drawing, $xmlNamespaceBase), 'id');
+                                            if (isset($vmlDrawingContents[$drawingRelId])) {
+                                                $unparsedLoadedData['sheets'][$docSheet->getCodeName()]['legacyDrawing'] = $vmlDrawingContents[$drawingRelId];
+                                            }
+                                        }
+                                    }
 
                                     // unparsed drawing AlternateContent
                                     $xmlAltDrawing = $this->loadZip($fileDrawing, Namespaces::COMPATIBILITY);

src/PhpSpreadsheet/Reader/Xlsx.php

@@ -439,14 +439,17 @@ public function save($filename, int $flags = 0): void
             }
 
             // Add comment relationship parts
-            if (count($this->spreadSheet->getSheet($i)->getComments()) > 0) {
+            $legacy = $unparsedLoadedData['sheets'][$this->spreadSheet->getSheet($i)->getCodeName()]['legacyDrawing'] ?? null;
+            if (count($this->spreadSheet->getSheet($i)->getComments()) > 0 || $legacy !== null) {
                 // VML Comments relationships
                 $zipContent['xl/drawings/_rels/vmlDrawing' . ($i + 1) . '.vml.rels'] = $this->getWriterPartRels()->writeVMLDrawingRelationships($this->spreadSheet->getSheet($i));
 
                 // VML Comments
-                $zipContent['xl/drawings/vmlDrawing' . ($i + 1) . '.vml'] = $this->getWriterPartComments()->writeVMLComments($this->spreadSheet->getSheet($i));
+                $zipContent['xl/drawings/vmlDrawing' . ($i + 1) . '.vml'] = $legacy ?? $this->getWriterPartComments()->writeVMLComments($this->spreadSheet->getSheet($i));
+            }
 
-                // Comments
+            // Comments
+            if (count($this->spreadSheet->getSheet($i)->getComments()) > 0) {
                 $zipContent['xl/comments' . ($i + 1) . '.xml'] = $this->getWriterPartComments()->writeComments($this->spreadSheet->getSheet($i));
 
                 // Media
@@ -461,7 +464,9 @@ public function save($filename, int $flags = 0): void
             // Add unparsed relationship parts
             if (isset($unparsedLoadedData['sheets'][$sheetCodeName]['vmlDrawings'])) {
                 foreach ($unparsedLoadedData['sheets'][$sheetCodeName]['vmlDrawings'] as $vmlDrawing) {
-                    $zipContent[$vmlDrawing['filePath']] = $vmlDrawing['content'];
+                    if (!isset($zipContent[$vmlDrawing['filePath']])) {
+                        $zipContent[$vmlDrawing['filePath']] = $vmlDrawing['content'];
+                    }
                 }
             }
 

src/PhpSpreadsheet/Writer/Xlsx.php

@@ -236,14 +236,16 @@ public function writeWorksheetRelationships(\PhpOffice\PhpSpreadsheet\Worksheet\
 
         // Write comments relationship?
         $i = 1;
-        if (count($worksheet->getComments()) > 0) {
+        if (count($worksheet->getComments()) > 0 || isset($unparsedLoadedData['sheets'][$worksheet->getCodeName()]['legacyDrawing'])) {
             $this->writeRelationship(
                 $objWriter,
                 '_comments_vml' . $i,
                 'http://schemas.openxmlformats.org/officeDocument/2006/relationships/vmlDrawing',
                 '../drawings/vmlDrawing' . $worksheetId . '.vml'
             );
+        }
 
+        if (count($worksheet->getComments()) > 0) {
             $this->writeRelationship(
                 $objWriter,
                 '_comments' . $i,

src/PhpSpreadsheet/Writer/Xlsx/Rels.php

@@ -1317,7 +1317,8 @@ private function writeDrawings(XMLWriter $objWriter, PhpspreadsheetWorksheet $wo
     private function writeLegacyDrawing(XMLWriter $objWriter, PhpspreadsheetWorksheet $worksheet): void
     {
         // If sheet contains comments, add the relationships
-        if (count($worksheet->getComments()) > 0) {
+        $unparsedLoadedData = $worksheet->getParent()->getUnparsedLoadedData();
+        if (count($worksheet->getComments()) > 0 || isset($unparsedLoadedData['sheets'][$worksheet->getCodeName()]['legacyDrawing'])) {
             $objWriter->startElement('legacyDrawing');
             $objWriter->writeAttribute('r:id', 'rId_comments_vml1');
             $objWriter->endElement();