poi/poi/src/test/java/org/apache/poi/hssf/usermodel/TestHSSFWorkbook.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.hssf.usermodel;

import static org.apache.poi.POITestCase.assertContains;
import static org.apache.poi.hssf.HSSFTestDataSamples.openSampleWorkbook;
import static org.junit.jupiter.api.Assertions.assertDoesNotThrow;
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.Assertions.assertNull;
import static org.junit.jupiter.api.Assertions.assertThrows;
import static org.junit.jupiter.api.Assertions.assertTrue;
import static org.junit.jupiter.api.Assertions.fail;

import java.io.ByteArrayOutputStream;
import java.io.File;
import java.io.FileInputStream;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
import java.util.ArrayList;
import java.util.Collection;
import java.util.List;
import java.util.Map;
import java.util.function.Supplier;

import org.apache.commons.io.output.UnsynchronizedByteArrayOutputStream;
import org.apache.poi.POIDataSamples;
import org.apache.poi.ddf.EscherBSERecord;
import org.apache.poi.hpsf.ClassID;
import org.apache.poi.hssf.HSSFITestDataProvider;
import org.apache.poi.hssf.HSSFTestDataSamples;
import org.apache.poi.hssf.OldExcelFormatException;
import org.apache.poi.hssf.model.HSSFFormulaParser;
import org.apache.poi.hssf.model.InternalSheet;
import org.apache.poi.hssf.model.InternalWorkbook;
import org.apache.poi.hssf.record.CFRuleRecord;
import org.apache.poi.hssf.record.HSSFRecordTypes;
import org.apache.poi.hssf.record.NameRecord;
import org.apache.poi.hssf.record.Record;
import org.apache.poi.hssf.record.RecordBase;
import org.apache.poi.hssf.record.WindowOneRecord;
import org.apache.poi.poifs.filesystem.DirectoryEntry;
import org.apache.poi.poifs.filesystem.DirectoryNode;
import org.apache.poi.poifs.filesystem.POIFSFileSystem;
import org.apache.poi.ss.formula.ptg.Area3DPtg;
import org.apache.poi.ss.usermodel.BaseTestWorkbook;
import org.apache.poi.ss.usermodel.Cell;
import org.apache.poi.ss.usermodel.CellReferenceType;
import org.apache.poi.ss.usermodel.ConditionalFormatting;
import org.apache.poi.ss.usermodel.ConditionalFormattingRule;
import org.apache.poi.ss.usermodel.Name;
import org.apache.poi.ss.usermodel.Row;
import org.apache.poi.ss.usermodel.Sheet;
import org.apache.poi.ss.usermodel.SheetConditionalFormatting;
import org.apache.poi.ss.usermodel.Workbook;
import org.apache.poi.ss.usermodel.WorkbookFactory;
import org.apache.poi.ss.util.CellRangeAddress;
import org.apache.poi.util.IOUtils;
import org.apache.poi.util.TempFile;
import org.junit.jupiter.api.Disabled;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.params.ParameterizedTest;
import org.junit.jupiter.params.provider.CsvSource;

/**
 * Tests for {@link HSSFWorkbook}
 */
public final class TestHSSFWorkbook extends BaseTestWorkbook {
    private static final HSSFITestDataProvider _testDataProvider = HSSFITestDataProvider.instance;
    private static final POIDataSamples samples = POIDataSamples.getSpreadSheetInstance();

    public TestHSSFWorkbook() {
        super(_testDataProvider);
    }

    /**
     * gives test code access to the {@link InternalWorkbook} within {@link HSSFWorkbook}
     */
    public static InternalWorkbook getInternalWorkbook(HSSFWorkbook wb) {
        return wb.getWorkbook();
    }

    /**
     * Tests for {@link HSSFWorkbook#isHidden()} etc
     */
    @Test
    void hidden() throws IOException {
        HSSFWorkbook wb = new HSSFWorkbook();

        WindowOneRecord w1 = wb.getWorkbook().getWindowOne();

        assertFalse(wb.isHidden());
        assertFalse(w1.getHidden());

        wb.setHidden(true);
        assertTrue(wb.isHidden());
        assertTrue(w1.getHidden());

        HSSFWorkbook wbBack = HSSFTestDataSamples.writeOutAndReadBack(wb);
        w1 = wbBack.getWorkbook().getWindowOne();

        wbBack.setHidden(true);
        assertTrue(wbBack.isHidden());
        assertTrue(w1.getHidden());

        wbBack.setHidden(false);
        assertFalse(wbBack.isHidden());
        assertFalse(w1.getHidden());

        wbBack.close();
        wb.close();
    }

    @Test
    void readWriteWithCharts() throws IOException {
        Sheet s;

        // Single chart, two sheets
        HSSFWorkbook b1 = openSampleWorkbook("44010-SingleChart.xls");
        assertEquals(2, b1.getNumberOfSheets());
        assertEquals("Graph2", b1.getSheetName(1));
        s = b1.getSheetAt(1);
        assertEquals(0, s.getFirstRowNum());
        assertEquals(8, s.getLastRowNum());

        // Has chart on 1st sheet??
        // FIXME
        assertNotNull(b1.getSheetAt(0).getDrawingPatriarch());
        assertNull(b1.getSheetAt(1).getDrawingPatriarch());
        assertFalse(b1.getSheetAt(0).getDrawingPatriarch().containsChart());
        b1.close();

        // We've now called getDrawingPatriarch() so
        //  everything will be all screwy
        // So, start again
        HSSFWorkbook b2 = openSampleWorkbook("44010-SingleChart.xls");

        HSSFWorkbook b3 = HSSFTestDataSamples.writeOutAndReadBack(b2);
        b2.close();

        assertEquals(2, b3.getNumberOfSheets());
        s = b3.getSheetAt(1);
        assertEquals(0, s.getFirstRowNum());
        assertEquals(8, s.getLastRowNum());
        b3.close();

        // Two charts, three sheets
        HSSFWorkbook b4 = openSampleWorkbook("44010-TwoCharts.xls");
        assertEquals(3, b4.getNumberOfSheets());

        s = b4.getSheetAt(1);
        assertEquals(0, s.getFirstRowNum());
        assertEquals(8, s.getLastRowNum());
        s = b4.getSheetAt(2);
        assertEquals(0, s.getFirstRowNum());
        assertEquals(8, s.getLastRowNum());

        // Has chart on 1st sheet??
        // FIXME
        assertNotNull(b4.getSheetAt(0).getDrawingPatriarch());
        assertNull(b4.getSheetAt(1).getDrawingPatriarch());
        assertNull(b4.getSheetAt(2).getDrawingPatriarch());
        assertFalse(b4.getSheetAt(0).getDrawingPatriarch().containsChart());
        b4.close();

        // We've now called getDrawingPatriarch() so
        //  everything will be all screwy
        // So, start again
        HSSFWorkbook b5 = openSampleWorkbook("44010-TwoCharts.xls");

        Workbook b6 = HSSFTestDataSamples.writeOutAndReadBack(b5);
        b5.close();
        assertEquals(3, b6.getNumberOfSheets());

        s = b6.getSheetAt(1);
        assertEquals(0, s.getFirstRowNum());
        assertEquals(8, s.getLastRowNum());
        s = b6.getSheetAt(2);
        assertEquals(0, s.getFirstRowNum());
        assertEquals(8, s.getLastRowNum());
        b6.close();
    }

    @Test
    void selectedSheet_bug44523() throws IOException {
        HSSFWorkbook wb=new HSSFWorkbook();
        HSSFSheet sheet1 = wb.createSheet("Sheet1");
        HSSFSheet sheet2 = wb.createSheet("Sheet2");
        HSSFSheet sheet3 = wb.createSheet("Sheet3");
        HSSFSheet sheet4 = wb.createSheet("Sheet4");

        confirmActiveSelected(sheet1, true);
        confirmActiveSelected(sheet2, false);
        confirmActiveSelected(sheet3, false);
        confirmActiveSelected(sheet4, false);

        wb.setSelectedTab(1);

        // Demonstrate bug 44525:
        // Well... not quite, since isActive + isSelected were also added in the same bug fix
        assertFalse(sheet1.isSelected(), "Identified bug 44523 a");
        wb.setActiveSheet(1);
        assertFalse(sheet1.isActive(), "Identified bug 44523 b");

        confirmActiveSelected(sheet1, false);
        confirmActiveSelected(sheet2, true);
        confirmActiveSelected(sheet3, false);
        confirmActiveSelected(sheet4, false);

        wb.close();
    }

    private static List<Integer> arrayToList(int[] array) {
        List<Integer> list = new ArrayList<>(array.length);
        for ( Integer element : array ) {
            list.add(element);
        }
        return list;
    }

    private static void assertCollectionsEquals(Collection<Integer> expected, Collection<Integer> actual) {
        assertEquals(expected.size(), actual.size());
        for (int e : expected) {
            assertTrue(actual.contains(e));
        }
        for (int a : actual) {
            assertTrue(expected.contains(a));
        }
    }

    @Test
    void selectMultiple() throws IOException {
        HSSFWorkbook wb = new HSSFWorkbook();
        HSSFSheet sheet0 = wb.createSheet("Sheet0");
        HSSFSheet sheet1 = wb.createSheet("Sheet1");
        HSSFSheet sheet2 = wb.createSheet("Sheet2");
        HSSFSheet sheet3 = wb.createSheet("Sheet3");
        HSSFSheet sheet4 = wb.createSheet("Sheet4");
        HSSFSheet sheet5 = wb.createSheet("Sheet5");


        List<Integer> selected = arrayToList(new int[] { 0, 2, 3 });
        wb.setSelectedTabs(selected);

        assertCollectionsEquals(selected, wb.getSelectedTabs());
        assertTrue(sheet0.isSelected());
        assertFalse(sheet1.isSelected());
        assertTrue(sheet2.isSelected());
        assertTrue(sheet3.isSelected());
        assertFalse(sheet4.isSelected());
        assertFalse(sheet5.isSelected());

        selected = arrayToList(new int[] { 1, 3, 5 });
        wb.setSelectedTabs(selected);

        // previous selection should be cleared
        assertCollectionsEquals(selected, wb.getSelectedTabs());
        assertFalse(sheet0.isSelected());
        assertTrue(sheet1.isSelected());
        assertFalse(sheet2.isSelected());
        assertTrue(sheet3.isSelected());
        assertFalse(sheet4.isSelected());
        assertTrue(sheet5.isSelected());

        assertTrue(sheet0.isActive());
        assertFalse(sheet2.isActive());
        wb.setActiveSheet(2);
        assertFalse(sheet0.isActive());
        assertTrue(sheet2.isActive());

        wb.close();
    }


