From: Nick Burch Date: Fri, 8 Jan 2010 16:18:52 +0000 (+0000) Subject: Rename the outlook extractor to be more consistent with other extractors X-Git-Tag: REL_3_7_BETA1~152 X-Git-Url: https://source.dussan.org/?a=commitdiff_plain;h=07551a092544bb9f654227ff942e5605363defaa;p=poi.git Rename the outlook extractor to be more consistent with other extractors git-svn-id: https://svn.apache.org/repos/asf/poi/trunk@897249 13f79535-47bb-0310-9956-ffa450edef68 --- diff --git a/src/documentation/content/xdocs/status.xml b/src/documentation/content/xdocs/status.xml index b14c690e52..15b3750815 100644 --- a/src/documentation/content/xdocs/status.xml +++ b/src/documentation/content/xdocs/status.xml @@ -34,7 +34,7 @@ - Add a text extractor to HSMF for simpler extraction of text from .msg files + Add a text extractor (OutlookTextExtractor) to HSMF for simpler extraction of text from .msg files Some improvements to HSMF parsing of .msg files Initialise the link type of HSSFHyperLink, so that getType() on it works 48425 - improved performance of DateUtil.isCellDateFormatted() diff --git a/src/ooxml/java/org/apache/poi/extractor/ExtractorFactory.java b/src/ooxml/java/org/apache/poi/extractor/ExtractorFactory.java index 28af05b3e2..7657635e75 100644 --- a/src/ooxml/java/org/apache/poi/extractor/ExtractorFactory.java +++ b/src/ooxml/java/org/apache/poi/extractor/ExtractorFactory.java @@ -31,7 +31,7 @@ import org.apache.poi.POIXMLDocument; import org.apache.poi.POIXMLTextExtractor; import org.apache.poi.hdgf.extractor.VisioTextExtractor; import org.apache.poi.hslf.extractor.PowerPointExtractor; -import org.apache.poi.hsmf.extractor.HSMFTextExtactor; +import org.apache.poi.hsmf.extractor.OutlookTextExtactor; import org.apache.poi.hssf.extractor.ExcelExtractor; import org.apache.poi.hwpf.extractor.WordExtractor; import org.apache.poi.openxml4j.exceptions.InvalidFormatException; @@ -142,7 +142,7 @@ public class ExtractorFactory { if(entry.getName().equals("__substg1.0_1000001E") || entry.getName().equals("__substg1.0_0047001E") || entry.getName().equals("__substg1.0_0037001E")) { - return new HSMFTextExtactor(poifsDir, fs); + return new OutlookTextExtactor(poifsDir, fs); } } throw new IllegalArgumentException("No supported documents found in the OLE2 stream"); diff --git a/src/ooxml/testcases/org/apache/poi/extractor/TestExtractorFactory.java b/src/ooxml/testcases/org/apache/poi/extractor/TestExtractorFactory.java index 8518b6eab1..f9b88794bd 100644 --- a/src/ooxml/testcases/org/apache/poi/extractor/TestExtractorFactory.java +++ b/src/ooxml/testcases/org/apache/poi/extractor/TestExtractorFactory.java @@ -25,7 +25,7 @@ import org.apache.poi.POITextExtractor; import org.apache.poi.POIDataSamples; import org.apache.poi.hdgf.extractor.VisioTextExtractor; import org.apache.poi.hslf.extractor.PowerPointExtractor; -import org.apache.poi.hsmf.extractor.HSMFTextExtactor; +import org.apache.poi.hsmf.extractor.OutlookTextExtactor; import org.apache.poi.hssf.extractor.ExcelExtractor; import org.apache.poi.hwpf.extractor.WordExtractor; import org.apache.poi.poifs.filesystem.POIFSFileSystem; @@ -169,7 +169,7 @@ public class TestExtractorFactory extends TestCase { // Outlook msg assertTrue( ExtractorFactory.createExtractor(msg) - instanceof HSMFTextExtactor + instanceof OutlookTextExtactor ); assertTrue( ExtractorFactory.createExtractor(msg).getText().length() > 50 @@ -248,7 +248,7 @@ public class TestExtractorFactory extends TestCase { // Outlook msg assertTrue( ExtractorFactory.createExtractor(new FileInputStream(msg)) - instanceof HSMFTextExtactor + instanceof OutlookTextExtactor ); assertTrue( ExtractorFactory.createExtractor(new FileInputStream(msg)).getText().length() > 50 @@ -303,7 +303,7 @@ public class TestExtractorFactory extends TestCase { // Outlook msg assertTrue( ExtractorFactory.createExtractor(new POIFSFileSystem(new FileInputStream(msg))) - instanceof HSMFTextExtactor + instanceof OutlookTextExtactor ); assertTrue( ExtractorFactory.createExtractor(new POIFSFileSystem(new FileInputStream(msg))).getText().length() > 50 diff --git a/src/scratchpad/src/org/apache/poi/hsmf/extractor/HSMFTextExtactor.java b/src/scratchpad/src/org/apache/poi/hsmf/extractor/HSMFTextExtactor.java deleted file mode 100644 index fd72feaa56..0000000000 --- a/src/scratchpad/src/org/apache/poi/hsmf/extractor/HSMFTextExtactor.java +++ /dev/null @@ -1,78 +0,0 @@ -/* ==================================================================== - 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.hsmf.extractor; - -import java.io.IOException; -import java.io.InputStream; -import java.text.SimpleDateFormat; - -import org.apache.poi.POIOLE2TextExtractor; -import org.apache.poi.hsmf.MAPIMessage; -import org.apache.poi.hsmf.exceptions.ChunkNotFoundException; -import org.apache.poi.poifs.filesystem.DirectoryNode; -import org.apache.poi.poifs.filesystem.POIFSFileSystem; - -public class HSMFTextExtactor extends POIOLE2TextExtractor { - public HSMFTextExtactor(MAPIMessage msg) { - super(msg); - } - public HSMFTextExtactor(DirectoryNode poifsDir, POIFSFileSystem fs) throws IOException { - this(new MAPIMessage(poifsDir, fs)); - } - public HSMFTextExtactor(POIFSFileSystem fs) throws IOException { - this(new MAPIMessage(fs)); - } - public HSMFTextExtactor(InputStream inp) throws IOException { - this(new MAPIMessage(inp)); - } - - /** - * Outputs something a little like a RFC822 email - */ - public String getText() { - MAPIMessage msg = (MAPIMessage)document; - StringBuffer s = new StringBuffer(); - - try { - s.append("From: " + msg.getDisplayFrom() + "\n"); - } catch(ChunkNotFoundException e) {} - try { - s.append("To: " + msg.getDisplayTo() + "\n"); - } catch(ChunkNotFoundException e) {} - try { - if(msg.getDisplayCC().length() > 0) - s.append("CC: " + msg.getDisplayCC() + "\n"); - } catch(ChunkNotFoundException e) {} - try { - if(msg.getDisplayBCC().length() > 0) - s.append("BCC: " + msg.getDisplayBCC() + "\n"); - } catch(ChunkNotFoundException e) {} - try { - SimpleDateFormat f = new SimpleDateFormat("E, d MMM yyyy HH:mm:ss"); - s.append("Date: " + f.format(msg.getMessageDate().getTime()) + "\n"); - } catch(ChunkNotFoundException e) {} - try { - s.append("Subject: " + msg.getSubject() + "\n"); - } catch(ChunkNotFoundException e) {} - try { - s.append("\n" + msg.getTextBody() + "\n"); - } catch(ChunkNotFoundException e) {} - - return s.toString(); - } - -} diff --git a/src/scratchpad/src/org/apache/poi/hsmf/extractor/OutlookTextExtactor.java b/src/scratchpad/src/org/apache/poi/hsmf/extractor/OutlookTextExtactor.java new file mode 100644 index 0000000000..54a2ddda67 --- /dev/null +++ b/src/scratchpad/src/org/apache/poi/hsmf/extractor/OutlookTextExtactor.java @@ -0,0 +1,81 @@ +/* ==================================================================== + 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.hsmf.extractor; + +import java.io.IOException; +import java.io.InputStream; +import java.text.SimpleDateFormat; + +import org.apache.poi.POIOLE2TextExtractor; +import org.apache.poi.hsmf.MAPIMessage; +import org.apache.poi.hsmf.exceptions.ChunkNotFoundException; +import org.apache.poi.poifs.filesystem.DirectoryNode; +import org.apache.poi.poifs.filesystem.POIFSFileSystem; + +/** + * A text extractor for HSMF (Outlook) .msg files. + * Outputs in a format somewhat like a plain text email. + */ +public class OutlookTextExtactor extends POIOLE2TextExtractor { + public OutlookTextExtactor(MAPIMessage msg) { + super(msg); + } + public OutlookTextExtactor(DirectoryNode poifsDir, POIFSFileSystem fs) throws IOException { + this(new MAPIMessage(poifsDir, fs)); + } + public OutlookTextExtactor(POIFSFileSystem fs) throws IOException { + this(new MAPIMessage(fs)); + } + public OutlookTextExtactor(InputStream inp) throws IOException { + this(new MAPIMessage(inp)); + } + + /** + * Outputs something a little like a RFC822 email + */ + public String getText() { + MAPIMessage msg = (MAPIMessage)document; + StringBuffer s = new StringBuffer(); + + try { + s.append("From: " + msg.getDisplayFrom() + "\n"); + } catch(ChunkNotFoundException e) {} + try { + s.append("To: " + msg.getDisplayTo() + "\n"); + } catch(ChunkNotFoundException e) {} + try { + if(msg.getDisplayCC().length() > 0) + s.append("CC: " + msg.getDisplayCC() + "\n"); + } catch(ChunkNotFoundException e) {} + try { + if(msg.getDisplayBCC().length() > 0) + s.append("BCC: " + msg.getDisplayBCC() + "\n"); + } catch(ChunkNotFoundException e) {} + try { + SimpleDateFormat f = new SimpleDateFormat("E, d MMM yyyy HH:mm:ss"); + s.append("Date: " + f.format(msg.getMessageDate().getTime()) + "\n"); + } catch(ChunkNotFoundException e) {} + try { + s.append("Subject: " + msg.getSubject() + "\n"); + } catch(ChunkNotFoundException e) {} + try { + s.append("\n" + msg.getTextBody() + "\n"); + } catch(ChunkNotFoundException e) {} + + return s.toString(); + } +} diff --git a/src/scratchpad/testcases/org/apache/poi/hsmf/extractor/TestHSMFTextExtractor.java b/src/scratchpad/testcases/org/apache/poi/hsmf/extractor/TestHSMFTextExtractor.java deleted file mode 100644 index 84ebbb1509..0000000000 --- a/src/scratchpad/testcases/org/apache/poi/hsmf/extractor/TestHSMFTextExtractor.java +++ /dev/null @@ -1,95 +0,0 @@ -/* ==================================================================== - 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.hsmf.extractor; - -import java.io.FileInputStream; -import java.io.IOException; - -import junit.framework.TestCase; - -import org.apache.poi.POIDataSamples; -import org.apache.poi.hsmf.MAPIMessage; -import org.apache.poi.poifs.filesystem.POIFSFileSystem; - -/** - * Tests to verify that the text extractor works - */ -public final class TestHSMFTextExtractor extends TestCase { - private POIDataSamples samples; - - public TestHSMFTextExtractor() throws IOException { - samples = POIDataSamples.getHSMFInstance(); - } - - private void assertContains(String haystack, String needle) { - if(haystack.indexOf(needle) > -1) { - return; - } - fail("'" + needle + "' wasn't found in '" + haystack + "'"); - } - - public void testQuick() throws Exception { - POIFSFileSystem simple = new POIFSFileSystem( - new FileInputStream(samples.getFile("quick.msg")) - ); - MAPIMessage msg = new MAPIMessage(simple); - - HSMFTextExtactor ext = new HSMFTextExtactor(msg); - String text = ext.getText(); - - assertContains(text, "From: Kevin Roast\n"); - assertContains(text, "To: Kevin Roast\n"); - assertEquals(-1, text.indexOf("CC:")); - assertEquals(-1, text.indexOf("BCC:")); - assertContains(text, "Subject: Test the content transformer\n"); - assertContains(text, "Date: Thu, 14 Jun 2007 09:42:55\n"); - assertContains(text, "The quick brown fox jumps over the lazy dog"); - } - - public void testSimple() throws Exception { - MAPIMessage msg = new MAPIMessage(new POIFSFileSystem( - new FileInputStream(samples.getFile("simple_test_msg.msg")) - )); - - HSMFTextExtactor ext = new HSMFTextExtactor(msg); - String text = ext.getText(); - - assertContains(text, "From: Travis Ferguson\n"); - assertContains(text, "To: travis@overwrittenstack.com\n"); - assertEquals(-1, text.indexOf("CC:")); - assertEquals(-1, text.indexOf("BCC:")); - assertContains(text, "Subject: test message\n"); - assertEquals(-1, text.indexOf("Date:")); - assertContains(text, "This is a test message."); - } - - public void testConstructors() throws Exception { - String inp = (new HSMFTextExtactor(new FileInputStream( - samples.getFile("simple_test_msg.msg") - )).getText()); - String poifs = (new HSMFTextExtactor(new POIFSFileSystem(new FileInputStream( - samples.getFile("simple_test_msg.msg") - ))).getText()); - String mapi = (new HSMFTextExtactor(new MAPIMessage(new FileInputStream( - samples.getFile("simple_test_msg.msg") - ))).getText()); - - assertEquals(inp, poifs); - assertEquals(inp, mapi); - } -} diff --git a/src/scratchpad/testcases/org/apache/poi/hsmf/extractor/TestOutlookTextExtractor.java b/src/scratchpad/testcases/org/apache/poi/hsmf/extractor/TestOutlookTextExtractor.java new file mode 100644 index 0000000000..b15bbc7249 --- /dev/null +++ b/src/scratchpad/testcases/org/apache/poi/hsmf/extractor/TestOutlookTextExtractor.java @@ -0,0 +1,95 @@ +/* ==================================================================== + 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.hsmf.extractor; + +import java.io.FileInputStream; +import java.io.IOException; + +import junit.framework.TestCase; + +import org.apache.poi.POIDataSamples; +import org.apache.poi.hsmf.MAPIMessage; +import org.apache.poi.poifs.filesystem.POIFSFileSystem; + +/** + * Tests to verify that the text extractor works + */ +public final class TestOutlookTextExtractor extends TestCase { + private POIDataSamples samples; + + public TestOutlookTextExtractor() throws IOException { + samples = POIDataSamples.getHSMFInstance(); + } + + private void assertContains(String haystack, String needle) { + if(haystack.indexOf(needle) > -1) { + return; + } + fail("'" + needle + "' wasn't found in '" + haystack + "'"); + } + + public void testQuick() throws Exception { + POIFSFileSystem simple = new POIFSFileSystem( + new FileInputStream(samples.getFile("quick.msg")) + ); + MAPIMessage msg = new MAPIMessage(simple); + + OutlookTextExtactor ext = new OutlookTextExtactor(msg); + String text = ext.getText(); + + assertContains(text, "From: Kevin Roast\n"); + assertContains(text, "To: Kevin Roast\n"); + assertEquals(-1, text.indexOf("CC:")); + assertEquals(-1, text.indexOf("BCC:")); + assertContains(text, "Subject: Test the content transformer\n"); + assertContains(text, "Date: Thu, 14 Jun 2007 09:42:55\n"); + assertContains(text, "The quick brown fox jumps over the lazy dog"); + } + + public void testSimple() throws Exception { + MAPIMessage msg = new MAPIMessage(new POIFSFileSystem( + new FileInputStream(samples.getFile("simple_test_msg.msg")) + )); + + OutlookTextExtactor ext = new OutlookTextExtactor(msg); + String text = ext.getText(); + + assertContains(text, "From: Travis Ferguson\n"); + assertContains(text, "To: travis@overwrittenstack.com\n"); + assertEquals(-1, text.indexOf("CC:")); + assertEquals(-1, text.indexOf("BCC:")); + assertContains(text, "Subject: test message\n"); + assertEquals(-1, text.indexOf("Date:")); + assertContains(text, "This is a test message."); + } + + public void testConstructors() throws Exception { + String inp = (new OutlookTextExtactor(new FileInputStream( + samples.getFile("simple_test_msg.msg") + )).getText()); + String poifs = (new OutlookTextExtactor(new POIFSFileSystem(new FileInputStream( + samples.getFile("simple_test_msg.msg") + ))).getText()); + String mapi = (new OutlookTextExtactor(new MAPIMessage(new FileInputStream( + samples.getFile("simple_test_msg.msg") + ))).getText()); + + assertEquals(inp, poifs); + assertEquals(inp, mapi); + } +}