poi-scratchpad/src/test/java/org/apache/poi/hwpf/usermodel/TestProblems.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.hwpf.usermodel;

import static org.apache.poi.hwpf.HWPFTestDataSamples.openSampleFile;
import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertNotNull;
import static org.junit.jupiter.api.Assertions.assertThrows;

import java.io.IOException;

import org.apache.poi.EncryptedDocumentException;
import org.apache.poi.hwpf.HWPFDocument;
import org.apache.poi.hwpf.HWPFTestCase;
import org.apache.poi.hwpf.HWPFTestDataSamples;
import org.apache.poi.hwpf.extractor.WordExtractor;
import org.apache.poi.hwpf.model.StyleSheet;
import org.junit.jupiter.api.Test;

/**
 * Test various problem documents
 */
public final class TestProblems extends HWPFTestCase {

    /**
     * ListEntry passed no ListTable
     */
    @Test
    void testListEntryNoListTable() throws IOException {
        try (HWPFDocument doc = openSampleFile("ListEntryNoListTable.doc")) {
            Range r = doc.getRange();
            for (int x = 0; x < r.numSections(); x++) {
                Section s = r.getSection(x);
                for (int y = 0; y < s.numParagraphs(); y++) {
                    assertNotNull(s.getParagraph(y));
                }
            }
        }
    }

    /**
     * AIOOB for TableSprmUncompressor.unCompressTAPOperation
     */
    @Test
    void testSprmAIOOB() throws IOException {
        try (HWPFDocument doc = openSampleFile("AIOOB-Tap.doc")) {
            StyleSheet styleSheet = doc.getStyleSheet();
            assertNotNull(styleSheet);

            Range r = doc.getRange();
            for (int x = 0; x < r.numSections(); x++) {
                Section s = r.getSection(x);
                for (int y = 0; y < s.numParagraphs(); y++) {
                    Paragraph paragraph = s.getParagraph(y);
                    assertNotNull(paragraph);
                }
            }
        }
    }

    /**
     * Test for TableCell not skipping the last paragraph. Bugs #45062 and
     * #44292
     */
    @Test
    void testTableCellLastParagraph() throws IOException {
        try (HWPFDocument doc = openSampleFile("Bug44292.doc")) {
            Range r = doc.getRange();
            assertEquals(6, r.numParagraphs());
            assertEquals(0, r.getStartOffset());
            assertEquals(87, r.getEndOffset());

            // Paragraph with table
            Paragraph p = r.getParagraph(0);
            assertEquals(0, p.getStartOffset());
            assertEquals(20, p.getEndOffset());

            // Check a few bits of the table directly
            assertEquals("One paragraph is ok\7", r.getParagraph(0).text());
            assertEquals("First para is ok\r", r.getParagraph(1).text());
            assertEquals("Second paragraph is skipped\7", r.getParagraph(2).text());
            assertEquals("One paragraph is ok\7", r.getParagraph(3).text());
            assertEquals("\7", r.getParagraph(4).text());
            assertEquals("\r", r.getParagraph(5).text());

            // Get the table
            Table t = r.getTable(p);

            // get the only row
            assertEquals(1, t.numRows());
            TableRow row = t.getRow(0);

            // sanity check our row
            assertEquals(5, row.numParagraphs());
            assertEquals(0, row._parStart);
            assertEquals(5, row._parEnd);
            assertEquals(0, row.getStartOffset());
            assertEquals(86, row.getEndOffset());

            // get the first cell
            TableCell cell = row.getCell(0);
            // First cell should have one paragraph
            assertEquals(1, cell.numParagraphs());
            assertEquals("One paragraph is ok\7", cell.getParagraph(0).text());
            assertEquals(0, cell._parStart);
            assertEquals(1, cell._parEnd);
            assertEquals(0, cell.getStartOffset());
            assertEquals(20, cell.getEndOffset());

            // get the second
            cell = row.getCell(1);
            // Second cell should be detected as having two paragraphs
            assertEquals(2, cell.numParagraphs());
            assertEquals("First para is ok\r", cell.getParagraph(0).text());
            assertEquals("Second paragraph is skipped\7",
                cell.getParagraph(1).text());
            assertEquals(1, cell._parStart);
            assertEquals(3, cell._parEnd);
            assertEquals(20, cell.getStartOffset());
            assertEquals(65, cell.getEndOffset());

            // get the last cell
            cell = row.getCell(2);
            // Last cell should have one paragraph
            assertEquals(1, cell.numParagraphs());
            assertEquals("One paragraph is ok\7", cell.getParagraph(0).text());
            assertEquals(3, cell._parStart);
            assertEquals(4, cell._parEnd);
            assertEquals(65, cell.getStartOffset());
            assertEquals(85, cell.getEndOffset());
        }
    }

