From 35c07feabe4299d6a698af0513a6823196ba9cbc Mon Sep 17 00:00:00 2001 From: Josh Micich Date: Tue, 3 Nov 2009 20:23:21 +0000 Subject: [PATCH] Bugzilla 48096 - relaxed validation check in RecalcIdRecord git-svn-id: https://svn.apache.org/repos/asf/poi/trunk@832536 13f79535-47bb-0310-9956-ffa450edef68 --- src/documentation/content/xdocs/status.xml | 1 + .../poi/hssf/record/RecalcIdRecord.java | 14 ++-- .../poi/hssf/record/AllRecordTests.java | 1 + .../poi/hssf/record/TestRecalcIdRecord.java | 72 +++++++++++++++++++ 4 files changed, 78 insertions(+), 10 deletions(-) create mode 100644 src/testcases/org/apache/poi/hssf/record/TestRecalcIdRecord.java diff --git a/src/documentation/content/xdocs/status.xml b/src/documentation/content/xdocs/status.xml index bd533988e6..0cd747f15d 100644 --- a/src/documentation/content/xdocs/status.xml +++ b/src/documentation/content/xdocs/status.xml @@ -34,6 +34,7 @@ + 48096 - relaxed validation check in RecalcIdRecord 48085 - improved error checking in BlockAllocationTableReader to trap unreasonable field values 47924 - fixed logic for matching cells and comments in HSSFCell.getCellComment() 47942 - added implementation of protection features to XLSX and DOCX files diff --git a/src/java/org/apache/poi/hssf/record/RecalcIdRecord.java b/src/java/org/apache/poi/hssf/record/RecalcIdRecord.java index 7b416a909a..c336e14d30 100644 --- a/src/java/org/apache/poi/hssf/record/RecalcIdRecord.java +++ b/src/java/org/apache/poi/hssf/record/RecalcIdRecord.java @@ -25,11 +25,8 @@ import org.apache.poi.util.LittleEndianOutput; * Description: This record contains an ID that marks when a worksheet was last * recalculated. It's an optimization Excel uses to determine if it * needs to recalculate the spreadsheet when it's opened. So far, only - * the two values 0xC1 0x01 0x00 0x00 0x80 0x38 0x01 0x00 - * (do not recalculate) and 0xC1 0x01 0x00 0x00 0x60 0x69 0x01 - * 0x00 have been seen. If the field isNeeded is - * set to false (default), then this record is swallowed during the - * serialization process

+ * the two engine ids 0x80 0x38 0x01 0x00 + * and 0x60 0x69 0x01 0x00 have been seen.

* REFERENCE: http://chicago.sourceforge.net/devel/docs/excel/biff8.html

* @author Luc Girardin (luc dot girardin at macrofocus dot com) * @@ -41,10 +38,7 @@ public final class RecalcIdRecord extends StandardRecord { private final int _engineId; public RecalcIdRecord(RecordInputStream in) { - int rt = in.readUShort(); - if (rt != sid) { - throw new RecordFormatException("expected " + sid + " but got " + rt); - } + in.readUShort(); // field 'rt' should have value 0x01C1, but Excel doesn't care during reading _reserved0 = in.readUShort(); _engineId = in.readInt(); } @@ -64,7 +58,7 @@ public final class RecalcIdRecord extends StandardRecord { } public void serialize(LittleEndianOutput out) { - out.writeShort(sid); + out.writeShort(sid); // always write 'rt' field as 0x01C1 out.writeShort(_reserved0); out.writeInt(_engineId); } diff --git a/src/testcases/org/apache/poi/hssf/record/AllRecordTests.java b/src/testcases/org/apache/poi/hssf/record/AllRecordTests.java index 920cfe7142..adb249ef34 100644 --- a/src/testcases/org/apache/poi/hssf/record/AllRecordTests.java +++ b/src/testcases/org/apache/poi/hssf/record/AllRecordTests.java @@ -69,6 +69,7 @@ public final class AllRecordTests { result.addTestSuite(TestObjRecord.class); result.addTestSuite(TestPaletteRecord.class); result.addTestSuite(TestPaneRecord.class); + result.addTestSuite(TestRecalcIdRecord.class); result.addTestSuite(TestRecordFactory.class); result.addTestSuite(TestRecordFactoryInputStream.class); result.addTestSuite(TestRecordInputStream.class); diff --git a/src/testcases/org/apache/poi/hssf/record/TestRecalcIdRecord.java b/src/testcases/org/apache/poi/hssf/record/TestRecalcIdRecord.java new file mode 100644 index 0000000000..9ac03d2e4e --- /dev/null +++ b/src/testcases/org/apache/poi/hssf/record/TestRecalcIdRecord.java @@ -0,0 +1,72 @@ +/* ==================================================================== + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +==================================================================== */ + +package org.apache.poi.hssf.record; + +import java.util.Arrays; + +import junit.framework.AssertionFailedError; +import junit.framework.TestCase; + +import org.apache.poi.util.HexRead; +/** + * + * @author Josh Micich + */ +public final class TestRecalcIdRecord extends TestCase { + + private static RecalcIdRecord create(byte[] data) { + RecordInputStream in = TestcaseRecordInputStream.create(RecalcIdRecord.sid, data); + RecalcIdRecord result = new RecalcIdRecord(in); + assertEquals(0, in.remaining()); + return result; + } + public void testBasicDeserializeReserialize() { + + byte[] data = HexRead.readFromString( + "C1 01" + // rt + "00 00" + // reserved + "1D EB 01 00"); // engine id + + RecalcIdRecord r = create(data); + TestcaseRecordInputStream.confirmRecordEncoding(RecalcIdRecord.sid, data, r.serialize()); + } + + public void testBadFirstField_bug48096() { + /** + * Data taken from the sample file referenced in Bugzilla 48096, file offset 0x0D45. + * The apparent problem is that the first data short field has been written with the + * wrong endianness. Excel seems to ignore whatever value is present in this + * field, and always rewrites it as (C1, 01). POI now does the same. + */ + byte[] badData = HexRead.readFromString("C1 01 08 00 01 C1 00 00 00 01 69 61"); + byte[] goodData = HexRead.readFromString("C1 01 08 00 C1 01 00 00 00 01 69 61"); + + RecordInputStream in = TestcaseRecordInputStream.create(badData); + RecalcIdRecord r; + try { + r = new RecalcIdRecord(in); + } catch (RecordFormatException e) { + if (e.getMessage().equals("expected 449 but got 49409")) { + throw new AssertionFailedError("Identified bug 48096"); + } + throw e; + } + assertEquals(0, in.remaining()); + assertTrue(Arrays.equals(r.serialize(), goodData)); + } +} -- 2.39.5