commit 631e5fc1a444fa7faa3b13e798efac20ff112848 Author: gered Date: Sat Apr 1 14:58:23 2017 -0400 initial commit diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..b8f73f5 --- /dev/null +++ b/.gitignore @@ -0,0 +1,18 @@ +.DS_Store +/target +/classes +/checkouts +/out +pom.xml +pom.xml.asc +*.jar +*.class +.lein-* +.nrepl-port +/*.project +/*.classpath +/.settings/ +*.iml +*.ipr +*.iws +.idea \ No newline at end of file diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..02bbb60 --- /dev/null +++ b/LICENSE @@ -0,0 +1,165 @@ + GNU LESSER GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + + This version of the GNU Lesser General Public License incorporates +the terms and conditions of version 3 of the GNU General Public +License, supplemented by the additional permissions listed below. + + 0. Additional Definitions. + + As used herein, "this License" refers to version 3 of the GNU Lesser +General Public License, and the "GNU GPL" refers to version 3 of the GNU +General Public License. + + "The Library" refers to a covered work governed by this License, +other than an Application or a Combined Work as defined below. + + An "Application" is any work that makes use of an interface provided +by the Library, but which is not otherwise based on the Library. +Defining a subclass of a class defined by the Library is deemed a mode +of using an interface provided by the Library. + + A "Combined Work" is a work produced by combining or linking an +Application with the Library. The particular version of the Library +with which the Combined Work was made is also called the "Linked +Version". + + The "Minimal Corresponding Source" for a Combined Work means the +Corresponding Source for the Combined Work, excluding any source code +for portions of the Combined Work that, considered in isolation, are +based on the Application, and not on the Linked Version. + + The "Corresponding Application Code" for a Combined Work means the +object code and/or source code for the Application, including any data +and utility programs needed for reproducing the Combined Work from the +Application, but excluding the System Libraries of the Combined Work. + + 1. Exception to Section 3 of the GNU GPL. + + You may convey a covered work under sections 3 and 4 of this License +without being bound by section 3 of the GNU GPL. + + 2. Conveying Modified Versions. + + If you modify a copy of the Library, and, in your modifications, a +facility refers to a function or data to be supplied by an Application +that uses the facility (other than as an argument passed when the +facility is invoked), then you may convey a copy of the modified +version: + + a) under this License, provided that you make a good faith effort to + ensure that, in the event an Application does not supply the + function or data, the facility still operates, and performs + whatever part of its purpose remains meaningful, or + + b) under the GNU GPL, with none of the additional permissions of + this License applicable to that copy. + + 3. Object Code Incorporating Material from Library Header Files. + + The object code form of an Application may incorporate material from +a header file that is part of the Library. You may convey such object +code under terms of your choice, provided that, if the incorporated +material is not limited to numerical parameters, data structure +layouts and accessors, or small macros, inline functions and templates +(ten or fewer lines in length), you do both of the following: + + a) Give prominent notice with each copy of the object code that the + Library is used in it and that the Library and its use are + covered by this License. + + b) Accompany the object code with a copy of the GNU GPL and this license + document. + + 4. Combined Works. + + You may convey a Combined Work under terms of your choice that, +taken together, effectively do not restrict modification of the +portions of the Library contained in the Combined Work and reverse +engineering for debugging such modifications, if you also do each of +the following: + + a) Give prominent notice with each copy of the Combined Work that + the Library is used in it and that the Library and its use are + covered by this License. + + b) Accompany the Combined Work with a copy of the GNU GPL and this license + document. + + c) For a Combined Work that displays copyright notices during + execution, include the copyright notice for the Library among + these notices, as well as a reference directing the user to the + copies of the GNU GPL and this license document. + + d) Do one of the following: + + 0) Convey the Minimal Corresponding Source under the terms of this + License, and the Corresponding Application Code in a form + suitable for, and under terms that permit, the user to + recombine or relink the Application with a modified version of + the Linked Version to produce a modified Combined Work, in the + manner specified by section 6 of the GNU GPL for conveying + Corresponding Source. + + 1) Use a suitable shared library mechanism for linking with the + Library. A suitable mechanism is one that (a) uses at run time + a copy of the Library already present on the user's computer + system, and (b) will operate properly with a modified version + of the Library that is interface-compatible with the Linked + Version. + + e) Provide Installation Information, but only if you would otherwise + be required to provide such information under section 6 of the + GNU GPL, and only to the extent that such information is + necessary to install and execute a modified version of the + Combined Work produced by recombining or relinking the + Application with a modified version of the Linked Version. (If + you use option 4d0, the Installation Information must accompany + the Minimal Corresponding Source and Corresponding Application + Code. If you use option 4d1, you must provide the Installation + Information in the manner specified by section 6 of the GNU GPL + for conveying Corresponding Source.) + + 5. Combined Libraries. + + You may place library facilities that are a work based on the +Library side by side in a single library together with other library +facilities that are not Applications and are not covered by this +License, and convey such a combined library under terms of your +choice, if you do both of the following: + + a) Accompany the combined library with a copy of the same work based + on the Library, uncombined with any other library facilities, + conveyed under the terms of this License. + + b) Give prominent notice with the combined library that part of it + is a work based on the Library, and explaining where to find the + accompanying uncombined form of the same work. + + 6. Revised Versions of the GNU Lesser General Public License. + + The Free Software Foundation may publish revised and/or new versions +of the GNU Lesser General Public License from time to time. Such new +versions will be similar in spirit to the present version, but may +differ in detail to address new problems or concerns. + + Each version is given a distinguishing version number. If the +Library as you received it specifies that a certain numbered version +of the GNU Lesser General Public License "or any later version" +applies to it, you have the option of following the terms and +conditions either of that published version or of any later version +published by the Free Software Foundation. If the Library as you +received it does not specify a version number of the GNU Lesser +General Public License, you may choose any version of the GNU Lesser +General Public License ever published by the Free Software Foundation. + + If the Library as you received it specifies that a proxy can decide +whether future versions of the GNU Lesser General Public License shall +apply, that proxy's public statement of acceptance of any version is +permanent authorization for you to choose that version for the +Library. \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..34b8cc3 --- /dev/null +++ b/README.md @@ -0,0 +1,35 @@ +# clj-htmltopdf + +A light-weight wrapper for the [Open HTML to PDF](https://github.com/danfickle/openhtmltopdf) +library to make it a little bit easier to use directly from Clojure. + +## Leiningen + +``` +[clj-htmltopdf "0.1"] +``` + +## Usage + +```clojure +(use 'clj-htmltopdf.core) + +(->pdf + [:div + [:h1 "HTML to PDF"] + [:p "Glorious!"]] + "output.pdf") +``` + +`clj-htmltopdf.core/->pdf` can take a variety of different input and output argument types, +such as strings, `java.io.File` objects, `java.net.URL` objects, streams, etc. + +As shown in the above example, a special case is made when the input argument is +[Hiccup](https://github.com/weavejester/hiccup)-style HTML where it will be automatically +converted to an HTML string before being rendered as a PDF. + +## License + +Copyright © 2017 Gered King + +Distributed under the LGPL3 license. diff --git a/project.clj b/project.clj new file mode 100644 index 0000000..77fda07 --- /dev/null +++ b/project.clj @@ -0,0 +1,14 @@ +(defproject clj-htmltopdf "0.1.0-SNAPSHOT" + :description "Simple Clojure wrapper for Open HTML to PDF" + :url "https://github.com/gered/clj-htmltopdf" + :license {:name "GNU Lesser General Public License v3.0" + :url "https://www.gnu.org/licenses/lgpl.html"} + + :dependencies [[com.openhtmltopdf/openhtmltopdf-core "0.0.1-RC9"] + [com.openhtmltopdf/openhtmltopdf-jsoup-dom-converter "0.0.1-RC9"] + [com.openhtmltopdf/openhtmltopdf-pdfbox "0.0.1-RC9"] + [com.openhtmltopdf/openhtmltopdf-rtl-support "0.0.1-RC9"] + [hiccup "1.0.5"]] + + :profiles {:provided + {:dependencies [[org.clojure/clojure "1.8.0"]]}}) diff --git a/src/clj_htmltopdf/core.clj b/src/clj_htmltopdf/core.clj new file mode 100644 index 0000000..4f7887a --- /dev/null +++ b/src/clj_htmltopdf/core.clj @@ -0,0 +1,60 @@ +(ns clj-htmltopdf.core + (:require + [clojure.java.io :as io] + [hiccup.page :as h]) + (:import + [java.io OutputStream] + [com.openhtmltopdf DOMBuilder] + [com.openhtmltopdf.pdfboxout PdfRendererBuilder] + [com.openhtmltopdf.util XRLog] + [org.jsoup Jsoup])) + +(defn- read-html + [in] + (try + (cond + (string? in) in + (sequential? in) (h/html5 {} in) + :else (with-open [r (io/reader in)] + (slurp r))) + (catch Exception ex + (throw (Exception. "Error reading HTML from input." ex))))) + +(defn- ->output-stream + [out] + (try + (if (instance? OutputStream out) + out + (io/output-stream out)) + (catch Exception ex + (throw (Exception. "Error preparing an OutputStream from output given." ex))))) + +(defn- parse-html5 + [^String html] + (try + (let [parsed-doc (Jsoup/parse html)] + (DOMBuilder/jsoup2DOM parsed-doc)) + (catch Exception ex + (throw (Exception. "Error parsing input as HTML5." ex))))) + +(defn ->pdf + [in out & [options]] + (let [builder (PdfRendererBuilder.) + base-uri (str (or (:base-uri options) ".")) + html (read-html in) + html-doc (parse-html5 html) + output (->output-stream out)] + (if (:logging? options) + (let [logger (:logger options)] + (if logger (XRLog/setLoggerImpl logger)) + (XRLog/setLoggingEnabled true)) + (XRLog/setLoggingEnabled false)) + (.withW3cDocument builder html-doc base-uri) + (with-open [os output] + (.toStream builder os) + (try + (.run builder) + os + (catch Exception ex + (throw (Exception. "Failed to convert to PDF." ex))))))) +