    @Test
    void testRangeDelete() throws IOException {
        try (HWPFDocument doc = openSampleFile("Bug28627.doc")) {
            Range range = doc.getRange();
            int numParagraphs = range.numParagraphs();

            int totalLength = 0, deletedLength = 0;

            for (int i = 0; i < numParagraphs; i++) {
                Paragraph para = range.getParagraph(i);
                String text = para.text();

                totalLength += text.length();
                if (text.contains("{delete me}")) {
                    para.delete();
                    deletedLength = text.length();
                }
            }

            // check the text length after deletion
            int newLength = 0;
            range = doc.getRange();
            numParagraphs = range.numParagraphs();

            for (int i = 0; i < numParagraphs; i++) {
                Paragraph para = range.getParagraph(i);
                String text = para.text();

                newLength += text.length();
            }

            assertEquals(newLength, totalLength - deletedLength);
        }
    }

    /**
     * With an encrypted file, we should give a suitable exception, and not OOM
     */
    @Test
    void testEncryptedFile() {
        assertThrows(EncryptedDocumentException.class, () -> openSampleFile("PasswordProtected.doc"));

    }

    @Test
    void testWriteProperties() throws IOException {
        HWPFDocument doc = openSampleFile("SampleDoc.doc");
        assertEquals("Nick Burch", doc.getSummaryInformation().getAuthor());

        // Write and read
        HWPFDocument doc2 = writeOutAndRead(doc);
        assertEquals("Nick Burch", doc2.getSummaryInformation().getAuthor());
        doc2.close();
        doc.close();
    }

    /**
     * Test for reading paragraphs from Range after replacing some text in this
     * Range. Bug #45269
     */
    @Test
    void testReadParagraphsAfterReplaceText() throws IOException {
        HWPFDocument doc = openSampleFile("Bug45269.doc");
        Range range = doc.getRange();

        String toFind = "campo1";
        String longer = " foi porraaaaa ";
        String shorter = " foi ";

        // check replace with longer text
        for (int x = 0; x < range.numParagraphs(); x++) {
            Paragraph para = range.getParagraph(x);
            int offset = para.text().indexOf(toFind);
            if (offset >= 0) {
                para.replaceText(toFind, longer, offset);
                assertEquals(offset, para.text().indexOf(longer));
            }
        }

        doc = openSampleFile("Bug45269.doc");
        range = doc.getRange();

        // check replace with shorter text
        for (int x = 0; x < range.numParagraphs(); x++) {
            Paragraph para = range.getParagraph(x);
            int offset = para.text().indexOf(toFind);
            if (offset >= 0) {
                para.replaceText(toFind, shorter, offset);
                assertEquals(offset, para.text().indexOf(shorter));
            }
        }

        doc.close();
    }

    /**
     * Bug #49936 - Problems with reading the header out of the Header Stories
     */
    @SuppressWarnings("deprecation")
    @Test
    void testProblemHeaderStories49936() throws IOException {
        HWPFDocument doc = openSampleFile("HeaderFooterProblematic.doc");
        HeaderStories hs = new HeaderStories(doc);

        assertEquals("", hs.getFirstHeader());
        assertEquals("\r", hs.getEvenHeader());
        assertEquals("", hs.getOddHeader());

        assertEquals("", hs.getFirstFooter());
        assertEquals("", hs.getEvenFooter());
        assertEquals("", hs.getOddFooter());

        WordExtractor ext = new WordExtractor(doc);
        assertEquals("\n", ext.getHeaderText());
        assertEquals("", ext.getFooterText());
        ext.close();
        doc.close();
    }

    /**
     * Bug #45877 - problematic PAPX with no parent set
     */
    @Test
    void testParagraphPAPXNoParent45877() throws IOException {
        HWPFDocument doc = openSampleFile("Bug45877.doc");
        assertEquals(17, doc.getRange().numParagraphs());

        assertEquals("First paragraph\r",
                doc.getRange().getParagraph(0).text());
        assertEquals("After Crashing Part\r",
                doc.getRange().getParagraph(13).text());

        doc.close();
    }

