PdfObjectTest.java

/*
    This file is part of the iText (R) project.
    Copyright (c) 1998-2025 Apryse Group NV
    Authors: Apryse Software.

    This program is offered under a commercial and under the AGPL license.
    For commercial licensing, contact us at https://itextpdf.com/sales.  For AGPL licensing, see below.

    AGPL licensing:
    This program is free software: you can redistribute it and/or modify
    it under the terms of the GNU Affero General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU Affero General Public License for more details.

    You should have received a copy of the GNU Affero General Public License
    along with this program.  If not, see <https://www.gnu.org/licenses/>.
 */
package com.itextpdf.kernel.pdf;

import com.itextpdf.io.logs.IoLogMessageConstant;
import com.itextpdf.test.ExtendedITextTest;
import com.itextpdf.test.annotations.LogMessage;
import com.itextpdf.test.annotations.LogMessages;
import org.junit.jupiter.api.Assertions;
import org.junit.jupiter.api.Tag;
import org.junit.jupiter.api.Test;

import java.io.ByteArrayInputStream;
import java.io.ByteArrayOutputStream;
import java.io.IOException;
import java.util.HashMap;

@Tag("IntegrationTest")
public class PdfObjectTest extends ExtendedITextTest {

    @Test
    public void indirectsChain1() {
        PdfDocument document = new PdfDocument(new PdfWriter(new ByteArrayOutputStream()));
        document.addNewPage();
        PdfDictionary catalog = document.getCatalog().getPdfObject();
        catalog.put(new PdfName("a"), getTestPdfDictionary()
                .makeIndirect(document).getIndirectReference().makeIndirect(document).getIndirectReference().makeIndirect(document));
        PdfObject object = ((PdfIndirectReference)catalog.get(new PdfName("a"), false)).getRefersTo(true);
        Assertions.assertTrue(object instanceof PdfDictionary);
        document.close();
    }

    @Test
    public void indirectsChain2() {
        PdfDocument document = new PdfDocument(new PdfWriter(new ByteArrayOutputStream()));
        document.addNewPage();
        PdfDictionary catalog = document.getCatalog().getPdfObject();
        PdfDictionary dictionary = getTestPdfDictionary();
        PdfObject object = dictionary;
        for (int i = 0; i < 200; i++) {
            object = object.makeIndirect(document).getIndirectReference();
        }
        catalog.put(new PdfName("a"), object);
        ((PdfIndirectReference)catalog.get(new PdfName("a"))).getRefersTo(true);
        Assertions.assertNotNull(((PdfIndirectReference) catalog.get(new PdfName("a"))).getRefersTo(true));
        document.close();
    }

    @Test
    public void indirectsChain3() {
        PdfDocument document = new PdfDocument(new PdfWriter(new ByteArrayOutputStream()));
        document.addNewPage();
        PdfDictionary catalog = document.getCatalog().getPdfObject();
        PdfDictionary dictionary = getTestPdfDictionary();
        PdfObject object = dictionary;
        for (int i = 0; i < 31; i++) {
            object = object.makeIndirect(document).getIndirectReference();
        }
        catalog.put(new PdfName("a"), object);
        object = catalog.get(new PdfName("a"), true);
        Assertions.assertTrue(object instanceof PdfDictionary);
        Assertions.assertEquals(new PdfName("c").toString(), ((PdfDictionary) object).get(new PdfName("b")).toString());
        document.close();
    }

    @Test
    public void indirectsChain4() {
        PdfDocument document = new PdfDocument(new PdfWriter(new ByteArrayOutputStream()));
        document.addNewPage();
        PdfDictionary catalog = document.getCatalog().getPdfObject();
        PdfDictionary dictionary = getTestPdfDictionary();
        PdfObject object = dictionary;
        for (int i = 0; i < 31; i++) {
            object = object.makeIndirect(document).getIndirectReference();
        }
        PdfArray array = new PdfArray();
        array.add(object);
        catalog.put(new PdfName("a"), array);
        object = ((PdfArray)catalog.get(new PdfName("a"))).get(0, true);
        Assertions.assertTrue(object instanceof PdfDictionary);
        Assertions.assertEquals(new PdfName("c").toString(), ((PdfDictionary)object).get(new PdfName("b")).toString());
        document.close();
    }