    @Test
    void activeSheetAfterDelete_bug40414() throws IOException {
        HSSFWorkbook wb=new HSSFWorkbook();
        HSSFSheet sheet0 = wb.createSheet("Sheet0");
        HSSFSheet sheet1 = wb.createSheet("Sheet1");
        HSSFSheet sheet2 = wb.createSheet("Sheet2");
        HSSFSheet sheet3 = wb.createSheet("Sheet3");
        HSSFSheet sheet4 = wb.createSheet("Sheet4");

        // confirm default activation/selection
        confirmActiveSelected(sheet0, true);
        confirmActiveSelected(sheet1, false);
        confirmActiveSelected(sheet2, false);
        confirmActiveSelected(sheet3, false);
        confirmActiveSelected(sheet4, false);

        wb.setActiveSheet(3);
        wb.setSelectedTab(3);

        confirmActiveSelected(sheet0, false);
        confirmActiveSelected(sheet1, false);
        confirmActiveSelected(sheet2, false);
        confirmActiveSelected(sheet3, true);
        confirmActiveSelected(sheet4, false);

        wb.removeSheetAt(3);
        // after removing the only active/selected sheet, another should be active/selected in its place
        assertTrue(sheet4.isSelected(), "identified bug 40414 a");
        assertTrue(sheet4.isActive(), "identified bug 40414 b");

        confirmActiveSelected(sheet0, false);
        confirmActiveSelected(sheet1, false);
        confirmActiveSelected(sheet2, false);
        confirmActiveSelected(sheet4, true);

        sheet3 = sheet4; // re-align local vars in this test case

        // Some more cases of removing sheets

        // Starting with a multiple selection, and different active sheet
        wb.setSelectedTabs(new int[] { 1, 3, });
        wb.setActiveSheet(2);
        confirmActiveSelected(sheet0, false, false);
        confirmActiveSelected(sheet1, false, true);
        confirmActiveSelected(sheet2, true,  false);
        confirmActiveSelected(sheet3, false, true);

        // removing a sheet that is not active, and not the only selected sheet
        wb.removeSheetAt(3);
        confirmActiveSelected(sheet0, false, false);
        confirmActiveSelected(sheet1, false, true);
        confirmActiveSelected(sheet2, true,  false);

        // removing the only selected sheet
        wb.removeSheetAt(1);
        confirmActiveSelected(sheet0, false, false);
        confirmActiveSelected(sheet2, true,  true);

        // The last remaining sheet should always be active+selected
        wb.removeSheetAt(1);
        confirmActiveSelected(sheet0, true,  true);

        wb.close();
    }

    private static void confirmActiveSelected(HSSFSheet sheet, boolean expected) {
        confirmActiveSelected(sheet, expected, expected);
    }


    private static void confirmActiveSelected(HSSFSheet sheet,
            boolean expectedActive, boolean expectedSelected) {
        assertEquals(expectedActive, sheet.isActive(), "active");
        assertEquals(expectedSelected, sheet.isSelected(), "selected");
    }

    /**
     * If Sheet.getSize() returns a different result to Sheet.serialize(), this will cause the BOF
     * records to be written with invalid offset indexes.  Excel does not like this, and such
     * errors are particularly hard to track down.  This test ensures that HSSFWorkbook throws
     * a specific exception as soon as the situation is detected. See bugzilla 45066
     */
    @Test
    void sheetSerializeSizeMismatch_bug45066() throws IOException {
        try (HSSFWorkbook wb = new HSSFWorkbook()) {
            InternalSheet sheet = wb.createSheet("Sheet1").getSheet();
            List<RecordBase> sheetRecords = sheet.getRecords();
            // one way (of many) to cause the discrepancy is with a badly behaved record:
            sheetRecords.add(new BadlyBehavedRecord());
            // There is also much logic inside Sheet that (if buggy) might also cause the discrepancy
            IllegalStateException e = assertThrows(IllegalStateException.class, wb::getBytes, "Identified bug 45066 a");
            assertTrue(e.getMessage().startsWith("Actual serialized sheet size"));
        }
    }

    /**
     * Checks that us and HSSFName play nicely with named ranges
     *  that point to deleted sheets
     */
    @Test
    void namesToDeleteSheets() throws IOException {
        HSSFWorkbook b = openSampleWorkbook("30978-deleted.xls");
        assertEquals(3, b.getNumberOfNames());

        // Sheet 2 is deleted
        assertEquals("Sheet1", b.getSheetName(0));
        assertEquals("Sheet3", b.getSheetName(1));

        Area3DPtg ptg;
        NameRecord nr;
        HSSFName n;

        /* ======= Name pointing to deleted sheet ====== */

        // First at low level
        nr = b.getWorkbook().getNameRecord(0);
        assertEquals("On2", nr.getNameText());
        assertEquals(0, nr.getSheetNumber());
        assertEquals(1, nr.getExternSheetNumber());
        assertEquals(1, nr.getNameDefinition().length);

        ptg = (Area3DPtg)nr.getNameDefinition()[0];
        assertEquals(1, ptg.getExternSheetIndex());
        assertEquals(0, ptg.getFirstColumn());
        assertEquals(0, ptg.getFirstRow());
        assertEquals(0, ptg.getLastColumn());
        assertEquals(2, ptg.getLastRow());

        // Now at high level
        n = b.getNameAt(0);
        assertEquals("On2", n.getNameName());
        assertEquals("", n.getSheetName());
        assertEquals("#REF!$A$1:$A$3", n.getRefersToFormula());


        /* ======= Name pointing to 1st sheet ====== */

        // First at low level
        nr = b.getWorkbook().getNameRecord(1);
        assertEquals("OnOne", nr.getNameText());
        assertEquals(0, nr.getSheetNumber());
        assertEquals(0, nr.getExternSheetNumber());
        assertEquals(1, nr.getNameDefinition().length);

        ptg = (Area3DPtg)nr.getNameDefinition()[0];
        assertEquals(0, ptg.getExternSheetIndex());
        assertEquals(0, ptg.getFirstColumn());
        assertEquals(2, ptg.getFirstRow());
        assertEquals(0, ptg.getLastColumn());
        assertEquals(3, ptg.getLastRow());

        // Now at high level
        n = b.getNameAt(1);
        assertEquals("OnOne", n.getNameName());
        assertEquals("Sheet1", n.getSheetName());
        assertEquals("Sheet1!$A$3:$A$4", n.getRefersToFormula());


        /* ======= Name pointing to 3rd sheet ====== */

        // First at low level
        nr = b.getWorkbook().getNameRecord(2);
        assertEquals("OnSheet3", nr.getNameText());
        assertEquals(0, nr.getSheetNumber());
        assertEquals(2, nr.getExternSheetNumber());
        assertEquals(1, nr.getNameDefinition().length);

        ptg = (Area3DPtg)nr.getNameDefinition()[0];
        assertEquals(2, ptg.getExternSheetIndex());
        assertEquals(0, ptg.getFirstColumn());
        assertEquals(0, ptg.getFirstRow());
        assertEquals(0, ptg.getLastColumn());
        assertEquals(1, ptg.getLastRow());

        // Now at high level
        n = b.getNameAt(2);
        assertEquals("OnSheet3", n.getNameName());
        assertEquals("Sheet3", n.getSheetName());
        assertEquals("Sheet3!$A$1:$A$2", n.getRefersToFormula());

        b.close();
    }

