From 0e9861932ae265f44c61d9a767d070941b5b6eb6 Mon Sep 17 00:00:00 2001 From: Nick Burch Date: Sat, 26 Dec 2009 19:57:09 +0000 Subject: [PATCH] More work on FeatRecord/Shared Features. More is still needed though, it's still WIP git-svn-id: https://svn.apache.org/repos/asf/poi/trunk@894018 13f79535-47bb-0310-9956-ffa450edef68 --- .../org/apache/poi/hssf/dev/BiffViewer.java | 2 + .../apache/poi/hssf/model/RecordOrderer.java | 3 +- .../apache/poi/hssf/record/FeatHdrRecord.java | 16 +++- .../apache/poi/hssf/record/FeatRecord.java | 31 ++++-- .../apache/poi/hssf/record/RecordFactory.java | 2 + .../poi/hssf/record/RecordInputStream.java | 6 ++ .../apache/poi/hssf/record/UnknownRecord.java | 2 - .../poi/hssf/record/common/FtrHeader.java | 89 ++++++++++++++++++ .../eventusermodel/TestHSSFEventFactory.java | 10 +- .../poi/hssf/record/TestFeatRecord.java | 89 ++++++++++++++++++ .../poi/hssf/usermodel/HSSFTestHelper.java | 33 +++++++ test-data/spreadsheet/46136-NoWarnings.xls | Bin 0 -> 13824 bytes test-data/spreadsheet/46136-WithWarnings.xls | Bin 0 -> 13824 bytes 13 files changed, 264 insertions(+), 19 deletions(-) create mode 100644 src/java/org/apache/poi/hssf/record/common/FtrHeader.java create mode 100644 src/testcases/org/apache/poi/hssf/record/TestFeatRecord.java create mode 100644 src/testcases/org/apache/poi/hssf/usermodel/HSSFTestHelper.java create mode 100644 test-data/spreadsheet/46136-NoWarnings.xls create mode 100644 test-data/spreadsheet/46136-WithWarnings.xls diff --git a/src/java/org/apache/poi/hssf/dev/BiffViewer.java b/src/java/org/apache/poi/hssf/dev/BiffViewer.java index 66223b2274..aed5c199e4 100644 --- a/src/java/org/apache/poi/hssf/dev/BiffViewer.java +++ b/src/java/org/apache/poi/hssf/dev/BiffViewer.java @@ -162,6 +162,8 @@ public final class BiffViewer { case ExtSSTRecord.sid: return new ExtSSTRecord(in); case ExtendedFormatRecord.sid: return new ExtendedFormatRecord(in); case ExternSheetRecord.sid: return new ExternSheetRecord(in); + case FeatRecord.sid: return new FeatRecord(in); + case FeatHdrRecord.sid: return new FeatHdrRecord(in); case FilePassRecord.sid: return new FilePassRecord(in); case FileSharingRecord.sid: return new FileSharingRecord(in); case FnGroupCountRecord.sid: return new FnGroupCountRecord(in); diff --git a/src/java/org/apache/poi/hssf/model/RecordOrderer.java b/src/java/org/apache/poi/hssf/model/RecordOrderer.java index 5740f20925..31c25db850 100644 --- a/src/java/org/apache/poi/hssf/model/RecordOrderer.java +++ b/src/java/org/apache/poi/hssf/model/RecordOrderer.java @@ -34,6 +34,7 @@ import org.apache.poi.hssf.record.DimensionsRecord; import org.apache.poi.hssf.record.DrawingRecord; import org.apache.poi.hssf.record.DrawingSelectionRecord; import org.apache.poi.hssf.record.EOFRecord; +import org.apache.poi.hssf.record.FeatRecord; import org.apache.poi.hssf.record.FormulaRecord; import org.apache.poi.hssf.record.GridsetRecord; import org.apache.poi.hssf.record.GutsRecord; @@ -341,7 +342,7 @@ final class RecordOrderer { switch(sid) { case UnknownRecord.SHEETEXT_0862: case UnknownRecord.SHEETPROTECTION_0867: - case UnknownRecord.RANGEPROTECTION_0868: + case FeatRecord.sid: case EOFRecord.sid: return true; } diff --git a/src/java/org/apache/poi/hssf/record/FeatHdrRecord.java b/src/java/org/apache/poi/hssf/record/FeatHdrRecord.java index fcc5cd5c00..fe7a137eb6 100644 --- a/src/java/org/apache/poi/hssf/record/FeatHdrRecord.java +++ b/src/java/org/apache/poi/hssf/record/FeatHdrRecord.java @@ -17,6 +17,7 @@ package org.apache.poi.hssf.record; +import org.apache.poi.hssf.record.common.FtrHeader; import org.apache.poi.util.LittleEndianOutput; /** @@ -51,7 +52,8 @@ public final class FeatHdrRecord extends StandardRecord { public final static short sid = 0x0867; - + + private FtrHeader futureHeader; private int isf_sharedFeatureType; // See SHAREDFEATURES_ private byte reserved; // Should always be one /** @@ -63,6 +65,8 @@ public final class FeatHdrRecord extends StandardRecord { private byte[] rgbHdrData; public FeatHdrRecord() { + futureHeader = new FtrHeader(); + futureHeader.setRecordType(sid); } public short getSid() { @@ -70,9 +74,11 @@ public final class FeatHdrRecord extends StandardRecord { } public FeatHdrRecord(RecordInputStream in) { + futureHeader = new FtrHeader(in); + isf_sharedFeatureType = in.readShort(); reserved = in.readByte(); - cbHdrData = in.readLong(); + cbHdrData = in.readInt(); // Don't process this just yet, need the BOFRecord rgbHdrData = in.readRemainder(); } @@ -88,13 +94,15 @@ public final class FeatHdrRecord extends StandardRecord { } public void serialize(LittleEndianOutput out) { + futureHeader.serialize(out); + out.writeShort(isf_sharedFeatureType); out.writeByte(reserved); - out.writeLong(cbHdrData); + out.writeInt((int)cbHdrData); out.write(rgbHdrData); } protected int getDataSize() { - return 2+1+4+rgbHdrData.length; + return 12 + 2+1+4+rgbHdrData.length; } } diff --git a/src/java/org/apache/poi/hssf/record/FeatRecord.java b/src/java/org/apache/poi/hssf/record/FeatRecord.java index 6e2f4d6432..a772ca5488 100644 --- a/src/java/org/apache/poi/hssf/record/FeatRecord.java +++ b/src/java/org/apache/poi/hssf/record/FeatRecord.java @@ -17,6 +17,7 @@ package org.apache.poi.hssf.record; +import org.apache.poi.hssf.record.common.FtrHeader; import org.apache.poi.hssf.record.common.Ref8U; import org.apache.poi.util.LittleEndianOutput; @@ -29,14 +30,14 @@ import org.apache.poi.util.LittleEndianOutput; public final class FeatRecord extends StandardRecord { public final static short sid = 0x0868; + private FtrHeader futureHeader; + /** * See SHAREDFEATURES_* on {@link FeatHdrRecord} */ private int isf_sharedFeatureType; private byte reserved1; // Should always be zero private long reserved2; // Should always be zero - /** The number of refs */ - private int cref; /** Only matters if type is ISFFEC2 */ private long cbFeatData; private int reserved3; // Should always be zero @@ -45,6 +46,8 @@ public final class FeatRecord extends StandardRecord { private byte[] rgbFeat; public FeatRecord() { + futureHeader = new FtrHeader(); + futureHeader.setRecordType(sid); } public short getSid() { @@ -52,11 +55,13 @@ public final class FeatRecord extends StandardRecord { } public FeatRecord(RecordInputStream in) { + futureHeader = new FtrHeader(in); + isf_sharedFeatureType = in.readShort(); reserved1 = in.readByte(); - reserved2 = in.readLong(); - cref = in.readUShort(); - cbFeatData = in.readLong(); + reserved2 = in.readInt(); + int cref = in.readUShort(); + cbFeatData = in.readInt(); reserved3 = in.readShort(); cellRefs = new Ref8U[cref]; @@ -69,7 +74,7 @@ public final class FeatRecord extends StandardRecord { public String toString() { StringBuffer buffer = new StringBuffer(); - buffer.append("[SHARDED FEATURE]\n"); + buffer.append("[SHARED FEATURE]\n"); // TODO ... @@ -78,13 +83,23 @@ public final class FeatRecord extends StandardRecord { } public void serialize(LittleEndianOutput out) { + futureHeader.serialize(out); + out.writeShort(isf_sharedFeatureType); + out.writeByte(reserved1); + out.writeInt((int)reserved2); + out.writeShort(cellRefs.length); + out.writeInt((int)cbFeatData); + out.writeShort(reserved3); - // TODO ... + for(int i=0; i + * This record part specifies a header for a Ftr (Future) + * style record, which includes extra attributes above and + * beyond those of a traditional record. + */ +public final class FtrHeader { + /** This MUST match the type on the containing record */ + private short recordType; + /** This is a FrtFlags */ + private short grbitFrt; + /** MUST be 8 bytes and all zero */ + private byte[] reserved; + + public FtrHeader() { + reserved = new byte[8]; + } + + public FtrHeader(RecordInputStream in) { + recordType = in.readShort(); + grbitFrt = in.readShort(); + + reserved = new byte[8]; + in.read(reserved, 0, 8); + } + + public String toString() { + StringBuffer buffer = new StringBuffer(); + buffer.append(" [FUTURE HEADER]\n"); + buffer.append(" Type " + recordType); + buffer.append(" Flags " + grbitFrt); + buffer.append(" [/FUTURE HEADER]\n"); + return buffer.toString(); + } + + public void serialize(LittleEndianOutput out) { + out.writeShort(recordType); + out.writeShort(grbitFrt); + out.write(reserved); + } + + public static int getDataSize() { + return 12; + } + + public short getRecordType() { + return recordType; + } + public void setRecordType(short recordType) { + this.recordType = recordType; + } + + public short getGrbitFrt() { + return grbitFrt; + } + public void setGrbitFrt(short grbitFrt) { + this.grbitFrt = grbitFrt; + } + + public byte[] getReserved() { + return reserved; + } + public void setReserved(byte[] reserved) { + this.reserved = reserved; + } +} \ No newline at end of file diff --git a/src/testcases/org/apache/poi/hssf/eventusermodel/TestHSSFEventFactory.java b/src/testcases/org/apache/poi/hssf/eventusermodel/TestHSSFEventFactory.java index 74e1ceb4a5..9766331085 100644 --- a/src/testcases/org/apache/poi/hssf/eventusermodel/TestHSSFEventFactory.java +++ b/src/testcases/org/apache/poi/hssf/eventusermodel/TestHSSFEventFactory.java @@ -27,6 +27,7 @@ import org.apache.poi.hssf.record.ContinueRecord; import org.apache.poi.hssf.record.DVALRecord; import org.apache.poi.hssf.record.DVRecord; import org.apache.poi.hssf.record.EOFRecord; +import org.apache.poi.hssf.record.FeatHdrRecord; import org.apache.poi.hssf.record.Record; import org.apache.poi.hssf.record.SelectionRecord; import org.apache.poi.hssf.record.WindowTwoRecord; @@ -86,9 +87,10 @@ public final class TestHSSFEventFactory extends TestCase { // Check that the last few records are as we expect // (Makes sure we don't accidently skip the end ones) int numRec = recs.length; - assertEquals(DVALRecord.class, recs[numRec-3].getClass()); - assertEquals(DVRecord.class, recs[numRec-2].getClass()); - assertEquals(EOFRecord.class, recs[numRec-1].getClass()); + assertEquals(DVALRecord.class, recs[numRec-4].getClass()); + assertEquals(DVRecord.class, recs[numRec-3].getClass()); + assertEquals(FeatHdrRecord.class, recs[numRec-2].getClass()); + assertEquals(EOFRecord.class, recs[numRec-1].getClass()); } /** @@ -110,7 +112,7 @@ public final class TestHSSFEventFactory extends TestCase { } private static class MockHSSFListener implements HSSFListener { - private final List records = new ArrayList(); + private final List records = new ArrayList(); public MockHSSFListener() {} public Record[] getRecords() { diff --git a/src/testcases/org/apache/poi/hssf/record/TestFeatRecord.java b/src/testcases/org/apache/poi/hssf/record/TestFeatRecord.java new file mode 100644 index 0000000000..0ba8b77273 --- /dev/null +++ b/src/testcases/org/apache/poi/hssf/record/TestFeatRecord.java @@ -0,0 +1,89 @@ +/* ==================================================================== + 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 org.apache.poi.hssf.HSSFTestDataSamples; +import org.apache.poi.hssf.model.InternalWorkbook; +import org.apache.poi.hssf.usermodel.HSSFTestHelper; +import org.apache.poi.hssf.usermodel.HSSFWorkbook; + +import junit.framework.TestCase; +/** + * Tests for FeatRecord + * + * @author Josh Micich + */ +public final class TestFeatRecord extends TestCase { + public void testWithoutFeatRecord() throws Exception { + HSSFWorkbook hssf = + HSSFTestDataSamples.openSampleWorkbook("46136-WithWarnings.xls"); + InternalWorkbook wb = HSSFTestHelper.getWorkbookForTest(hssf); + + int countFR = 0; + int countFRH = 0; + for(Record r : wb.getRecords()) { + if(r instanceof FeatRecord) { + countFR++; + } else if (r.getSid() == FeatRecord.sid) { + countFR++; + } + if(r instanceof FeatHdrRecord) { + countFRH++; + } else if (r.getSid() == FeatHdrRecord.sid) { + countFRH++; + } + } + + assertEquals(0, countFR); + assertEquals(0, countFRH); + } + + /** + * TODO - make this work! + * (Need to have the Internal Workbook capture it or something) + */ + public void DISABLEDtestReadFeatRecord() throws Exception { + HSSFWorkbook hssf = + HSSFTestDataSamples.openSampleWorkbook("46136-NoWarnings.xls"); + InternalWorkbook wb = HSSFTestHelper.getWorkbookForTest(hssf); + + FeatRecord fr = null; + + int countFR = 0; + int countFRH = 0; + for(Record r : wb.getRecords()) { + if(r instanceof FeatRecord) { + fr = (FeatRecord)r; + countFR++; + } else if (r.getSid() == FeatRecord.sid) { + fail("FeatRecord SID found but not created correctly!"); + } + if(r instanceof FeatHdrRecord) { + countFRH++; + } else if (r.getSid() == FeatHdrRecord.sid) { + fail("FeatHdrRecord SID found but not created correctly!"); + } + } + + assertEquals(1, countFR); + assertEquals(1, countFRH); + assertNotNull(fr); + + // Now check the contents are as expected + } +} diff --git a/src/testcases/org/apache/poi/hssf/usermodel/HSSFTestHelper.java b/src/testcases/org/apache/poi/hssf/usermodel/HSSFTestHelper.java new file mode 100644 index 0000000000..132013da08 --- /dev/null +++ b/src/testcases/org/apache/poi/hssf/usermodel/HSSFTestHelper.java @@ -0,0 +1,33 @@ +/* ==================================================================== + 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.usermodel; +import org.apache.poi.hssf.model.InternalWorkbook; + +/** + * Helper class for HSSF tests that aren't within the + * HSSF UserModel package, but need to do internal + * UserModel things. + */ +public class HSSFTestHelper { + /** + * Lets non UserModel tests at the low level Workbook + */ + public static InternalWorkbook getWorkbookForTest(HSSFWorkbook wb) { + return wb.getWorkbook(); + } +} diff --git a/test-data/spreadsheet/46136-NoWarnings.xls b/test-data/spreadsheet/46136-NoWarnings.xls new file mode 100644 index 0000000000000000000000000000000000000000..3a67049ae848952b7593182c5eb71a7171743ec6 GIT binary patch literal 13824 zcmeHOUuc_E6#so`(xz+IrtSXd+)9=zY0_A_DXwg6sYPYZe`7;8Fp_m^G}76QwuAX( z{L?2DDtqu{F!nfvIT7?lq7C7;CGw0z9 zwH=&;(somyxh*u`-W););k;;F}rsyO<3B&)WfG%=R4DE!zO$| z`|@k^n(Dx4#CsUico}0jj(@JSH@q1UYy=YbCi*gceM9-wu3Ud`kxTW4xAJ?qxvu>A z1BLMy>Wva;!IrAg;81-#yjD|5-pa&Es}-$POm`rS?Lb~#NymepRW5V=rpTpsRTPQ) z6YO`se)cd^>6wO zDx2$S&1I~!+x=@fZqiQ{;?ip(nEscb==OTe%v;$v(yP^5+5eyQ9^x8ag#tVWd>npT zsZTY~XBz0!4fL&l(4P*45i2#7CA&(^Cc8^vlRc#tlPJODx>BTk#MX*Au0ZD_>SZ$y z77K;hp?47GJn?YBGa25~znx<8vY zecJQ`mcC({5^VyykHBy_#Oo|s49l0g^rl(AW$8JtB_6$K_#QPGFQbl-ma|p)EKAsG zsKZpgfzoJ*KRzUnKKx84t`ibbr={NzWUf}EJ)v%VV!M$MyY`bUv?G+FieLQ5D!>l% zOVJ*(%6w|_ZHmz(igju$_IMX-NmqVXYPBx!5O4@M1RMem0f&G?;7&*226tW&+t=2Q zM7ycwxwAiCeWn=u;JqjYk{^FNMBQ<+Hoq#@wf0epvbBGGlDw9DnA}4iCoAsxfm^9w zO4$U52+U$c$>`kP{DVtgZN9RhQ>i0|fJ49`;1F;KI0PI54grUNL%<>65O4@M1pWpD zZWsTDE?>HQX7HZa>Gv7`XRcmQynm6bm|yY#UNWCrV?Vi#thhf$K0;RfUnFlJpCId8 z;1pSB0B@6na{a^j2si{B0uBL(fJ49`AOsX8D~MJct~Va_Y+vtBD$dsbI$A097Ni1f z#qNsZ^%|#M&s2FAWj9&ze(-{*Vt$t?dfdxzPm@oWv{<-<5Cx@3j&4)mLh~B3$fuq)si9o$-$$x>|^sj!bx}pxM zND&;wNxZ_(n2r5$qVS^iNt#*y_hX8h#?(*$`VQ&)vs(W;KeK}}iU=N|hhx@uRlc^lZl-YMMdSD;hb~dx#!+< z-}mm^x#zt%Uwq!SaPGYgSFntBqYgL9ji_H@4_ICw9jCzha#@FwzJq0&oc==yG$wf= z>l5fnUuu}2Ww8#pf*3Bw=O}@1$$1<@5_s(KiQ}Ww#fkJkL3?ZrBZ0;+%Zay(r2uDW zZQ&f0wcTWg$#>1~Ba^#WGZwT2`5hm357G~8cQ7_=es7x0m~5d8@S(N&#w=U00iV&o z{L(2+bzn~-cmPv)9wRu4zpu6{z6lAe12T7Ix^vy#1BJew`QGRt-`5qtli$NlRrSy8 zD~>)}?UX?SHZMAD8K~}u$Lgwwmol^5Ygum<*X_t+8&J?tvgv4KmBW0m8S;HQD~8NH z8IHTqJ6vFtE$HKiO_#RIrk6I#rmI>EA%`8+!NN1Bj%Pz#5^`v0G3fp1=T%w^8nwR} zH)?F57h5i%(=PYV<+SNg%%)}6L@@hLQPu73nwhuquVq)SxAOl#+XJL^dKHTB><@AH zb-BH-hCNrqo~>bT{GI)DERIyEt}NYFsyE$Uikt2zHJC;TraMcC@*!I*PI3i0pU^1l zv45;soEdlnan6$f7Xs7qb^MBj3kWb5B*{Q&Fu*molwHhacI&o#%UDI<6YQ;-wj;?k zWELv4rlMo3SO^#DRMkS=6bmP={M2cYzt(5Tt8Hm(rW{49mD_BAOEK8B^FMs~x zc9g8muj+NI&7!hw?O&fDuO=TPcaTTP%6q=!F0zYSKG97C7BMWb{*zw{_ss`O%askC zYMmSbN5Bzq1RMcJz!7i+905nb5pVL;)c3WMM_{lj^hP>M(o@lB?`~km}HsZe?KN^ ssZG6%ukVn)KP!!|`)78ej4FW#8R3YHp=ej&kBw*WPn^G