pdfbox-trunk/pdfbox/src/test/java/org/apache/pdfbox/pdmodel/interactive/form/HandleDifferentDALevelsTest.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.pdfbox.pdmodel.interactive.form;

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

import java.io.File;
import java.io.IOException;
import java.util.List;

import org.apache.pdfbox.Loader;
import org.apache.pdfbox.cos.COSName;
import org.apache.pdfbox.pdmodel.PDDocument;
import org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationWidget;
import org.junit.jupiter.api.AfterEach;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;

class HandleDifferentDALevelsTest
{
    private static final File OUT_DIR = new File("target/test-output");
    private static final File IN_DIR = new File("src/test/resources/org/apache/pdfbox/pdmodel/interactive/form");
    private static final String NAME_OF_PDF = "DifferentDALevels.pdf";
    
    private PDDocument document;
    private PDAcroForm acroForm;

    @BeforeEach
    public void setUp() throws IOException
    {
        document = Loader.loadPDF(new File(IN_DIR, NAME_OF_PDF));
        acroForm = document.getDocumentCatalog().getAcroForm();
        OUT_DIR.mkdirs();
        
        // prefill the fields to generate the appearance streams
        PDTextField field = (PDTextField) acroForm.getField("SingleAnnotation");
        field.setValue("single annotation");
        
        field = (PDTextField) acroForm.getField("MultipeAnnotations-SameLayout");
        field.setValue("same layout");
        
        field = (PDTextField) acroForm.getField("MultipleAnnotations-DifferentLayout");
        field.setValue("different layout");
        
        File file = new File(OUT_DIR, NAME_OF_PDF);
        document.save(file);
        
    }

    @Test
    void checkSingleAnnotation() throws IOException
    {
        PDTextField field = (PDTextField) acroForm.getField("SingleAnnotation");
        String fieldFontSetting = getFontSettingFromDA(field);
        List<PDAnnotationWidget> widgets = field.getWidgets();
        for (PDAnnotationWidget widget : widgets)
        {
            String contentAsString = new String(widget.getNormalAppearanceStream().getContentStream().toByteArray());
            assertTrue(contentAsString.indexOf(fieldFontSetting) > 0);
        }
    }
    
    @Test
    void checkSameLayout() throws IOException
    {
        PDTextField field = (PDTextField) acroForm.getField("MultipeAnnotations-SameLayout");
        String fieldFontSetting = getFontSettingFromDA(field);
        List<PDAnnotationWidget> widgets = field.getWidgets();
        for (PDAnnotationWidget widget : widgets)
        {
            String contentAsString = new String(widget.getNormalAppearanceStream().getContentStream().toByteArray());
            assertTrue(contentAsString.indexOf(fieldFontSetting) > 0, "font setting in content stream shall be " + fieldFontSetting);
        }
    }
    
    // TODO: enable the test after issue 3687 has been fixed
    @Test
    void checkDifferentLayout() throws IOException
    {
        PDTextField field = (PDTextField) acroForm.getField("MultipleAnnotations-DifferentLayout");
        String fieldFontSetting = getFontSettingFromDA(field);
        List<PDAnnotationWidget> widgets = field.getWidgets();
        for (PDAnnotationWidget widget : widgets)
        {
            String widgetFontSetting = getFontSettingFromDA(widget);
            String fontSetting = widgetFontSetting == null ? fieldFontSetting : widgetFontSetting;
            String contentAsString = new String(widget.getNormalAppearanceStream().getContentStream().toByteArray());
            assertTrue(contentAsString.indexOf(fontSetting) > 0, "font setting in content stream shall be " + fontSetting);
        }
    }
    
    @AfterEach
    public void tearDown() throws IOException
    {
        document.close();
    }
    
    private String getFontSettingFromDA(PDTextField field)
    {
        String defaultAppearance = field.getDefaultAppearance();
        // get the font setting from the default appearance string
        return defaultAppearance.substring(0, defaultAppearance.lastIndexOf("Tf")+2);
    }
    
    private String getFontSettingFromDA(PDAnnotationWidget widget)
    {
        String defaultAppearance = widget.getCOSObject().getString(COSName.DA);
        if (defaultAppearance != null)
        {
            return defaultAppearance.substring(0, defaultAppearance.lastIndexOf("Tf")+2);
        }
        return defaultAppearance;
    }
}