    /**
     * result returned by getRecordSize() differs from result returned by serialize()
     */
    private static final class BadlyBehavedRecord extends Record {
        BadlyBehavedRecord() {
            //
        }
        @Override
        public short getSid() {
            return 0x777;
        }
        @Override
        public int serialize(int offset, byte[] data) {
            return 4;
        }
        @Override
        public int getRecordSize() {
            return 8;
        }
        @Override
        public BadlyBehavedRecord copy() {
            return null;
        }

        @Override
        public HSSFRecordTypes getGenericRecordType() {
            return null;
        }

        @Override
        public Map<String, Supplier<?>> getGenericProperties() {
            return null;
        }
    }

    /**
     * The sample file provided with bug 45582 seems to have one extra byte after the EOFRecord
     */
    @Test
    void extraDataAfterEOFRecord() throws IOException {
        // bug 45582 - RecordFormatException - getCause() instanceof LittleEndian.BufferUnderrunException
        try (HSSFWorkbook wb = openSampleWorkbook("ex45582-22397.xls")) {
            assertNotNull(wb);
        }
    }

    /**
     * Test to make sure that NameRecord.getSheetNumber() is interpreted as a
     * 1-based sheet tab index (not a 1-based extern sheet index)
     */
    @Test
    void findBuiltInNameRecord() throws IOException {
        // testRRaC has multiple (3) built-in name records
        // The second print titles name record has getSheetNumber()==4
        HSSFWorkbook wb1 = openSampleWorkbook("testRRaC.xls");
        NameRecord nr;
        assertEquals(3, wb1.getWorkbook().getNumNames());
        nr = wb1.getWorkbook().getNameRecord(2);
        // TODO - render full row and full column refs properly
        assertEquals("Sheet2!$A$1:$IV$1", HSSFFormulaParser.toFormulaString(wb1, nr.getNameDefinition())); // 1:1

        try {
          wb1.getSheetAt(3).setRepeatingRows(CellRangeAddress.valueOf("9:12"));
          wb1.getSheetAt(3).setRepeatingColumns(CellRangeAddress.valueOf("E:F"));
        } catch (RuntimeException e) {
            if (e.getMessage().equals("Builtin (7) already exists for sheet (4)")) {
                // there was a problem in the code which locates the existing print titles name record
                fail("Identified bug 45720b");
            }
            wb1.close();
            throw e;
        }
        HSSFWorkbook wb2 = HSSFTestDataSamples.writeOutAndReadBack(wb1);
        wb1.close();
        assertEquals(3, wb2.getWorkbook().getNumNames());
        nr = wb2.getWorkbook().getNameRecord(2);
        assertEquals("Sheet2!E:F,Sheet2!$A$9:$IV$12", HSSFFormulaParser.toFormulaString(wb2, nr.getNameDefinition())); // E:F,9:12
        wb2.close();
    }

    /**
     * Test that the storage clsid property is preserved
     */
    @Test
    void bug47920() throws IOException {
        try (POIFSFileSystem fs1 = new POIFSFileSystem(samples.openResourceAsStream("47920.xls"));
             HSSFWorkbook wb = new HSSFWorkbook(fs1)) {
            ClassID clsid1 = fs1.getRoot().getStorageClsid();

            UnsynchronizedByteArrayOutputStream out = UnsynchronizedByteArrayOutputStream.builder().setBufferSize(4096).get();
            wb.write(out);
            try (POIFSFileSystem fs2 = new POIFSFileSystem(out.toInputStream())) {
                ClassID clsid2 = fs2.getRoot().getStorageClsid();
                assertEquals(clsid1, clsid2);
            }
        }
    }

    /**
     * If we try to open an old (pre-97) workbook, we get a helpful
     *  Exception give to explain what we've done wrong
     */
    @ParameterizedTest
    @CsvSource({
        "testEXCEL_4.xls,BIFF4",
        "testEXCEL_5.xls,BIFF5",
        "testEXCEL_95.xls,BIFF5"
    })
    void helpfulExceptionOnOldFiles(String file, String format) throws Exception {
        try (InputStream is = samples.openResourceAsStream(file)) {
            OldExcelFormatException e = assertThrows(OldExcelFormatException.class, () -> new HSSFWorkbook(is),
                "Shouldn't be able to load an Excel " + format + " file");
            assertContains(e.getMessage(), format);
        }
    }

    /**
     * Tests that we can work with both {@link POIFSFileSystem}
     *  and {@link POIFSFileSystem}
     */
    @Test
    void differentPOIFS() throws Exception {
       // Open the two filesystems
       DirectoryNode[] files = new DirectoryNode[2];
        try (POIFSFileSystem poifsFileSystem = new POIFSFileSystem(HSSFTestDataSamples.openSampleFileStream("Simple.xls"))) {
            files[0] = poifsFileSystem.getRoot();
            try (POIFSFileSystem poifsFileSystem2 = new POIFSFileSystem(HSSFTestDataSamples.getSampleFile("Simple.xls"))) {
                files[1] = poifsFileSystem2.getRoot();

                // Open without preserving nodes
                for (DirectoryNode dir : files) {
                    HSSFWorkbook workbook = new HSSFWorkbook(dir, false);
                    HSSFSheet sheet = workbook.getSheetAt(0);
                    HSSFCell cell = sheet.getRow(0).getCell(0);
                    assertEquals("replaceMe", cell.getRichStringCellValue().getString());

                    workbook.close();
                }

                // Now re-check with preserving
                for (DirectoryNode dir : files) {
                    HSSFWorkbook workbook = new HSSFWorkbook(dir, true);
                    HSSFSheet sheet = workbook.getSheetAt(0);
                    HSSFCell cell = sheet.getRow(0).getCell(0);
                    assertEquals("replaceMe", cell.getRichStringCellValue().getString());

                    workbook.close();
                }
            }
        }
    }

