/*
 * Copyright 2014 The Apache Software Foundation.
 *
 * Licensed 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.pdfbox.multipdf;

import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertTrue;

import java.awt.Color;
import java.io.ByteArrayOutputStream;
import java.io.File;
import java.io.IOException;
import java.util.Iterator;

import org.apache.pdfbox.pdmodel.PDDocument;
import org.apache.pdfbox.Loader;
import org.apache.pdfbox.cos.COSDictionary;
import org.apache.pdfbox.cos.COSName;
import org.apache.pdfbox.cos.COSObject;
import org.apache.pdfbox.pdmodel.PDPage;
import org.apache.pdfbox.pdmodel.PDPageContentStream;
import org.apache.pdfbox.pdmodel.PDPageContentStream.AppendMode;
import org.apache.pdfbox.pdmodel.common.PDStream;
import org.apache.pdfbox.pdmodel.graphics.optionalcontent.PDOptionalContentProperties;
import static org.junit.jupiter.api.Assertions.assertFalse;
import static org.junit.jupiter.api.Assertions.assertNotNull;
import org.junit.jupiter.api.Test;

/**
 * Test suite for PDFCloneUtility, see PDFBOX-2052.
 *
 * @author Cornelis Hoeflake
 * @author Tilman Hausherr
 */
class PDFCloneUtilityTest
{
    /**
     * original (minimal) test from PDFBOX-2052.
     * 
     * @throws IOException 
     */
    @Test
    void testClonePDFWithCosArrayStream() throws IOException
    {
        try (PDDocument srcDoc = new PDDocument();
             PDDocument dstDoc = new PDDocument())
        {
            PDPage pdPage = new PDPage();
            srcDoc.addPage(pdPage);
            new PDPageContentStream(srcDoc, pdPage, AppendMode.APPEND, true).close();
            new PDPageContentStream(srcDoc, pdPage, AppendMode.APPEND, true).close();
            PDFCloneUtility cloner = new PDFCloneUtility(dstDoc);
            assertEquals(dstDoc, cloner.getDestination());
            COSDictionary clonedPageDictionary = cloner.cloneForNewDocument(pdPage.getCOSObject());
            PDPage clonedPage = new PDPage(clonedPageDictionary);
            Iterator<PDStream> contentStreams = clonedPage.getContentStreams();
            assertNotNull(contentStreams.next());
            assertNotNull(contentStreams.next());
            assertFalse(contentStreams.hasNext());
        }
    }

    /**
     * broader test that saves to a real PDF document.
     * 
     * @throws IOException 
     */
    @Test
    void testClonePDFWithCosArrayStream2() throws IOException
    {
        final String TESTDIR = "target/test-output/clone/";
        final String CLONESRC = "clone-src.pdf";
        final String CLONEDST = "clone-dst.pdf";

        new File(TESTDIR).mkdirs();

        PDDocument srcDoc = new PDDocument();
        PDPage pdPage = new PDPage();
        srcDoc.addPage(pdPage);
        try (PDPageContentStream pdPageContentStream1 = new PDPageContentStream(srcDoc, pdPage, AppendMode.APPEND, false))
        {
            pdPageContentStream1.setNonStrokingColor(Color.black);
            pdPageContentStream1.addRect(100, 600, 300, 100);
            pdPageContentStream1.fill();
        }
        try (PDPageContentStream pdPageContentStream2 = new PDPageContentStream(srcDoc, pdPage, AppendMode.APPEND, false))
        {
            pdPageContentStream2.setNonStrokingColor(Color.red);
            pdPageContentStream2.addRect(100, 500, 300, 100);
            pdPageContentStream2.fill();
        }
        try (PDPageContentStream pdPageContentStream3 = new PDPageContentStream(srcDoc, pdPage, AppendMode.APPEND, false))
        {
            pdPageContentStream3.setNonStrokingColor(Color.yellow);
            pdPageContentStream3.addRect(100, 400, 300, 100);
            pdPageContentStream3.fill();
        }

        srcDoc.save(TESTDIR + CLONESRC);
        PDFMergerUtility merger = new PDFMergerUtility();
        try (PDDocument dstDoc = new PDDocument())
        {
            // this calls PDFCloneUtility.cloneForNewDocument(),
            // which would fail before the fix in PDFBOX-2052
            merger.appendDocument(dstDoc, srcDoc);
            
            // save and reload PDF, so that one can see that the files are legit
            dstDoc.save(TESTDIR + CLONEDST);
        }
        try (PDDocument doc = Loader.loadPDF(new File(TESTDIR + CLONESRC)))
        {
            assertEquals(1, doc.getNumberOfPages());
        }
        try (PDDocument doc = Loader.loadPDF(new File(TESTDIR + CLONESRC), (String) null))
        {
            assertEquals(1, doc.getNumberOfPages());
        }
        try (PDDocument doc = Loader.loadPDF(new File(TESTDIR + CLONEDST)))
        {
            assertEquals(1, doc.getNumberOfPages());
        }
        try (PDDocument doc = Loader.loadPDF(new File(TESTDIR + CLONEDST), (String) null))
        {
            assertEquals(1, doc.getNumberOfPages());
        }
    }

    /**
     * PDFBOX-4814: this tests merging a direct and an indirect COSDictionary, when "target" is
     * indirect in cloneMerge().
     *
     * @throws IOException
     */
    @Test
    void testDirectIndirect() throws IOException
    {
        try (PDDocument doc1 = new PDDocument())
        {
            doc1.addPage(new PDPage());
            doc1.getDocumentCatalog().setOCProperties(new PDOptionalContentProperties());
            ByteArrayOutputStream baos = new ByteArrayOutputStream();
            doc1.save(baos);
            try (PDDocument doc2 = Loader.loadPDF(baos.toByteArray()))
            {
                PDFMergerUtility merger = new PDFMergerUtility();
                // The OCProperties is a direct object here, but gets saved as an indirect object.
                assertTrue(doc1.getDocumentCatalog().getCOSObject().getItem(COSName.OCPROPERTIES) instanceof COSDictionary);
                assertTrue(doc2.getDocumentCatalog().getCOSObject().getItem(COSName.OCPROPERTIES) instanceof COSObject);
                merger.appendDocument(doc2, doc1);
                assertEquals(2, doc2.getNumberOfPages());
            }
        }
    }
}