com.itextpdf.html2pdf.HtmlConverter Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of html2pdf Show documentation
Show all versions of html2pdf Show documentation
pdfHTML is an iText add-on that lets you to parse (X)HTML snippets and the associated CSS and converts
them to PDF.
/*
This file is part of the iText (R) project.
Copyright (c) 1998-2018 iText Group NV
Authors: Bruno Lowagie, Paulo Soares, et al.
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]
*/
package com.itextpdf.html2pdf;
import com.itextpdf.html2pdf.attach.Attacher;
import com.itextpdf.html2pdf.exception.Html2PdfException;
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;
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;
import java.io.File;
import java.io.FileInputStream;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
import java.nio.file.Paths;
import java.util.List;
/**
* The HtmlConverter is the class you will use most when converting HTML to PDF.
* It contains a series of static methods that accept HTML as a {@link String},
* {@link File}, or {@link InputStream}, and convert it to PDF in the
* form of an {@link OutputStream}, {@link File}, or a series of
* iText elements. It's also possible to write to a {@link PdfWriter} or
* {@link PdfDocument} instance.
*/
public class HtmlConverter {
/**
* Instantiates a new HtmlConverter instance.
*/
private HtmlConverter() {
}
// TODO add overloads without automatic elements flushing
/**
* Converts a {@link String} containing HTML to an {@link OutputStream}
* containing PDF.
*
* @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 {
convertToPdf(html, pdfStream, null);
}
/**
* Converts a {@link String} containing HTML to an {@link OutputStream}
* containing PDF, using specific {@link ConverterProperties}.
*
* @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 {
convertToPdf(html, new PdfWriter(pdfStream), converterProperties);
}
/**
* Converts a {@link String} containing HTML to PDF by writing PDF content
* to a {@link PdfWriter} instance.
*
* @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 {
convertToPdf(html, pdfWriter, null);
}
/**
* Converts a {@link String} containing HTML to PDF by writing PDF content
* to a {@link PdfWriter} instance, using specific {@link ConverterProperties}.
*
* @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 {
convertToPdf(html, new PdfDocument(pdfWriter, new DocumentProperties().setEventCountingMetaInfo(new HtmlMetaInfo())), converterProperties);
}
/**
* Converts HTML obtained from an {@link InputStream} to objects that
* will be added to a {@link PdfDocument}, using specific {@link ConverterProperties}.
*
* @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 {
Document document = convertToDocument(html, pdfDocument, converterProperties);
document.close();
}
/**
* Converts HTML stored in a {@link File} to a PDF {@link File}.
*
* @param htmlFile the {@link File} containing the source HTML
* @param pdfFile the {@link File} containing the resulting PDF
* @throws IOException Signals that an I/O exception has occurred.
*/
public static void convertToPdf(File htmlFile, File pdfFile) throws IOException {
convertToPdf(htmlFile, pdfFile, null);
}
/**
* Converts HTML stored in a {@link File} to a PDF {@link File},
* using specific {@link ConverterProperties}.
*
* @param htmlFile the {@link File} containing the source HTML
* @param pdfFile the {@link File} containing the resulting PDF
* @param converterProperties a {@link ConverterProperties} instance
* @throws IOException Signals that an I/O exception has occurred.
*/
public static void convertToPdf(File htmlFile, File pdfFile, ConverterProperties converterProperties) throws IOException {
if (converterProperties == null) {
converterProperties = new ConverterProperties().setBaseUri(Paths.get(FileUtil.getParentDirectory(htmlFile.getAbsolutePath())).toUri().toURL().toExternalForm() + File.separator);
} else if (converterProperties.getBaseUri() == null) {
converterProperties = new ConverterProperties(converterProperties).setBaseUri(Paths.get(FileUtil.getParentDirectory(htmlFile.getAbsolutePath())).toUri().toURL().toExternalForm() + File.separator);
}
try (FileInputStream fileInputStream = new FileInputStream(htmlFile.getAbsolutePath());
FileOutputStream fileOutputStream = new FileOutputStream(pdfFile.getAbsolutePath())) {
convertToPdf(fileInputStream, fileOutputStream, converterProperties);
}
}
/**
* Converts HTML obtained from an {@link InputStream} to a PDF written to
* an {@link OutputStream}.
*
* @param htmlStream the {@link InputStream} with the source HTML
* @param pdfStream the {@link OutputStream} for the resulting PDF
* @throws IOException Signals that an I/O exception has occurred.
*/
public static void convertToPdf(InputStream htmlStream, OutputStream pdfStream) throws IOException {
convertToPdf(htmlStream, pdfStream, null);
}
/**
* Converts HTML obtained from an {@link InputStream} to a PDF written to
* an {@link OutputStream}.
*
* @param htmlStream the {@link InputStream} with the source HTML
* @param pdfStream the {@link OutputStream} for the resulting PDF
* @param converterProperties a {@link ConverterProperties} instance
* @throws IOException Signals that an I/O exception has occurred.
*/
public static void convertToPdf(InputStream htmlStream, OutputStream pdfStream, ConverterProperties converterProperties) throws IOException {
convertToPdf(htmlStream, new PdfWriter(pdfStream), converterProperties);
}
/**
* Converts HTML obtained from an {@link InputStream} to objects that
* will be added to a {@link PdfDocument}.
*
* @param htmlStream the {@link InputStream} with the source HTML
* @param pdfDocument the {@link PdfDocument} instance
* @throws IOException Signals that an I/O exception has occurred.
*/
public static void convertToPdf(InputStream htmlStream, PdfDocument pdfDocument) throws IOException {
convertToPdf(htmlStream, pdfDocument, null);
}
/**
* Converts HTML obtained from an {@link InputStream} to content that
* will be written to a {@link PdfWriter}.
*
* @param htmlStream the {@link InputStream} with the source HTML
* @param pdfWriter the {@link PdfWriter} containing the resulting PDF
* @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, new DocumentProperties().setEventCountingMetaInfo(new HtmlMetaInfo())));
}
/**
* Converts HTML obtained from an {@link InputStream} to content that
* will be written to a {@link PdfWriter}, using specific
* {@link ConverterProperties}.
*
* @param htmlStream the {@link InputStream} with the source HTML
* @param pdfWriter the {@link PdfWriter} containing the resulting PDF
* @param converterProperties a {@link ConverterProperties} instance
* @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, new DocumentProperties().setEventCountingMetaInfo(new HtmlMetaInfo())), converterProperties);
}
/**
* Converts HTML obtained from an {@link InputStream} to objects that
* will be added to a {@link PdfDocument}, using specific {@link ConverterProperties}.
*
* @param htmlStream the {@link InputStream} with the source HTML
* @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(InputStream htmlStream, PdfDocument pdfDocument, ConverterProperties converterProperties) throws IOException {
Document document = convertToDocument(htmlStream, pdfDocument, converterProperties);
document.close();
}
/**
* Converts HTML obtained from an {@link InputStream} to content that
* will be written to a {@link PdfWriter}, returning a {@link Document} instance.
*
* @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 {
return convertToDocument(html, pdfWriter, null);
}
/**
* Converts HTML obtained from an {@link InputStream} to content that
* will be written to a {@link PdfWriter}, returning a {@link Document} instance.
*
* @param htmlStream the {@link InputStream} with the source HTML
* @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(InputStream htmlStream, PdfWriter pdfWriter) throws IOException {
return convertToDocument(htmlStream, pdfWriter, null);
}
/**
* Converts HTML obtained from an {@link InputStream} to content that
* will be written to a {@link PdfWriter}, using specific
* {@link ConverterProperties}, returning a {@link Document} instance.
*
* @param html the html in the form of a {@link String}
* @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 {
return convertToDocument(html, new PdfDocument(pdfWriter), converterProperties);
}
/**
* Converts HTML obtained from an {@link InputStream} to content that
* will be written to a {@link PdfWriter}, using specific
* {@link ConverterProperties}, returning a {@link Document} instance.
*
* @param htmlStream the html stream
* @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(InputStream htmlStream, PdfWriter pdfWriter, ConverterProperties converterProperties) throws IOException {
return convertToDocument(htmlStream, new PdfDocument(pdfWriter), converterProperties);
}
/**
* Converts HTML obtained from an {@link InputStream} to objects that
* will be added to a {@link PdfDocument}, using specific {@link ConverterProperties},
* returning a {@link Document} instance.
*
* @param html the html in the form of a {@link String}
* @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 {
String licenseKeyClassName = "com.itextpdf.licensekey.LicenseKey";
String licenseKeyProductClassName = "com.itextpdf.licensekey.LicenseKeyProduct";
String licenseKeyFeatureClassName = "com.itextpdf.licensekey.LicenseKeyProductFeature";
String checkLicenseKeyMethodName = "scheduledCheck";
try {
Class licenseKeyClass = Class.forName(licenseKeyClassName);
Class licenseKeyProductClass = Class.forName(licenseKeyProductClassName);
Class licenseKeyProductFeatureClass = Class.forName(licenseKeyFeatureClassName);
Object licenseKeyProductFeatureArray = Array.newInstance(licenseKeyProductFeatureClass, 0);
Class[] params = new Class[] {
String.class,
Integer.TYPE,
Integer.TYPE,
licenseKeyProductFeatureArray.getClass()
};
Constructor licenseKeyProductConstructor = licenseKeyProductClass.getConstructor(params);
Object licenseKeyProductObject = licenseKeyProductConstructor.newInstance(
Html2PdfProductInfo.PRODUCT_NAME,
Html2PdfProductInfo.MAJOR_VERSION,
Html2PdfProductInfo.MINOR_VERSION,
licenseKeyProductFeatureArray
);
Method method = licenseKeyClass.getMethod(checkLicenseKeyMethodName, licenseKeyProductClass);
method.invoke(null, licenseKeyProductObject);
} catch (Exception e) {
if ( ! Version.isAGPLVersion() ) {
throw new RuntimeException(e.getCause());
}
}
if (pdfDocument.getReader() != null) {
throw new Html2PdfException(Html2PdfException.PdfDocumentShouldBeInWritingMode);
}
IXmlParser parser = new JsoupHtmlParser();
IDocumentNode doc = parser.parse(html);
return Attacher.attach(doc, pdfDocument, converterProperties);
}
/**
* Converts HTML obtained from an {@link InputStream} to objects that
* will be added to a {@link PdfDocument}, using specific {@link ConverterProperties},
* returning a {@link Document} instance.
*
* @param htmlStream the {@link InputStream} with the source HTML
* @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(InputStream htmlStream, PdfDocument pdfDocument, ConverterProperties converterProperties) throws IOException {
String licenseKeyClassName = "com.itextpdf.licensekey.LicenseKey";
String licenseKeyProductClassName = "com.itextpdf.licensekey.LicenseKeyProduct";
String licenseKeyFeatureClassName = "com.itextpdf.licensekey.LicenseKeyProductFeature";
String checkLicenseKeyMethodName = "scheduledCheck";
try {
Class licenseKeyClass = Class.forName(licenseKeyClassName);
Class licenseKeyProductClass = Class.forName(licenseKeyProductClassName);
Class licenseKeyProductFeatureClass = Class.forName(licenseKeyFeatureClassName);
Object licenseKeyProductFeatureArray = Array.newInstance(licenseKeyProductFeatureClass, 0);
Class[] params = new Class[] {
String.class,
Integer.TYPE,
Integer.TYPE,
licenseKeyProductFeatureArray.getClass()
};
Constructor licenseKeyProductConstructor = licenseKeyProductClass.getConstructor(params);
Object licenseKeyProductObject = licenseKeyProductConstructor.newInstance(
Html2PdfProductInfo.PRODUCT_NAME,
Html2PdfProductInfo.MAJOR_VERSION,
Html2PdfProductInfo.MINOR_VERSION,
licenseKeyProductFeatureArray
);
Method method = licenseKeyClass.getMethod(checkLicenseKeyMethodName, licenseKeyProductClass);
method.invoke(null, licenseKeyProductObject);
} catch (Exception e) {
if ( ! Version.isAGPLVersion() ) {
throw new RuntimeException(e.getCause());
}
}
if (pdfDocument.getReader() != null) {
throw new Html2PdfException(Html2PdfException.PdfDocumentShouldBeInWritingMode);
}
IXmlParser parser = new JsoupHtmlParser();
IDocumentNode doc = parser.parse(htmlStream, converterProperties != null ? converterProperties.getCharset() : null);
return Attacher.attach(doc, pdfDocument, converterProperties);
}
/**
* Converts a {@link String} containing HTML to a {@link List} of
* iText objects ({@link IElement} instances).
*
* @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 convertToElements(String html) throws IOException {
return convertToElements(html, null);
}
/**
* Converts HTML obtained from an {@link InputStream} to a {@link List} of
* iText objects ({@link IElement} instances).
*
* @param htmlStream the {@link InputStream} with the source HTML
* @return a list of iText building blocks
* @throws IOException Signals that an I/O exception has occurred.
*/
public static List convertToElements(InputStream htmlStream) throws IOException {
return convertToElements(htmlStream, null);
}
/**
* Converts a {@link String} containing HTML to a {@link List} of
* iText objects ({@link IElement} instances), using specific
* {@link ConverterProperties}.
*
* @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 convertToElements(String html, ConverterProperties converterProperties) throws IOException {
String licenseKeyClassName = "com.itextpdf.licensekey.LicenseKey";
String licenseKeyProductClassName = "com.itextpdf.licensekey.LicenseKeyProduct";
String licenseKeyFeatureClassName = "com.itextpdf.licensekey.LicenseKeyProductFeature";
String checkLicenseKeyMethodName = "scheduledCheck";
try {
Class licenseKeyClass = Class.forName(licenseKeyClassName);
Class licenseKeyProductClass = Class.forName(licenseKeyProductClassName);
Class licenseKeyProductFeatureClass = Class.forName(licenseKeyFeatureClassName);
Object licenseKeyProductFeatureArray = Array.newInstance(licenseKeyProductFeatureClass, 0);
Class[] params = new Class[] {
String.class,
Integer.TYPE,
Integer.TYPE,
licenseKeyProductFeatureArray.getClass()
};
Constructor licenseKeyProductConstructor = licenseKeyProductClass.getConstructor(params);
Object licenseKeyProductObject = licenseKeyProductConstructor.newInstance(
Html2PdfProductInfo.PRODUCT_NAME,
Html2PdfProductInfo.MAJOR_VERSION,
Html2PdfProductInfo.MINOR_VERSION,
licenseKeyProductFeatureArray
);
Method method = licenseKeyClass.getMethod(checkLicenseKeyMethodName, licenseKeyProductClass);
method.invoke(null, licenseKeyProductObject);
} catch (Exception e) {
if ( ! Version.isAGPLVersion() ) {
throw new RuntimeException(e.getCause());
}
}
IXmlParser parser = new JsoupHtmlParser();
IDocumentNode doc = parser.parse(html);
return Attacher.attach(doc, converterProperties);
}
/**
* Converts HTML obtained from an {@link InputStream} to a {@link List} of
* iText objects ({@link IElement} instances), using specific
* {@link ConverterProperties}.
*
* @param htmlStream the {@link InputStream} with the source HTML
* @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 convertToElements(InputStream htmlStream, ConverterProperties converterProperties) throws IOException {
String licenseKeyClassName = "com.itextpdf.licensekey.LicenseKey";
String licenseKeyProductClassName = "com.itextpdf.licensekey.LicenseKeyProduct";
String licenseKeyFeatureClassName = "com.itextpdf.licensekey.LicenseKeyProductFeature";
String checkLicenseKeyMethodName = "scheduledCheck";
try {
Class licenseKeyClass = Class.forName(licenseKeyClassName);
Class licenseKeyProductClass = Class.forName(licenseKeyProductClassName);
Class licenseKeyProductFeatureClass = Class.forName(licenseKeyFeatureClassName);
Object licenseKeyProductFeatureArray = Array.newInstance(licenseKeyProductFeatureClass, 0);
Class[] params = new Class[] {
String.class,
Integer.TYPE,
Integer.TYPE,
licenseKeyProductFeatureArray.getClass()
};
Constructor licenseKeyProductConstructor = licenseKeyProductClass.getConstructor(params);
Object licenseKeyProductObject = licenseKeyProductConstructor.newInstance(
Html2PdfProductInfo.PRODUCT_NAME,
Html2PdfProductInfo.MAJOR_VERSION,
Html2PdfProductInfo.MINOR_VERSION,
licenseKeyProductFeatureArray
);
Method method = licenseKeyClass.getMethod(checkLicenseKeyMethodName, licenseKeyProductClass);
method.invoke(null, licenseKeyProductObject);
} catch (Exception e) {
if ( ! Version.isAGPLVersion() ) {
throw new RuntimeException(e.getCause());
}
}
IXmlParser parser = new JsoupHtmlParser();
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;
}
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy