Support PDF A4 checks for actions

DEVSIX-7746

Author: guustysebie

pdfa/src/main/java/com/itextpdf/pdfa/checker/PdfA2Checker.java

@@ -570,16 +570,26 @@ protected void checkForm(PdfDictionary form) {
         }
     }
 
+
+    /**
+     *  Checks if the catalog is compliant with the PDF/A-2 standard.
+     *
+     *  @param dict the catalog dictionary
+     */
+    protected void checkCatalogAAConformance(PdfDictionary dict) {
+        if (dict.containsKey(PdfName.AA)) {
+            throw new PdfAConformanceException(
+                    PdfAConformanceException.A_CATALOG_DICTIONARY_SHALL_NOT_CONTAIN_AA_ENTRY);
+        }
+    }
+
     @Override
     protected void checkCatalogValidEntries(PdfDictionary catalogDict) {
         if (catalogDict.containsKey(PdfName.NeedsRendering)) {
             throw new PdfAConformanceException(PdfAConformanceException.THE_CATALOG_DICTIONARY_SHALL_NOT_CONTAIN_THE_NEEDSRENDERING_KEY);
         }
 
-        if (catalogDict.containsKey(PdfName.AA)) {
-            throw new PdfAConformanceException(PdfAConformanceException.A_CATALOG_DICTIONARY_SHALL_NOT_CONTAIN_AA_ENTRY);
-        }
-
+        checkCatalogAAConformance(catalogDict);
         if (catalogDict.containsKey(PdfName.Requirements)) {
             throw new PdfAConformanceException(PdfAConformanceException.A_CATALOG_DICTIONARY_SHALL_NOT_CONTAIN_REQUIREMENTS_ENTRY);
         }
@@ -714,12 +724,20 @@ protected void checkPdfStream(PdfStream stream) {
         }
     }
 
