poi/src/ooxml/testcases/org/apache/poi/extractor/TestExtractorFactory.java

/* ====================================================================
   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.extractor;

import java.io.File;
import java.io.FileInputStream;
import java.io.IOException;

import org.apache.poi.POIOLE2TextExtractor;
import org.apache.poi.POITextExtractor;
import org.apache.poi.POIDataSamples;
import org.apache.poi.hdgf.extractor.VisioTextExtractor;
import org.apache.poi.hpbf.extractor.PublisherTextExtractor;
import org.apache.poi.hslf.extractor.PowerPointExtractor;
import org.apache.poi.hsmf.extractor.OutlookTextExtactor;
import org.apache.poi.hssf.extractor.EventBasedExcelExtractor;
import org.apache.poi.hssf.extractor.ExcelExtractor;
import org.apache.poi.hwpf.extractor.WordExtractor;
import org.apache.poi.poifs.filesystem.POIFSFileSystem;
import org.apache.poi.xslf.extractor.XSLFPowerPointExtractor;
import org.apache.poi.xssf.extractor.XSSFExcelExtractor;
import org.apache.poi.xwpf.extractor.XWPFWordExtractor;

import junit.framework.TestCase;

import org.apache.poi.openxml4j.exceptions.InvalidOperationException;
import org.apache.poi.openxml4j.opc.OPCPackage;

/**
 * Test that the extractor factory plays nicely
 */
public class TestExtractorFactory extends TestCase {

   private File txt;

   private File xls;
   private File xlsx;
   private File xltx;
   private File xlsEmb;

   private File doc;
   private File docx;
   private File dotx;
   private File docEmb;

   private File ppt;
   private File pptx;

   private File msg;
   private File msgEmb;
   
   private File vsd;
   
   private File pub;

   protected void setUp() throws Exception {
      super.setUp();

      POIDataSamples ssTests = POIDataSamples.getSpreadSheetInstance();
      xls = ssTests.getFile("SampleSS.xls");
      xlsx = ssTests.getFile("SampleSS.xlsx");
      xltx = ssTests.getFile("test.xltx");
      xlsEmb = ssTests.getFile("excel_with_embeded.xls");

      POIDataSamples wpTests = POIDataSamples.getDocumentInstance();
      doc = wpTests.getFile("SampleDoc.doc");
      docx = wpTests.getFile("SampleDoc.docx");
      dotx = wpTests.getFile("test.dotx");
      docEmb = wpTests.getFile("word_with_embeded.doc");

      POIDataSamples slTests = POIDataSamples.getSlideShowInstance();
      ppt = slTests.getFile("SampleShow.ppt");
      pptx = slTests.getFile("SampleShow.pptx");
      txt = slTests.getFile("SampleShow.txt");

      POIDataSamples dgTests = POIDataSamples.getDiagramInstance();
      vsd = dgTests.getFile("Test_Visio-Some_Random_Text.vsd");
      
      POIDataSamples pubTests = POIDataSamples.getPublisherInstance();
      pub = pubTests.getFile("Simple.pub");
      
      POIDataSamples olTests = POIDataSamples.getHSMFInstance();
      msg = olTests.getFile("quick.msg");
      msgEmb = olTests.getFile("attachment_test_msg.msg");
   }