    @Test
    void wordDocEmbeddedInXls() throws IOException {
       // Open the two filesystems
       DirectoryNode[] files = new DirectoryNode[2];
        try (POIFSFileSystem poifsFileSystem = new POIFSFileSystem(HSSFTestDataSamples.openSampleFileStream("WithEmbeddedObjects.xls"))) {
            files[0] = poifsFileSystem.getRoot();
            try (POIFSFileSystem poifsFileSystem2 = new POIFSFileSystem(HSSFTestDataSamples.getSampleFile("WithEmbeddedObjects.xls"))) {
                files[1] = poifsFileSystem2.getRoot();

                // Check the embedded parts
                for (DirectoryNode root : files) {
                    HSSFWorkbook hw = new HSSFWorkbook(root, true);
                    List<HSSFObjectData> objects = hw.getAllEmbeddedObjects();
                    boolean found = false;
                    for (HSSFObjectData embeddedObject : objects) {
                        if (embeddedObject.hasDirectoryEntry()) {
                            DirectoryEntry dir = embeddedObject.getDirectory();
                            if (dir instanceof DirectoryNode) {
                                DirectoryNode dNode = (DirectoryNode) dir;
                                if (dNode.hasEntry("WordDocument")) {
                                    found = true;
                                    break;
                                }
                            }
                        }
                    }
                    assertTrue(found);

                    hw.close();
                }
            }
        }
    }

    /**
     * Checks that we can open a workbook with POIFS, and write it out
     *  again (via POIFS) and have it be valid
     */
    @Test
    void writeWorkbookFromPOIFS() throws IOException {
        try (InputStream is = HSSFTestDataSamples.openSampleFileStream("WithEmbeddedObjects.xls");
            POIFSFileSystem fs = new POIFSFileSystem(is)) {

            HSSFWorkbook wb = new HSSFWorkbook(fs.getRoot(), true);
            assertEquals(3, wb.getNumberOfSheets());
            assertEquals("Root xls", wb.getSheetAt(0).getRow(0).getCell(0).getStringCellValue());

            HSSFWorkbook wbBack = HSSFTestDataSamples.writeOutAndReadBack(wb);
            assertEquals(3, wbBack.getNumberOfSheets());
            assertEquals("Root xls", wbBack.getSheetAt(0).getRow(0).getCell(0).getStringCellValue());
            wbBack.close();

            wb.close();
        }
    }

    @Test
    void cellStylesLimit() throws IOException {
        try (Workbook wb = new HSSFWorkbook()) {
            int numBuiltInStyles = wb.getNumCellStyles();
            int MAX_STYLES = 4030;
            int limit = MAX_STYLES - numBuiltInStyles;
            for (int i = 0; i < limit; i++) {
                wb.createCellStyle();
            }

            assertEquals(MAX_STYLES, wb.getNumCellStyles());
            IllegalStateException e = assertThrows(IllegalStateException.class, wb::createCellStyle);
            assertEquals("The maximum number of cell styles was exceeded. " +
                "You can define up to 4000 styles in a .xls workbook", e.getMessage());
            assertEquals(MAX_STYLES, wb.getNumCellStyles());
        }
    }

    @Test
    void setSheetOrderHSSF() throws IOException{
        Workbook wb = new HSSFWorkbook();
        Sheet s1 = wb.createSheet("first sheet");
        Sheet s2 = wb.createSheet("other sheet");

        Name name1 = wb.createName();
        name1.setNameName("name1");
        name1.setRefersToFormula("'first sheet'!D1");

        Name name2 = wb.createName();
        name2.setNameName("name2");
        name2.setRefersToFormula("'other sheet'!C1");


        Row s1r1 = s1.createRow(2);
        Cell c1 = s1r1.createCell(3);
        c1.setCellValue(30);
        Cell c2 = s1r1.createCell(2);
        c2.setCellFormula("SUM('other sheet'!C1,'first sheet'!C1)");

        Row s2r1 = s2.createRow(0);
        Cell c3 = s2r1.createCell(1);
        c3.setCellFormula("'first sheet'!D3");
        Cell c4 = s2r1.createCell(2);
        c4.setCellFormula("'other sheet'!D3");

        // conditional formatting
        SheetConditionalFormatting sheetCF = s1.getSheetConditionalFormatting();

        ConditionalFormattingRule rule1 = sheetCF.createConditionalFormattingRule(
                CFRuleRecord.ComparisonOperator.BETWEEN, "'first sheet'!D1", "'other sheet'!D1");

        ConditionalFormattingRule [] cfRules = { rule1 };

        CellRangeAddress[] regions = {
            new CellRangeAddress(2, 4, 0, 0), // A3:A5
        };
        sheetCF.addConditionalFormatting(regions, cfRules);

        wb.setSheetOrder("other sheet", 0);

        // names
        //noinspection ConstantConditions
        assertEquals("'first sheet'!D1", wb.getName("name1").getRefersToFormula());
        //noinspection ConstantConditions
        assertEquals("'other sheet'!C1", wb.getName("name2").getRefersToFormula());

        // cells
        assertEquals("SUM('other sheet'!C1,'first sheet'!C1)", c2.getCellFormula());
        assertEquals("'first sheet'!D3", c3.getCellFormula());
        assertEquals("'other sheet'!D3", c4.getCellFormula());

        // conditional formatting
        ConditionalFormatting cf = sheetCF.getConditionalFormattingAt(0);
        assertEquals("'first sheet'!D1", cf.getRule(0).getFormula1());
        assertEquals("'other sheet'!D1", cf.getRule(0).getFormula2());

        wb.close();
    }

