Clientbase
/
PhpSpreadsheet
mirror of https://github.com/basemaster/PhpSpreadsheet.git
3
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Refactor xlsx writer 

* Move file handler creation and file addition to the end
This commit is contained in:
Vivek Kumar 2021-03-14 22:20:11 +05:30
parent 5686453bcc
commit 51abdf0b8f
4 changed files with 54 additions and 42 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
src/PhpSpreadsheet/Writer/BaseWriter.php
View File

@ -108,7 +108,7 @@ abstract class BaseWriter implements IWriter
return; return;
} }
$fileHandle = $filename ? fopen($filename, 'wb') : false; $fileHandle = $filename ? fopen($filename, 'wb+') : false;
if ($fileHandle === false) { if ($fileHandle === false) {
throw new Exception('Could not open file "' . $filename . '" for writing.'); throw new Exception('Could not open file "' . $filename . '" for writing.');
} }

93
src/PhpSpreadsheet/Writer/Xlsx.php
View File

@ -182,8 +182,6 @@ class Xlsx extends BaseWriter
$this->pathNames = []; $this->pathNames = [];
$this->spreadSheet->garbageCollect(); $this->spreadSheet->garbageCollect();
$this->openFileHandle($pFilename);
$saveDebugLog = Calculation::getInstance($this->spreadSheet)->getDebugLog()->getWriteDebugLog(); $saveDebugLog = Calculation::getInstance($this->spreadSheet)->getDebugLog()->getWriteDebugLog();
Calculation::getInstance($this->spreadSheet)->getDebugLog()->setWriteDebugLog(false); Calculation::getInstance($this->spreadSheet)->getDebugLog()->setWriteDebugLog(false);
$saveDateReturnType = Functions::getReturnDateType(); $saveDateReturnType = Functions::getReturnDateType();
@ -206,77 +204,72 @@ class Xlsx extends BaseWriter
// Create drawing dictionary // Create drawing dictionary
$this->drawingHashTable->addFromSource($this->getWriterPart('Drawing')->allDrawings($this->spreadSheet)); $this->drawingHashTable->addFromSource($this->getWriterPart('Drawing')->allDrawings($this->spreadSheet));
$options = new Archive(); $zipContent = [];
$options->setEnableZip64(false);
$options->setOutputStream($this->fileHandle);
$this->zip = new ZipStream(null, $options);
// Add [Content_Types].xml to ZIP file // Add [Content_Types].xml to ZIP file
$this->addZipFile('[Content_Types].xml', $this->getWriterPart('ContentTypes')->writeContentTypes($this->spreadSheet, $this->includeCharts)); $zipContent['[Content_Types].xml'] = $this->getWriterPart('ContentTypes')->writeContentTypes($this->spreadSheet, $this->includeCharts);
//if hasMacros, add the vbaProject.bin file, Certificate file(if exists) //if hasMacros, add the vbaProject.bin file, Certificate file(if exists)
if ($this->spreadSheet->hasMacros()) { if ($this->spreadSheet->hasMacros()) {
$macrosCode = $this->spreadSheet->getMacrosCode(); $macrosCode = $this->spreadSheet->getMacrosCode();
if ($macrosCode !== null) { if ($macrosCode !== null) {
// we have the code ? // we have the code ?
$this->addZipFile('xl/vbaProject.bin', $macrosCode); //allways in 'xl', allways named vbaProject.bin $zipContent['xl/vbaProject.bin'] = $macrosCode; //allways in 'xl', allways named vbaProject.bin
if ($this->spreadSheet->hasMacrosCertificate()) { if ($this->spreadSheet->hasMacrosCertificate()) {
//signed macros ? //signed macros ?
// Yes : add the certificate file and the related rels file // Yes : add the certificate file and the related rels file
$this->addZipFile('xl/vbaProjectSignature.bin', $this->spreadSheet->getMacrosCertificate()); $zipContent['xl/vbaProjectSignature.bin'] = $this->spreadSheet->getMacrosCertificate();
$this->addZipFile('xl/_rels/vbaProject.bin.rels', $this->getWriterPart('RelsVBA')->writeVBARelationships($this->spreadSheet)); $zipContent['xl/_rels/vbaProject.bin.rels'] = $this->getWriterPart('RelsVBA')->writeVBARelationships($this->spreadSheet);
} }
} }
} }
//a custom UI in this workbook ? add it ("base" xml and additional objects (pictures) and rels) //a custom UI in this workbook ? add it ("base" xml and additional objects (pictures) and rels)
if ($this->spreadSheet->hasRibbon()) { if ($this->spreadSheet->hasRibbon()) {
$tmpRibbonTarget = $this->spreadSheet->getRibbonXMLData('target'); $tmpRibbonTarget = $this->spreadSheet->getRibbonXMLData('target');
$this->addZipFile($tmpRibbonTarget, $this->spreadSheet->getRibbonXMLData('data')); $zipContent[$tmpRibbonTarget] = $this->spreadSheet->getRibbonXMLData('data');
if ($this->spreadSheet->hasRibbonBinObjects()) { if ($this->spreadSheet->hasRibbonBinObjects()) {
$tmpRootPath = dirname($tmpRibbonTarget) . '/'; $tmpRootPath = dirname($tmpRibbonTarget) . '/';
$ribbonBinObjects = $this->spreadSheet->getRibbonBinObjects('data'); //the files to write $ribbonBinObjects = $this->spreadSheet->getRibbonBinObjects('data'); //the files to write
foreach ($ribbonBinObjects as $aPath => $aContent) { foreach ($ribbonBinObjects as $aPath => $aContent) {
$this->addZipFile($tmpRootPath . $aPath, $aContent); $zipContent[$tmpRootPath . $aPath] = $aContent;
} }
//the rels for files //the rels for files
$this->addZipFile($tmpRootPath . '_rels/' . basename($tmpRibbonTarget) . '.rels', $this->getWriterPart('RelsRibbonObjects')->writeRibbonRelationships($this->spreadSheet)); $zipContent[$tmpRootPath . '_rels/' . basename($tmpRibbonTarget) . '.rels'] = $this->getWriterPart('RelsRibbonObjects')->writeRibbonRelationships($this->spreadSheet);
} }
} }
// Add relationships to ZIP file // Add relationships to ZIP file
$this->addZipFile('_rels/.rels', $this->getWriterPart('Rels')->writeRelationships($this->spreadSheet)); $zipContent['_rels/.rels'] = $this->getWriterPart('Rels')->writeRelationships($this->spreadSheet);
$this->addZipFile('xl/_rels/workbook.xml.rels', $this->getWriterPart('Rels')->writeWorkbookRelationships($this->spreadSheet)); $zipContent['xl/_rels/workbook.xml.rels'] = $this->getWriterPart('Rels')->writeWorkbookRelationships($this->spreadSheet);
// Add document properties to ZIP file // Add document properties to ZIP file
$this->addZipFile('docProps/app.xml', $this->getWriterPart('DocProps')->writeDocPropsApp($this->spreadSheet)); $zipContent['docProps/app.xml'] = $this->getWriterPart('DocProps')->writeDocPropsApp($this->spreadSheet);
$this->addZipFile('docProps/core.xml', $this->getWriterPart('DocProps')->writeDocPropsCore($this->spreadSheet)); $zipContent['docProps/core.xml'] = $this->getWriterPart('DocProps')->writeDocPropsCore($this->spreadSheet);
$customPropertiesPart = $this->getWriterPart('DocProps')->writeDocPropsCustom($this->spreadSheet); $customPropertiesPart = $this->getWriterPart('DocProps')->writeDocPropsCustom($this->spreadSheet);
if ($customPropertiesPart !== null) { if ($customPropertiesPart !== null) {
$this->addZipFile('docProps/custom.xml', $customPropertiesPart); $zipContent['docProps/custom.xml'] = $customPropertiesPart;
} }
// Add theme to ZIP file // Add theme to ZIP file
$this->addZipFile('xl/theme/theme1.xml', $this->getWriterPart('Theme')->writeTheme($this->spreadSheet)); $zipContent['xl/theme/theme1.xml'] = $this->getWriterPart('Theme')->writeTheme($this->spreadSheet);
// Add string table to ZIP file // Add string table to ZIP file
$this->addZipFile('xl/sharedStrings.xml', $this->getWriterPart('StringTable')->writeStringTable($this->stringTable)); $zipContent['xl/sharedStrings.xml'] = $this->getWriterPart('StringTable')->writeStringTable($this->stringTable);
// Add styles to ZIP file // Add styles to ZIP file
$this->addZipFile('xl/styles.xml', $this->getWriterPart('Style')->writeStyles($this->spreadSheet)); $zipContent['xl/styles.xml'] = $this->getWriterPart('Style')->writeStyles($this->spreadSheet);
// Add workbook to ZIP file // Add workbook to ZIP file
$this->addZipFile('xl/workbook.xml', $this->getWriterPart('Workbook')->writeWorkbook($this->spreadSheet, $this->preCalculateFormulas)); $zipContent['xl/workbook.xml'] = $this->getWriterPart('Workbook')->writeWorkbook($this->spreadSheet, $this->preCalculateFormulas);
$chartCount = 0; $chartCount = 0;
// Add worksheets // Add worksheets
for ($i = 0; $i < $this->spreadSheet->getSheetCount(); ++$i) { for ($i = 0; $i < $this->spreadSheet->getSheetCount(); ++$i) {
$this->addZipFile('xl/worksheets/sheet' . ($i + 1) . '.xml', $this->getWriterPart('Worksheet')->writeWorksheet($this->spreadSheet->getSheet($i), $this->stringTable, $this->includeCharts)); $zipContent['xl/worksheets/sheet' . ($i + 1) . '.xml'] = $this->getWriterPart('Worksheet')->writeWorksheet($this->spreadSheet->getSheet($i), $this->stringTable, $this->includeCharts);
if ($this->includeCharts) { if ($this->includeCharts) {
$charts = $this->spreadSheet->getSheet($i)->getChartCollection(); $charts = $this->spreadSheet->getSheet($i)->getChartCollection();
if (count($charts) > 0) { if (count($charts) > 0) {
foreach ($charts as $chart) { foreach ($charts as $chart) {
$this->addZipFile('xl/charts/chart' . ($chartCount + 1) . '.xml', $this->getWriterPart('Chart')->writeChart($chart, $this->preCalculateFormulas)); $zipContent['xl/charts/chart' . ($chartCount + 1) . '.xml'] = $this->getWriterPart('Chart')->writeChart($chart, $this->preCalculateFormulas);
++$chartCount; ++$chartCount;
} }
} }
@ -287,19 +280,19 @@ class Xlsx extends BaseWriter
// Add worksheet relationships (drawings, ...) // Add worksheet relationships (drawings, ...)
for ($i = 0; $i < $this->spreadSheet->getSheetCount(); ++$i) { for ($i = 0; $i < $this->spreadSheet->getSheetCount(); ++$i) {
// Add relationships // Add relationships
$this->addZipFile('xl/worksheets/_rels/sheet' . ($i + 1) . '.xml.rels', $this->getWriterPart('Rels')->writeWorksheetRelationships($this->spreadSheet->getSheet($i), ($i + 1), $this->includeCharts)); $zipContent['xl/worksheets/_rels/sheet' . ($i + 1) . '.xml.rels'] = $this->getWriterPart('Rels')->writeWorksheetRelationships($this->spreadSheet->getSheet($i), ($i + 1), $this->includeCharts);
// Add unparsedLoadedData // Add unparsedLoadedData
$sheetCodeName = $this->spreadSheet->getSheet($i)->getCodeName(); $sheetCodeName = $this->spreadSheet->getSheet($i)->getCodeName();
$unparsedLoadedData = $this->spreadSheet->getUnparsedLoadedData(); $unparsedLoadedData = $this->spreadSheet->getUnparsedLoadedData();
if (isset($unparsedLoadedData['sheets'][$sheetCodeName]['ctrlProps'])) { if (isset($unparsedLoadedData['sheets'][$sheetCodeName]['ctrlProps'])) {
foreach ($unparsedLoadedData['sheets'][$sheetCodeName]['ctrlProps'] as $ctrlProp) { foreach ($unparsedLoadedData['sheets'][$sheetCodeName]['ctrlProps'] as $ctrlProp) {
$this->addZipFile($ctrlProp['filePath'], $ctrlProp['content']); $zipContent[$ctrlProp['filePath']] = $ctrlProp['content'];
} }
} }
if (isset($unparsedLoadedData['sheets'][$sheetCodeName]['printerSettings'])) { if (isset($unparsedLoadedData['sheets'][$sheetCodeName]['printerSettings'])) {
foreach ($unparsedLoadedData['sheets'][$sheetCodeName]['printerSettings'] as $ctrlProp) { foreach ($unparsedLoadedData['sheets'][$sheetCodeName]['printerSettings'] as $ctrlProp) {
$this->addZipFile($ctrlProp['filePath'], $ctrlProp['content']); $zipContent[$ctrlProp['filePath']] = $ctrlProp['content'];
} }
} }
@ -312,13 +305,13 @@ class Xlsx extends BaseWriter
// Add drawing and image relationship parts // Add drawing and image relationship parts
if (($drawingCount > 0) || ($chartCount > 0)) { if (($drawingCount > 0) || ($chartCount > 0)) {
// Drawing relationships // Drawing relationships
$this->addZipFile('xl/drawings/_rels/drawing' . ($i + 1) . '.xml.rels', $this->getWriterPart('Rels')->writeDrawingRelationships($this->spreadSheet->getSheet($i), $chartRef1, $this->includeCharts)); $zipContent['xl/drawings/_rels/drawing' . ($i + 1) . '.xml.rels'] = $this->getWriterPart('Rels')->writeDrawingRelationships($this->spreadSheet->getSheet($i), $chartRef1, $this->includeCharts);
// Drawings // Drawings
$this->addZipFile('xl/drawings/drawing' . ($i + 1) . '.xml', $this->getWriterPart('Drawing')->writeDrawings($this->spreadSheet->getSheet($i), $this->includeCharts)); $zipContent['xl/drawings/drawing' . ($i + 1) . '.xml'] = $this->getWriterPart('Drawing')->writeDrawings($this->spreadSheet->getSheet($i), $this->includeCharts);
} elseif (isset($unparsedLoadedData['sheets'][$sheetCodeName]['drawingAlternateContents'])) { } elseif (isset($unparsedLoadedData['sheets'][$sheetCodeName]['drawingAlternateContents'])) {
// Drawings // Drawings
$this->addZipFile('xl/drawings/drawing' . ($i + 1) . '.xml', $this->getWriterPart('Drawing')->writeDrawings($this->spreadSheet->getSheet($i), $this->includeCharts)); $zipContent['xl/drawings/drawing' . ($i + 1) . '.xml'] = $this->getWriterPart('Drawing')->writeDrawings($this->spreadSheet->getSheet($i), $this->includeCharts);
} }
// Add unparsed drawings // Add unparsed drawings
@ -327,7 +320,7 @@ class Xlsx extends BaseWriter
$drawingFile = array_search($relId, $unparsedLoadedData['sheets'][$sheetCodeName]['drawingOriginalIds']); $drawingFile = array_search($relId, $unparsedLoadedData['sheets'][$sheetCodeName]['drawingOriginalIds']);
if ($drawingFile !== false) { if ($drawingFile !== false) {
$drawingFile = ltrim($drawingFile, '.'); $drawingFile = ltrim($drawingFile, '.');
$this->addZipFile('xl' . $drawingFile, $drawingXml); $zipContent['xl' . $drawingFile] = $drawingXml;
} }
} }
} }
@ -335,30 +328,30 @@ class Xlsx extends BaseWriter
// Add comment relationship parts // Add comment relationship parts
if (count($this->spreadSheet->getSheet($i)->getComments()) > 0) { if (count($this->spreadSheet->getSheet($i)->getComments()) > 0) {
// VML Comments // VML Comments
$this->addZipFile('xl/drawings/vmlDrawing' . ($i + 1) . '.vml', $this->getWriterPart('Comments')->writeVMLComments($this->spreadSheet->getSheet($i))); $zipContent['xl/drawings/vmlDrawing' . ($i + 1) . '.vml'] = $this->getWriterPart('Comments')->writeVMLComments($this->spreadSheet->getSheet($i));
// Comments // Comments
$this->addZipFile('xl/comments' . ($i + 1) . '.xml', $this->getWriterPart('Comments')->writeComments($this->spreadSheet->getSheet($i))); $zipContent['xl/comments' . ($i + 1) . '.xml'] = $this->getWriterPart('Comments')->writeComments($this->spreadSheet->getSheet($i));
} }
// Add unparsed relationship parts // Add unparsed relationship parts
if (isset($unparsedLoadedData['sheets'][$sheetCodeName]['vmlDrawings'])) { if (isset($unparsedLoadedData['sheets'][$sheetCodeName]['vmlDrawings'])) {
foreach ($unparsedLoadedData['sheets'][$sheetCodeName]['vmlDrawings'] as $vmlDrawing) { foreach ($unparsedLoadedData['sheets'][$sheetCodeName]['vmlDrawings'] as $vmlDrawing) {
$this->addZipFile($vmlDrawing['filePath'], $vmlDrawing['content']); $zipContent[$vmlDrawing['filePath']] = $vmlDrawing['content'];
} }
} }
// Add header/footer relationship parts // Add header/footer relationship parts
if (count($this->spreadSheet->getSheet($i)->getHeaderFooter()->getImages()) > 0) { if (count($this->spreadSheet->getSheet($i)->getHeaderFooter()->getImages()) > 0) {
// VML Drawings // VML Drawings
$this->addZipFile('xl/drawings/vmlDrawingHF' . ($i + 1) . '.vml', $this->getWriterPart('Drawing')->writeVMLHeaderFooterImages($this->spreadSheet->getSheet($i))); $zipContent['xl/drawings/vmlDrawingHF' . ($i + 1) . '.vml'] = $this->getWriterPart('Drawing')->writeVMLHeaderFooterImages($this->spreadSheet->getSheet($i));
// VML Drawing relationships // VML Drawing relationships
$this->addZipFile('xl/drawings/_rels/vmlDrawingHF' . ($i + 1) . '.vml.rels', $this->getWriterPart('Rels')->writeHeaderFooterDrawingRelationships($this->spreadSheet->getSheet($i))); $zipContent['xl/drawings/_rels/vmlDrawingHF' . ($i + 1) . '.vml.rels'] = $this->getWriterPart('Rels')->writeHeaderFooterDrawingRelationships($this->spreadSheet->getSheet($i));
// Media // Media
foreach ($this->spreadSheet->getSheet($i)->getHeaderFooter()->getImages() as $image) { foreach ($this->spreadSheet->getSheet($i)->getHeaderFooter()->getImages() as $image) {
$this->addZipFile('xl/media/' . $image->getIndexedFilename(), file_get_contents($image->getPath())); $zipContent['xl/media/' . $image->getIndexedFilename()] = file_get_contents($image->getPath());
} }
} }
} }
@ -381,7 +374,7 @@ class Xlsx extends BaseWriter
$imageContents = file_get_contents($imagePath); $imageContents = file_get_contents($imagePath);
} }
$this->addZipFile('xl/media/' . str_replace(' ', '_', $this->getDrawingHashTable()->getByIndex($i)->getIndexedFilename()), $imageContents); $zipContent['xl/media/' . str_replace(' ', '_', $this->getDrawingHashTable()->getByIndex($i)->getIndexedFilename())] = $imageContents;
} elseif ($this->getDrawingHashTable()->getByIndex($i) instanceof MemoryDrawing) { } elseif ($this->getDrawingHashTable()->getByIndex($i) instanceof MemoryDrawing) {
ob_start(); ob_start();
call_user_func( call_user_func(
@ -391,13 +384,23 @@ class Xlsx extends BaseWriter
$imageContents = ob_get_contents(); $imageContents = ob_get_contents();
ob_end_clean(); ob_end_clean();
$this->addZipFile('xl/media/' . str_replace(' ', '_', $this->getDrawingHashTable()->getByIndex($i)->getIndexedFilename()), $imageContents); $zipContent['xl/media/' . str_replace(' ', '_', $this->getDrawingHashTable()->getByIndex($i)->getIndexedFilename())] = $imageContents;
} }
} }
Functions::setReturnDateType($saveDateReturnType); Functions::setReturnDateType($saveDateReturnType);
Calculation::getInstance($this->spreadSheet)->getDebugLog()->setWriteDebugLog($saveDebugLog); Calculation::getInstance($this->spreadSheet)->getDebugLog()->setWriteDebugLog($saveDebugLog);
$this->openFileHandle($pFilename);
$options = new Archive();
$options->setEnableZip64(false);
$options->setOutputStream($this->fileHandle);
$this->zip = new ZipStream(null, $options);
$this->addZipFiles($zipContent);
// Close file // Close file
try { try {
$this->zip->finish(); $this->zip->finish();
@ -545,4 +548,12 @@ class Xlsx extends BaseWriter
$this->zip->addFile($path, $content); $this->zip->addFile($path, $content);
} }
} }
private function addZipFiles(array $zipContent): void
{
foreach ($zipContent as $path => $content)
{
$this->addZipFile($path, $content);
}
}
} }

1
tests/PhpSpreadsheetTests/Writer/Xlsx/DrawingsTest.php
View File

@ -2,6 +2,7 @@
namespace PhpOffice\PhpSpreadsheetTests\Writer\Xlsx; namespace PhpOffice\PhpSpreadsheetTests\Writer\Xlsx;
use PhpOffice\PhpSpreadsheet\IOFactory;
use PhpOffice\PhpSpreadsheet\Reader\Xlsx; use PhpOffice\PhpSpreadsheet\Reader\Xlsx;
use PhpOffice\PhpSpreadsheet\Settings; use PhpOffice\PhpSpreadsheet\Settings;
use PhpOffice\PhpSpreadsheetTests\Functional\AbstractFunctional; use PhpOffice\PhpSpreadsheetTests\Functional\AbstractFunctional;

BIN
tests/data/Writer/XLSX/saving_drawing_with_same_path.xlsx
View File

Binary file not shown.