   public void testFile() throws Exception {
      // Excel
      assertTrue(
            ExtractorFactory.createExtractor(xls)
            instanceof ExcelExtractor
      );
      assertTrue(
            ExtractorFactory.createExtractor(xls).getText().length() > 200
      );

      assertTrue(
            ExtractorFactory.createExtractor(xlsx)
            instanceof XSSFExcelExtractor
      );
      assertTrue(
            ExtractorFactory.createExtractor(xlsx).getText().length() > 200
      );

      assertTrue(
            ExtractorFactory.createExtractor(xltx)
            instanceof XSSFExcelExtractor
      );
      assertTrue(
            ExtractorFactory.createExtractor(xltx).getText().contains("test")
      );


      // Word
      assertTrue(
            ExtractorFactory.createExtractor(doc)
            instanceof WordExtractor
      );
      assertTrue(
            ExtractorFactory.createExtractor(doc).getText().length() > 120
      );

      assertTrue(
            ExtractorFactory.createExtractor(docx)
            instanceof XWPFWordExtractor
      );
      assertTrue(
            ExtractorFactory.createExtractor(docx).getText().length() > 120
      );

      assertTrue(
            ExtractorFactory.createExtractor(dotx)
            instanceof XWPFWordExtractor
      );
      assertTrue(
            ExtractorFactory.createExtractor(dotx).getText().contains("Test")
      );

      // PowerPoint
      assertTrue(
            ExtractorFactory.createExtractor(ppt)
            instanceof PowerPointExtractor
      );
      assertTrue(
            ExtractorFactory.createExtractor(ppt).getText().length() > 120
      );

      assertTrue(
            ExtractorFactory.createExtractor(pptx)
            instanceof XSLFPowerPointExtractor
      );
      assertTrue(
            ExtractorFactory.createExtractor(pptx).getText().length() > 120
      );

      // Visio
      assertTrue(
            ExtractorFactory.createExtractor(vsd)
            instanceof VisioTextExtractor
      );
      assertTrue(
            ExtractorFactory.createExtractor(vsd).getText().length() > 50
      );
      
      // Publisher
      assertTrue(
            ExtractorFactory.createExtractor(pub)
            instanceof PublisherTextExtractor
      );
      assertTrue(
            ExtractorFactory.createExtractor(pub).getText().length() > 50
      );
      
      // Outlook msg
      assertTrue(
            ExtractorFactory.createExtractor(msg)
            instanceof OutlookTextExtactor
      );
      assertTrue(
            ExtractorFactory.createExtractor(msg).getText().length() > 50
      );

      // Text
      try {
         ExtractorFactory.createExtractor(txt);
         fail();
      } catch(IllegalArgumentException e) {
         // Good
      }
	}
	
	public void testInputStream() throws Exception {
		// Excel
		assertTrue(
				ExtractorFactory.createExtractor(new FileInputStream(xls))
				instanceof ExcelExtractor
		);
		assertTrue(
				ExtractorFactory.createExtractor(new FileInputStream(xls)).getText().length() > 200
		);
		
		assertTrue(
				ExtractorFactory.createExtractor(new FileInputStream(xlsx))
				instanceof XSSFExcelExtractor
		);
		assertTrue(
				ExtractorFactory.createExtractor(new FileInputStream(xlsx)).getText().length() > 200
		);
		
		// Word
		assertTrue(
				ExtractorFactory.createExtractor(new FileInputStream(doc))
				instanceof WordExtractor
		);
		assertTrue(
				ExtractorFactory.createExtractor(new FileInputStream(doc)).getText().length() > 120
		);
		
		assertTrue(
				ExtractorFactory.createExtractor(new FileInputStream(docx))
				instanceof XWPFWordExtractor
		);
		assertTrue(
				ExtractorFactory.createExtractor(new FileInputStream(docx)).getText().length() > 120
		);
		
		// PowerPoint
		assertTrue(
				ExtractorFactory.createExtractor(new FileInputStream(ppt))
				instanceof PowerPointExtractor
		);
		assertTrue(
				ExtractorFactory.createExtractor(new FileInputStream(ppt)).getText().length() > 120
		);
		
		assertTrue(
				ExtractorFactory.createExtractor(new FileInputStream(pptx))
				instanceof XSLFPowerPointExtractor
		);
		assertTrue(
				ExtractorFactory.createExtractor(new FileInputStream(pptx)).getText().length() > 120
		);
		
		// Visio
		assertTrue(
				ExtractorFactory.createExtractor(new FileInputStream(vsd))
				instanceof VisioTextExtractor
		);
		assertTrue(
				ExtractorFactory.createExtractor(new FileInputStream(vsd)).getText().length() > 50
		);
		
      // Publisher
      assertTrue(
            ExtractorFactory.createExtractor(new FileInputStream(pub))
            instanceof PublisherTextExtractor
      );
      assertTrue(
            ExtractorFactory.createExtractor(new FileInputStream(pub)).getText().length() > 50
      );
      
		// Outlook msg
      assertTrue(
            ExtractorFactory.createExtractor(new FileInputStream(msg))
            instanceof OutlookTextExtactor
      );
      assertTrue(
            ExtractorFactory.createExtractor(new FileInputStream(msg)).getText().length() > 50
      );
		
		// Text
		try {
			ExtractorFactory.createExtractor(new FileInputStream(txt));
			fail();
		} catch(IllegalArgumentException e) {
			// Good
		}
	}
	