    @Test
    void clonePictures() throws IOException {
        HSSFWorkbook wb = openSampleWorkbook("SimpleWithImages.xls");
        InternalWorkbook iwb = wb.getWorkbook();
        iwb.findDrawingGroup();

        for(int pictureIndex=1; pictureIndex <= 4; pictureIndex++){
            EscherBSERecord bse = iwb.getBSERecord(pictureIndex);
            assertEquals(1, bse.getRef());
        }

        wb.cloneSheet(0);
        for(int pictureIndex=1; pictureIndex <= 4; pictureIndex++){
            EscherBSERecord bse = iwb.getBSERecord(pictureIndex);
            assertEquals(2, bse.getRef());
        }

        wb.cloneSheet(0);
        for(int pictureIndex=1; pictureIndex <= 4; pictureIndex++){
            EscherBSERecord bse = iwb.getBSERecord(pictureIndex);
            assertEquals(3, bse.getRef());
        }

        wb.close();
    }

    // Should throw exception about invalid POIFSFileSystem
    @Test
    void emptyDirectoryNode() throws IOException {
        try (POIFSFileSystem fs = new POIFSFileSystem()) {
            assertThrows(IllegalArgumentException.class, () -> new HSSFWorkbook(fs).close());
        }
    }

    @Test
    void selectedSheetShort() throws IOException {
        HSSFWorkbook wb=new HSSFWorkbook();

        HSSFSheet sheet1 = wb.createSheet("Sheet1");
        HSSFSheet sheet2 = wb.createSheet("Sheet2");
        HSSFSheet sheet3 = wb.createSheet("Sheet3");
        HSSFSheet sheet4 = wb.createSheet("Sheet4");

        confirmActiveSelected(sheet1, true);
        confirmActiveSelected(sheet2, false);
        confirmActiveSelected(sheet3, false);
        confirmActiveSelected(sheet4, false);

        wb.setSelectedTab((short)1);

        // Demonstrate bug 44525:
        // Well... not quite, since isActive + isSelected were also added in the same bug fix
        assertFalse(sheet1.isSelected(), "Identified bug 44523 a");
        wb.setActiveSheet(1);
        assertFalse(sheet1.isActive(), "Identified bug 44523 b");

        confirmActiveSelected(sheet1, false);
        confirmActiveSelected(sheet2, true);
        confirmActiveSelected(sheet3, false);
        confirmActiveSelected(sheet4, false);

        assertEquals(0, wb.getFirstVisibleTab());
        wb.setFirstVisibleTab((short)2);
        assertEquals(2, wb.getFirstVisibleTab());

        wb.close();
    }

    @Test
    void names() throws IOException {
        HSSFWorkbook wb=new HSSFWorkbook();

        IllegalStateException ex1 = assertThrows(IllegalStateException.class, () -> wb.getNameAt(0));
        assertTrue(ex1.getMessage().contains("no defined names"));

        HSSFName name = wb.createName();
        assertNotNull(name);

        assertNull(wb.getName("somename"));

        name.setNameName("myname");
        assertNotNull(wb.getName("myname"));

        assertEquals(0, wb.getNameIndex(name));
        assertEquals(0, wb.getNameIndex("myname"));

        IllegalArgumentException ex2 = assertThrows(IllegalArgumentException.class, () -> wb.getNameAt(5));
        assertTrue(ex2.getMessage().contains("outside the allowable range"));

        IllegalArgumentException ex = assertThrows(IllegalArgumentException.class, () -> wb.getNameAt(-3));
        assertTrue(ex.getMessage().contains("outside the allowable range"));

        wb.close();
    }

    @Test
    void testMethods() throws IOException {
        try (HSSFWorkbook wb=new HSSFWorkbook()) {
            assertDoesNotThrow(wb::insertChartRecord);
            //wb.dumpDrawingGroupRecords(true);
            //wb.dumpDrawingGroupRecords(false);
        }
    }

    @Test
    void writeProtection() throws IOException {
        HSSFWorkbook wb=new HSSFWorkbook();

        assertFalse(wb.isWriteProtected());

        wb.writeProtectWorkbook("mypassword", "myuser");
        assertTrue(wb.isWriteProtected());

        wb.unwriteProtectWorkbook();
        assertFalse(wb.isWriteProtected());

        wb.close();
    }

    @Test
    void bug50298() throws Exception {
        HSSFWorkbook wb = openSampleWorkbook("50298.xls");

        assertSheetOrder(wb, "Invoice", "Invoice1", "Digest", "Deferred", "Received");

        HSSFSheet sheet = wb.cloneSheet(0);

        assertSheetOrder(wb, "Invoice", "Invoice1", "Digest", "Deferred", "Received", "Invoice (2)");

        wb.setSheetName(wb.getSheetIndex(sheet), "copy");

        assertSheetOrder(wb, "Invoice", "Invoice1", "Digest", "Deferred", "Received", "copy");

        wb.setSheetOrder("copy", 0);

        assertSheetOrder(wb, "copy", "Invoice", "Invoice1", "Digest", "Deferred", "Received");

        wb.removeSheetAt(0);

        assertSheetOrder(wb, "Invoice", "Invoice1", "Digest", "Deferred", "Received");

        // check that the overall workbook serializes with its correct size
        int expected = wb.getWorkbook().getSize();
        int written = wb.getWorkbook().serialize(0, new byte[expected*2]);

        assertEquals(expected, written, "Did not have the expected size when writing the workbook");

        HSSFWorkbook read = HSSFTestDataSamples.writeOutAndReadBack(wb);
        assertSheetOrder(read, "Invoice", "Invoice1", "Digest", "Deferred", "Received");
        read.close();
        wb.close();
    }

