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

Autoported commit.
Original commit hash: [4c1cf0b3a]
Manual files:
kernel/src/main/java/com/itextpdf/kernel/counter/NamespaceConstant.java

Author: ars18wrw

itext.tests/itext.kernel.tests/itext/kernel/counter/ContextManagerTest.cs

@@ -0,0 +1,69 @@
+/*
+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: [email protected]
+*/
+using System;
+using iText.Test;
+
+namespace iText.Kernel.Counter {
+    public class ContextManagerTest : ExtendedITextTest {
+        [NUnit.Framework.Test]
+        public virtual void GetRecognisedNamespaceForSpecificNamespaceTest() {
+            String outerNamespaces = NamespaceConstant.PDF_OCR.ToLowerInvariant();
+            String innerNamespaces = NamespaceConstant.PDF_OCR_TESSERACT4.ToLowerInvariant();
+            // 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
+            NUnit.Framework.Assert.IsTrue(innerNamespaces.StartsWith(outerNamespaces));
+            NUnit.Framework.Assert.AreEqual(outerNamespaces, ContextManager.GetInstance().GetRecognisedNamespace(outerNamespaces
+                ));
+            NUnit.Framework.Assert.AreEqual(innerNamespaces, ContextManager.GetInstance().GetRecognisedNamespace(innerNamespaces
+                ));
+        }
+
+        [NUnit.Framework.Test]
+        public virtual void NotRegisteredNamespaceTest() {
+            String notRegisteredNamespace = "com.hello.world";
+            NUnit.Framework.Assert.AreEqual(null, ContextManager.GetInstance().GetRecognisedNamespace(notRegisteredNamespace
+                ));
+        }
+    }
+}

itext/itext.kernel/itext/kernel/counter/ContextManager.cs

@@ -42,7 +42,6 @@ source product.
 address: [email protected]
 */
 using System;
-using System.Collections.Concurrent;
 using System.Collections.Generic;
 using iText.IO.Util;
 using iText.Kernel.Counter.Context;
@@ -53,8 +52,8 @@ public class ContextManager {
         private static readonly iText.Kernel.Counter.ContextManager instance = new iText.Kernel.Counter.ContextManager
             ();
 
-        private readonly IDictionary<String, IContext> contextMappings = new ConcurrentDictionary<String, IContext
-            >();
+        private readonly SortedDictionary<String, IContext> contextMappings = new SortedDictionary<String, IContext
+            >(new ContextManager.LengthComparator());
 
         private ContextManager() {
             RegisterGenericContext(JavaUtil.ArraysAsList(NamespaceConstant.CORE_IO, NamespaceConstant.CORE_KERNEL, NamespaceConstant
@@ -69,6 +68,10 @@ private ContextManager() {
                 .SingletonList(NamespaceConstant.PDF_INVOICE));
             RegisterGenericContext(JavaCollectionsUtil.SingletonList(NamespaceConstant.PDF_SWEEP), JavaCollectionsUtil
                 .SingletonList(NamespaceConstant.PDF_SWEEP));
+            RegisterGenericContext(JavaCollectionsUtil.SingletonList(NamespaceConstant.PDF_OCR_TESSERACT4), JavaCollectionsUtil
+                .SingletonList(NamespaceConstant.PDF_OCR_TESSERACT4));
+            RegisterGenericContext(JavaCollectionsUtil.SingletonList(NamespaceConstant.PDF_OCR), JavaCollectionsUtil.EmptyList
+                <String>());
         }
 
         /// <summary>Gets the singelton instance of this class</summary>
@@ -115,8 +118,11 @@ public virtual IContext GetContext(String className) {
             return GetNamespaceMapping(GetRecognisedNamespace(className));
         }
 
-        private String GetRecognisedNamespace(String className) {
+        internal virtual 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
                 foreach (String @namespace in contextMappings.Keys) {
                     //Conversion to lowercase is done to be compatible with possible changes in case of packages/namespaces
                     if (className.ToLowerInvariant().StartsWith(@namespace)) {
@@ -145,5 +151,17 @@ private void RegisterGenericContext(ICollection<String> namespaces, ICollection<
         private void RegisterContext(String @namespace, IContext context) {
             contextMappings.Put(@namespace, context);
         }
+
+        private class LengthComparator : IComparer<String> {
+            public virtual int Compare(String o1, String o2) {
+                int lengthComparison = -JavaUtil.IntegerCompare(o1.Length, o2.Length);
+                if (0 != lengthComparison) {
+                    return lengthComparison;
+                }
+                else {
+                    return string.CompareOrdinal(o1, o2);
+                }
+            }
+        }
     }
 }

itext/itext.kernel/itext/kernel/counter/NamespaceConstant.cs

@@ -74,5 +74,9 @@ public class NamespaceConstant {
         public const String PDF_INVOICE = ITEXT + ".Zugferd";
 
         public const String PDF_SWEEP = ITEXT + ".PdfCleanup";
+		
+		public const String PDF_OCR = ITEXT + ".Pdfocr";
+
+        public const String PDF_OCR_TESSERACT4 = PDF_OCR + ".Tesseract4";
     }
 }

port-hash

@@ -1 +1 @@
-2cf618d256e38f483918157a47a9184c98729f4e
+d4a4e3c555d69e0f913dd7cb49c77305a0b2fe0f