[RELEASE] iText 7 pdfHTML - 3.0.0

https://github.com/itext/i7j-pdfhtml/releases/tag/3.0.0

* release/3.0.0:
  [RELEASE] 3.0.0-SNAPSHOT -> 3.0.0
  Revise destination name generation mechanism when building outlines
  Remove redundant throws declarations
  Remove deprecated code
  Remove redundant interface extension for form field classes
  Remove gpl font license
  Add monospace tests
  Adjust page margin fonts tests
  Update misc cmp files
  Update test with special cases
  Update page margin tests
  Changed free fonts to noto fonts. Add NOTICE file
  Remove HTML mode setting in tests
  Enable HTML mode, update cmp files
  Make <page-size> ledger portrait-oriented
  Bump pdfHTML snapshot version to 3.0.0-SNAPSHOT.
  Block pipeline on Java builds only of iText Core
  Fix 'findFiles refers to incorrect path'
  Performance improvements of Jenkins builds
  Remove redundant FORCED_PLACEMENT check.
  Fix upload of jar files to Artifactory
  Add TODO to support link tags processing
  Add a default mode property for a running element
  Deprecate the constant RULE_IS_NOT_SUPPORTED
  Add missing copyright headers
  Support css orphans and widows properties
  Refactor references to deprecated constructor
  Add DEVSIX mention within Ignore
  Revert to typo_ascender scale coefficient usage for Type1Fonts for HTML mode
  Add test for linebox min height for line-height:normal
  Support line-height property and add tests
  Add AlignAttributeTest#imgAttrAlignLeftReadOrderPdfTest
  Add a test which demonstrates an NPE while tagging a button
  Change output formatting
  Add HtmlPageMarginBoxImageSizeTest
  Remove FontSelectorPerformanceTest
  Remove manual test ResourceResolverTest17
  Add missing copyright headers
  Fix minor mistype in WidthDimensionContainer. Add unit test for minContentDimension
  Add missing copyright headers
  Improve logic of creating destination name and update JavaDoc
  [RELEASE] Update dependency versions
  Add missing copyright headers
  Extract an inline constant from FontStyleApplierUtil to a class's final field
  Run package phase for faster Artifactory deploy
  Add OWASP dependency check
  Run non-test phases of the Maven lifecycle multithreaded
  Replace Findbugs with Spotbugs
  Refactor nested if to switch in Pipeline

Author: iText-CI

Jenkinsfile

@@ -1,24 +1,30 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
   <modelVersion>4.0.0</modelVersion>
+
   <parent>
     <groupId>com.itextpdf</groupId>
     <artifactId>root</artifactId>
-    <version>7.1.10</version>
+    <version>7.1.11</version>
     <relativePath/>
   </parent>
+
   <artifactId>html2pdf</artifactId>
-  <version>2.1.7</version>
+  <version>3.0.0</version>
+
   <name>pdfHTML</name>
   <description>pdfHTML is an iText 7 add-on that lets you to parse (X)HTML snippets and the associated CSS and converts
     them to PDF.</description>
+
   <scm>
     <connection>scm:git:ssh://[email protected]:7999/i7j/html2pdf.git</connection>
     <url>https://git.itextsupport.com/projects/I7J/repos/html2pdf</url>
   </scm>
+
   <properties>
     <itext.version>${project.parent.version}</itext.version>
   </properties>
+
   <repositories>
     <repository>
       <snapshots>
@@ -37,6 +43,7 @@
       <url>https://repo.itextsupport.com/releases</url>
     </repository>
   </repositories>
+
   <dependencies>
     <dependency>
       <groupId>com.itextpdf</groupId>
@@ -72,6 +79,7 @@
       <scope>test</scope>
     </dependency>
   </dependencies>
+
   <build>
     <resources>
       <resource>
@@ -90,25 +98,7 @@
     </resources>
     <plugins>
       <plugin>
