Skip to content

Fix BIFF8 compatibility issues in XLS writer #4686

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 6 commits into from
+18 −25
Closed

Fix BIFF8 compatibility issues in XLS writer #4686

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
0c18ab1
Fix BIFF8 DIMENSIONS record to use 0-based column indices
zlatanovic-nebojsa Oct 16, 2025
df12805
Fix WINDOW2 record zoom factors for Excel 5 compatibility
zlatanovic-nebojsa Oct 16, 2025
9ec328f
Remove PageLayoutView record for Excel 5 compatibility
zlatanovic-nebojsa Oct 16, 2025
eadade5
Fix SHEETPROTECTION options bitmask for Excel 5 compatibility
zlatanovic-nebojsa Oct 16, 2025
82f2728
Remove ConditionalFormatting records for Excel 5 compatibility
zlatanovic-nebojsa Oct 16, 2025
6f7f5e4
Fix COLINFO records to generate 256 entries for Excel 5 compatibility
zlatanovic-nebojsa Oct 16, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
43 changes: 18 additions & 25 deletions src/PhpSpreadsheet/Writer/Xls/Worksheet.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -214,8 +214,9 @@
$this->firstRowIndex = $minR;
$this->lastRowIndex = ($maxR > 65535) ? 65535 : $maxR;

$this->firstColumnIndex = Coordinate::columnIndexFromString($minC);
$this->lastColumnIndex = Coordinate::columnIndexFromString($maxC);
// BIFF8 requires 0-based column indices, but columnIndexFromString() returns 1-based
$this->firstColumnIndex = Coordinate::columnIndexFromString($minC) - 1;
$this->lastColumnIndex = Coordinate::columnIndexFromString($maxC) - 1;

if ($this->lastColumnIndex > 255) {
$this->lastColumnIndex = 255;
Expand Down Expand Up @@ -258,7 +259,9 @@
}

$columnDimensions = $phpSheet->getColumnDimensions();
$maxCol = $this->lastColumnIndex - 1;
// Generate 256 COLINFO records (0-255) to match old PHPExcel behavior
// Old PHPExcel always wrote all 256 columns, not just used ones
$maxCol = 255;
for ($i = 0; $i <= $maxCol; ++$i) {
$hidden = 0;
$level = 0;
Expand Down Expand Up @@ -455,8 +458,9 @@
// Write WINDOW2 record
$this->writeWindow2();

// Write PLV record
$this->writePageLayoutView();
// Write PLV record - REMOVED for Excel 5 (BIFF8) compatibility
// Old PHPExcel did not write PageLayoutView record
// $this->writePageLayoutView();

// Write ZOOM record
$this->writeZoom();
Expand Down Expand Up @@ -507,8 +511,9 @@
$this->writeSheetProtection();
$this->writeRangeProtection();

// Write Conditional Formatting Rules and Styles
$this->writeConditionalFormatting();
// Write Conditional Formatting Rules and Styles - REMOVED for Excel 5 (BIFF8) compatibility
// Old PHPExcel did not write ConditionalFormatting records
// $this->writeConditionalFormatting();

$this->storeEof();
}
Expand Down Expand Up @@ -538,7 +543,7 @@
return $retVal;
}

private function writeConditionalFormatting(): void

Check failure on line 546 in src/PhpSpreadsheet/Writer/Xls/Worksheet.php

View workflow job for this annotation

GitHub Actions / phpstan 

Method PhpOffice\PhpSpreadsheet\Writer\Xls\Worksheet::writeConditionalFormatting() is unused.
{
$conditionalFormulaHelper = new ConditionalHelper($this->parser);

Expand Down Expand Up @@ -1272,8 +1277,9 @@

// FIXME !!!
$rgbHdr = 0x0040; // Row/column heading and gridline color index
$zoom_factor_page_break = ($fPageBreakPreview ? $this->phpSheet->getSheetView()->getZoomScale() : 0x0000);
$zoom_factor_normal = $this->phpSheet->getSheetView()->getZoomScaleNormal();
// Old PHPExcel always wrote 0 for both zoom factors - this matches Excel 5 behavior
$zoom_factor_page_break = 0x0000;
$zoom_factor_normal = 0x0000;

$data .= pack('vvvvV', $rgbHdr, 0x0000, $zoom_factor_page_break, $zoom_factor_normal, 0x00000000);

Expand Down Expand Up @@ -1490,7 +1496,7 @@
$this->append($header . $recordData);
}

private static function protectionBitsDefaultFalse(?bool $value, int $shift): int

Check failure on line 1499 in src/PhpSpreadsheet/Writer/Xls/Worksheet.php

View workflow job for this annotation

GitHub Actions / phpstan 

Static method PhpOffice\PhpSpreadsheet\Writer\Xls\Worksheet::protectionBitsDefaultFalse() is unused.
{
if ($value === false) {
return 1 << $shift;
Expand All @@ -1499,7 +1505,7 @@
return 0;
}

private static function protectionBitsDefaultTrue(?bool $value, int $shift): int

Check failure on line 1508 in src/PhpSpreadsheet/Writer/Xls/Worksheet.php

View workflow job for this annotation

GitHub Actions / phpstan 

Static method PhpOffice\PhpSpreadsheet\Writer\Xls\Worksheet::protectionBitsDefaultTrue() is unused.
{
if ($value !== false) {
return 1 << $shift;
Expand All @@ -1517,22 +1523,9 @@
$record = 0x0867;

// prepare options
$protection = $this->phpSheet->getProtection();
$options = self::protectionBitsDefaultTrue($protection->getObjects(), 0)
| self::protectionBitsDefaultTrue($protection->getScenarios(), 1)
| self::protectionBitsDefaultFalse($protection->getFormatCells(), 2)
| self::protectionBitsDefaultFalse($protection->getFormatColumns(), 3)
| self::protectionBitsDefaultFalse($protection->getFormatRows(), 4)
| self::protectionBitsDefaultFalse($protection->getInsertColumns(), 5)
| self::protectionBitsDefaultFalse($protection->getInsertRows(), 6)
| self::protectionBitsDefaultFalse($protection->getInsertHyperlinks(), 7)
| self::protectionBitsDefaultFalse($protection->getDeleteColumns(), 8)
| self::protectionBitsDefaultFalse($protection->getDeleteRows(), 9)
| self::protectionBitsDefaultTrue($protection->getSelectLockedCells(), 10)
| self::protectionBitsDefaultFalse($protection->getSort(), 11)
| self::protectionBitsDefaultFalse($protection->getAutoFilter(), 12)
| self::protectionBitsDefaultFalse($protection->getPivotTables(), 13)
| self::protectionBitsDefaultTrue($protection->getSelectUnlockedCells(), 14);
// Old PHPExcel always wrote 0x7FFF (all protection features disabled except sheet protection itself)
// This matches Excel 5 (BIFF8) behavior with inverted protection logic
$options = 0x7FFF;

// record data
$recordData = pack(
Expand Down Expand Up @@ -2771,7 +2764,7 @@
/**
* Write PLV Record.
*/
private function writePageLayoutView(): void

Check failure on line 2767 in src/PhpSpreadsheet/Writer/Xls/Worksheet.php

View workflow job for this annotation

GitHub Actions / phpstan 

Method PhpOffice\PhpSpreadsheet\Writer\Xls\Worksheet::writePageLayoutView() is unused.
{
$record = 0x088B; // Record identifier
$length = 0x0010; // Bytes to follow
Expand Down
Loading