/*
* 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 java.io.ByteArrayInputStream;
import java.io.ByteArrayOutputStream;
import java.io.FileNotFoundException;
import java.io.InputStream;

import junit.framework.TestCase;

import org.apache.poi.hssf.HSSFTestDataSamples;
import org.apache.poi.poifs.filesystem.POIFSFileSystem;

/**
 * Tests for how HSSFWorkbook behaves with XLS files
 *  with a WORKBOOK or BOOK directory entry (instead of 
 *  the more usual, Workbook)
 */
public final class TestNonStandardWorkbookStreamNames extends TestCase {
	private final String xlsA = "WORKBOOK_in_capitals.xls";
   private final String xlsB = "BOOK_in_capitals.xls";

	/**
	 * Test that we can open a file with WORKBOOK
	 */
	public void testOpenWORKBOOK() throws Exception {
		InputStream is = HSSFTestDataSamples.openSampleFileStream(xlsA);
		
		POIFSFileSystem fs = new POIFSFileSystem(is);

		// Ensure that we have a WORKBOOK entry
		fs.getRoot().getEntry("WORKBOOK");
		// And a summary
		fs.getRoot().getEntry("\005SummaryInformation");
		assertTrue(true);

		// But not a Workbook one
		try {
			fs.getRoot().getEntry("Workbook");
			fail();
		} catch(FileNotFoundException e) {}
		
		// Try to open the workbook
		HSSFWorkbook wb = new HSSFWorkbook(fs);
	}

   /**
    * Test that we can open a file with BOOK
    */
   public void testOpenBOOK() throws Exception {
      InputStream is = HSSFTestDataSamples.openSampleFileStream(xlsB);
      
      POIFSFileSystem fs = new POIFSFileSystem(is);

      // Ensure that we have a BOOK entry
      fs.getRoot().getEntry("BOOK");
      assertTrue(true);

      // But not a Workbook one
      try {
         fs.getRoot().getEntry("Workbook");
         fail();
      } catch(FileNotFoundException e) {}
      // And not a Summary one
      try {
         fs.getRoot().getEntry("\005SummaryInformation");
         fail();
      } catch(FileNotFoundException e) {}
      
      // Try to open the workbook
      HSSFWorkbook wb = new HSSFWorkbook(fs);
   }

	/**
	 * Test that when we write out, we go back to the correct case
	 */
	public void testWrite() throws Exception {
	   for (String file : new String[] {xlsA, xlsB}) {
   		InputStream is = HSSFTestDataSamples.openSampleFileStream(file);
   		POIFSFileSystem fs = new POIFSFileSystem(is);
   
   		// Open the workbook, not preserving nodes
   		HSSFWorkbook wb = new HSSFWorkbook(fs);
   		ByteArrayOutputStream out = new ByteArrayOutputStream();
   		wb.write(out);
   
   		// Check now
   		ByteArrayInputStream in = new ByteArrayInputStream(out.toByteArray());
   		POIFSFileSystem fs2 = new POIFSFileSystem(in);
   
   		// Check that we have the new entries
   		fs2.getRoot().getEntry("Workbook");
   		try {
   			fs2.getRoot().getEntry("BOOK");
   			fail();
   		} catch(FileNotFoundException e) {}
         try {
            fs2.getRoot().getEntry("WORKBOOK");
            fail();
         } catch(FileNotFoundException e) {}
   
   		// And it can be opened
   		HSSFWorkbook wb2 = new HSSFWorkbook(fs2);
	   }
	}

	/**
	 * Test that when we write out preserving nodes, we go back to the
	 *  correct case
	 */
	public void testWritePreserve() throws Exception {
		InputStream is = HSSFTestDataSamples.openSampleFileStream(xlsA);
		POIFSFileSystem fs = new POIFSFileSystem(is);

		// Open the workbook, not preserving nodes
		HSSFWorkbook wb = new HSSFWorkbook(fs,true);

		ByteArrayOutputStream out = new ByteArrayOutputStream();
		wb.write(out);

		// Check now
		ByteArrayInputStream in = new ByteArrayInputStream(out.toByteArray());
		POIFSFileSystem fs2 = new POIFSFileSystem(in);

		// Check that we have the new entries
		fs2.getRoot().getEntry("Workbook");
		try {
			fs2.getRoot().getEntry("WORKBOOK");
			fail();
		} catch(FileNotFoundException e) {}

		// As we preserved, should also have a few other streams
		fs2.getRoot().getEntry("\005SummaryInformation");

		// And it can be opened
		HSSFWorkbook wb2 = new HSSFWorkbook(fs2);
	}
}