Fix anchor links handling with destinations on elements handled by SpanTagWorker

yulian-gaponenko · iText-CI · commit 7b53a5094b76 · 2019-04-05T07:11:34.000+02:00
DEVSIX-2774

Autoported commit.
Original commit hash: [55c40116]
diff --git a/itext.tests/itext.html2pdf.tests/itext/html2pdf/element/LinkTest.cs b/itext.tests/itext.html2pdf.tests/itext/html2pdf/element/LinkTest.cs
@@ -204,5 +204,16 @@ public virtual void LinkTest12() {
             NUnit.Framework.Assert.IsNull(new CompareTool().CompareByContent(destinationFolder + "linkTest12.pdf", sourceFolder
                  + "cmp_linkTest12.pdf", destinationFolder, "diff12_"));
         }
+
+        /// <exception cref="System.IO.IOException"/>
+        /// <exception cref="System.Exception"/>
+        [NUnit.Framework.Test]
+        public virtual void AnchorLinkToSpanTest01() {
+            String fileName = "anchorLinkToSpanTest01";
+            HtmlConverter.ConvertToPdf(new FileInfo(sourceFolder + fileName + ".html"), new FileInfo(destinationFolder
+                 + fileName + ".pdf"));
+            NUnit.Framework.Assert.IsNull(new CompareTool().CompareByContent(destinationFolder + fileName + ".pdf", sourceFolder
+                 + "cmp_" + fileName + ".pdf", destinationFolder));
+        }
     }
 }