-        <groupId>external.atlassian.jgitflow</groupId>
-        <artifactId>jgitflow-maven-plugin</artifactId>
-        <version>1.0-m5.1</version>
-      </plugin>
-      <plugin>
-        <groupId>org.apache.maven.plugins</groupId>
-        <artifactId>maven-failsafe-plugin</artifactId>
-        <version>${failsafe.version}</version>
-        <configuration>
-          <includes>
-            <include>**/*.java</include>
-          </includes>
-          <groups>${integrationtests}</groups>
-        </configuration>
-      </plugin>
-      <plugin>
-        <groupId>org.apache.maven.plugins</groupId>
         <artifactId>maven-javadoc-plugin</artifactId>
-        <version>${javadoc.version}</version>
         <configuration>
           <sourceFileExcludes>
             <sourceFileExclude>com/itextpdf/html2pdf/attach/impl/layout/BodyHtmlStylesContainer.java</sourceFileExclude>
@@ -124,30 +114,6 @@
           </groups>
         </configuration>
       </plugin>
-      <plugin>
-        <groupId>org.apache.maven.plugins</groupId>
-        <artifactId>maven-surefire-plugin</artifactId>
-        <version>${surefire.version}</version>
-        <configuration>
-          <groups>${unittests}</groups>
-        </configuration>
-      </plugin>
-      <plugin>
-        <groupId>org.pitest</groupId>
-        <artifactId>pitest-maven</artifactId>
-        <version>1.1.11</version>
-        <configuration>
-          <skip>true</skip>
-        </configuration>
-      </plugin>
-      <plugin>
-        <groupId>org.revapi</groupId>
-        <artifactId>revapi-maven-plugin</artifactId>
-        <version>0.8.2</version>
-        <configuration>
-          <skip>true</skip>
-        </configuration>
-      </plugin>
     </plugins>
   </build>
 </project>

pom.xml

@@ -53,8 +53,8 @@ public class Html2PdfProductInfo {
     public static final String PRODUCT_NAME = "pdfHtml";
 
     /** The major version number. */
-    public static final int MAJOR_VERSION = 2;
+    public static final int MAJOR_VERSION = 3;
 
     /** The minor version number. */
-    public static final int MINOR_VERSION = 1;
+    public static final int MINOR_VERSION = 0;
 }

src/main/java/com/itextpdf/html2pdf/Html2PdfProductInfo.java

@@ -46,16 +46,13 @@ This file is part of the iText (R) project.
 import com.itextpdf.html2pdf.attach.Attacher;
 import com.itextpdf.html2pdf.exception.Html2PdfException;
 import com.itextpdf.io.util.FileUtil;
+import com.itextpdf.kernel.Version;
 import com.itextpdf.kernel.counter.event.IMetaInfo;
 import com.itextpdf.kernel.pdf.DocumentProperties;
 import com.itextpdf.kernel.pdf.PdfDocument;
 import com.itextpdf.kernel.pdf.PdfWriter;
 import com.itextpdf.layout.Document;
 import com.itextpdf.layout.element.IElement;
-import java.lang.reflect.Array;
-import java.lang.reflect.Constructor;
-import java.lang.reflect.Method;
-import com.itextpdf.kernel.Version;
 import com.itextpdf.styledxmlparser.IXmlParser;
 import com.itextpdf.styledxmlparser.node.IDocumentNode;
 import com.itextpdf.styledxmlparser.node.impl.jsoup.JsoupHtmlParser;
@@ -66,6 +63,9 @@ This file is part of the iText (R) project.
 import java.io.IOException;
 import java.io.InputStream;
 import java.io.OutputStream;
+import java.lang.reflect.Array;
+import java.lang.reflect.Constructor;
+import java.lang.reflect.Method;
 import java.util.List;
 
 /**
@@ -92,9 +92,8 @@ private HtmlConverter() {
      *
      * @param html the html in the form of a {@link String}
      * @param pdfStream the PDF as an {@link OutputStream}
-     * @throws IOException Signals that an I/O exception has occurred.
      */
