diff --git a/src/documentation/content/xdocs/changes.xml b/src/documentation/content/xdocs/changes.xml index 1a2604f85b..76d53e6287 100644 --- a/src/documentation/content/xdocs/changes.xml +++ b/src/documentation/content/xdocs/changes.xml @@ -37,6 +37,7 @@ + 45876 - fixed BoundSheetRecord to allow sheet names longer than 31 chars 45890 - fixed HSSFSheet.shiftRows to also update conditional formats 45865 modified Formula Parser/Evaluator to handle cross-worksheet formulas Optimised the FormulaEvaluator to take cell dependencies into account diff --git a/src/documentation/content/xdocs/status.xml b/src/documentation/content/xdocs/status.xml index a56de462fe..34a3bc3271 100644 --- a/src/documentation/content/xdocs/status.xml +++ b/src/documentation/content/xdocs/status.xml @@ -34,6 +34,7 @@ + 45876 - fixed BoundSheetRecord to allow sheet names longer than 31 chars 45890 - fixed HSSFSheet.shiftRows to also update conditional formats 45865 modified Formula Parser/Evaluator to handle cross-worksheet formulas Optimised the FormulaEvaluator to take cell dependencies into account diff --git a/src/java/org/apache/poi/hssf/model/Workbook.java b/src/java/org/apache/poi/hssf/model/Workbook.java index 0728d0e29f..54639adb18 100644 --- a/src/java/org/apache/poi/hssf/model/Workbook.java +++ b/src/java/org/apache/poi/hssf/model/Workbook.java @@ -55,6 +55,12 @@ import org.apache.poi.util.POILogger; * @version 1.0-pre */ public final class Workbook implements Model { + /** + * Excel silently truncates long sheet names to 31 chars. + * This constant is used to ensure uniqueness in the first 31 chars + */ + private static final int MAX_SENSITIVE_SHEET_NAME_LEN = 31; + private static final int DEBUG = POILogger.DEBUG; /** @@ -488,32 +494,43 @@ public final class Workbook implements Model { /** * sets the name for a given sheet. If the boundsheet record doesn't exist and - * its only one more than we have, go ahead and create it. If its > 1 more than + * its only one more than we have, go ahead and create it. If it's > 1 more than * we have, except * * @param sheetnum the sheet number (0 based) * @param sheetname the name for the sheet */ - public void setSheetName(int sheetnum, String sheetname ) { + public void setSheetName(int sheetnum, String sheetname) { checkSheets(sheetnum); BoundSheetRecord sheet = (BoundSheetRecord)boundsheets.get( sheetnum ); sheet.setSheetname(sheetname); } /** - * Determines whether a workbook contains the provided sheet name. + * Determines whether a workbook contains the provided sheet name. For the purpose of + * comparison, long names are truncated to 31 chars. * * @param name the name to test (case insensitive match) * @param excludeSheetIdx the sheet to exclude from the check or -1 to include all sheets in the check. * @return true if the sheet contains the name, false otherwise. */ - public boolean doesContainsSheetName( String name, int excludeSheetIdx ) - { - for ( int i = 0; i < boundsheets.size(); i++ ) - { + public boolean doesContainsSheetName(String name, int excludeSheetIdx) { + String aName = name; + if (aName.length() > MAX_SENSITIVE_SHEET_NAME_LEN) { + aName = aName.substring(0, MAX_SENSITIVE_SHEET_NAME_LEN); + } + for (int i = 0; i < boundsheets.size(); i++) { BoundSheetRecord boundSheetRecord = getBoundSheetRec(i); - if (excludeSheetIdx != i && name.equalsIgnoreCase(boundSheetRecord.getSheetname())) + if (excludeSheetIdx == i) { + continue; + } + String bName = boundSheetRecord.getSheetname(); + if (bName.length() > MAX_SENSITIVE_SHEET_NAME_LEN) { + bName = bName.substring(0, MAX_SENSITIVE_SHEET_NAME_LEN); + } + if (aName.equalsIgnoreCase(bName)) { return true; + } } return false; } @@ -1954,9 +1971,9 @@ public final class Workbook implements Model { return (short)getOrCreateLinkTable().checkExternSheet(sheetNumber); } - public int getExternalSheetIndex(String workbookName, String sheetName) { - return getOrCreateLinkTable().getExternalSheetIndex(workbookName, sheetName); - } + public int getExternalSheetIndex(String workbookName, String sheetName) { + return getOrCreateLinkTable().getExternalSheetIndex(workbookName, sheetName); + } /** gets the total number of names diff --git a/src/java/org/apache/poi/hssf/record/BoundSheetRecord.java b/src/java/org/apache/poi/hssf/record/BoundSheetRecord.java index 2c1d0220f5..4ecddce7e8 100644 --- a/src/java/org/apache/poi/hssf/record/BoundSheetRecord.java +++ b/src/java/org/apache/poi/hssf/record/BoundSheetRecord.java @@ -116,9 +116,8 @@ public final class BoundSheetRecord extends Record { throw new IllegalArgumentException("sheetName must not be null"); } int len = sheetName.length(); - if (len < 1 || len > 31) { - throw new IllegalArgumentException("sheetName '" + sheetName - + "' is invalid - must be 1-30 characters long"); + if (len < 1) { + throw new IllegalArgumentException("sheetName must not be empty string"); } for (int i=0; i