123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204 |
- /* ====================================================================
- 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.stress;
-
- import static org.junit.jupiter.api.Assertions.assertEquals;
- import static org.junit.jupiter.api.Assertions.assertFalse;
- import static org.junit.jupiter.api.Assertions.assertNotNull;
- import static org.junit.jupiter.api.Assumptions.assumeFalse;
-
- import java.io.File;
- import java.io.FileInputStream;
- import java.io.IOException;
- import java.io.InputStream;
- import java.util.Arrays;
- import java.util.HashSet;
- import java.util.Set;
-
- import org.apache.poi.EncryptedDocumentException;
- import org.apache.poi.extractor.ExtractorFactory;
- import org.apache.poi.extractor.POIOLE2TextExtractor;
- import org.apache.poi.extractor.POITextExtractor;
- import org.apache.poi.hpsf.extractor.HPSFPropertiesExtractor;
- import org.apache.poi.hssf.extractor.EventBasedExcelExtractor;
- import org.apache.poi.ooxml.POIXMLException;
- import org.apache.poi.ss.extractor.ExcelExtractor;
-
- /**
- * Base class with things that can be run for any supported file handler
- * in the integration tests, mostly text-extraction related at the moment.
- */
- public abstract class AbstractFileHandler implements FileHandler {
- // some FileHandlers extend this list!?!
- protected static final Set<String> EXPECTED_EXTRACTOR_FAILURES = new HashSet<>(Arrays.asList(
- // password protected files without password
- // ... currently none ...
-
- // unsupported file-types, no supported OLE2 parts
- "hmef/quick-winmail.dat",
- "hmef/winmail-sample1.dat",
- "hmef/bug52400-winmail-simple.dat",
- "hmef/bug52400-winmail-with-attachments.dat",
- "hmef/bug63955-winmail.dat",
- "hpsf/Test0313rur.adm",
- "poifs/Notes.ole2",
- "poifs/64322.ole2",
- //commons-compress 1.21 no longer supports truncated files
- "document/truncated62886.docx"
- ));
-
- @Override
- public void handleExtracting(File file) throws Exception {
- boolean before = ExtractorFactory.getThreadPrefersEventExtractors();
- try {
- ExtractorFactory.setThreadPrefersEventExtractors(true);
- handleExtractingInternal(file);
-
- ExtractorFactory.setThreadPrefersEventExtractors(false);
- handleExtractingInternal(file);
- } finally {
- ExtractorFactory.setThreadPrefersEventExtractors(before);
- }
-
- /* Did fail for some documents with special XML contents...
- try {
- OOXMLPrettyPrint.main(new String[] { file.getAbsolutePath(),
- "/tmp/pretty-" + file.getName() });
- } catch (ZipException e) {
- // ignore, not a Zip/OOXML file
- }*/
- }
-
- private void handleExtractingInternal(File file) throws Exception {
- long length = file.length();
- long modified = file.lastModified();
-
- String fileAndParentName = file.getParentFile().getName() + "/" + file.getName();
- try {
- handleExtractingAsStream(file);
-
- // fix windows absolute paths for exception message tracking
- String relPath = file.getPath().replaceAll(".*test-data", "test-data").replace('\\', '/');
- try (POITextExtractor extractor = ExtractorFactory.createExtractor(file)) {
- assertNotNull(extractor, "Should get a POITextExtractor but had none for file " + relPath);
-
- assertNotNull(extractor.getText(), "Should get some text but had none for file " + relPath);
-
- // also try metadata
- POITextExtractor metadataExtractor = extractor.getMetadataTextExtractor();
- assertNotNull(metadataExtractor.getText());
-
- assertFalse(EXPECTED_EXTRACTOR_FAILURES.contains(fileAndParentName),
- "Expected Extraction to fail for file " + relPath + " and handler " + this + ", but did not fail!");
-
- assertEquals(length, file.length(), "File should not be modified by extractor");
- assertEquals(modified, file.lastModified(), "File should not be modified by extractor");
-
- if (extractor instanceof POIOLE2TextExtractor) {
- POIOLE2TextExtractor ole2Extractor = (POIOLE2TextExtractor) extractor;
- ole2Extractor.getRoot();
- if (!(ole2Extractor instanceof EventBasedExcelExtractor)) {
- ole2Extractor.getSummaryInformation();
- ole2Extractor.getDocSummaryInformation();
- }
-
- try (HPSFPropertiesExtractor hpsfExtractor = new HPSFPropertiesExtractor(ole2Extractor)) {
- assertNotNull(hpsfExtractor.getDocumentSummaryInformationText());
- assertNotNull(hpsfExtractor.getSummaryInformationText());
- String text = hpsfExtractor.getText();
- //System.out.println(text);
- assertNotNull(text);
- }
-
- if (ole2Extractor.getRoot() != null && !Boolean.getBoolean("scratchpad.ignore")) {
- POITextExtractor[] embedded = ExtractorFactory.getEmbeddedDocsTextExtractors(ole2Extractor);
- try {
- for (POITextExtractor poiTextExtractor : embedded) {
- poiTextExtractor.getText();
- poiTextExtractor.getDocument();
- poiTextExtractor.getFilesystem();
- POITextExtractor metaData = poiTextExtractor.getMetadataTextExtractor();
- metaData.getFilesystem();
- metaData.getText();
- }
- } finally {
- for (POITextExtractor embeddedExtractor : embedded) {
- embeddedExtractor.close();
- }
- }
- }
- }
-
- // test again with including formulas and cell-comments as this caused some bugs
- if (extractor instanceof ExcelExtractor &&
- // comment-extraction and formula extraction are not well supported in event based extraction
- !(extractor instanceof EventBasedExcelExtractor)) {
- ((ExcelExtractor) extractor).setFormulasNotResults(true);
-
- String text = extractor.getText();
- assertNotNull(text);
- // */
-
- ((ExcelExtractor) extractor).setIncludeCellComments(true);
-
- text = extractor.getText();
- assertNotNull(text);
- }
- }
- } catch (IOException | POIXMLException e) {
- Exception prevE = e;
- Throwable cause;
- while ((cause = prevE.getCause()) instanceof Exception) {
- if (cause instanceof IOException || cause instanceof POIXMLException) {
- prevE = (Exception)cause;
- } else {
- throw (Exception)cause;
- }
- }
- throw e;
- } catch (IllegalArgumentException e) {
- if(!EXPECTED_EXTRACTOR_FAILURES.contains(fileAndParentName)) {
- throw e;
- }
- } catch (EncryptedDocumentException e) {
- String msg = "org.apache.poi.EncryptedDocumentException: Export Restrictions in place - please install JCE Unlimited Strength Jurisdiction Policy files";
- assumeFalse(msg.equals(e.getMessage()));
- throw e;
- } catch (IllegalStateException e) {
- if (!e.getMessage().contains("POI Scratchpad jar missing") || !Boolean.getBoolean("scratchpad.ignore")) {
- throw e;
- }
- }
- }
-
- private void handleExtractingAsStream(File file) throws IOException {
- try (InputStream stream = new FileInputStream(file)) {
- try (POITextExtractor streamExtractor = ExtractorFactory.createExtractor(stream)) {
- assertNotNull(streamExtractor);
-
- assertNotNull(streamExtractor.getText());
-
- assertNotNull(streamExtractor.getMetadataTextExtractor());
- }
- }
- }
-
- @Override
- public void handleAdditional(File file) throws Exception {
- // by default we do nothing here
- }
- }
|