-    @Override
-    protected void checkPageObject(PdfDictionary pageDict, PdfDictionary pageResources) {
-        if (pageDict.containsKey(PdfName.AA)) {
+    /**
+     *  Checks if the page is compliant with the PDF/A-2 standard.
+     *
+     *  @param dict the page dictionary
+     */
+    protected void checkPageAAConformance(PdfDictionary dict) {
+        if (dict.containsKey(PdfName.AA)) {
             throw new PdfAConformanceException(PdfAConformanceException.THE_PAGE_DICTIONARY_SHALL_NOT_CONTAIN_AA_ENTRY);
         }
+    }
 
+    @Override
+    protected void checkPageObject(PdfDictionary pageDict, PdfDictionary pageResources) {
+        checkPageAAConformance(pageDict);
         if (pageDict.containsKey(PdfName.PresSteps)) {
             throw new PdfAConformanceException(PdfAConformanceException.THE_PAGE_DICTIONARY_SHALL_NOT_CONTAIN_PRESSTEPS_ENTRY);
         }

pdfa/src/main/java/com/itextpdf/pdfa/checker/PdfA4Checker.java

@@ -103,6 +103,29 @@ public class PdfA4Checker extends PdfA3Checker {
 
     private static final Logger LOGGER = LoggerFactory.getLogger(PdfAChecker.class);
 
+
+    private static final Set<PdfName> forbiddenActionsE = Collections
+            .unmodifiableSet(new HashSet<>(Arrays.asList(
+                    PdfName.Launch,
+                    PdfName.Sound,
+                    PdfName.Movie,
+                    PdfName.ResetForm,
+                    PdfName.ImportData,
+                    PdfName.JavaScript,
+                    PdfName.Hide,
+                    PdfName.Rendition,
+                    PdfName.Trans
+            )));
+    private static final Set<PdfName> allowedEntriesInAAWhenNonWidget = Collections
+            .unmodifiableSet(new HashSet<>(Arrays.asList(
+                    PdfName.E,
+                    PdfName.X,
+                    PdfName.D,
+                    PdfName.U,
+                    PdfName.Fo,
+                    PdfName.Bl
+            )));
+
     /**
      * Creates a PdfA4Checker with the required conformance level
      *
@@ -200,6 +223,36 @@ protected void checkPageTransparency(PdfDictionary pageDict, PdfDictionary pageR
         }
     }
 
+
+    /**
+     * Check the conformity of the AA dictionary on catalog level.
+     *
+     * @param dict the catalog dictionary
+     */
+    @Override
+    protected void checkCatalogAAConformance(PdfDictionary dict) {
+        final PdfDictionary aa = dict.getAsDictionary(PdfName.AA);
+        if (aa != null && hasAAIllegalEntries(aa)) {
+            throw new PdfAConformanceException(
+                    PdfaExceptionMessageConstant.CATALOG_AA_DICTIONARY_SHALL_CONTAIN_ONLY_ALLOWED_KEYS);
+        }
+    }
+
+
+    /**
+     * Check the conformity of the AA dictionary on catalog level.
+     *
+     * @param dict the catalog dictionary
+     */
+    @Override
+    protected void checkPageAAConformance(PdfDictionary dict) {
+        final PdfDictionary aa = dict.getAsDictionary(PdfName.AA);
+        if (aa != null && hasAAIllegalEntries(aa)) {
+            throw new PdfAConformanceException(
+                    PdfaExceptionMessageConstant.PAGE_AA_DICTIONARY_SHALL_CONTAIN_ONLY_ALLOWED_KEYS);
+        }
+    }
+
     //There are no limits for numbers in pdf-a/4
     /**
      * {@inheritDoc}
@@ -276,6 +329,22 @@ protected Set<PdfName> getAppearanceLessAnnotations() {
         return apLessAnnotations;
     }
 
+
+    /**
+     * Check the conformity of the AA dictionary on widget level.
+     *
+     * @param dict the widget dictionary
+     */
+    protected void checkWidgetAAConformance(PdfDictionary dict) {
+        if (!PdfName.Widget.equals(dict.getAsName(PdfName.Subtype)) && dict.containsKey(PdfName.AA)) {
+            final PdfObject additionalActions = dict.get(PdfName.AA);
+            if (additionalActions.isDictionary() && hasAAIllegalEntries((PdfDictionary) additionalActions)) {
+                throw new PdfAConformanceException(
+                        PdfaExceptionMessageConstant.ANNOTATION_AA_DICTIONARY_SHALL_CONTAIN_ONLY_ALLOWED_KEYS);
+            }
+        }
+    }
+
     /**
      * {@inheritDoc}
      */
@@ -285,9 +354,27 @@ protected void checkAnnotationAgainstActions(PdfDictionary annotDic) {
             throw new PdfAConformanceException(
                     PdfaExceptionMessageConstant.WIDGET_ANNOTATION_DICTIONARY_OR_FIELD_DICTIONARY_SHALL_NOT_INCLUDE_A_ENTRY);
         }
-        if (!PdfName.Widget.equals(annotDic.getAsName(PdfName.Subtype)) && annotDic.containsKey(PdfName.AA)) {
-            throw new PdfAConformanceException(PdfAConformanceException.AN_ANNOTATION_DICTIONARY_SHALL_NOT_CONTAIN_AA_KEY);
+        checkWidgetAAConformance(annotDic);
+    }
+
+    private static boolean hasAAIllegalEntries(PdfDictionary aa) {
+        for (final PdfName key : aa.keySet()) {
+            if (!allowedEntriesInAAWhenNonWidget.contains(key)) {
+                return true;
+            }
+        }
+        return false;
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    @Override
+    protected Set<PdfName> getForbiddenActions() {
+        if ("E".equals(conformanceLevel.getConformance())) {
+            return forbiddenActionsE;
         }
+        return super.getForbiddenActions();
     }
 
     /**

pdfa/src/main/java/com/itextpdf/pdfa/exceptions/PdfaExceptionMessageConstant.java

@@ -38,6 +38,17 @@ public final class PdfaExceptionMessageConstant {
             = "Can't find an appropriate checker for a specified name.";
     public static final String FILE_SPECIFICATION_DICTIONARY_SHALL_CONTAIN_AFRELATIONSHIP_KEY = "Each embedded file’s file specification dictionary shall contain an AFRelationship key.";
     public static final String WIDGET_ANNOTATION_DICTIONARY_OR_FIELD_DICTIONARY_SHALL_NOT_INCLUDE_A_ENTRY = "Widget annotation dictionary or field dictionary shall not include a entry";
+    public static final String ANNOTATION_AA_DICTIONARY_SHALL_CONTAIN_ONLY_ALLOWED_KEYS =
+            "If annotation dictionary (other than a Widget "
+                    + "annotation dictionary) includes an AA entry, its value (which is an additional-actions "
+                    + "dictionary) shall only contain keys from the following list: E, X, D, U, Fo, and B";
+    public static final String CATALOG_AA_DICTIONARY_SHALL_CONTAIN_ONLY_ALLOWED_KEYS =
+            "If a document catalog dictionary includes an AA entry, its value (which is an additional-actions "
+                    + "dictionary) shall only contain keys from the following list: E, X, D, U, Fo, and B";
+    public static final String PAGE_AA_DICTIONARY_SHALL_CONTAIN_ONLY_ALLOWED_KEYS =
+            "If page dictionary includes an AA entry, its value (which is an additional-actions "
+                    + "dictionary) shall only contain keys from the following list: E, X, D, U, Fo, and B";
+
 
     public static final String THE_DOCUMENT_AND_THE_PAGE_DO_NOT_CONTAIN_A_PDFA_OUTPUTINTENT_BUT_PAGE_CONTAINS_TRANSPARENCY_AND_DOES_NOT_CONTAIN_BLENDING_COLOR_SPACE =
             "If the document does not contain a PDF/A output intent, then all pages that contain transparency shall"