    @Test
    public void pdfIndirectReferenceFlags(){
        PdfIndirectReference reference = new PdfIndirectReference(null, 1);
        reference.setState(PdfObject.FREE);
        reference.setState(PdfObject.READING);
        reference.setState(PdfObject.MODIFIED);

        Assertions.assertEquals(Boolean.TRUE, reference.checkState(PdfObject.FREE), "Free");
        Assertions.assertEquals(Boolean.TRUE, reference.checkState(PdfObject.READING), "Reading");
        Assertions.assertEquals(Boolean.TRUE, reference.checkState(PdfObject.MODIFIED), "Modified");
        Assertions.assertEquals(Boolean.TRUE,
                reference.checkState((byte) (PdfObject.FREE | PdfObject.MODIFIED | PdfObject.READING)),
                "Free|Reading|Modified");

        reference.clearState(PdfObject.FREE);

        Assertions.assertEquals(Boolean.FALSE, reference.checkState(PdfObject.FREE), "Free");
        Assertions.assertEquals(Boolean.TRUE, reference.checkState(PdfObject.READING), "Reading");
        Assertions.assertEquals(Boolean.TRUE, reference.checkState(PdfObject.MODIFIED), "Modified");
        Assertions.assertEquals(Boolean.TRUE,
                reference.checkState((byte)(PdfObject.READING |PdfObject.MODIFIED)), "Reading|Modified");
        Assertions.assertEquals(Boolean.FALSE,
                reference.checkState((byte) (PdfObject.FREE | PdfObject.READING | PdfObject.MODIFIED)),
                "Free|Reading|Modified");

        reference.clearState(PdfObject.READING);

        Assertions.assertEquals(Boolean.FALSE, reference.checkState(PdfObject.FREE), "Free");
        Assertions.assertEquals(Boolean.FALSE, reference.checkState(PdfObject.READING), "Reading");
        Assertions.assertEquals(Boolean.TRUE, reference.checkState(PdfObject.MODIFIED), "Modified");
        Assertions.assertEquals(Boolean.FALSE,
                reference.checkState((byte) (PdfObject.FREE | PdfObject.READING)), "Free|Reading");

        reference.clearState(PdfObject.MODIFIED);

        Assertions.assertEquals(Boolean.FALSE, reference.checkState(PdfObject.FREE), "Free");
        Assertions.assertEquals(Boolean.FALSE, reference.checkState(PdfObject.READING), "Reading");
        Assertions.assertEquals(Boolean.FALSE, reference.checkState(PdfObject.MODIFIED), "Modified");


        Assertions.assertEquals(Boolean.TRUE, !reference.isFree(), "Is InUse");

        reference.setState(PdfObject.FREE);

        Assertions.assertEquals(Boolean.FALSE, !reference.isFree(), "Not IsInUse");
    }

    @Test
    public void pdtIndirectReferenceLateInitializing1() throws IOException {
        ByteArrayOutputStream baos = new ByteArrayOutputStream();
        PdfDocument document = new PdfDocument(new PdfWriter(baos));
        document.addNewPage();
        PdfDictionary catalog = document.getCatalog().getPdfObject();

        PdfIndirectReference indRef = document.createNextIndirectReference();
        catalog.put(new PdfName("Smth"), indRef);

        PdfDictionary dictionary = new PdfDictionary();
        dictionary.put(new PdfName("A"), new PdfString("a"));

        dictionary.makeIndirect(document, indRef);

        document.close();


        ByteArrayInputStream bais = new ByteArrayInputStream(baos.toByteArray());
        document = new PdfDocument(new PdfReader(bais));

        PdfObject object = document.getCatalog().getPdfObject().get(new PdfName("Smth"));
        Assertions.assertTrue(object instanceof PdfDictionary);
        dictionary = (PdfDictionary) object;
        PdfString a = (PdfString) dictionary.get(new PdfName("A"));
        Assertions.assertTrue(a.getValue().equals("a"));

        document.close();
    }