    /**
     * Bug #48245 - don't include the text from the next cell in the current one
     */
    @Test
    void testTableIterator() throws IOException {
        HWPFDocument doc = openSampleFile("simple-table2.doc");
        Range r = doc.getRange();

        // Check the text is as we'd expect
        assertEquals(13, r.numParagraphs());
        assertEquals("Row 1/Cell 1\u0007", r.getParagraph(0).text());
        assertEquals("Row 1/Cell 2\u0007", r.getParagraph(1).text());
        assertEquals("Row 1/Cell 3\u0007", r.getParagraph(2).text());
        assertEquals("\u0007", r.getParagraph(3).text());
        assertEquals("Row 2/Cell 1\u0007", r.getParagraph(4).text());
        assertEquals("Row 2/Cell 2\u0007", r.getParagraph(5).text());
        assertEquals("Row 2/Cell 3\u0007", r.getParagraph(6).text());
        assertEquals("\u0007", r.getParagraph(7).text());
        assertEquals("Row 3/Cell 1\u0007", r.getParagraph(8).text());
        assertEquals("Row 3/Cell 2\u0007", r.getParagraph(9).text());
        assertEquals("Row 3/Cell 3\u0007", r.getParagraph(10).text());
        assertEquals("\u0007", r.getParagraph(11).text());
        assertEquals("\r", r.getParagraph(12).text());

        Paragraph p;

        // Take a look in detail at the first couple of
        // paragraphs
        p = r.getParagraph(0);
        assertEquals(1, p.numParagraphs());
        assertEquals(0, p.getStartOffset());
        assertEquals(13, p.getEndOffset());
        assertEquals(0, p._parStart);
        assertEquals(1, p._parEnd);

        p = r.getParagraph(1);
        assertEquals(1, p.numParagraphs());
        assertEquals(13, p.getStartOffset());
        assertEquals(26, p.getEndOffset());
        assertEquals(1, p._parStart);
        assertEquals(2, p._parEnd);

        p = r.getParagraph(2);
        assertEquals(1, p.numParagraphs());
        assertEquals(26, p.getStartOffset());
        assertEquals(39, p.getEndOffset());
        assertEquals(2, p._parStart);
        assertEquals(3, p._parEnd);

        // Now look at the table
        Table table = r.getTable(r.getParagraph(0));
        assertEquals(3, table.numRows());

        TableRow row;
        TableCell cell;

        row = table.getRow(0);
        assertEquals(0, row._parStart);
        assertEquals(4, row._parEnd);

        cell = row.getCell(0);
        assertEquals(1, cell.numParagraphs());
        assertEquals(0, cell._parStart);
        assertEquals(1, cell._parEnd);
        assertEquals(0, cell.getStartOffset());
        assertEquals(13, cell.getEndOffset());
        assertEquals("Row 1/Cell 1\u0007", cell.text());
        assertEquals("Row 1/Cell 1\u0007", cell.getParagraph(0).text());

        cell = row.getCell(1);
        assertEquals(1, cell.numParagraphs());
        assertEquals(1, cell._parStart);
        assertEquals(2, cell._parEnd);
        assertEquals(13, cell.getStartOffset());
        assertEquals(26, cell.getEndOffset());
        assertEquals("Row 1/Cell 2\u0007", cell.text());
        assertEquals("Row 1/Cell 2\u0007", cell.getParagraph(0).text());

        cell = row.getCell(2);
        assertEquals(1, cell.numParagraphs());
        assertEquals(2, cell._parStart);
        assertEquals(3, cell._parEnd);
        assertEquals(26, cell.getStartOffset());
        assertEquals(39, cell.getEndOffset());
        assertEquals("Row 1/Cell 3\u0007", cell.text());
        assertEquals("Row 1/Cell 3\u0007", cell.getParagraph(0).text());

        // Onto row #2
        row = table.getRow(1);
        assertEquals(4, row._parStart);
        assertEquals(8, row._parEnd);

        cell = row.getCell(0);
        assertEquals(1, cell.numParagraphs());
        assertEquals(4, cell._parStart);
        assertEquals(5, cell._parEnd);
        assertEquals(40, cell.getStartOffset());
        assertEquals(53, cell.getEndOffset());
        assertEquals("Row 2/Cell 1\u0007", cell.text());

        cell = row.getCell(1);
        assertEquals(1, cell.numParagraphs());
        assertEquals(5, cell._parStart);
        assertEquals(6, cell._parEnd);
        assertEquals(53, cell.getStartOffset());
        assertEquals(66, cell.getEndOffset());
        assertEquals("Row 2/Cell 2\u0007", cell.text());

        cell = row.getCell(2);
        assertEquals(1, cell.numParagraphs());
        assertEquals(6, cell._parStart);
        assertEquals(7, cell._parEnd);
        assertEquals(66, cell.getStartOffset());
        assertEquals(79, cell.getEndOffset());
        assertEquals("Row 2/Cell 3\u0007", cell.text());

        // Finally row 3
        row = table.getRow(2);
        assertEquals(8, row._parStart);
        assertEquals(12, row._parEnd);

        cell = row.getCell(0);
        assertEquals(1, cell.numParagraphs());
        assertEquals(8, cell._parStart);
        assertEquals(9, cell._parEnd);
        assertEquals(80, cell.getStartOffset());
        assertEquals(93, cell.getEndOffset());
        assertEquals("Row 3/Cell 1\u0007", cell.text());

        cell = row.getCell(1);
        assertEquals(1, cell.numParagraphs());
        assertEquals(9, cell._parStart);
        assertEquals(10, cell._parEnd);
        assertEquals(93, cell.getStartOffset());
        assertEquals(106, cell.getEndOffset());
        assertEquals("Row 3/Cell 2\u0007", cell.text());

        cell = row.getCell(2);
        assertEquals(1, cell.numParagraphs());
        assertEquals(10, cell._parStart);
        assertEquals(11, cell._parEnd);
        assertEquals(106, cell.getStartOffset());
        assertEquals(119, cell.getEndOffset());
        assertEquals("Row 3/Cell 3\u0007", cell.text());

        doc.close();
    }
}