    @Test
    void bug50298a() throws Exception {
        HSSFWorkbook wb = openSampleWorkbook("50298.xls");

        assertSheetOrder(wb, "Invoice", "Invoice1", "Digest", "Deferred", "Received");

        HSSFSheet sheet = wb.cloneSheet(0);

        assertSheetOrder(wb, "Invoice", "Invoice1", "Digest", "Deferred", "Received", "Invoice (2)");

        wb.setSheetName(wb.getSheetIndex(sheet), "copy");

        assertSheetOrder(wb, "Invoice", "Invoice1", "Digest", "Deferred", "Received", "copy");

        wb.setSheetOrder("copy", 0);

        assertSheetOrder(wb, "copy", "Invoice", "Invoice1", "Digest", "Deferred", "Received");

        wb.removeSheetAt(0);

        assertSheetOrder(wb, "Invoice", "Invoice1", "Digest", "Deferred", "Received");

        wb.removeSheetAt(1);

        assertSheetOrder(wb, "Invoice", "Digest", "Deferred", "Received");

        wb.setSheetOrder("Digest", 3);

        assertSheetOrder(wb, "Invoice", "Deferred", "Received", "Digest");

        // check that the overall workbook serializes with its correct size
        int expected = wb.getWorkbook().getSize();
        int written = wb.getWorkbook().serialize(0, new byte[expected*2]);

        assertEquals(expected, written, "Did not have the expected size when writing the workbook");

        HSSFWorkbook read = HSSFTestDataSamples.writeOutAndReadBack(wb);
        assertSheetOrder(read, "Invoice", "Deferred", "Received", "Digest");
        read.close();
        wb.close();
    }

    @Test
    void bug54500() throws Exception {
        String nameName = "AName";
        String sheetName = "ASheet";
        HSSFWorkbook wb = openSampleWorkbook("54500.xls");

        assertSheetOrder(wb, "Sheet1", "Sheet2", "Sheet3");

        wb.createSheet(sheetName);

        assertSheetOrder(wb, "Sheet1", "Sheet2", "Sheet3", "ASheet");

        Name n = wb.createName();
        n.setNameName(nameName);
        n.setSheetIndex(3);
        n.setRefersToFormula(sheetName + "!A1");

        assertSheetOrder(wb, "Sheet1", "Sheet2", "Sheet3", "ASheet");
        final HSSFName name = wb.getName(nameName);
        assertNotNull(name);
        assertEquals("ASheet!A1", name.getRefersToFormula());

        UnsynchronizedByteArrayOutputStream stream = UnsynchronizedByteArrayOutputStream.builder().get();
        wb.write(stream);

        assertSheetOrder(wb, "Sheet1", "Sheet2", "Sheet3", "ASheet");
        assertEquals("ASheet!A1", name.getRefersToFormula());

        wb.removeSheetAt(1);

        assertSheetOrder(wb, "Sheet1", "Sheet3", "ASheet");
        assertEquals("ASheet!A1", name.getRefersToFormula());

        UnsynchronizedByteArrayOutputStream stream2 = UnsynchronizedByteArrayOutputStream.builder().get();
        wb.write(stream2);

        assertSheetOrder(wb, "Sheet1", "Sheet3", "ASheet");
        assertEquals("ASheet!A1", name.getRefersToFormula());

        HSSFWorkbook wb2 = new HSSFWorkbook(stream.toInputStream());
        expectName(wb2, nameName, "ASheet!A1");
        HSSFWorkbook wb3 = new HSSFWorkbook(stream2.toInputStream());
        expectName(wb3, nameName, "ASheet!A1");
        wb3.close();
        wb2.close();
        wb.close();
    }

    @SuppressWarnings("SameParameterValue")
    private void expectName(HSSFWorkbook wb, String name, String expect) {
        final HSSFName hssfName = wb.getName(name);
        assertNotNull(hssfName);
        assertEquals(expect, hssfName.getRefersToFormula());
    }

    @Test
    void test49423() throws Exception
    {
        HSSFWorkbook workbook = openSampleWorkbook("49423.xls");

        boolean found = false;
        int numSheets = workbook.getNumberOfSheets();
        for (int i = 0; i < numSheets; i++) {
            HSSFSheet sheet = workbook.getSheetAt(i);
            List<HSSFShape> shapes = sheet.getDrawingPatriarch().getChildren();
            for(HSSFShape shape : shapes){
                HSSFAnchor anchor = shape.getAnchor();

                if(anchor instanceof HSSFClientAnchor){
                    // absolute coordinates
                    HSSFClientAnchor clientAnchor = (HSSFClientAnchor)anchor;
                    assertNotNull(clientAnchor);
                    //System.out.println(clientAnchor.getRow1() + "," + clientAnchor.getRow2());
                    found = true;
                } else if (anchor instanceof HSSFChildAnchor){
                    // shape is grouped and the anchor is expressed in the coordinate system of the group
                    HSSFChildAnchor childAnchor = (HSSFChildAnchor)anchor;
                    assertNotNull(childAnchor);
                    //System.out.println(childAnchor.getDy1() + "," + childAnchor.getDy2());
                    found = true;
                }
            }
        }

        assertTrue(found, "Should find some images via Client or Child anchors, but did not find any at all");
        workbook.close();
    }

    @Test
    void testRewriteFileBug58480() throws IOException {
        final File file = TempFile.createTempFile("TestHSSFWorkbook", ".xls");

        try {
            // create new workbook
            {
                final Workbook workbook = new HSSFWorkbook();
                final Sheet sheet = workbook.createSheet("foo");
                final Row row = sheet.createRow(1);
                row.createCell(1).setCellValue("bar");

                writeAndCloseWorkbook(workbook, file);
            }

            // edit the workbook
            {
                try (POIFSFileSystem fs = new POIFSFileSystem(file, false)) {
                    DirectoryNode root = fs.getRoot();
                    final Workbook workbook = new HSSFWorkbook(root, true);
                    final Sheet sheet = workbook.getSheet("foo");
                    sheet.getRow(1).createCell(2).setCellValue("baz");

                    writeAndCloseWorkbook(workbook, file);
                }
            }
        } finally {
            assertTrue(file.exists());
            assertTrue(file.delete());
        }
    }