diff --git a/itext.tests/itext.html2pdf.tests/resources/itext/html2pdf/element/LinkTest/anchorLinkToSpanTest01.html b/itext.tests/itext.html2pdf.tests/resources/itext/html2pdf/element/LinkTest/anchorLinkToSpanTest01.html
@@ -0,0 +1,13 @@
+<html>
+<body>
+
+<a id="main_q" href="#Welsh_Corgi">Who's a good boy?</a>
+<p style="page-break-before: always;">
+	<span id="Welsh_Corgi">corgi</span>
+	<a href="#main_q">Back to main question!</a>
+</p>
+
+
+</body>
+</html>
+
diff --git a/itext.tests/itext.html2pdf.tests/resources/itext/html2pdf/element/LinkTest/cmp_anchorLinkToSpanTest01.pdf b/itext.tests/itext.html2pdf.tests/resources/itext/html2pdf/element/LinkTest/cmp_anchorLinkToSpanTest01.pdf
diff --git a/itext/itext.html2pdf/itext/html2pdf/LogMessageConstant.cs b/itext/itext.html2pdf/itext/html2pdf/LogMessageConstant.cs
@@ -48,6 +48,8 @@ public sealed class LogMessageConstant {
         /// <summary>The Constant ACROFORM_NOT_SUPPORTED_FOR_SELECT.</summary>
         public const String ACROFORM_NOT_SUPPORTED_FOR_SELECT = "AcroForm fields creation for select fields (ComboBoxField and ListBoxField) is not supported. They will be flattened instead.";
 
+        public const String ANCHOR_LINK_NOT_HANDLED = "The anchor link was not handled. Could not create a destination for element \"{0}\" with ID \"{1}\", which is processed by \"{2}\" tag worker class.";
+
         /// <summary>The Constant CONTENT_PROPERTY_INVALID.</summary>
         public const String CONTENT_PROPERTY_INVALID = "Content property \"{0}\" is either invalid or uses unsupported function.";
 
diff --git a/itext/itext.html2pdf/itext/html2pdf/attach/impl/LinkContext.cs b/itext/itext.html2pdf/itext/html2pdf/attach/impl/LinkContext.cs
@@ -78,10 +78,12 @@ public virtual iText.Html2pdf.Attach.Impl.LinkContext ScanForIds(INode root) {
             while (!stk.IsEmpty()) {
                 INode n = stk.Pop();
                 if (n is IElementNode) {
-                    IElementNode n2 = (IElementNode)n;
-                    if (n2.Name().Equals(AttributeConstants.a) && n2.GetAttribute(AttributeConstants.HREF) != null && n2.GetAttribute
-                        (AttributeConstants.HREF).StartsWith("#")) {
-                        linkDestinations.Add(n2.GetAttribute(AttributeConstants.HREF).Substring(1));
+                    IElementNode elem = (IElementNode)n;
+                    if (TagConstants.A.Equals(elem.Name())) {
+                        String href = elem.GetAttribute(AttributeConstants.HREF);
+                        if (href != null && href.StartsWith("#")) {
+                            linkDestinations.Add(href.Substring(1));
+                        }
                     }
                 }
                 if (!n.ChildNodes().IsEmpty()) {
diff --git a/itext/itext.html2pdf/itext/html2pdf/attach/util/LinkHelper.cs b/itext/itext.html2pdf/itext/html2pdf/attach/util/LinkHelper.cs
@@ -41,8 +41,12 @@ source product.
 address: sales@itextpdf.com
 */
 using System;
+using System.Collections.Generic;
+using Common.Logging;
 using iText.Html2pdf.Attach;
+using iText.Html2pdf.Attach.Impl.Tags;
 using iText.Html2pdf.Html;
+using iText.IO.Util;
 using iText.Kernel.Geom;
 using iText.Kernel.Pdf;
 using iText.Kernel.Pdf.Action;
@@ -93,22 +97,33 @@ public static void ApplyLinkAnnotation(IPropertyContainer container, String url)
         /// <param name="element">the (HTML) element being converted</param>
         /// <param name="context">the Processor context</param>
         public static void CreateDestination(ITagWorker tagWorker, IElementNode element, ProcessorContext context) {
-            if (element.GetAttribute(AttributeConstants.ID) == null) {
+            String id = element.GetAttribute(AttributeConstants.ID);
+            if (id == null) {
                 return;
             }
-            if (tagWorker == null) {
+            if (!context.GetLinkContext().IsUsedLinkDestination(id)) {
                 return;
             }
-            IPropertyContainer propertyContainer = tagWorker.GetElementResult();
+            IPropertyContainer propertyContainer = null;
+            if (tagWorker != null) {
+                if (tagWorker is SpanTagWorker) {
+                    IList<IPropertyContainer> spanElements = ((SpanTagWorker)tagWorker).GetAllElements();
+                    if (!spanElements.IsEmpty()) {
+                        propertyContainer = spanElements[0];
+                    }
+                }
+                else {
+                    propertyContainer = tagWorker.GetElementResult();
+                }
+            }
             if (propertyContainer == null) {
+                ILog logger = LogManager.GetLogger(typeof(iText.Html2pdf.Attach.Util.LinkHelper));
+                String tagWorkerClassName = tagWorker != null ? tagWorker.GetType().FullName : "null";
+                logger.Warn(MessageFormatUtil.Format(iText.Html2pdf.LogMessageConstant.ANCHOR_LINK_NOT_HANDLED, element.Name
+                    (), id, tagWorkerClassName));
                 return;
             }
-            // get id
-            String id = element.GetAttribute(AttributeConstants.ID);
-            // set property
-            if (context.GetLinkContext().IsUsedLinkDestination(id)) {
-                propertyContainer.SetProperty(Property.DESTINATION, id);
-            }
+            propertyContainer.SetProperty(Property.DESTINATION, id);
         }
     }
 }
diff --git a/port-hash b/port-hash
@@ -1 +1 @@
-db4b9714d85f18a7ee4c20693455b9dbb266f27d
+55c40116085862a958782d9d94e070c88e27f2f6

Original file line number	Diff line number	Diff line change
`@@ -204,5 +204,16 @@ public virtual void LinkTest12() {`
`204`	`204`	`NUnit.Framework.Assert.IsNull(new CompareTool().CompareByContent(destinationFolder + "linkTest12.pdf", sourceFolder`
`205`	`205`	`+ "cmp_linkTest12.pdf", destinationFolder, "diff12_"));`
`206`	`206`	`}`
	`207`	`+`
	`208`	`+ /// <exception cref="System.IO.IOException"/>`
	`209`	`+ /// <exception cref="System.Exception"/>`
	`210`	`+ [NUnit.Framework.Test]`
	`211`	`+ public virtual void AnchorLinkToSpanTest01() {`
	`212`	`+ String fileName = "anchorLinkToSpanTest01";`
	`213`	`+ HtmlConverter.ConvertToPdf(new FileInfo(sourceFolder + fileName + ".html"), new FileInfo(destinationFolder`
	`214`	`+ + fileName + ".pdf"));`
	`215`	`+ NUnit.Framework.Assert.IsNull(new CompareTool().CompareByContent(destinationFolder + fileName + ".pdf", sourceFolder`
	`216`	`+ + "cmp_" + fileName + ".pdf", destinationFolder));`
	`217`	`+ }`
`207`	`218`	`}`
`208`	`219`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		`-db4b9714d85f18a7ee4c20693455b9dbb266f27d`
	`1`	`+55c40116085862a958782d9d94e070c88e27f2f6`