POI-HDGF - Java API To Access Microsoft Visio Format Files

HWPF is still in early development. It is in the + href="http://svn.apache.org/viewcvs.cgi/poi/trunk/src/scratchpad/"> scratchpad section of the SVN. You will need to ensure you either have a recent SVN checkout, or a recent SVN nightly build (including the scratchpad jar!)

We would also like to confirm that verion 3.0 of Apache POI does + not contain any viruses. Users of broken virus checkers + which do detect a 94 byte file, sci_cec.db, as containing one are + advised to contact their vendor for a fix.

HPSF for Document Properties

HPSF is our port of the OLE 2 property set format to pure Java. Property sets are mostly use to store a document's properties diff --git a/src/documentation/content/xdocs/status.xml b/src/documentation/content/xdocs/status.xml index ef5c5aaeb4..b236f22880 100644 --- a/src/documentation/content/xdocs/status.xml +++ b/src/documentation/content/xdocs/status.xml @@ -32,7 +32,7 @@ - + Administrative updates to the Maven POMs, and the release artificat build process 23951 - [PATCH] Fix for HSSF setSheetOrder and tab names 42524 - [PATCH] Better HSLF support for problem shape groups @@ -41,6 +41,9 @@ Additional HSLF support for Title and Slide Master Sheets 42474 - [PATCH] Improved HSLF note to slide matching, and a NPE 42481 - [PATCH] Tweak some HSLF exceptions, to make it clearer what you're catching + 42667 - [PATCH] Fix for HSLF writing of files with tables + Improved way of detecting HSSF cells that contain dates, isADateFormat + Initial, read-only support for Visio documents, as HDGF diff --git a/src/scratchpad/src/org/apache/poi/hdgf/chunks/Chunk.java b/src/scratchpad/src/org/apache/poi/hdgf/chunks/Chunk.java index 54c37b3e83..5928927c4d 100644 --- a/src/scratchpad/src/org/apache/poi/hdgf/chunks/Chunk.java +++ b/src/scratchpad/src/org/apache/poi/hdgf/chunks/Chunk.java @@ -20,6 +20,9 @@ import java.util.ArrayList; import org.apache.poi.hdgf.chunks.ChunkFactory.CommandDefinition; import org.apache.poi.util.LittleEndian; +import org.apache.poi.util.POILogFactory; +import org.apache.poi.util.POILogger; +import org.apache.poi.util.StringUtil; /** * Base of all chunks, which hold data, flags etc @@ -44,6 +47,9 @@ public class Chunk { /** The name of the chunk, as found from the commandDefinitions */ private String name; + /** For logging warnings about the structure of the file */ + private POILogger logger = POILogFactory.getLogger(Chunk.class); + public Chunk(ChunkHeader header, ChunkTrailer trailer, ChunkSeparator separator, byte[] contents) { this.header = header; this.trailer = trailer; @@ -148,7 +154,9 @@ public class Chunk { // Check we seem to have enough data if(offset >= contents.length) { - System.err.println("Command offset " + offset + " past end of data at " + contents.length); + logger.log(POILogger.WARN, + "Command offset " + offset + " past end of data at " + contents.length + ); continue; } @@ -167,9 +175,27 @@ public class Chunk { LittleEndian.getDouble(contents, offset) ); break; + case 12: + // A Little Endian String + // Starts 8 bytes into the data segment + // Ends at end of data, or 00 00 + int startsAt = 8; + int endsAt = startsAt; + for(int j=startsAt; j data.length) { - System.err.println("Header called for " + header.getLength() +" bytes, but that would take us passed the end of the data!"); + logger.log(POILogger.WARN, + "Header called for " + header.getLength() +" bytes, but that would take us passed the end of the data!"); endOfDataPos = data.length; header.length = data.length - offset - header.getSizeInBytes(); diff --git a/src/scratchpad/src/org/apache/poi/hdgf/chunks/ChunkHeaderV11.java b/src/scratchpad/src/org/apache/poi/hdgf/chunks/ChunkHeaderV11.java index 51eca5649c..c77a249204 100644 --- a/src/scratchpad/src/org/apache/poi/hdgf/chunks/ChunkHeaderV11.java +++ b/src/scratchpad/src/org/apache/poi/hdgf/chunks/ChunkHeaderV11.java @@ -24,6 +24,10 @@ public class ChunkHeaderV11 extends ChunkHeaderV6 { * Does the chunk have a separator? */ public boolean hasSeparator() { + // For some reason, there are two types that don't have a + // separator despite the flags that indicate they do + if(type == 0x1f || type == 0xc9) { return false; } + // If there's a trailer, there's a separator if(hasTrailer()) { return true; } diff --git a/src/scratchpad/src/org/apache/poi/hdgf/chunks/ChunkSeparator.java b/src/scratchpad/src/org/apache/poi/hdgf/chunks/ChunkSeparator.java index 7098f17ea6..5ce4097446 100644 --- a/src/scratchpad/src/org/apache/poi/hdgf/chunks/ChunkSeparator.java +++ b/src/scratchpad/src/org/apache/poi/hdgf/chunks/ChunkSeparator.java @@ -27,4 +27,8 @@ public class ChunkSeparator { separatorData = new byte[4]; System.arraycopy(data, offset, separatorData, 0, 4); } + + public String toString() { + return ""; + } } diff --git a/src/scratchpad/src/org/apache/poi/hdgf/chunks/ChunkTrailer.java b/src/scratchpad/src/org/apache/poi/hdgf/chunks/ChunkTrailer.java index a610b49b14..a590732466 100644 --- a/src/scratchpad/src/org/apache/poi/hdgf/chunks/ChunkTrailer.java +++ b/src/scratchpad/src/org/apache/poi/hdgf/chunks/ChunkTrailer.java @@ -26,4 +26,8 @@ public class ChunkTrailer { trailerData = new byte[8]; System.arraycopy(data, offset, trailerData, 0, 8); } + + public String toString() { + return ""; + } } diff --git a/src/scratchpad/src/org/apache/poi/hdgf/dev/VSDDumper.java b/src/scratchpad/src/org/apache/poi/hdgf/dev/VSDDumper.java index 3c20e4f3ff..614b9259a0 100644 --- a/src/scratchpad/src/org/apache/poi/hdgf/dev/VSDDumper.java +++ b/src/scratchpad/src/org/apache/poi/hdgf/dev/VSDDumper.java @@ -70,6 +70,11 @@ public class VSDDumper { " - " + Integer.toHexString(ptr.getFormat())); System.out.println(ind + " Length is\t" + ptr.getLength() + " - " + Integer.toHexString(ptr.getLength())); + if(ptr.destinationCompressed()) { + int decompLen = stream._getContentsLength(); + System.out.println(ind + " DC.Length is\t" + decompLen + + " - " + Integer.toHexString(decompLen)); + } System.out.println(ind + " Compressed is\t" + ptr.destinationCompressed()); System.out.println(ind + " Stream is\t" + stream.getClass().getName()); @@ -100,6 +105,9 @@ public class VSDDumper { for(int i=0; i"); + System.exit(1); + } + + VisioTextExtractor extractor = + new VisioTextExtractor(new FileInputStream(args[0])); + + // Print not PrintLn as already has \n added to it + System.out.print(extractor.getText()); + } +} diff --git a/src/scratchpad/src/org/apache/poi/hdgf/streams/ChunkStream.java b/src/scratchpad/src/org/apache/poi/hdgf/streams/ChunkStream.java index 75b6beefd1..a59fe43ff9 100644 --- a/src/scratchpad/src/org/apache/poi/hdgf/streams/ChunkStream.java +++ b/src/scratchpad/src/org/apache/poi/hdgf/streams/ChunkStream.java @@ -43,6 +43,11 @@ public class ChunkStream extends Stream { public void findChunks() { ArrayList chunksA = new ArrayList(); + if(getPointer().getOffset() == 0x64b3) { + int i = 0; + i++; + } + int pos = 0; byte[] contents = getStore().getContents(); while(pos < contents.length) { diff --git a/src/scratchpad/src/org/apache/poi/hdgf/streams/Stream.java b/src/scratchpad/src/org/apache/poi/hdgf/streams/Stream.java index 35aa7e5291..163fa83d9a 100644 --- a/src/scratchpad/src/org/apache/poi/hdgf/streams/Stream.java +++ b/src/scratchpad/src/org/apache/poi/hdgf/streams/Stream.java @@ -83,7 +83,7 @@ public abstract class Stream { return new ChunkStream(pointer, store, chunkFactory); } else if(pointer.destinationHasStrings()) { - return new StringsStream(pointer, store); + return new StringsStream(pointer, store, chunkFactory); } // Give up and return a generic one diff --git a/src/scratchpad/src/org/apache/poi/hdgf/streams/StringsStream.java b/src/scratchpad/src/org/apache/poi/hdgf/streams/StringsStream.java index 2688b156e9..b23ff92149 100644 --- a/src/scratchpad/src/org/apache/poi/hdgf/streams/StringsStream.java +++ b/src/scratchpad/src/org/apache/poi/hdgf/streams/StringsStream.java @@ -16,13 +16,16 @@ limitations under the License. ==================================================================== */ package org.apache.poi.hdgf.streams; +import org.apache.poi.hdgf.chunks.ChunkFactory; import org.apache.poi.hdgf.pointers.Pointer; /** - * A Stream which holds Strings + * A Stream which holds Strings. This is just another kind + * of ChunkStream, it seems */ public class StringsStream extends Stream { - protected StringsStream(Pointer pointer, StreamStore store) { + protected StringsStream(Pointer pointer, StreamStore store, ChunkFactory chunkFactory) { super(pointer, store); +// super(pointer, store, chunkFactory); } } diff --git a/src/scratchpad/testcases/org/apache/poi/hdgf/extractor/TestVisioExtractor.java b/src/scratchpad/testcases/org/apache/poi/hdgf/extractor/TestVisioExtractor.java new file mode 100644 index 0000000000..a6541e9b0d --- /dev/null +++ b/src/scratchpad/testcases/org/apache/poi/hdgf/extractor/TestVisioExtractor.java @@ -0,0 +1,107 @@ +/* ==================================================================== + 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.hdgf.extractor; + +import java.io.ByteArrayOutputStream; +import java.io.FileInputStream; +import java.io.PrintStream; + +import junit.framework.TestCase; + +import org.apache.poi.hdgf.HDGFDiagram; +import org.apache.poi.hdgf.chunks.Chunk; +import org.apache.poi.hdgf.chunks.ChunkFactory; +import org.apache.poi.hdgf.pointers.Pointer; +import org.apache.poi.hdgf.pointers.PointerFactory; +import org.apache.poi.hssf.record.formula.eval.StringOperationEval; +import org.apache.poi.poifs.filesystem.DocumentEntry; +import org.apache.poi.poifs.filesystem.POIFSFileSystem; + +public class TestVisioExtractor extends TestCase { + private String filename; + protected void setUp() throws Exception { + String dirname = System.getProperty("HDGF.testdata.path"); + filename = dirname + "/Test_Visio-Some_Random_Text.vsd"; + } + + /** + * Test the 3 different ways of creating one + */ + public void testCreation() throws Exception { + VisioTextExtractor extractor; + + extractor = new VisioTextExtractor(new FileInputStream(filename)); + assertNotNull(extractor); + assertNotNull(extractor.getAllText()); + assertEquals(3, extractor.getAllText().length); + + extractor = new VisioTextExtractor( + new POIFSFileSystem( + new FileInputStream(filename) + ) + ); + assertNotNull(extractor); + assertNotNull(extractor.getAllText()); + assertEquals(3, extractor.getAllText().length); + + extractor = new VisioTextExtractor( + new HDGFDiagram( + new POIFSFileSystem( + new FileInputStream(filename) + ) + ) + ); + assertNotNull(extractor); + assertNotNull(extractor.getAllText()); + assertEquals(3, extractor.getAllText().length); + } + + public void testExtraction() throws Exception { + VisioTextExtractor extractor = + new VisioTextExtractor(new FileInputStream(filename)); + + // Check the array fetch + String[] text = extractor.getAllText(); + assertNotNull(text); + assertEquals(3, text.length); + + assertEquals("Test View\n", text[0]); + assertEquals("I am a test view\n", text[1]); + assertEquals("Some random text, on a page\n", text[2]); + + // And the all-in fetch + String textS = extractor.getText(); + assertEquals("Test View\nI am a test view\nSome random text, on a page\n", textS); + } + + public void testMain() throws Exception { + PrintStream oldOut = System.out; + ByteArrayOutputStream baos = new ByteArrayOutputStream(); + PrintStream capture = new PrintStream(baos); + System.setOut(capture); + + VisioTextExtractor.main(new String[] {filename}); + + // Put things back + System.setOut(oldOut); + + // Check + capture.flush(); + String text = baos.toString(); + assertEquals("Test View\nI am a test view\nSome random text, on a page\n", text); + } +} diff --git a/src/scratchpad/testcases/org/apache/poi/hdgf/streams/TestStreamComplex.java b/src/scratchpad/testcases/org/apache/poi/hdgf/streams/TestStreamComplex.java index c2d03f0c89..5ea21d1a1c 100644 --- a/src/scratchpad/testcases/org/apache/poi/hdgf/streams/TestStreamComplex.java +++ b/src/scratchpad/testcases/org/apache/poi/hdgf/streams/TestStreamComplex.java @@ -18,6 +18,7 @@ package org.apache.poi.hdgf.streams; import java.io.FileInputStream; +import org.apache.poi.hdgf.chunks.Chunk; import org.apache.poi.hdgf.chunks.ChunkFactory; import org.apache.poi.hdgf.pointers.Pointer; import org.apache.poi.hdgf.pointers.PointerFactory; @@ -202,4 +203,63 @@ public class TestStreamComplex extends StreamTest { assertTrue(s8451.getPointedToStreams()[0] instanceof StringsStream); assertTrue(s8451.getPointedToStreams()[1] instanceof StringsStream); } + + public void testChunkWithText() throws Exception { + // Parent ChunkStream is at 0x7194 + // This is one of the last children of the trailer + Pointer trailerPtr = ptrFactory.createPointer(contents, trailerPointerAt); + TrailerStream ts = (TrailerStream) + Stream.createStream(trailerPtr, contents, chunkFactory, ptrFactory); + + ts.findChildren(contents); + + assertNotNull(ts.getChildPointers()); + assertNotNull(ts.getPointedToStreams()); + assertEquals(20, ts.getChildPointers().length); + assertEquals(20, ts.getPointedToStreams().length); + + assertEquals(0x7194, ts.getChildPointers()[13].getOffset()); + assertEquals(0x7194, ts.getPointedToStreams()[13].getPointer().getOffset()); + + PointerContainingStream ps7194 = (PointerContainingStream) + ts.getPointedToStreams()[13]; + + // First child is at 0x64b3 + assertEquals(0x64b3, ps7194.getChildPointers()[0].getOffset()); + assertEquals(0x64b3, ps7194.getPointedToStreams()[0].getPointer().getOffset()); + + ChunkStream cs = (ChunkStream)ps7194.getPointedToStreams()[0]; + + // Should be 26bc bytes un-compressed + assertEquals(0x26bc, cs.getStore().getContents().length); + // And should have lots of children + assertEquals(131, cs.getChunks().length); + + // One of which is Text + boolean hasText = false; + for(int i=0; i