    @Test
    @LogMessages(messages = {
            @LogMessage(messageTemplate = IoLogMessageConstant.FLUSHED_OBJECT_CONTAINS_REFERENCE_WHICH_NOT_REFER_TO_ANY_OBJECT),
            @LogMessage(messageTemplate = IoLogMessageConstant.INDIRECT_REFERENCE_USED_IN_FLUSHED_OBJECT_MADE_FREE),
            @LogMessage(messageTemplate = IoLogMessageConstant.XREF_ERROR_WHILE_READING_TABLE_WILL_BE_REBUILT_WITH_CAUSE)
    })
        public void pdtIndirectReferenceLateInitializing2() throws IOException {
        ByteArrayOutputStream baos = new ByteArrayOutputStream();

        PdfDocument document = new PdfDocument(new PdfWriter(baos));
        document.addNewPage();
        PdfDictionary catalog = document.getCatalog().getPdfObject();

        PdfIndirectReference indRef1 = document.createNextIndirectReference();
        PdfIndirectReference indRef2 = document.createNextIndirectReference();

        catalog.put(new PdfName("Smth1"), indRef1);
        catalog.put(new PdfName("Smth2"), indRef2);

        PdfArray array = new PdfArray();
        array.add(new PdfString("array string"));
        array.makeIndirect(document, indRef2);

        document.close();

        ByteArrayInputStream bais = new ByteArrayInputStream(baos.toByteArray());
        document = new PdfDocument(new PdfReader(bais));

        PdfDictionary catalogDict = document.getCatalog().getPdfObject();
        PdfObject object1 = catalogDict.get(new PdfName("Smth1"));
        PdfObject object2 = catalogDict.get(new PdfName("Smth2"));
        Assertions.assertTrue(object1 instanceof PdfNull);
        Assertions.assertTrue(object2 instanceof PdfArray);
    }

    @Test
    @LogMessages(messages = {
            @LogMessage(messageTemplate = IoLogMessageConstant.FLUSHED_OBJECT_CONTAINS_REFERENCE_WHICH_NOT_REFER_TO_ANY_OBJECT),
            @LogMessage(messageTemplate = IoLogMessageConstant.INDIRECT_REFERENCE_USED_IN_FLUSHED_OBJECT_MADE_FREE)
    })
    public void pdtIndirectReferenceLateInitializing3() {
        PdfDocument document = new PdfDocument(new PdfWriter(new ByteArrayOutputStream()));
        document.addNewPage();
        PdfDictionary catalog = document.getCatalog().getPdfObject();

        PdfIndirectReference indRef1 = document.createNextIndirectReference();
        PdfIndirectReference indRef2 = document.createNextIndirectReference();

        PdfArray array = new PdfArray();
        catalog.put(new PdfName("array1"), array);
        PdfString string = new PdfString("array string");
        array.add(string);
        array.add(indRef1);
        array.add(indRef2);

        PdfDictionary dict = new PdfDictionary();
        dict.makeIndirect(document, indRef1);


        PdfArray arrayClone = (PdfArray) array.clone();

        PdfObject object0 = arrayClone.get(0, false);
        PdfObject object1 = arrayClone.get(1, false);
        PdfObject object2 = arrayClone.get(2, false);

        Assertions.assertTrue(object0 instanceof PdfString);
        Assertions.assertTrue(object1 instanceof PdfDictionary);
        Assertions.assertTrue(object2 instanceof PdfNull);

        PdfString string1 = (PdfString)object0;
        Assertions.assertTrue(string != string1);
        Assertions.assertTrue(string.getValue().equals(string1.getValue()));

        PdfDictionary dict1 = (PdfDictionary) object1;
        Assertions.assertTrue(dict1.getIndirectReference().getObjNumber() == dict.getIndirectReference().getObjNumber());
        Assertions.assertTrue(dict1.getIndirectReference().getGenNumber() == dict.getIndirectReference().getGenNumber());
        Assertions.assertTrue(dict1 == dict);

        document.close();
    }

