Support event meta info

DEVSIX-1958

Author: IdamkinI

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

@@ -47,6 +47,7 @@ This file is part of the iText (R) project.
 import com.itextpdf.html2pdf.attach.impl.OutlineHandler;
 import com.itextpdf.html2pdf.css.apply.ICssApplierFactory;
 import com.itextpdf.html2pdf.css.media.MediaDeviceDescription;
+import com.itextpdf.kernel.counter.event.IMetaInfo;
 import com.itextpdf.layout.font.FontProvider;
 
 /**
@@ -81,6 +82,9 @@ public class ConverterProperties {
     /** Indicates whether the document should be opened in immediate flush or not **/
     private boolean immediateFlush = true;
 
+    /** Meta info that will be added to the events thrown by html2Pdf */
+    private IMetaInfo metaInfo;
+
     /**
      * Instantiates a new {@link ConverterProperties} instance.
      */
@@ -102,6 +106,7 @@ public ConverterProperties(ConverterProperties other) {
         this.createAcroForm = other.createAcroForm;
         this.outlineHandler = other.outlineHandler;
         this.charset = other.charset;
+        this.metaInfo = other.metaInfo;
     }
 
     /**
@@ -289,4 +294,26 @@ public ConverterProperties setImmediateFlush(boolean immediateFlush){
         this.immediateFlush = immediateFlush;
         return this;
     }
+
+    /**
+     * Gets html meta info. This meta info will be passed with to {@link com.itextpdf.kernel.counter.EventCounter}
+     * with {@link com.itextpdf.html2pdf.events.PdfHtmlEvent} and can be used to determine event origin.
+     *
+     * @return converter's {@link IMetaInfo}
+     */
+    public IMetaInfo getEventCountingMetaInfo() {
+        return metaInfo;
+    }
+
+    /**
+     * Sets html meta info. This meta info will be passed with to {@link com.itextpdf.kernel.counter.EventCounter}
+     * with {@link com.itextpdf.html2pdf.events.PdfHtmlEvent} and can be used to determine event origin.
+     *
+     * @param metaInfo meta info to set
+     * @return this {@link ConverterProperties} instance
+     */
+    public ConverterProperties setEventCountingMetaInfo(IMetaInfo metaInfo) {
+        this.metaInfo = metaInfo;
+        return this;
+    }
 }

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

@@ -49,6 +49,8 @@ This file is part of the iText (R) project.
 import com.itextpdf.html2pdf.html.impl.jsoup.JsoupHtmlParser;
 import com.itextpdf.html2pdf.html.node.IDocumentNode;
 import com.itextpdf.io.util.FileUtil;
+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;
@@ -132,7 +134,7 @@ public static void convertToPdf(String html, PdfWriter pdfWriter) throws IOExcep
      * @throws IOException Signals that an I/O exception has occurred.
      */
     public static void convertToPdf(String html, PdfWriter pdfWriter, ConverterProperties converterProperties) throws IOException {
-        convertToPdf(html, new PdfDocument(pdfWriter), converterProperties);
+        convertToPdf(html, new PdfDocument(pdfWriter, new DocumentProperties().setEventCountingMetaInfo(new HtmlMetaInfo())), converterProperties);
     }
 
     /**
@@ -227,7 +229,7 @@ public static void convertToPdf(InputStream htmlStream, PdfDocument pdfDocument)
      * @throws IOException Signals that an I/O exception has occurred.
      */
     public static void convertToPdf(InputStream htmlStream, PdfWriter pdfWriter) throws IOException {
-        convertToPdf(htmlStream, new PdfDocument(pdfWriter));
+        convertToPdf(htmlStream, new PdfDocument(pdfWriter, new DocumentProperties().setEventCountingMetaInfo(new HtmlMetaInfo())));
     }
 
     /**
@@ -241,7 +243,7 @@ public static void convertToPdf(InputStream htmlStream, PdfWriter pdfWriter) thr
      * @throws IOException Signals that an I/O exception has occurred.
      */
     public static void convertToPdf(InputStream htmlStream, PdfWriter pdfWriter, ConverterProperties converterProperties) throws IOException {
-        convertToPdf(htmlStream, new PdfDocument(pdfWriter), converterProperties);
+        convertToPdf(htmlStream, new PdfDocument(pdfWriter, new DocumentProperties().setEventCountingMetaInfo(new HtmlMetaInfo())), converterProperties);
     }
 
     /**
@@ -553,4 +555,9 @@ public static List<IElement> convertToElements(InputStream htmlStream, Converter
         IDocumentNode doc = parser.parse(htmlStream, converterProperties != null ? converterProperties.getCharset() : null);
         return Attacher.attach(doc, converterProperties);
     }
+
+    private static class HtmlMetaInfo implements IMetaInfo {
+
+        private static final long serialVersionUID = -295587336698550627L;
+    }
 }

src/main/java/com/itextpdf/html2pdf/attach/ProcessorContext.java

@@ -55,6 +55,7 @@ This file is part of the iText (R) project.
 import com.itextpdf.html2pdf.resolver.form.RadioCheckResolver;
 import com.itextpdf.html2pdf.resolver.resource.ResourceResolver;
 import com.itextpdf.io.font.FontProgram;
+import com.itextpdf.kernel.counter.event.IMetaInfo;
 import com.itextpdf.kernel.pdf.PdfDocument;
 import com.itextpdf.layout.font.FontInfo;
 import com.itextpdf.layout.font.FontProvider;
@@ -115,6 +116,9 @@ public class ProcessorContext {
     /** The PDF document. */
     private PdfDocument pdfDocument;
 
+    /** The Processor meta info */
+    private IMetaInfo metaInfo;
+
     /**
      * Instantiates a new {@link ProcessorContext} instance.
      *
@@ -165,6 +169,7 @@ public ProcessorContext(ConverterProperties converterProperties) {
         formFieldNameResolver = new FormFieldNameResolver();
         radioCheckResolver = new RadioCheckResolver();
         immediateFlush = converterProperties.isImmediateFlush();
+        metaInfo = converterProperties.getEventCountingMetaInfo();
     }
 
     /**
@@ -381,4 +386,14 @@ public String getBaseUri(){
     public boolean isImmediateFlush(){
         return immediateFlush;
     }
+
+    /**
+     * Gets html meta info. This meta info will be passed with to {@link com.itextpdf.kernel.counter.EventCounter}
+     * with {@link com.itextpdf.html2pdf.events.PdfHtmlEvent} and can be used to determine event origin.
+     *
+     * @return html meta info
+     */
+    public IMetaInfo getEventCountingMetaInfo() {
+        return metaInfo;
+    }
 }

src/main/java/com/itextpdf/html2pdf/attach/impl/DefaultHtmlProcessor.java

@@ -229,7 +229,7 @@ public List<com.itextpdf.layout.element.IElement> processElements(INode root) {
         }
         cssResolver = null;
         roots = null;
-        EventCounterHandler.getInstance().onEvent(PdfHtmlEvent.CONVERT, getClass());
+        EventCounterHandler.getInstance().onEvent(PdfHtmlEvent.CONVERT, context.getEventCountingMetaInfo(), getClass());
         return elements;
     }
 
@@ -293,7 +293,7 @@ public Document processDocument(INode root, PdfDocument pdfDocument) {
         }
         cssResolver = null;
         roots = null;
-        EventCounterHandler.getInstance().onEvent(PdfHtmlEvent.CONVERT, getClass());
+        EventCounterHandler.getInstance().onEvent(PdfHtmlEvent.CONVERT, context.getEventCountingMetaInfo(), getClass());
         return doc;
     }