[Summary view]

Differences Between: [Versions 310 and 401] [Versions 311 and 401] [Versions 39 and 401] [Versions 400 and 401] [Versions 401 and 402] [Versions 401 and 403]

   1  <?php
   2  
   3  namespace PhpOffice\PhpSpreadsheet\Writer\Xlsx;
   4  
   5  use PhpOffice\PhpSpreadsheet\Shared\File;
   6  use PhpOffice\PhpSpreadsheet\Shared\XMLWriter;
   7  use PhpOffice\PhpSpreadsheet\Spreadsheet;
   8  use PhpOffice\PhpSpreadsheet\Worksheet\MemoryDrawing;
   9  use PhpOffice\PhpSpreadsheet\Writer\Exception as WriterException;
  10  
  11  class ContentTypes extends WriterPart
  12  {
  13      /**
  14       * Write content types to XML format.
  15       *
  16       * @param bool $includeCharts Flag indicating if we should include drawing details for charts
  17       *
  18       * @return string XML Output
  19       */
  20      public function writeContentTypes(Spreadsheet $spreadsheet, $includeCharts = false)
  21      {
  22          // Create XML writer
  23          $objWriter = null;
  24          if ($this->getParentWriter()->getUseDiskCaching()) {
  25              $objWriter = new XMLWriter(XMLWriter::STORAGE_DISK, $this->getParentWriter()->getDiskCachingDirectory());
  26          } else {
  27              $objWriter = new XMLWriter(XMLWriter::STORAGE_MEMORY);
  28          }
  29  
  30          // XML header
  31          $objWriter->startDocument('1.0', 'UTF-8', 'yes');
  32  
  33          // Types
  34          $objWriter->startElement('Types');
  35          $objWriter->writeAttribute('xmlns', 'http://schemas.openxmlformats.org/package/2006/content-types');
  36  
  37          // Theme
  38          $this->writeOverrideContentType($objWriter, '/xl/theme/theme1.xml', 'application/vnd.openxmlformats-officedocument.theme+xml');
  39  
  40          // Styles
  41          $this->writeOverrideContentType($objWriter, '/xl/styles.xml', 'application/vnd.openxmlformats-officedocument.spreadsheetml.styles+xml');
  42  
  43          // Rels
  44          $this->writeDefaultContentType($objWriter, 'rels', 'application/vnd.openxmlformats-package.relationships+xml');
  45  
  46          // XML
  47          $this->writeDefaultContentType($objWriter, 'xml', 'application/xml');
  48  
  49          // VML
  50          $this->writeDefaultContentType($objWriter, 'vml', 'application/vnd.openxmlformats-officedocument.vmlDrawing');
  51  
  52          // Workbook
  53          if ($spreadsheet->hasMacros()) { //Macros in workbook ?
  54              // Yes : not standard content but "macroEnabled"
  55              $this->writeOverrideContentType($objWriter, '/xl/workbook.xml', 'application/vnd.ms-excel.sheet.macroEnabled.main+xml');
  56              //... and define a new type for the VBA project
  57              // Better use Override, because we can use 'bin' also for xl\printerSettings\printerSettings1.bin
  58              $this->writeOverrideContentType($objWriter, '/xl/vbaProject.bin', 'application/vnd.ms-office.vbaProject');
  59              if ($spreadsheet->hasMacrosCertificate()) {
  60                  // signed macros ?
  61                  // Yes : add needed information
  62                  $this->writeOverrideContentType($objWriter, '/xl/vbaProjectSignature.bin', 'application/vnd.ms-office.vbaProjectSignature');
  63              }
  64          } else {
  65              // no macros in workbook, so standard type
  66              $this->writeOverrideContentType($objWriter, '/xl/workbook.xml', 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet.main+xml');
  67          }
  68  
  69          // DocProps
  70          $this->writeOverrideContentType($objWriter, '/docProps/app.xml', 'application/vnd.openxmlformats-officedocument.extended-properties+xml');
  71  
  72          $this->writeOverrideContentType($objWriter, '/docProps/core.xml', 'application/vnd.openxmlformats-package.core-properties+xml');
  73  
  74          $customPropertyList = $spreadsheet->getProperties()->getCustomProperties();
  75          if (!empty($customPropertyList)) {
  76              $this->writeOverrideContentType($objWriter, '/docProps/custom.xml', 'application/vnd.openxmlformats-officedocument.custom-properties+xml');
  77          }
  78  
  79          // Worksheets
  80          $sheetCount = $spreadsheet->getSheetCount();
  81          for ($i = 0; $i < $sheetCount; ++$i) {
  82              $this->writeOverrideContentType($objWriter, '/xl/worksheets/sheet' . ($i + 1) . '.xml', 'application/vnd.openxmlformats-officedocument.spreadsheetml.worksheet+xml');
  83          }
  84  
  85          // Shared strings
  86          $this->writeOverrideContentType($objWriter, '/xl/sharedStrings.xml', 'application/vnd.openxmlformats-officedocument.spreadsheetml.sharedStrings+xml');
  87  
  88          // Table
  89          $table = 1;
  90          for ($i = 0; $i < $sheetCount; ++$i) {
  91              $tableCount = $spreadsheet->getSheet($i)->getTableCollection()->count();
  92  
  93              for ($t = 1; $t <= $tableCount; ++$t) {
  94                  $this->writeOverrideContentType($objWriter, '/xl/tables/table' . $table++ . '.xml', 'application/vnd.openxmlformats-officedocument.spreadsheetml.table+xml');
  95              }
  96          }
  97  
  98          // Add worksheet relationship content types
  99          $unparsedLoadedData = $spreadsheet->getUnparsedLoadedData();
 100          $chart = 1;
 101          for ($i = 0; $i < $sheetCount; ++$i) {
 102              $drawings = $spreadsheet->getSheet($i)->getDrawingCollection();
 103              $drawingCount = count($drawings);
 104              $chartCount = ($includeCharts) ? $spreadsheet->getSheet($i)->getChartCount() : 0;
 105              $hasUnparsedDrawing = isset($unparsedLoadedData['sheets'][$spreadsheet->getSheet($i)->getCodeName()]['drawingOriginalIds']);
 106  
 107              //    We need a drawing relationship for the worksheet if we have either drawings or charts
 108              if (($drawingCount > 0) || ($chartCount > 0) || $hasUnparsedDrawing) {
 109                  $this->writeOverrideContentType($objWriter, '/xl/drawings/drawing' . ($i + 1) . '.xml', 'application/vnd.openxmlformats-officedocument.drawing+xml');
 110              }
 111  
 112              //    If we have charts, then we need a chart relationship for every individual chart
 113              if ($chartCount > 0) {
 114                  for ($c = 0; $c < $chartCount; ++$c) {
 115                      $this->writeOverrideContentType($objWriter, '/xl/charts/chart' . $chart++ . '.xml', 'application/vnd.openxmlformats-officedocument.drawingml.chart+xml');
 116                  }
 117              }
 118          }
 119  
 120          // Comments
 121          for ($i = 0; $i < $sheetCount; ++$i) {
 122              if (count($spreadsheet->getSheet($i)->getComments()) > 0) {
 123                  $this->writeOverrideContentType($objWriter, '/xl/comments' . ($i + 1) . '.xml', 'application/vnd.openxmlformats-officedocument.spreadsheetml.comments+xml');
 124              }
 125          }
 126  
 127          // Add media content-types
 128          $aMediaContentTypes = [];
 129          $mediaCount = $this->getParentWriter()->getDrawingHashTable()->count();
 130          for ($i = 0; $i < $mediaCount; ++$i) {
 131              $extension = '';
 132              $mimeType = '';
 133  
 134              if ($this->getParentWriter()->getDrawingHashTable()->getByIndex($i) instanceof \PhpOffice\PhpSpreadsheet\Worksheet\Drawing) {
 135                  $extension = strtolower($this->getParentWriter()->getDrawingHashTable()->getByIndex($i)->getExtension());
 136                  $mimeType = $this->getImageMimeType($this->getParentWriter()->getDrawingHashTable()->getByIndex($i)->getPath());
 137              } elseif ($this->getParentWriter()->getDrawingHashTable()->getByIndex($i) instanceof MemoryDrawing) {
 138                  $extension = strtolower($this->getParentWriter()->getDrawingHashTable()->getByIndex($i)->getMimeType());
 139                  $extension = explode('/', $extension);
 140                  $extension = $extension[1];
 141  
 142                  $mimeType = $this->getParentWriter()->getDrawingHashTable()->getByIndex($i)->getMimeType();
 143              }
 144  
 145              if (!isset($aMediaContentTypes[$extension])) {
 146                  $aMediaContentTypes[$extension] = $mimeType;
 147  
 148                  $this->writeDefaultContentType($objWriter, $extension, $mimeType);
 149              }
 150          }
 151          if ($spreadsheet->hasRibbonBinObjects()) {
 152              // Some additional objects in the ribbon ?
 153              // we need to write "Extension" but not already write for media content
 154              $tabRibbonTypes = array_diff($spreadsheet->getRibbonBinObjects('types') ?? [], array_keys($aMediaContentTypes));
 155              foreach ($tabRibbonTypes as $aRibbonType) {
 156                  $mimeType = 'image/.' . $aRibbonType; //we wrote $mimeType like customUI Editor
 157                  $this->writeDefaultContentType($objWriter, $aRibbonType, $mimeType);
 158              }
 159          }
 160          $sheetCount = $spreadsheet->getSheetCount();
 161          for ($i = 0; $i < $sheetCount; ++$i) {
 162              if (count($spreadsheet->getSheet($i)->getHeaderFooter()->getImages()) > 0) {
 163                  foreach ($spreadsheet->getSheet($i)->getHeaderFooter()->getImages() as $image) {
 164                      if (!isset($aMediaContentTypes[strtolower($image->getExtension())])) {
 165                          $aMediaContentTypes[strtolower($image->getExtension())] = $this->getImageMimeType($image->getPath());
 166  
 167                          $this->writeDefaultContentType($objWriter, strtolower($image->getExtension()), $aMediaContentTypes[strtolower($image->getExtension())]);
 168                      }
 169                  }
 170              }
 171  
 172              if (count($spreadsheet->getSheet($i)->getComments()) > 0) {
 173                  foreach ($spreadsheet->getSheet($i)->getComments() as $comment) {
 174                      if (!$comment->hasBackgroundImage()) {
 175                          continue;
 176                      }
 177  
 178                      $bgImage = $comment->getBackgroundImage();
 179                      $bgImageExtentionKey = strtolower($bgImage->getImageFileExtensionForSave(false));
 180  
 181                      if (!isset($aMediaContentTypes[$bgImageExtentionKey])) {
 182                          $aMediaContentTypes[$bgImageExtentionKey] = $bgImage->getImageMimeType();
 183  
 184                          $this->writeDefaultContentType($objWriter, $bgImageExtentionKey, $aMediaContentTypes[$bgImageExtentionKey]);
 185                      }
 186                  }
 187              }
 188          }
 189  
 190          // unparsed defaults
 191          if (isset($unparsedLoadedData['default_content_types'])) {
 192              foreach ($unparsedLoadedData['default_content_types'] as $extName => $contentType) {
 193                  $this->writeDefaultContentType($objWriter, $extName, $contentType);
 194              }
 195          }
 196  
 197          // unparsed overrides
 198          if (isset($unparsedLoadedData['override_content_types'])) {
 199              foreach ($unparsedLoadedData['override_content_types'] as $partName => $overrideType) {
 200                  $this->writeOverrideContentType($objWriter, $partName, $overrideType);
 201              }
 202          }
 203  
 204          $objWriter->endElement();
 205  
 206          // Return
 207          return $objWriter->getData();
 208      }
 209  
 210      /**
 211       * Get image mime type.
 212       *
 213       * @param string $filename Filename
 214       *
 215       * @return string Mime Type
 216       */
 217      private function getImageMimeType($filename)
 218      {
 219          if (File::fileExists($filename)) {
 220              $image = getimagesize($filename);
 221  
 222              return image_type_to_mime_type((is_array($image) && count($image) >= 3) ? $image[2] : 0);
 223          }
 224  
 225          throw new WriterException("File $filename does not exist");
 226      }
 227  
 228      /**
 229       * Write Default content type.
 230       *
 231       * @param string $partName Part name
 232       * @param string $contentType Content type
 233       */
 234      private function writeDefaultContentType(XMLWriter $objWriter, $partName, $contentType): void
 235      {
 236          if ($partName != '' && $contentType != '') {
 237              // Write content type
 238              $objWriter->startElement('Default');
 239              $objWriter->writeAttribute('Extension', $partName);
 240              $objWriter->writeAttribute('ContentType', $contentType);
 241              $objWriter->endElement();
 242          } else {
 243              throw new WriterException('Invalid parameters passed.');
 244          }
 245      }
 246  
 247      /**
 248       * Write Override content type.
 249       *
 250       * @param string $partName Part name
 251       * @param string $contentType Content type
 252       */
 253      private function writeOverrideContentType(XMLWriter $objWriter, $partName, $contentType): void
 254      {
 255          if ($partName != '' && $contentType != '') {
 256              // Write content type
 257              $objWriter->startElement('Override');
 258              $objWriter->writeAttribute('PartName', $partName);
 259              $objWriter->writeAttribute('ContentType', $contentType);
 260              $objWriter->endElement();
 261          } else {
 262              throw new WriterException('Invalid parameters passed.');
 263          }
 264      }
 265  }