    @Test
    public void containsIndirectReference1Test() {
        PdfDocument pdfDoc = new PdfDocument(new PdfWriter(new ByteArrayOutputStream()));
        PdfDictionary testDict = getTestPdfDictionary();
        Assertions.assertFalse(testDict.containsIndirectReference());

        testDict.get(new PdfName("b")).makeIndirect(pdfDoc);
        Assertions.assertTrue(testDict.containsIndirectReference());
    }

    @Test
    public void containsIndirectReference2Test() {
        PdfDocument pdfDoc = new PdfDocument(new PdfWriter(new ByteArrayOutputStream()));
        PdfDictionary testDict = getTestPdfDictionary();
        PdfObject arrValue = new PdfName("arrValue");
        PdfArray pdfArr = new PdfArray();
        pdfArr.add(arrValue);

        testDict.put(new PdfName("array"), pdfArr);
        Assertions.assertFalse(testDict.containsIndirectReference());

        arrValue.makeIndirect(pdfDoc);
        Assertions.assertTrue(testDict.containsIndirectReference());
    }

    @Test
    public void containsIndirectReferenceFlushedDictValueTest() {
        PdfDocument pdfDoc = new PdfDocument(new PdfWriter(new ByteArrayOutputStream()));
        PdfDictionary testDict = getTestPdfDictionary();
        Assertions.assertFalse(testDict.containsIndirectReference());

        testDict.get(new PdfName("b")).makeIndirect(pdfDoc).flush();
        Assertions.assertTrue(testDict.containsIndirectReference());
    }

    @Test
    public void containsIndirectReferenceFlushedArrayTest() {
        PdfDocument pdfDoc = new PdfDocument(new PdfWriter(new ByteArrayOutputStream()));
        PdfDictionary testDict = getTestPdfDictionary();
        PdfObject arrValue = new PdfName("arrValue");
        PdfArray pdfArr = new PdfArray();
        pdfArr.add(arrValue);
        pdfArr.makeIndirect(pdfDoc);
        pdfArr.flush();

        testDict.put(new PdfName("array"), pdfArr);
        Assertions.assertTrue(testDict.containsIndirectReference());
    }

    @Test
    public void containsIndirectReferenceFlushedArrayValueTest() {
        PdfDocument pdfDoc = new PdfDocument(new PdfWriter(new ByteArrayOutputStream()));
        PdfDictionary testDict = getTestPdfDictionary();
        PdfObject arrValue = new PdfName("arrValue");
        PdfArray pdfArr = new PdfArray();
        pdfArr.add(arrValue);

        arrValue.makeIndirect(pdfDoc);
        arrValue.flush();

        testDict.put(new PdfName("array"), pdfArr);
        Assertions.assertTrue(testDict.containsIndirectReference());
    }

    @Test
    public void containsIndirectReferenceFlushedArrayAndArrayValueTest() {
        PdfDocument pdfDoc = new PdfDocument(new PdfWriter(new ByteArrayOutputStream()));
        PdfDictionary testDict = getTestPdfDictionary();
        PdfObject arrValue = new PdfName("arrValue");
        PdfArray pdfArr = new PdfArray();
        pdfArr.add(arrValue);

        arrValue.makeIndirect(pdfDoc);
        arrValue.flush();

        pdfArr.makeIndirect(pdfDoc);
        pdfArr.flush();

        testDict.put(new PdfName("array"), pdfArr);
        Assertions.assertTrue(testDict.containsIndirectReference());
    }

    private static PdfDictionary getTestPdfDictionary() {
        HashMap<PdfName, PdfObject> tmpMap = new HashMap<PdfName, PdfObject>();
        tmpMap.put(new PdfName("b"), new PdfName("c"));
        return new PdfDictionary(tmpMap);
    }
}