	public void testPOIFS() throws Exception {
		// Excel
		assertTrue(
				ExtractorFactory.createExtractor(new POIFSFileSystem(new FileInputStream(xls)))
				instanceof ExcelExtractor
		);
		assertTrue(
				ExtractorFactory.createExtractor(new POIFSFileSystem(new FileInputStream(xls))).getText().length() > 200
		);
		
		// Word
		assertTrue(
				ExtractorFactory.createExtractor(new POIFSFileSystem(new FileInputStream(doc)))
				instanceof WordExtractor
		);
		assertTrue(
				ExtractorFactory.createExtractor(new POIFSFileSystem(new FileInputStream(doc))).getText().length() > 120
		);
		
		// PowerPoint
		assertTrue(
				ExtractorFactory.createExtractor(new POIFSFileSystem(new FileInputStream(ppt)))
				instanceof PowerPointExtractor
		);
		assertTrue(
				ExtractorFactory.createExtractor(new POIFSFileSystem(new FileInputStream(ppt))).getText().length() > 120
		);
		
		// Visio
		assertTrue(
				ExtractorFactory.createExtractor(new POIFSFileSystem(new FileInputStream(vsd)))
				instanceof VisioTextExtractor
		);
		assertTrue(
				ExtractorFactory.createExtractor(new POIFSFileSystem(new FileInputStream(vsd))).getText().length() > 50
		);
      
      // Publisher
      assertTrue(
            ExtractorFactory.createExtractor(new POIFSFileSystem(new FileInputStream(pub)))
            instanceof PublisherTextExtractor
      );
      assertTrue(
            ExtractorFactory.createExtractor(new POIFSFileSystem(new FileInputStream(pub))).getText().length() > 50
      );
		
      // Outlook msg
      assertTrue(
            ExtractorFactory.createExtractor(new POIFSFileSystem(new FileInputStream(msg)))
            instanceof OutlookTextExtactor
      );
      assertTrue(
            ExtractorFactory.createExtractor(new POIFSFileSystem(new FileInputStream(msg))).getText().length() > 50
      );
      
		// Text
		try {
			ExtractorFactory.createExtractor(new POIFSFileSystem(new FileInputStream(txt)));
			fail();
		} catch(IOException e) {
			// Good
		}
	}
	
	public void testPackage() throws Exception {
		// Excel
		assertTrue(
				ExtractorFactory.createExtractor(OPCPackage.open(xlsx.toString()))
				instanceof XSSFExcelExtractor
		);
		assertTrue(
				ExtractorFactory.createExtractor(OPCPackage.open(xlsx.toString())).getText().length() > 200
		);
		
		// Word
		assertTrue(
				ExtractorFactory.createExtractor(OPCPackage.open(docx.toString()))
				instanceof XWPFWordExtractor
		);
		assertTrue(
				ExtractorFactory.createExtractor(OPCPackage.open(docx.toString())).getText().length() > 120
		);
		
		// PowerPoint
		assertTrue(
				ExtractorFactory.createExtractor(OPCPackage.open(pptx.toString()))
				instanceof XSLFPowerPointExtractor
		);
		assertTrue(
				ExtractorFactory.createExtractor(OPCPackage.open(pptx.toString())).getText().length() > 120
		);
		
		// Text
		try {
			ExtractorFactory.createExtractor(OPCPackage.open(txt.toString()));
			fail();
		} catch(InvalidOperationException e) {
			// Good
		}
	}
	