    private void writeAndCloseWorkbook(Workbook workbook, File file)
    throws IOException {
        final UnsynchronizedByteArrayOutputStream bytesOut = UnsynchronizedByteArrayOutputStream.builder().get();
        workbook.write(bytesOut);
        workbook.close();

        final byte[] byteArray = bytesOut.toByteArray();
        bytesOut.close();

        final FileOutputStream fileOut = new FileOutputStream(file);
        fileOut.write(byteArray);
        fileOut.close();

    }

    @Test
    void closeDoesNotModifyWorkbook() throws IOException {
        final String filename = "SampleSS.xls";
        final File file = samples.getFile(filename);
        Workbook wb;

        // File via POIFileStream (java.nio)
        wb = new HSSFWorkbook(new POIFSFileSystem(file));
        assertCloseDoesNotModifyFile(filename, wb);

        // InputStream
        wb = new HSSFWorkbook(new FileInputStream(file));
        assertCloseDoesNotModifyFile(filename, wb);
    }

    @Test
    void setSheetOrderToEnd() throws Exception {
        try (HSSFWorkbook workbook = new HSSFWorkbook()) {
            workbook.createSheet("A");
            workbook.createSheet("B");
            assertEquals("A", workbook.getSheetName(0));
            workbook.setSheetOrder("A", 1);
            assertEquals("A", workbook.getSheetName(1));
        }
    }

    @Test
    void invalidInPlaceWrite() throws Exception {
        // Can't work for new files
        try (HSSFWorkbook wb = new HSSFWorkbook()) {
            assertThrows(IllegalStateException.class, wb::write, "Shouldn't work for new files");
        }

        // Can't work for InputStream opened files
        try (InputStream is = samples.openResourceAsStream("SampleSS.xls");
            HSSFWorkbook wb = new HSSFWorkbook(is)) {
            assertThrows(IllegalStateException.class, wb::write, "Shouldn't work for InputStream");
        }

        // Can't work for Read-Only files
        try (POIFSFileSystem fs = new POIFSFileSystem(samples.getFile("SampleSS.xls"), true);
             HSSFWorkbook wb = new HSSFWorkbook(fs)) {
            assertThrows(IllegalStateException.class, wb::write, "Shouldn't work for Read Only");
        }
    }

    @Test
    void inPlaceWrite() throws Exception {
        // Setup as a copy of a known-good file
        final File file = TempFile.createTempFile("TestHSSFWorkbook", ".xls");
        try (InputStream inputStream = samples.openResourceAsStream("SampleSS.xls");
             FileOutputStream outputStream = new FileOutputStream(file)) {
            IOUtils.copy(inputStream, outputStream);
        }

        // Open from the temp file in read-write mode
        HSSFWorkbook wb = new HSSFWorkbook(new POIFSFileSystem(file, false));
        assertEquals(3, wb.getNumberOfSheets());

        // Change
        wb.removeSheetAt(2);
        wb.removeSheetAt(1);
        wb.getSheetAt(0).getRow(0).getCell(0).setCellValue("Changed!");

        // Save in-place, close, re-open and check
        wb.write();
        wb.close();

        wb = new HSSFWorkbook(new POIFSFileSystem(file));
        assertEquals(1, wb.getNumberOfSheets());
        assertEquals("Changed!", wb.getSheetAt(0).getRow(0).getCell(0).toString());

        wb.close();
    }

    @Test
    void testWriteToNewFile() throws Exception {
        // Save to a new temp file
        final File file = TempFile.createTempFile("TestHSSFWorkbook", ".xls");

        // Open from a Stream
        try (HSSFWorkbook wb = new HSSFWorkbook(
                samples.openResourceAsStream("SampleSS.xls"))) {
            wb.write(file);
        }

        // Read and check
        try (HSSFWorkbook wb = new HSSFWorkbook(new POIFSFileSystem(file))) {
            assertEquals(3, wb.getNumberOfSheets());
        }
    }

    @Test
    void checkExistingFileForR1C1Refs() throws IOException {
        try (
                UnsynchronizedByteArrayOutputStream bos = UnsynchronizedByteArrayOutputStream.builder().get();
                HSSFWorkbook wb = openSampleWorkbook("49423.xls")
        ) {
            assertEquals(CellReferenceType.A1, wb.getCellReferenceType());
            wb.setCellReferenceType(CellReferenceType.R1C1);
            assertEquals(CellReferenceType.R1C1, wb.getCellReferenceType());
            wb.write(bos);
            try (HSSFWorkbook wb2 = new HSSFWorkbook(bos.toInputStream())) {
                assertEquals(CellReferenceType.R1C1, wb2.getCellReferenceType());
            }
        }
    }

    @Test
    void checkNewFileForR1C1Refs() throws IOException {
        try (
                UnsynchronizedByteArrayOutputStream bos = UnsynchronizedByteArrayOutputStream.builder().get();
                HSSFWorkbook wb = new HSSFWorkbook()
        ) {
            assertEquals(CellReferenceType.UNKNOWN, wb.getCellReferenceType());
            HSSFSheet sheet = wb.createSheet();
            assertEquals(CellReferenceType.A1, wb.getCellReferenceType());
            wb.setCellReferenceType(CellReferenceType.R1C1);
            assertEquals(CellReferenceType.R1C1, wb.getCellReferenceType());
            wb.write(bos);
            try (HSSFWorkbook wb2 = new HSSFWorkbook(bos.toInputStream())) {
                assertEquals(CellReferenceType.R1C1, wb2.getCellReferenceType());
            }
        }
    }

    @Disabled
    void createDrawing() {
        // the dimensions for this image are different than for XSSF and SXSSF
    }

    @Test
    void writeInvalidFile() throws Exception {
        try (Workbook wb = WorkbookFactory.create(
                samples.getFile("clusterfuzz-testcase-minimized-POIHSSFFuzzer-5786329142919168.xls"),
                null, true)) {
            try (OutputStream out = new ByteArrayOutputStream()) {
                wb.write(out);
            }
        }
    }
}