From 4727ab718d374ab86f465e51a83a3ef0018a944a Mon Sep 17 00:00:00 2001 From: moparisthebest Date: Tue, 30 May 2017 16:14:35 -0400 Subject: [PATCH] Allow specifying SpreadsheetVersion when instantiating blank HSSFWorkbook --- .../apache/poi/hssf/model/InternalSheet.java | 10 +++++-- .../aggregates/RowRecordsAggregate.java | 16 +++++++--- .../apache/poi/hssf/usermodel/HSSFCell.java | 17 +++++------ .../usermodel/HSSFEvaluationWorkbook.java | 2 +- .../apache/poi/hssf/usermodel/HSSFName.java | 6 ++-- .../apache/poi/hssf/usermodel/HSSFRow.java | 2 +- .../apache/poi/hssf/usermodel/HSSFSheet.java | 30 +++++++++---------- .../HSSFSheetConditionalFormatting.java | 2 +- .../poi/hssf/usermodel/HSSFWorkbook.java | 29 +++++++++++++++++- .../apache/poi/xssf/usermodel/XSSFName.java | 2 +- 10 files changed, 76 insertions(+), 40 deletions(-) diff --git a/src/java/org/apache/poi/hssf/model/InternalSheet.java b/src/java/org/apache/poi/hssf/model/InternalSheet.java index ab07b7c7a..6f8463e36 100644 --- a/src/java/org/apache/poi/hssf/model/InternalSheet.java +++ b/src/java/org/apache/poi/hssf/model/InternalSheet.java @@ -70,6 +70,7 @@ import org.apache.poi.hssf.record.aggregates.RecordAggregate.PositionTrackingVis import org.apache.poi.hssf.record.aggregates.RecordAggregate.RecordVisitor; import org.apache.poi.hssf.record.aggregates.RowRecordsAggregate; import org.apache.poi.hssf.record.aggregates.WorksheetProtectionBlock; +import org.apache.poi.ss.SpreadsheetVersion; import org.apache.poi.ss.formula.FormulaShifter; import org.apache.poi.ss.util.CellRangeAddress; import org.apache.poi.ss.util.PaneInformation; @@ -444,9 +445,12 @@ public final class InternalSheet { * @return Sheet object with all values set to defaults */ public static InternalSheet createSheet() { - return new InternalSheet(); + return new InternalSheet(SpreadsheetVersion.EXCEL97); } - private InternalSheet() { + public static InternalSheet createSheet(final SpreadsheetVersion spreadsheetVersion) { + return new InternalSheet(spreadsheetVersion); + } + private InternalSheet(final SpreadsheetVersion spreadsheetVersion) { _mergedCellsTable = new MergedCellsTable(); List records = new ArrayList(32); @@ -487,7 +491,7 @@ public final class InternalSheet { _columnInfos = columns; _dimensions = createDimensions(); records.add(_dimensions); - _rowsAggregate = new RowRecordsAggregate(); + _rowsAggregate = new RowRecordsAggregate(spreadsheetVersion); records.add(_rowsAggregate); // 'Sheet View Settings' records.add(windowTwo = createWindowTwo()); diff --git a/src/java/org/apache/poi/hssf/record/aggregates/RowRecordsAggregate.java b/src/java/org/apache/poi/hssf/record/aggregates/RowRecordsAggregate.java index 5551639b4..f69e0ef71 100644 --- a/src/java/org/apache/poi/hssf/record/aggregates/RowRecordsAggregate.java +++ b/src/java/org/apache/poi/hssf/record/aggregates/RowRecordsAggregate.java @@ -40,6 +40,7 @@ public final class RowRecordsAggregate extends RecordAggregate { private final ValueRecordsAggregate _valuesAgg; private final List _unknownRecords; private final SharedValueManager _sharedValueManager; + private final SpreadsheetVersion _spreadsheetVersion; // Cache values to speed up performance of // getStartRowNumberForBlock / getEndRowNumberForBlock, see Bugzilla 47405 @@ -47,9 +48,15 @@ public final class RowRecordsAggregate extends RecordAggregate { /** Creates a new instance of ValueRecordsAggregate */ public RowRecordsAggregate() { - this(SharedValueManager.createEmpty()); + this(SharedValueManager.createEmpty(), SpreadsheetVersion.EXCEL97); } - private RowRecordsAggregate(SharedValueManager svm) { + public RowRecordsAggregate(final SpreadsheetVersion spreadsheetVersion) { + this(SharedValueManager.createEmpty(), spreadsheetVersion); + if (spreadsheetVersion == null) { + throw new IllegalArgumentException("SpreadsheetVersion must be provided."); + } + } + private RowRecordsAggregate(SharedValueManager svm, final SpreadsheetVersion spreadsheetVersion) { if (svm == null) { throw new IllegalArgumentException("SharedValueManager must be provided."); } @@ -57,6 +64,7 @@ public final class RowRecordsAggregate extends RecordAggregate { _valuesAgg = new ValueRecordsAggregate(); _unknownRecords = new ArrayList(); _sharedValueManager = svm; + _spreadsheetVersion = spreadsheetVersion; } /** @@ -66,7 +74,7 @@ public final class RowRecordsAggregate extends RecordAggregate { * and table records of the current sheet). Never null. */ public RowRecordsAggregate(RecordStream rs, SharedValueManager svm) { - this(svm); + this(svm, SpreadsheetVersion.EXCEL97); while(rs.hasNext()) { Record rec = rs.getNext(); switch (rec.getSid()) { @@ -143,7 +151,7 @@ public final class RowRecordsAggregate extends RecordAggregate { } public RowRecord getRow(int rowIndex) { - int maxrow = SpreadsheetVersion.EXCEL97.getLastRowIndex(); + int maxrow = _spreadsheetVersion.getLastRowIndex(); if (rowIndex < 0 || rowIndex > maxrow) { throw new IllegalArgumentException("The row number must be between 0 and " + maxrow + ", but had: " + rowIndex); } diff --git a/src/java/org/apache/poi/hssf/usermodel/HSSFCell.java b/src/java/org/apache/poi/hssf/usermodel/HSSFCell.java index a95ea239a..2875a8f81 100644 --- a/src/java/org/apache/poi/hssf/usermodel/HSSFCell.java +++ b/src/java/org/apache/poi/hssf/usermodel/HSSFCell.java @@ -70,11 +70,6 @@ import org.apache.poi.util.LocaleUtil; */ public class HSSFCell implements Cell { private static final String FILE_FORMAT_NAME = "BIFF8"; - /** - * The maximum number of columns in BIFF8 - */ - public static final int LAST_COLUMN_NUMBER = SpreadsheetVersion.EXCEL97.getLastColumnIndex(); // 2^8 - 1 - private static final String LAST_COLUMN_NAME = SpreadsheetVersion.EXCEL97.getLastColumnName(); public final static short ENCODING_UNCHANGED = -1; public final static short ENCODING_COMPRESSED_UNICODE = 0; @@ -105,7 +100,7 @@ public class HSSFCell implements Cell { */ protected HSSFCell(HSSFWorkbook book, HSSFSheet sheet, int row, short col) { - checkBounds(col); + checkBounds(col, book); _stringValue = null; _book = book; _sheet = sheet; @@ -150,7 +145,7 @@ public class HSSFCell implements Cell { protected HSSFCell(HSSFWorkbook book, HSSFSheet sheet, int row, short col, CellType type) { - checkBounds(col); + checkBounds(col, book); _cellType = CellType._NONE; // Force 'setCellType' to create a first Record _stringValue = null; _book = book; @@ -570,8 +565,8 @@ public class HSSFCell implements Cell { return; } - if(value.length() > SpreadsheetVersion.EXCEL97.getMaxTextLength()){ - throw new IllegalArgumentException("The maximum length of cell contents (text) is 32,767 characters"); + if(value.length() > _book.getSpreadsheetVersion().getMaxTextLength()){ + throw new IllegalArgumentException("The maximum length of cell contents (text) is "+_book.getSpreadsheetVersion().getMaxTextLength()+" characters"); } if (_cellType == CellType.FORMULA) { @@ -977,8 +972,10 @@ public class HSSFCell implements Cell { /** * @throws RuntimeException if the bounds are exceeded. */ - private static void checkBounds(int cellIndex) { + private static void checkBounds(int cellIndex, final HSSFWorkbook book) { + final int LAST_COLUMN_NUMBER = book.getSpreadsheetVersion().getLastColumnIndex(); // 2^8 - 1 if (cellIndex < 0 || cellIndex > LAST_COLUMN_NUMBER) { + final String LAST_COLUMN_NAME = book.getSpreadsheetVersion().getLastColumnName(); throw new IllegalArgumentException("Invalid column index (" + cellIndex + "). Allowable column range for " + FILE_FORMAT_NAME + " is (0.." + LAST_COLUMN_NUMBER + ") or ('A'..'" + LAST_COLUMN_NAME + "')"); diff --git a/src/java/org/apache/poi/hssf/usermodel/HSSFEvaluationWorkbook.java b/src/java/org/apache/poi/hssf/usermodel/HSSFEvaluationWorkbook.java index b0fa3e28f..2e139c3df 100644 --- a/src/java/org/apache/poi/hssf/usermodel/HSSFEvaluationWorkbook.java +++ b/src/java/org/apache/poi/hssf/usermodel/HSSFEvaluationWorkbook.java @@ -296,7 +296,7 @@ public final class HSSFEvaluationWorkbook implements FormulaRenderingWorkbook, E @Override public SpreadsheetVersion getSpreadsheetVersion(){ - return SpreadsheetVersion.EXCEL97; + return _uBook.getSpreadsheetVersion(); } /** diff --git a/src/java/org/apache/poi/hssf/usermodel/HSSFName.java b/src/java/org/apache/poi/hssf/usermodel/HSSFName.java index bbd48c23f..e8fa70bdd 100644 --- a/src/java/org/apache/poi/hssf/usermodel/HSSFName.java +++ b/src/java/org/apache/poi/hssf/usermodel/HSSFName.java @@ -129,7 +129,7 @@ public final class HSSFName implements Name { * @throws IllegalArgumentException if the name is invalid or the name already exists (case-insensitive) */ public void setNameName(String nameName){ - validateName(nameName); + validateName(nameName, _book.getSpreadsheetVersion()); InternalWorkbook wb = _book.getWorkbook(); _definedNameRec.setNameText(nameName); @@ -178,7 +178,7 @@ public final class HSSFName implements Name { * * @param name */ - private static void validateName(String name) { + private static void validateName(String name, SpreadsheetVersion spreadsheetVersion) { if (name.length() == 0) { throw new IllegalArgumentException("Name cannot be blank"); @@ -212,7 +212,7 @@ public final class HSSFName implements Name { if (name.matches("[A-Za-z]+\\d+")) { String col = name.replaceAll("\\d", ""); String row = name.replaceAll("[A-Za-z]", ""); - if (CellReference.cellReferenceIsWithinRange(col, row, SpreadsheetVersion.EXCEL97)) { + if (CellReference.cellReferenceIsWithinRange(col, row, spreadsheetVersion)) { throw new IllegalArgumentException("Invalid name: '"+name+"': cannot be $A$1-style cell reference"); } } diff --git a/src/java/org/apache/poi/hssf/usermodel/HSSFRow.java b/src/java/org/apache/poi/hssf/usermodel/HSSFRow.java index 7af241c85..c4f9864f0 100644 --- a/src/java/org/apache/poi/hssf/usermodel/HSSFRow.java +++ b/src/java/org/apache/poi/hssf/usermodel/HSSFRow.java @@ -247,7 +247,7 @@ public final class HSSFRow implements Row, Comparable { */ @Override public void setRowNum(int rowIndex) { - int maxrow = SpreadsheetVersion.EXCEL97.getLastRowIndex(); + int maxrow = book.getSpreadsheetVersion().getLastRowIndex(); if ((rowIndex < 0) || (rowIndex > maxrow)) { throw new IllegalArgumentException("Invalid row number (" + rowIndex + ") outside allowable range (0.." + maxrow + ")"); diff --git a/src/java/org/apache/poi/hssf/usermodel/HSSFSheet.java b/src/java/org/apache/poi/hssf/usermodel/HSSFSheet.java index 4e5f28095..3459653a2 100644 --- a/src/java/org/apache/poi/hssf/usermodel/HSSFSheet.java +++ b/src/java/org/apache/poi/hssf/usermodel/HSSFSheet.java @@ -123,7 +123,7 @@ public final class HSSFSheet implements org.apache.poi.ss.usermodel.Sheet { * @see org.apache.poi.hssf.usermodel.HSSFWorkbook#createSheet() */ protected HSSFSheet(HSSFWorkbook workbook) { - _sheet = InternalSheet.createSheet(); + _sheet = InternalSheet.createSheet(workbook.getSpreadsheetVersion()); _rows = new TreeMap(); this._workbook = workbook; this._book = workbook.getWorkbook(); @@ -715,7 +715,7 @@ public final class HSSFSheet implements org.apache.poi.ss.usermodel.Sheet { if (region.getNumberOfCells() < 2) { throw new IllegalArgumentException("Merged region " + region.formatAsString() + " must contain 2 or more cells"); } - region.validate(SpreadsheetVersion.EXCEL97); + region.validate(_workbook.getSpreadsheetVersion()); if (validate) { // throw IllegalStateException if the argument CellRangeAddress intersects with @@ -1453,7 +1453,7 @@ public final class HSSFSheet implements org.apache.poi.ss.usermodel.Sheet { */ @Override public void showInPane(int toprow, int leftcol) { - int maxrow = SpreadsheetVersion.EXCEL97.getLastRowIndex(); + final int maxrow = _workbook.getSpreadsheetVersion().getLastRowIndex(); if (toprow > maxrow) throw new IllegalArgumentException("Maximum row number is " + maxrow); showInPane((short)toprow, (short)leftcol); @@ -1530,10 +1530,10 @@ public final class HSSFSheet implements org.apache.poi.ss.usermodel.Sheet { * * @param row the row number */ - private static int clip(int row) { + private int clip(int row) { return Math.min( Math.max(0, row), - SpreadsheetVersion.EXCEL97.getLastRowIndex()); + _workbook.getSpreadsheetVersion().getLastRowIndex()); } /** @@ -1677,7 +1677,7 @@ public final class HSSFSheet implements org.apache.poi.ss.usermodel.Sheet { } } if (endRow + n > _lastrow) { - _lastrow = Math.min(endRow + n, SpreadsheetVersion.EXCEL97.getLastRowIndex()); + _lastrow = Math.min(endRow + n, _workbook.getSpreadsheetVersion().getLastRowIndex()); } } else { // Rows are moving up @@ -1687,7 +1687,7 @@ public final class HSSFSheet implements org.apache.poi.ss.usermodel.Sheet { if (endRow == _lastrow) { // Need to walk backward to find the last non-blank row // NOTE: n is always negative here - _lastrow = Math.min(endRow + n, SpreadsheetVersion.EXCEL97.getLastRowIndex()); + _lastrow = Math.min(endRow + n, _workbook.getSpreadsheetVersion().getLastRowIndex()); for (int i = endRow - 1; i > endRow + n; i--) { if (getRow(i) != null) { _lastrow = i; @@ -1703,7 +1703,7 @@ public final class HSSFSheet implements org.apache.poi.ss.usermodel.Sheet { String sheetName = _workbook.getSheetName(sheetIndex); short externSheetIndex = _book.checkExternSheet(sheetIndex); FormulaShifter shifter = FormulaShifter.createForRowShift( - externSheetIndex, sheetName, startRow, endRow, n, SpreadsheetVersion.EXCEL97); + externSheetIndex, sheetName, startRow, endRow, n, _workbook.getSpreadsheetVersion()); _sheet.updateFormulasAfterCellShift(shifter, externSheetIndex); int nSheets = _workbook.getNumberOfSheets(); @@ -1923,7 +1923,7 @@ public final class HSSFSheet implements org.apache.poi.ss.usermodel.Sheet { @Override public void setColumnBreak(int column) { validateColumn((short) column); - _sheet.getPageSettings().setColumnBreak((short) column, (short) 0, (short) SpreadsheetVersion.EXCEL97.getLastRowIndex()); + _sheet.getPageSettings().setColumnBreak((short) column, (short) 0, (short) _workbook.getSpreadsheetVersion().getLastRowIndex()); } /** @@ -1953,7 +1953,7 @@ public final class HSSFSheet implements org.apache.poi.ss.usermodel.Sheet { * @param row the index of the row to validate, zero-based */ protected void validateRow(int row) { - int maxrow = SpreadsheetVersion.EXCEL97.getLastRowIndex(); + final int maxrow = _workbook.getSpreadsheetVersion().getLastRowIndex(); if (row > maxrow) throw new IllegalArgumentException("Maximum row number is " + maxrow); if (row < 0) throw new IllegalArgumentException("Minumum row number is 0"); } @@ -1964,7 +1964,7 @@ public final class HSSFSheet implements org.apache.poi.ss.usermodel.Sheet { * @param column the index of the column to validate, zero-based */ protected void validateColumn(int column) { - int maxcol = SpreadsheetVersion.EXCEL97.getLastColumnIndex(); + final int maxcol = _workbook.getSpreadsheetVersion().getLastColumnIndex(); if (column > maxcol) throw new IllegalArgumentException("Maximum column number is " + maxcol); if (column < 0) throw new IllegalArgumentException("Minimum column number is 0"); } @@ -2496,8 +2496,8 @@ public final class HSSFSheet implements org.apache.poi.ss.usermodel.Sheet { private void setRepeatingRowsAndColumns( CellRangeAddress rowDef, CellRangeAddress colDef) { int sheetIndex = _workbook.getSheetIndex(this); - int maxRowIndex = SpreadsheetVersion.EXCEL97.getLastRowIndex(); - int maxColIndex = SpreadsheetVersion.EXCEL97.getLastColumnIndex(); + final int maxRowIndex = _workbook.getSpreadsheetVersion().getLastRowIndex(); + final int maxColIndex = _workbook.getSpreadsheetVersion().getLastColumnIndex(); int col1 = -1; int col2 = -1; @@ -2582,8 +2582,8 @@ public final class HSSFSheet implements org.apache.poi.ss.usermodel.Sheet { return null; } - int maxRowIndex = SpreadsheetVersion.EXCEL97.getLastRowIndex(); - int maxColIndex = SpreadsheetVersion.EXCEL97.getLastColumnIndex(); + final int maxRowIndex = _workbook.getSpreadsheetVersion().getLastRowIndex(); + final int maxColIndex = _workbook.getSpreadsheetVersion().getLastColumnIndex(); for (Ptg ptg : nameDefinition) { diff --git a/src/java/org/apache/poi/hssf/usermodel/HSSFSheetConditionalFormatting.java b/src/java/org/apache/poi/hssf/usermodel/HSSFSheetConditionalFormatting.java index d3aba5ba2..fcca91d2f 100644 --- a/src/java/org/apache/poi/hssf/usermodel/HSSFSheetConditionalFormatting.java +++ b/src/java/org/apache/poi/hssf/usermodel/HSSFSheetConditionalFormatting.java @@ -174,7 +174,7 @@ public final class HSSFSheetConditionalFormatting implements SheetConditionalFor if (regions == null) { throw new IllegalArgumentException("regions must not be null"); } - for(CellRangeAddress range : regions) range.validate(SpreadsheetVersion.EXCEL97); + for(CellRangeAddress range : regions) range.validate(_sheet._workbook.getSpreadsheetVersion()); if (cfRules == null) { throw new IllegalArgumentException("cfRules must not be null"); diff --git a/src/java/org/apache/poi/hssf/usermodel/HSSFWorkbook.java b/src/java/org/apache/poi/hssf/usermodel/HSSFWorkbook.java index a24bab7f0..8bbd847d4 100644 --- a/src/java/org/apache/poi/hssf/usermodel/HSSFWorkbook.java +++ b/src/java/org/apache/poi/hssf/usermodel/HSSFWorkbook.java @@ -143,6 +143,11 @@ public final class HSSFWorkbook extends POIDocument implements org.apache.poi.ss public final static int INITIAL_CAPACITY = Configurator.getIntValue("HSSFWorkbook.SheetInitialCapacity",3); + /** + * SpreadsheetVersion used by this workbook, EXCEL97 in every case where we need to read or write to disk + */ + public final SpreadsheetVersion spreadsheetVersion; + /** * this is the reference to the low level Workbook object */ @@ -207,8 +212,19 @@ public final class HSSFWorkbook extends POIDocument implements org.apache.poi.ss this(InternalWorkbook.createWorkbook()); } + public HSSFWorkbook(final SpreadsheetVersion spreadsheetVersion) { + this(InternalWorkbook.createWorkbook(), spreadsheetVersion); + if(spreadsheetVersion == null) + throw new IllegalArgumentException("SpreadsheetVersion must be non-null"); + } + private HSSFWorkbook(InternalWorkbook book) { + this(book, SpreadsheetVersion.EXCEL97); + } + + private HSSFWorkbook(InternalWorkbook book, final SpreadsheetVersion spreadsheetVersion) { super((DirectoryNode)null); + this.spreadsheetVersion = spreadsheetVersion; workbook = book; _sheets = new ArrayList(INITIAL_CAPACITY); names = new ArrayList(INITIAL_CAPACITY); @@ -328,6 +344,7 @@ public final class HSSFWorkbook extends POIDocument implements org.apache.poi.ss throws IOException { super(directory); + spreadsheetVersion = SpreadsheetVersion.EXCEL97; String workbookName = getWorkbookDirEntryName(directory); this.preserveNodes = preserveNodes; @@ -1363,6 +1380,12 @@ public final class HSSFWorkbook extends POIDocument implements org.apache.poi.ss super.close(); } + protected void validateSpreadsheetVersionWritePossible() throws IllegalStateException { + if (this.spreadsheetVersion != SpreadsheetVersion.EXCEL97) { + throw new IllegalStateException("SpreadsheetVersion not EXCEL97, cannot write file meant only for in-memory calculations"); + } + } + /** * Write out this workbook to the currently open {@link File} via the * writeable {@link POIFSFileSystem} it was opened as. @@ -1375,6 +1398,7 @@ public final class HSSFWorkbook extends POIDocument implements org.apache.poi.ss */ @Override public void write() throws IOException { + validateSpreadsheetVersionWritePossible(); validateInPlaceWritePossible(); final DirectoryNode dir = getDirectory(); @@ -1408,6 +1432,7 @@ public final class HSSFWorkbook extends POIDocument implements org.apache.poi.ss */ @Override public void write(File newFile) throws IOException { + validateSpreadsheetVersionWritePossible(); POIFSFileSystem fs = POIFSFileSystem.create(newFile); try { write(fs); @@ -1434,6 +1459,7 @@ public final class HSSFWorkbook extends POIDocument implements org.apache.poi.ss */ @Override public void write(OutputStream stream) throws IOException { + validateSpreadsheetVersionWritePossible(); NPOIFSFileSystem fs = new NPOIFSFileSystem(); try { write(fs); @@ -1445,6 +1471,7 @@ public final class HSSFWorkbook extends POIDocument implements org.apache.poi.ss /** Writes the workbook out to a brand new, empty POIFS */ private void write(NPOIFSFileSystem fs) throws IOException { + validateSpreadsheetVersionWritePossible(); // For tracking what we've written out, used if we're // going to be preserving nodes List excepts = new ArrayList(1); @@ -2325,6 +2352,6 @@ public final class HSSFWorkbook extends POIDocument implements org.apache.poi.ss */ @Override public SpreadsheetVersion getSpreadsheetVersion() { - return SpreadsheetVersion.EXCEL97; + return this.spreadsheetVersion; } } diff --git a/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFName.java b/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFName.java index 1e97f8275..d60ed5f89 100644 --- a/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFName.java +++ b/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFName.java @@ -402,7 +402,7 @@ public final class XSSFName implements Name { if (name.matches("[A-Za-z]+\\d+")) { String col = name.replaceAll("\\d", ""); String row = name.replaceAll("[A-Za-z]", ""); - if (CellReference.cellReferenceIsWithinRange(col, row, SpreadsheetVersion.EXCEL97)) { + if (CellReference.cellReferenceIsWithinRange(col, row, SpreadsheetVersion.EXCEL97)) { // todo: is EXCEL97 correct? sounds wrong... throw new IllegalArgumentException("Invalid name: '"+name+"': cannot be $A$1-style cell reference"); } }