	public void testPreferEventBased() throws Exception {
	   assertEquals(false, ExtractorFactory.getPreferEventExtractor());
	   assertEquals(false, ExtractorFactory.getThreadPrefersEventExtractors());
	   assertEquals(null, ExtractorFactory.getAllThreadsPreferEventExtractors());
	   
	   ExtractorFactory.setThreadPrefersEventExtractors(true);
	   
      assertEquals(true, ExtractorFactory.getPreferEventExtractor());
      assertEquals(true, ExtractorFactory.getThreadPrefersEventExtractors());
      assertEquals(null, ExtractorFactory.getAllThreadsPreferEventExtractors());
      
      ExtractorFactory.setAllThreadsPreferEventExtractors(false);
      
      assertEquals(false, ExtractorFactory.getPreferEventExtractor());
      assertEquals(true, ExtractorFactory.getThreadPrefersEventExtractors());
      assertEquals(Boolean.FALSE, ExtractorFactory.getAllThreadsPreferEventExtractors());
      
      ExtractorFactory.setAllThreadsPreferEventExtractors(null);
      
      assertEquals(true, ExtractorFactory.getPreferEventExtractor());
      assertEquals(true, ExtractorFactory.getThreadPrefersEventExtractors());
      assertEquals(null, ExtractorFactory.getAllThreadsPreferEventExtractors());
      
      
      // Check we get the right extractors now
      assertTrue(
            ExtractorFactory.createExtractor(new POIFSFileSystem(new FileInputStream(xls)))
            instanceof EventBasedExcelExtractor
      );
      assertTrue(
            ExtractorFactory.createExtractor(new POIFSFileSystem(new FileInputStream(xls))).getText().length() > 200
      );
      
      assertTrue(
            ExtractorFactory.createExtractor(OPCPackage.open(xlsx.toString()))
            instanceof XSSFExcelExtractor // TODO
      );
      assertTrue(
            ExtractorFactory.createExtractor(OPCPackage.open(xlsx.toString())).getText().length() > 200
      );
      
      
      // Put back to normal
      ExtractorFactory.setThreadPrefersEventExtractors(false);
      assertEquals(false, ExtractorFactory.getPreferEventExtractor());
      assertEquals(false, ExtractorFactory.getThreadPrefersEventExtractors());
      assertEquals(null, ExtractorFactory.getAllThreadsPreferEventExtractors());
      
      // And back
      assertTrue(
            ExtractorFactory.createExtractor(new POIFSFileSystem(new FileInputStream(xls)))
            instanceof ExcelExtractor
      );
      assertTrue(
            ExtractorFactory.createExtractor(new POIFSFileSystem(new FileInputStream(xls))).getText().length() > 200
      );
      
      assertTrue(
            ExtractorFactory.createExtractor(OPCPackage.open(xlsx.toString()))
            instanceof XSSFExcelExtractor
      );
      assertTrue(
            ExtractorFactory.createExtractor(OPCPackage.open(xlsx.toString())).getText().length() > 200
      );
	}

   /**
    * Test embeded docs text extraction. For now, only
    *  does poifs embeded, but will do ooxml ones 
    *  at some point.
    */
   public void testEmbeded() throws Exception {
      POIOLE2TextExtractor ext;
      POITextExtractor[] embeds;

      // No embedings
      ext = (POIOLE2TextExtractor)
      ExtractorFactory.createExtractor(xls);
      embeds = ExtractorFactory.getEmbededDocsTextExtractors(ext);
      assertEquals(0, embeds.length);

      // Excel
      ext = (POIOLE2TextExtractor)
      ExtractorFactory.createExtractor(xlsEmb);
      embeds = ExtractorFactory.getEmbededDocsTextExtractors(ext);

      assertEquals(6, embeds.length);
      int numWord = 0, numXls = 0, numPpt = 0;
      for(int i=0; i<embeds.length; i++) {
         assertTrue(embeds[i].getText().length() > 20);

         if(embeds[i] instanceof PowerPointExtractor) numPpt++;
         else if(embeds[i] instanceof ExcelExtractor) numXls++;
         else if(embeds[i] instanceof WordExtractor) numWord++;
      }
      assertEquals(2, numPpt);
      assertEquals(2, numXls);
      assertEquals(2, numWord);

      // Word
      ext = (POIOLE2TextExtractor)
      ExtractorFactory.createExtractor(docEmb);
      embeds = ExtractorFactory.getEmbededDocsTextExtractors(ext);

      numWord = 0; numXls = 0; numPpt = 0;
      assertEquals(4, embeds.length);
      for(int i=0; i<embeds.length; i++) {
         assertTrue(embeds[i].getText().length() > 20);
         if(embeds[i] instanceof PowerPointExtractor) numPpt++;
         else if(embeds[i] instanceof ExcelExtractor) numXls++;
         else if(embeds[i] instanceof WordExtractor) numWord++;
      }
      assertEquals(1, numPpt);
      assertEquals(2, numXls);
      assertEquals(1, numWord);
      
      // Outlook
      ext = (OutlookTextExtactor)
      ExtractorFactory.createExtractor(msgEmb);
      embeds = ExtractorFactory.getEmbededDocsTextExtractors(ext);

      numWord = 0; numXls = 0; numPpt = 0;
      assertEquals(1, embeds.length);
      for(int i=0; i<embeds.length; i++) {
         assertTrue(embeds[i].getText().length() > 20);
         if(embeds[i] instanceof PowerPointExtractor) numPpt++;
         else if(embeds[i] instanceof ExcelExtractor) numXls++;
         else if(embeds[i] instanceof WordExtractor) numWord++;
      }
      assertEquals(0, numPpt);
      assertEquals(0, numXls);
      assertEquals(1, numWord);

      // TODO - PowerPoint
      // TODO - Publisher
      // TODO - Visio
   }
}