-    public static void convertToPdf(String html, OutputStream pdfStream) throws IOException {
+    public static void convertToPdf(String html, OutputStream pdfStream) {
         convertToPdf(html, pdfStream, null);
     }
 
@@ -105,9 +104,8 @@ public static void convertToPdf(String html, OutputStream pdfStream) throws IOEx
      * @param html the html in the form of a {@link String}
      * @param pdfStream the PDF as an {@link OutputStream}
      * @param converterProperties a {@link ConverterProperties} instance
-     * @throws IOException Signals that an I/O exception has occurred.
      */
-    public static void convertToPdf(String html, OutputStream pdfStream, ConverterProperties converterProperties) throws IOException {
+    public static void convertToPdf(String html, OutputStream pdfStream, ConverterProperties converterProperties) {
         convertToPdf(html, new PdfWriter(pdfStream), converterProperties);
     }
 
@@ -117,9 +115,8 @@ public static void convertToPdf(String html, OutputStream pdfStream, ConverterPr
      *
      * @param html the html in the form of a {@link String}
      * @param pdfWriter the {@link PdfWriter} instance
-     * @throws IOException Signals that an I/O exception has occurred.
      */
-    public static void convertToPdf(String html, PdfWriter pdfWriter) throws IOException {
+    public static void convertToPdf(String html, PdfWriter pdfWriter) {
         convertToPdf(html, pdfWriter, null);
     }
 
@@ -130,9 +127,8 @@ public static void convertToPdf(String html, PdfWriter pdfWriter) throws IOExcep
      * @param html the html in the form of a {@link String}
      * @param pdfWriter the {@link PdfWriter} instance
      * @param converterProperties a {@link ConverterProperties} instance
-     * @throws IOException Signals that an I/O exception has occurred.
      */
-    public static void convertToPdf(String html, PdfWriter pdfWriter, ConverterProperties converterProperties) throws IOException {
+    public static void convertToPdf(String html, PdfWriter pdfWriter, ConverterProperties converterProperties) {
         convertToPdf(html, new PdfDocument(pdfWriter, new DocumentProperties().setEventCountingMetaInfo(new HtmlMetaInfo())), converterProperties);
     }
 
@@ -143,9 +139,8 @@ public static void convertToPdf(String html, PdfWriter pdfWriter, ConverterPrope
      * @param html the html in the form of a {@link String}
      * @param pdfDocument the {@link PdfDocument} instance
      * @param converterProperties a {@link ConverterProperties} instance
-     * @throws IOException Signals that an I/O exception has occurred.
      */
-    public static void convertToPdf(String html, PdfDocument pdfDocument, ConverterProperties converterProperties) throws IOException {
+    public static void convertToPdf(String html, PdfDocument pdfDocument, ConverterProperties converterProperties) {
         Document document = convertToDocument(html, pdfDocument, converterProperties);
         document.close();
     }
@@ -268,9 +263,8 @@ public static void convertToPdf(InputStream htmlStream, PdfDocument pdfDocument,
      * @param html the html in the form of a {@link String}
      * @param pdfWriter the {@link PdfWriter} containing the resulting PDF
      * @return a {@link Document} instance
-     * @throws IOException Signals that an I/O exception has occurred.
      */
-    public static Document convertToDocument(String html, PdfWriter pdfWriter) throws IOException {
+    public static Document convertToDocument(String html, PdfWriter pdfWriter) {
         return convertToDocument(html, pdfWriter, null);
     }
 
@@ -296,9 +290,8 @@ public static Document convertToDocument(InputStream htmlStream, PdfWriter pdfWr
      * @param pdfWriter the pdf writer
      * @param converterProperties a {@link ConverterProperties} instance
      * @return a {@link Document} instance
-     * @throws IOException Signals that an I/O exception has occurred.
      */
-    public static Document convertToDocument(String html, PdfWriter pdfWriter, ConverterProperties converterProperties) throws IOException {
+    public static Document convertToDocument(String html, PdfWriter pdfWriter, ConverterProperties converterProperties) {
         return convertToDocument(html, new PdfDocument(pdfWriter), converterProperties);
     }
 
@@ -326,9 +319,8 @@ public static Document convertToDocument(InputStream htmlStream, PdfWriter pdfWr
      * @param pdfDocument the {@link PdfDocument} instance
      * @param converterProperties a {@link ConverterProperties} instance
      * @return a {@link Document} instance
-     * @throws IOException Signals that an I/O exception has occurred.
      */
-    public static Document convertToDocument(String html, PdfDocument pdfDocument, ConverterProperties converterProperties) throws IOException {
+    public static Document convertToDocument(String html, PdfDocument pdfDocument, ConverterProperties converterProperties) {
         String licenseKeyClassName = "com.itextpdf.licensekey.LicenseKey";
         String licenseKeyProductClassName = "com.itextpdf.licensekey.LicenseKeyProduct";
         String licenseKeyFeatureClassName = "com.itextpdf.licensekey.LicenseKeyProductFeature";
@@ -435,9 +427,8 @@ public static Document convertToDocument(InputStream htmlStream, PdfDocument pdf
      *
      * @param html the html in the form of a {@link String}
      * @return a list of iText building blocks
-     * @throws IOException Signals that an I/O exception has occurred.
      */
-    public static List<IElement> convertToElements(String html) throws IOException {
+    public static List<IElement> convertToElements(String html) {
         return convertToElements(html, null);
     }
 
@@ -461,9 +452,8 @@ public static List<IElement> convertToElements(InputStream htmlStream) throws IO
      * @param html the html in the form of a {@link String}
      * @param converterProperties a {@link ConverterProperties} instance
      * @return a list of iText building blocks
-     * @throws IOException Signals that an I/O exception has occurred.
      */
-    public static List<IElement> convertToElements(String html, ConverterProperties converterProperties) throws IOException {
+    public static List<IElement> convertToElements(String html, ConverterProperties converterProperties) {
         String licenseKeyClassName = "com.itextpdf.licensekey.LicenseKey";
         String licenseKeyProductClassName = "com.itextpdf.licensekey.LicenseKeyProduct";
         String licenseKeyFeatureClassName = "com.itextpdf.licensekey.LicenseKeyProductFeature";

src/main/java/com/itextpdf/html2pdf/HtmlConverter.java

@@ -65,14 +65,8 @@ public final class LogMessageConstant {
     public static final String ERROR_WHILE_LAYOUT_OF_FORM_FIELD = "Cannot layout form field field. It won't be displayed";
     /** The Constant ERROR_WHILE_LAYOUT_OF_FORM_FIELD_WITH_TYPE. */
     public static final String ERROR_WHILE_LAYOUT_OF_FORM_FIELD_WITH_TYPE = "Error during layout of form filed with type {0}.";
-    /** The Constant HEIGHT_VALUE_IN_PERCENT_NOT_SUPPORTED. */
-    @Deprecated
-    public static final String HEIGHT_VALUE_IN_PERCENT_NOT_SUPPORTED = "Height value in percent not supported";
     /** The Constant INPUT_FIELD_DOES_NOT_FIT. */
     public static final String INPUT_FIELD_DOES_NOT_FIT = "Input field doesn't fit in outer object. It will be clipped";
-    /** The Constant INPUT_SUPPORTS_ONLY_POINT_WIDTH. */
-    @Deprecated
-    public static final String INPUT_SUPPORTS_ONLY_POINT_WIDTH = "Input field supports only point width";
     /** The Constant INPUT_TYPE_IS_INVALID. */
     public static final String INPUT_TYPE_IS_INVALID = "Input type {0} is invalid. The default text type will be used instead.";
     /** The Constant INPUT_TYPE_IS_NOT_SUPPORTED. */
@@ -103,22 +97,14 @@ public final class LogMessageConstant {
     public static final String PDF_DOCUMENT_NOT_PRESENT = "PdfDocument is not present";
     /** The Constant QUOTES_PROPERTY_INVALID. */
     public static final String QUOTES_PROPERTY_INVALID = "Quote property \"{0}\" is invalid. It should contain even number of <string> values.";
-    /** The Constant RULE_IS_NOT_SUPPORTED. */
-    public static final String RULE_IS_NOT_SUPPORTED = "The rule @{0} is unsupported. All selectors in this rule will be ignored.";
     /** The Constant TEXT_DECORATION_BLINK_NOT_SUPPORTED. */
     public static final String TEXT_DECORATION_BLINK_NOT_SUPPORTED = "text-decoration: blink not supported";
-    /** The Constant TEXT_WAS_NOT_PROCESSED. */
-    @Deprecated
-    public static final String TEXT_WAS_NOT_PROCESSED = "Text was not processed: {0}";
     /** The Constant UNABLE_TO_PROCESS_EXTERNAL_CSS_FILE. */
     public static final String UNABLE_TO_PROCESS_EXTERNAL_CSS_FILE = "Unable to process external css file";
     /** The Constant UNABLE_TO_PROCESS_IMAGE_AS_SVG */
     public static final String UNABLE_TO_PROCESS_IMAGE_AS_SVG = "Unable to process image found at {0} as an SVG";
     /** The Constant UNABLE_TO_RESOLVE_COUNTER. */
     public static final String UNABLE_TO_RESOLVE_COUNTER = "Unable to resolve counter \"{0}\"";
-    /** The Constant UNABLE_TO_RESOLVE_FONT. */
-    @Deprecated
-    public static final String UNABLE_TO_RESOLVE_FONT = "Unable to resolve font: {0}. The default one will be used instead";
     /** The Constant UNABLE_TO_RETRIEVE_FONT. */
     public static final String UNABLE_TO_RETRIEVE_FONT = "Unable to retrieve font:\n {0}";
     /** The Constant UNABLE_TO_RETRIEVE_IMAGE_WITH_GIVEN_BASE_URI. */

src/main/java/com/itextpdf/html2pdf/LogMessageConstant.java

@@ -71,9 +71,11 @@ This file is part of the iText (R) project.
 import com.itextpdf.layout.Document;
 import com.itextpdf.layout.IPropertyContainer;
 import com.itextpdf.layout.element.Div;
+import com.itextpdf.layout.font.FontFamilySplitter;
 import com.itextpdf.layout.font.FontInfo;
 import com.itextpdf.layout.font.Range;
 import com.itextpdf.layout.property.Property;
+import com.itextpdf.layout.property.RenderingMode;
 import com.itextpdf.styledxmlparser.css.CssDeclaration;
 import com.itextpdf.styledxmlparser.css.CssFontFaceRule;
 import com.itextpdf.styledxmlparser.css.ICssResolver;
@@ -83,6 +85,8 @@ This file is part of the iText (R) project.
 import com.itextpdf.styledxmlparser.node.IElementNode;
 import com.itextpdf.styledxmlparser.node.INode;
 import com.itextpdf.styledxmlparser.node.ITextNode;
+
+import java.util.Map;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
@@ -163,6 +167,29 @@ public DefaultHtmlProcessor(ConverterProperties converterProperties) {
         this.context = new ProcessorContext(converterProperties);
     }
 
+    /**
+     * Sets properties to top-level layout elements converted from HTML.
+     * This enables features set by user via HTML converter API and also changes properties defaults
+     * to the ones specific to HTML-like behavior.
+     * @param cssProperties HTML document-level css properties.
+     * @param context processor context specific to the current HTML conversion.
+     * @param propertyContainer top-level layout element converted from HTML.
+     */
+    public static void setConvertedRootElementProperties(Map<String, String> cssProperties, ProcessorContext context, IPropertyContainer propertyContainer) {
+        propertyContainer.setProperty(Property.COLLAPSING_MARGINS, true);
+        propertyContainer.setProperty(Property.RENDERING_MODE, RenderingMode.HTML_MODE);
+        propertyContainer.setProperty(Property.FONT_PROVIDER, context.getFontProvider());
+        if (context.getTempFonts() != null) {
+            propertyContainer.setProperty(Property.FONT_SET, context.getTempFonts());
+        }
+
+        // TODO DEVSIX-2534
+        List<String> fontFamilies = FontFamilySplitter.splitFontFamily(cssProperties.get(CssConstants.FONT_FAMILY));
+        if (fontFamilies != null && !propertyContainer.hasOwnProperty(Property.FONT)) {
+            propertyContainer.setProperty(Property.FONT, fontFamilies.toArray(new String[0]));
+        }
+    }
+
     /* (non-Javadoc)
      * @see com.itextpdf.html2pdf.attach.IHtmlProcessor#processElements(com.itextpdf.html2pdf.html.node.INode)
      */
@@ -220,13 +247,11 @@ public List<com.itextpdf.layout.element.IElement> processElements(INode root) {
 
         Div bodyDiv = (Div) roots.get(0);
         List<com.itextpdf.layout.element.IElement> elements = new ArrayList<>();
+        // re-resolve body element styles in order to use them in top-level elements properties setting
+        body.setStyles(cssResolver.resolveStyles(body, context.getCssContext()));
         for (IPropertyContainer propertyContainer : bodyDiv.getChildren()) {
             if (propertyContainer instanceof com.itextpdf.layout.element.IElement) {
-                propertyContainer.setProperty(Property.COLLAPSING_MARGINS, true);
-                propertyContainer.setProperty(Property.FONT_PROVIDER, context.getFontProvider());
-                if (context.getTempFonts() != null) {
-                    propertyContainer.setProperty(Property.FONT_SET, context.getTempFonts());
-                }
+                setConvertedRootElementProperties(body.getStyles(), context, propertyContainer);
                 elements.add((com.itextpdf.layout.element.IElement) propertyContainer);
             }
         }
@@ -325,7 +350,7 @@ private void visit(INode node) {
                 ((HtmlTagWorker) tagWorker).processPageRules(node, cssResolver, context);
             }
 
-            context.getOutlineHandler().addOutline(tagWorker, element, context);
+            context.getOutlineHandler().addOutlineAndDestToDocument(tagWorker, element, context);
 
 
             visitPseudoElement(element, tagWorker, CssConstants.BEFORE);
@@ -342,7 +367,7 @@ private void visit(INode node) {
             if (tagWorker != null) {
                 tagWorker.processEnd(element, context);
                 LinkHelper.createDestination(tagWorker, element, context);
-                context.getOutlineHandler().addDestination(tagWorker, element);
+                context.getOutlineHandler().setDestinationToElement(tagWorker, element);
                 context.getState().pop();
 
                 if (!TagConstants.BODY.equals(element.name()) && !TagConstants.HTML.equals(element.name()))