PVQ-4179 Fixed checking MCIDs in nested tags and tags with variable content marks

Author: jozefbaranec

README.md

@@ -34,6 +34,11 @@ Operations:
 Arguments:
   -i <file>         : Path to a single PDF file to validate.
   -d <folder>       : Path to a directory of PDF files to validate (will process all PDFs in the folder).
+
+Return Codes:
+  success with no duplicate MCIDs: 0 - no duplcate MCIDs
+  success with found duplicate MCIDs: count of invalid duplicate MCIDs (maximum 100)
+  error: 101 and higher - error check the message in System.err
 ```
 
 ## Run the CLI Commands

config.json

@@ -22,7 +22,106 @@
             ],
             "returnCodes": [
                 0,
-                1
+                1,
+                2,
+                3,
+                4,
+                5,
+                6,
+                7,
+                8,
+                9,
+                10,
+                11,
+                12,
+                13,
+                14,
+                15,
+                16,
+                17,
+                18,
+                19,
+                20,
+                21,
+                22,
+                23,
+                24,
+                25,
+                26,
+                27,
+                28,
+                29,
+                30,
+                31,
+                32,
+                33,
+                34,
+                35,
+                36,
+                37,
+                38,
+                39,
+                40,
+                41,
+                42,
+                43,
+                44,
+                45,
+                46,
+                47,
+                48,
+                49,
+                50,
+                51,
+                52,
+                53,
+                54,
+                55,
+                56,
+                57,
+                58,
+                59,
+                60,
+                61,
+                62,
+                63,
+                64,
+                65,
+                66,
+                67,
+                68,
+                69,
+                70,
+                71,
+                72,
+                73,
+                74,
+                75,
+                76,
+                77,
+                78,
+                79,
+                80,
+                81,
+                82,
+                83,
+                84,
+                85,
+                86,
+                87,
+                88,
+                89,
+                90,
+                91,
+                92,
+                93,
+                94,
+                95,
+                96,
+                97,
+                98,
+                99,
+                100
             ],
             "stdout": "${output_txt}",
             "program": "java -jar \"${action_path}/net.pdfix.validate-pdf-0.0.0.jar\" duplicate-mcid -i \"${input_pdf}\"",

pom.xml

@@ -41,7 +41,7 @@
     <dependency>
       <groupId>net.pdfix</groupId>
       <artifactId>net.pdfix.pdfixlib</artifactId>
-      <version>8.4.3</version>
+      <version>8.7.3</version>
     </dependency>
   </dependencies>
 
@@ -122,7 +122,7 @@
               <groupId>net.pdfix</groupId>
               <artifactId>net.pdfix.pdfixlib</artifactId>
               <version>${project.version}</version>
-              <file>${pom.basedir}/lib/net.pdfix.pdfixlib-8.4.3.jar</file>
+              <file>${pom.basedir}/lib/net.pdfix.pdfixlib-8.7.3.jar</file>
               <packaging>jar</packaging>
               <generatePom>true</generatePom>
             </configuration>

resources/test1.pdf

@@ -2,6 +2,7 @@
 
 import java.io.File;
 import java.io.FileInputStream;
+import java.io.FileNotFoundException;
 import java.io.IOException;
 import java.nio.file.Files;
 import java.nio.file.Paths;
@@ -15,6 +16,13 @@ public class App {
   private static String VERSION = "1.0.0";
   private static String APP_NAME = "Validate PDF Accessibility";
 
+    // Success codes: 0-255 for object counts
+    // Error codes: 256+ to avoid conflict with object counts
+    private static final int ERROR_GENERAL = 101;
+    
+    // Maximum count we can return as exit code is 100
+    private static final int MAX_EXIT_CODE = 100;    // maximum number of errors returned as an exit code  
+
   private static void displayVersion() {
     Properties properties = new Properties();
     try {
@@ -65,13 +73,13 @@ private static List<File> collectFiles(String directoryPath) {
     return fileList;
   }
 
-  private static void processFile(File file) throws Exception {
+  private static int processFile(File file) throws Exception {
     // Process single file
     System.out.println("File: " + file.getPath() + "");
 
     if (!isPDFFile(file.getAbsolutePath())) {
       System.out.println("Not a PDF file");
-      return;
+      return 0;
     }
 
     int count = FindDuplicateMcid.checkDuplicateMcid(file.getAbsolutePath());
@@ -80,6 +88,7 @@ private static void processFile(File file) throws Exception {
     } else {
       System.out.println(String.format("Total %d duplicate MCID(s) found", count));
     }
+    return count;
   }
 
   private static String OP_DUPLICATE_MCID = "OP_DUPLICATE_MCID";
@@ -152,21 +161,25 @@ public int compare(File f1, File f2) {
         }
       });
 
+      int count = 0;
+
       // Process each file
       for (File file : fileList) {
         System.out.println("===============================================================================");
         try {
           if (op == OP_DUPLICATE_MCID) {
-            processFile(file);
+            count += processFile(file);
           }
         } catch (Exception e) {
-          System.out.println(e.getLocalizedMessage());
+          System.err.println(e.getLocalizedMessage());
         }
         System.out.println("===============================================================================\n");
       }
       System.out.println("Process complete");
+      System.exit(Math.min(count, MAX_EXIT_CODE));
     } catch (Exception e) {
-      System.out.println(e.getLocalizedMessage());
+      System.err.println(e.getLocalizedMessage());
+      System.exit(ERROR_GENERAL);
     }
   }
 }

src/main/java/net/pdfix/App.java

@@ -1,12 +1,17 @@
 package net.pdfix;
 
+import java.io.File;
+import java.io.FileNotFoundException;
 import java.nio.channels.NonReadableChannelException;
 import java.util.ArrayList;
 import java.util.List;
 
 import net.pdfix.pdfixlib.*;
 
 public class FindDuplicateMcid {
+    private static int kReportTypeDplicateMcid = 1;
+    private static int kReportTypeArtifactMcid = 2;
+
     // Helper function to get a readable object type
     private static String getNiceObjType(PdfPageObjectType type) {
         switch (type) {
@@ -42,8 +47,13 @@ private static String getObjContent(PdsPageObject obj) {
         return info.toString();
     }
 
-    public static void reportMcid(int pageNum, PdsPageObject obj, int index, int mcid) {
-        System.out.println("Duplicate MCID Found:");
+    public static void reportMcid(int pageNum, PdsPageObject obj, int index, int mcid, int reportType) {
+        // report type
+        if (reportType == kReportTypeDplicateMcid) {
+            System.out.println("Error: Duplicate MCID found");
+        } else if (reportType == kReportTypeArtifactMcid) {
+            System.out.println("Warning: Artifact with MCID found");
+        }
         String objType = getNiceObjType(obj.GetObjectType());
         String objBBox = getObjBBox(obj);
         String objContent = getObjContent(obj);
@@ -63,11 +73,40 @@ public static void reportMcid(int pageNum, PdsPageObject obj, int index, int mci
         System.out.println(info.toString());
     }
 
+    private static Boolean compareContentMarkMCID(PdsPageObject obj1, PdsPageObject obj2) {
+        if (obj1 == obj2) {
+            return true;
+        }
+        if ((obj1 == null) || (obj2 == null)) {
+            return false;
+        }
+        PdsContentMark cm1 = obj1.GetContentMark();
+        PdsContentMark cm2 = obj2.GetContentMark();
+
+        // compare content mark index with MCID
+        if (cm1.GetTagMcid() != cm2.GetTagMcid()) {
+            return false;
+        } 
+
+        // compare content mark names, manes on each index must me equal
+        for (int i = 0; i <= cm1.GetTagMcid(); i++) {
+            if (cm1.GetTagName(i).compareTo(cm2.GetTagName(i)) != 0) {
+                return false;
+            }
+        }
+        return true;
+    }
+
     // Check for duplicate MCIDs in a PDF file. Return the number of dulicate mcids
     // found
     public static int checkDuplicateMcid(String path) throws Exception {
         Pdfix pdfix = new Pdfix();
 
+        File file = new File(path);
+        if (!file.exists()) {
+            throw new FileNotFoundException(path);
+        }
+
         PdfDoc doc = pdfix.OpenDoc(path, "");
         if (doc == null) {
             throw new RuntimeException(pdfix.GetError());
@@ -89,34 +128,37 @@ public static int checkDuplicateMcid(String path) throws Exception {
             }
 
             int lastMcid = -1;
+            PdsPageObject lastObject = null;
             List<Integer> mcids = new ArrayList<Integer>();
-            PdsPageObject lastObj = null;
             for (int j = 0; j < content.GetNumObjects(); j++) {
                 PdsPageObject obj = content.GetObject(j);
+                PdsContentMark contentMark = obj.GetContentMark();
                 int mcid = obj.GetMcid();
-                if ((mcid != -1) && (mcid == lastMcid)) {
-                    // content marks must be equal for equal mcid
-                    if (lastObj != null) {
-                        if (obj.GetNumEqualTags(lastObj) != obj.GetContentMark().GetNumTags()) {
-                            reportMcid(i, obj, j, mcid);
-                            found++;
-                        }
-                    }
-                } else if (mcid != lastMcid) {
+                Boolean isArtifact = (contentMark.GetTagArtifact() != -1);
+
+                // reports following options:
+                // Error: duplicite MCID in tagged content (second MCID occurence can be in tagged content or artifact)
+                // Warning: MCID set for Artifact (it may be used in tag tree)
+
+                if ((mcid != lastMcid) || ((mcid != -1) && (lastObject != null) && (!compareContentMarkMCID(obj, lastObject)))) {
                     lastMcid = mcid;
                     if (mcid == -1) {
                         continue;
                     }
-
                     if (mcids.contains(mcid)) {
-                        reportMcid(i, obj, j, mcid);
+                        reportMcid(i, obj, j, mcid, kReportTypeDplicateMcid);
                         found++;
                     }
                     mcids.add(mcid);
                 }
-                lastObj = obj;
+                if (isArtifact && (mcid != -1)) {
+                    if (mcid != -1) {
+                        reportMcid(i, obj, j, mcid, kReportTypeArtifactMcid);
+                    }
+                    lastMcid = -1;
+                }
+                lastObject = obj;
             }
-
             page.Release();
         }
 

src/main/java/net/pdfix/FindDuplicateMcid.java

@@ -1,20 +1,37 @@
 package net.pdfix;
 
+import java.util.AbstractMap;
+import java.util.ArrayList;
+import java.util.List;
+
 import org.junit.jupiter.api.Test;
 
 public class FindDuplicateMcidTest {
 
-  // Test validation of dulicate MCID 
-  // test.pdf contains a duplicate MCID '0' with content 'Multi-Platform PDF Library SDK'
+  // Test validation of dulicate MCID
+  // test.pdf contains a duplicate MCID '0' with content 'Multi-Platform PDF
+  // Library SDK'
   // on top of the page
 
   @Test
   void testDuplicateMcid() throws Exception {
+
+    // list of files to test. Each item contains path to the file and number of
+    // expected errors found
+    List<AbstractMap.SimpleEntry<String, Integer>> testFiles = new ArrayList<>();
+    testFiles.add(new AbstractMap.SimpleEntry<>("/resources/test.pdf", 1));
+    testFiles.add(new AbstractMap.SimpleEntry<>("/resources/test1.pdf", 40));
+
     String basePath = System.getProperty("user.dir"); // path to current folder
-    String pdfPath = basePath + "/resources/test.pdf";
-    int numberOfDuplicities = FindDuplicateMcid.checkDuplicateMcid(pdfPath);
-    if (numberOfDuplicities != 5) {
-      throw new Exception("testDuplicateMcid Failed - Expected 5 duplicate MCIDs, found " + numberOfDuplicities);
+
+    for (AbstractMap.SimpleEntry<String, Integer> entry : testFiles) {
+      String pdfPath = basePath + entry.getKey();
+      System.out.println(pdfPath);
+      int numberOfDuplicities = FindDuplicateMcid.checkDuplicateMcid(pdfPath);
+      if (numberOfDuplicities != entry.getValue()) {
+        throw new Exception(String.format("testDuplicateMcid Failed - Expected %d duplicate MCIDs, found %d",
+            entry.getValue(), numberOfDuplicities));
+      }
     }
   }
 }