Register pdfOcr events on kernel level. Treat inner namespaces in ContextManager correctly

Now iText could return a context for a.b event even if a.b context is registered

DEVSIX-4170

Author: ars18wrw

kernel/src/main/java/com/itextpdf/kernel/counter/ContextManager.java

@@ -49,8 +49,9 @@ This file is part of the iText (R) project.
 import java.util.Arrays;
 import java.util.Collection;
 import java.util.Collections;
-import java.util.Map;
-import java.util.concurrent.ConcurrentHashMap;
+import java.util.Comparator;
+import java.util.SortedMap;
+import java.util.TreeMap;
 
 /**
  * The class that retrieves context of its invocation.
@@ -62,7 +63,7 @@ public class ContextManager {
     private static final long SECURITY_ERROR_LOGGING_INTERVAL = 60000;
     private volatile long securityErrorLastLogged = 0;
 
-    private final Map<String, IContext> contextMappings = new ConcurrentHashMap<>();
+    private final SortedMap<String, IContext> contextMappings = new TreeMap<>(new LengthComparator());
 
     private ContextManager() {
         registerGenericContext(Arrays.asList(
@@ -75,10 +76,17 @@ private ContextManager() {
                 NamespaceConstant.CORE_FORMS,
                 NamespaceConstant.CORE_SXP,
                 NamespaceConstant.CORE_SVG), Collections.singletonList(NamespaceConstant.ITEXT));
-        registerGenericContext(Collections.singletonList(NamespaceConstant.PDF_DEBUG), Collections.singletonList(NamespaceConstant.PDF_DEBUG));
-        registerGenericContext(Collections.singletonList(NamespaceConstant.PDF_HTML), Collections.singletonList(NamespaceConstant.PDF_HTML));
-        registerGenericContext(Collections.singletonList(NamespaceConstant.PDF_INVOICE), Collections.singletonList(NamespaceConstant.PDF_INVOICE));
-        registerGenericContext(Collections.singletonList(NamespaceConstant.PDF_SWEEP), Collections.singletonList(NamespaceConstant.PDF_SWEEP));
+        registerGenericContext(Collections.singletonList(NamespaceConstant.PDF_DEBUG),
+                Collections.singletonList(NamespaceConstant.PDF_DEBUG));
+        registerGenericContext(Collections.singletonList(NamespaceConstant.PDF_HTML),
+                Collections.singletonList(NamespaceConstant.PDF_HTML));
+        registerGenericContext(Collections.singletonList(NamespaceConstant.PDF_INVOICE),
+                Collections.singletonList(NamespaceConstant.PDF_INVOICE));
+        registerGenericContext(Collections.singletonList(NamespaceConstant.PDF_SWEEP),
+                Collections.singletonList(NamespaceConstant.PDF_SWEEP));
+        registerGenericContext(Collections.singletonList(NamespaceConstant.PDF_OCR_TESSERACT4),
+                Collections.singletonList(NamespaceConstant.PDF_OCR_TESSERACT4));
+        registerGenericContext(Collections.singletonList(NamespaceConstant.PDF_OCR), Collections.<String>emptyList());
     }
 
     /**
@@ -112,8 +120,11 @@ public IContext getContext(String className) {
         return getNamespaceMapping(getRecognisedNamespace(className));
     }
 
-    private String getRecognisedNamespace(String className) {
+    String getRecognisedNamespace(String className) {
         if (className != null) {
+            // If both "a" and "a.b" namespaces are registered,
+            // iText should consider the context of "a.b" for an "a.b" event,
+            // that's why the contexts are sorted by the length of the namespace
             for (String namespace : contextMappings.keySet()) {
                 //Conversion to lowercase is done to be compatible with possible changes in case of packages/namespaces
                 if (className.toLowerCase().startsWith(namespace)) {
@@ -138,8 +149,20 @@ private void registerGenericContext(Collection<String> namespaces, Collection<St
             registerContext(namespace.toLowerCase(), context);
         }
     }
-    
+
     private void registerContext(String namespace, IContext context) {
         contextMappings.put(namespace, context);
     }
+
+    private static class LengthComparator implements Comparator<String> {
+        @Override
+        public int compare(String o1, String o2) {
+            int lengthComparison = -Integer.compare(o1.length(), o2.length());
+            if (0 != lengthComparison) {
+                return lengthComparison;
+            } else {
+                return o1.compareTo(o2);
+            }
+        }
+    }
 }

kernel/src/main/java/com/itextpdf/kernel/counter/NamespaceConstant.java

@@ -63,4 +63,6 @@ public class NamespaceConstant {
     public static final String PDF_HTML = ITEXT + ".html2pdf";
     public static final String PDF_INVOICE = ITEXT + ".zugferd";
     public static final String PDF_SWEEP = ITEXT + ".pdfcleanup";
+    public static final String PDF_OCR = ITEXT + ".pdfocr";
+    public static final String PDF_OCR_TESSERACT4 = PDF_OCR + ".tesseract4";
 }

kernel/src/test/java/com/itextpdf/kernel/counter/ContextManagerTest.java

@@ -0,0 +1,77 @@
+/*
+    This file is part of the iText (R) project.
+    Copyright (c) 1998-2020 iText Group NV
+    Authors: iText Software.
+
+    This program is free software; you can redistribute it and/or modify
+    it under the terms of the GNU Affero General Public License version 3
+    as published by the Free Software Foundation with the addition of the
+    following permission added to Section 15 as permitted in Section 7(a):
+    FOR ANY PART OF THE COVERED WORK IN WHICH THE COPYRIGHT IS OWNED BY
+    ITEXT GROUP. ITEXT GROUP DISCLAIMS THE WARRANTY OF NON INFRINGEMENT
+    OF THIRD PARTY RIGHTS
+
+    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 http://www.gnu.org/licenses or write to
+    the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
+    Boston, MA, 02110-1301 USA, or download the license from the following URL:
+    http://itextpdf.com/terms-of-use/
+
+    The interactive user interfaces in modified source and object code versions
+    of this program must display Appropriate Legal Notices, as required under
+    Section 5 of the GNU Affero General Public License.
+
+    In accordance with Section 7(b) of the GNU Affero General Public License,
+    a covered work must retain the producer line in every PDF that is created
+    or manipulated using iText.
+
+    You can be released from the requirements of the license by purchasing
+    a commercial license. Buying such a license is mandatory as soon as you
+    develop commercial activities involving the iText software without
+    disclosing the source code of your own applications.
+    These activities include: offering paid services to customers as an ASP,
+    serving PDFs on the fly in a web application, shipping iText with a closed
+    source product.
+
+    For more information, please contact iText Software Corp. at this
+    address: sales@itextpdf.com
+ */
+package com.itextpdf.kernel.counter;
+
+import com.itextpdf.test.ExtendedITextTest;
+import com.itextpdf.test.annotations.type.UnitTest;
+
+import org.junit.Assert;
+import org.junit.Test;
+import org.junit.experimental.categories.Category;
+
+@Category(UnitTest.class)
+public class ContextManagerTest extends ExtendedITextTest {
+
+    @Test
+    public void getRecognisedNamespaceForSpecificNamespaceTest() {
+        String outerNamespaces = NamespaceConstant.PDF_OCR.toLowerCase();
+        String innerNamespaces = NamespaceConstant.PDF_OCR_TESSERACT4.toLowerCase();
+
+        // Since both NamespaceConstant.PDF_OCR and NamespaceConstant.PDF_OCR_TESSERACT4 are registered
+        // and the latter one begins with the former, we should check that correct namespaces are
+        // recognized for each of them
+        Assert.assertTrue(innerNamespaces.startsWith(outerNamespaces));
+        Assert.assertEquals(outerNamespaces,
+                ContextManager.getInstance().getRecognisedNamespace(outerNamespaces));
+        Assert.assertEquals(innerNamespaces,
+                ContextManager.getInstance().getRecognisedNamespace(innerNamespaces));
+    }
+
+    @Test
+    public void notRegisteredNamespaceTest() {
+        String notRegisteredNamespace = "com.hello.world";
+
+        Assert.assertEquals(null,
+                ContextManager.getInstance().getRecognisedNamespace(notRegisteredNamespace));
+    }
+}