hdoc-tools 0.19.8 → 0.20.0

package/hdoc-build-pdf.js

@@ -1,173 +1,219 @@
-(function () {
-    'use strict';
-
-    const axios = require('axios'),
-        cheerio = require('cheerio'),
-        fs = require('fs-extra'),
-        mime = require('mime-types'),
-        path = require('path'),
-        hdoc = require(path.join(__dirname, 'hdoc-module.js'));
-
-    let hb_logo = '',
-        footer = '',
-        header = '';
-
-    const get_footer = function (template_path) {
-        let footer_content = null;
-        try {
-            footer_content = fs.readFileSync(path.join(template_path, 'template-footer.html'), 'utf8');
-        } catch (err) {
-            console.error(`Error loading template: ${err}`);
-        }
-        return footer_content;
-    };
-
-    const get_header = function (template_path) {
-        let header_content = null;
-        try {
-            header_content = fs.readFileSync(path.join(template_path, 'template-header.html'), 'utf8');
-        } catch (err) {
-            console.error(`Error loading template: ${err}`);
-        }
-        return header_content;
-    };
-
-    exports.process_images = async function (file_path, html_source, verbose) {
-        const book_work_root = file_path.path.replace(file_path.relativePath, '');
-        if (verbose) console.log('Parsing img tags from HTML source');
-
-        // Use cheerio to parse html
-        const $ = cheerio.load(html_source);
-
-        // Get iFrames from HTML, to replace with a tags
-        let iframes = [];
-        const iframe_html = $('iframe').map(function () {
-            const response = {
-                html: $.html(this),
-                src: $(this).attr('src'),
-                title: $(this).attr('title') ? $(this).attr('title') : 'No Link Title Provided'
-            };
-            return response;
-        }).get();
-        iframes.push(...iframe_html);
-        for (let i = 0; i < iframes.length; i++) {
-            const link = `<p><a href="${iframes[i].src}">${iframes[i].title}</a></p>`;
-            const regex = new RegExp(`<iframe.*src="${iframes[i].src.replace('/', '\\/')}".*</iframe>`);
-            html_source = html_source.replace(regex, link);
-        }
-
-        // Get image links from HTML, to embed into the pdf
-        let imgs = [];
-        const srcs = $('img').map(function (i) {
-            return $(this).attr('src');
-        }).get();
-        imgs.push(...srcs);
-        for (let i = 0; i < imgs.length; i++) {
-            if (!hdoc.valid_url(imgs[i])) {
-                // Internal link
-                const image_path = path.join(book_work_root, imgs[i].replace('_books/', ''));
-                try {
-                    const image_buffer = fs.readFileSync(image_path);
-                    const mime_type = mime.lookup(image_path);
-                    let image_b64 = image_buffer.toString("base64");
-                    image_b64 = `data:${mime_type};base64,${image_b64}`;
-                    html_source = html_source.replace(imgs[i], image_b64);
-                } catch (err) {
-                    console.error('Error reading image from HTML source [', image_path, '] -', err);
-                    return null;
-                }
-            } else {
-                // External Link
-                try {
-                    const file_response = await axios.get(imgs[i]);
-                    if (file_response.status === 200) {
-                        const image_buffer = file_response.data;
-                        const mime_type = mime.lookup(imgs[i]);
-                        let image_b64 = image_buffer.toString("base64");
-                        image_b64 = `data:${mime_type};base64,${image_b64}`;
-                        html_source = html_source.replace(imgs[i], image_b64);
-                    } else {
-                        throw `Unexpected Status ${file_response.status}`;
-                    }
-                } catch (err) {
-                    console.error(`Error downloading external source [${imgs[i]}] - ${err}`);
-                }
-            }
-        }
-
-        return html_source;
-    };
-
-    exports.generate_pdf = async function (browser, pdf_template_path, pdf_template_content, book_config, html_source, target_file, css_templates, verbose = false) {
-        let pdf_size = 0;
-
-        // Cache footer
-        if (footer === '') footer = get_footer(pdf_template_path);
-
-        // Read svg logo file into buffer, convert to B64 string 
-        if (hb_logo === '') {
-            const hb_logo_path = path.join(pdf_template_path, 'images', 'hornbill-logo-full.svg');
-            try {
-                const hb_logo_file_buffer = fs.readFileSync(hb_logo_path);
-                hb_logo = hb_logo_file_buffer.toString("base64");
-                hb_logo = `data:image/svg+xml;base64,${hb_logo}`;
-            } catch (err) {
-                console.error('Error reading logo from template:', err);
-                return pdf_size;
-            }
-        }
-
-        // Cache header
-        if (header === '') {
-            header = get_header(pdf_template_path).replace('{{book_title}}', book_config.title).replace('{{hb_logo}}', hb_logo);
-        }
-
-        html_source = pdf_template_content.replace('{{book_title}}', book_config.title).replace('{{document_content}}', html_source);
-
-        const page = await browser.newPage();
-
-        // To reflect CSS used for screens instead of print
-        await page.emulateMediaType('screen');
-
-        // Set HTML content from HTML source
-        await page.setContent(html_source, {
-            waitUntil: 'domcontentloaded'
-        });
-        for (let i = 0; i < css_templates.length; i++) {
-            try {
-                await page.addStyleTag({
-                    content: css_templates[i]
-                });
-            } catch (e) {
-                console.error(`Error applying template for [${target_file}]: ${e}`);
-            }
-        }
-
-        try {
-            const pdf_gen = await page.pdf({
-                path: target_file,
-                printBackground: true,
-                format: 'A4',
-                displayHeaderFooter: true,
-                headerTemplate: header,
-                footerTemplate: footer,
-                margin: {
-                    top: "90px",
-                    right: "30px",
-                    bottom: "60px",
-                    left: "30px"
-                },
-                timeout: 0
-            });
-            let currdate = new Date;
-            let datetime = currdate.toISOString();
-            if (verbose) console.log(`[${datetime}] PDF generation success: ${target_file}`);
-
-            pdf_size = pdf_gen.byteLength;
-        } catch (err) {
-            console.error(`Error generating PDF ${target_file} - ${err}`);
-        }
-        await page.close();
-        return pdf_size;
-    };
-})();
+(() => {
+	const axios = require("axios");
+	const cheerio = require("cheerio");
+	const fs = require("fs-extra");
+	const mime = require("mime-types");
+	const path = require("node:path");
+	const hdoc = require(path.join(__dirname, "hdoc-module.js"));
+
+	let hb_logo = "";
+	let footer = "";
+	let header = "";
+
+	const get_footer = (template_path) => {
+		let footer_content = null;
+		try {
+			footer_content = fs.readFileSync(
+				path.join(template_path, "template-footer.html"),
+				"utf8",
+			);
+		} catch (err) {
+			console.error(`Error loading template: ${err}`);
+		}
+		return footer_content;
+	};
+
+	const get_header = (template_path) => {
+		let header_content = null;
+		try {
+			header_content = fs.readFileSync(
+				path.join(template_path, "template-header.html"),
+				"utf8",
+			);
+		} catch (err) {
+			console.error(`Error loading template: ${err}`);
+		}
+		return header_content;
+	};
+
+	exports.process_images = async (file_path, html_source, verbose) => {
+		const book_work_root = file_path.path.replace(file_path.relativePath, "");
+		if (verbose) console.log("Parsing img tags from HTML source");
+
+		let processed_html_source = html_source;
+		// Use cheerio to parse html
+		const $ = cheerio.load(processed_html_source);
+
+		// Get iFrames from HTML, to replace with a tags
+		const iframes = [];
+		const iframe_html = $("iframe")
+			.map(function () {
+				const response = {
+					html: $.html(this),
+					src: $(this).attr("src"),
+					title: $(this).attr("title")
+						? $(this).attr("title")
+						: "No Link Title Provided",
+				};
+				return response;
+			})
+			.get();
+		iframes.push(...iframe_html);
+		for (let i = 0; i < iframes.length; i++) {
+			const link = `<p><a href="${iframes[i].src}">${iframes[i].title}</a></p>`;
+			const regex = new RegExp(
+				`<iframe.*src="${iframes[i].src.replace("/", "\\/")}".*</iframe>`,
+			);
+			processed_html_source = processed_html_source.replace(regex, link);
+		}
+
+		// Get image links from HTML, to embed into the pdf
+		const imgs = [];
+		const srcs = $("img")
+			.map(function (i) {
+				return $(this).attr("src");
+			})
+			.get();
+		imgs.push(...srcs);
+		for (let i = 0; i < imgs.length; i++) {
+			if (!hdoc.valid_url(imgs[i])) {
+				// Internal link
+				const image_path = path.join(
+					book_work_root,
+					imgs[i].replace("_books/", ""),
+				);
+				try {
+					const image_buffer = fs.readFileSync(image_path);
+					const mime_type = mime.lookup(image_path);
+					let image_b64 = image_buffer.toString("base64");
+					image_b64 = `data:${mime_type};base64,${image_b64}`;
+					processed_html_source = processed_html_source.replace(
+						imgs[i],
+						image_b64,
+					);
+				} catch (err) {
+					console.error(
+						"Error reading image from HTML source [",
+						image_path,
+						"] -",
+						err,
+					);
+					return null;
+				}
+			} else {
+				// External Link
+				try {
+					const file_response = await axios.get(imgs[i]);
+					if (file_response.status === 200) {
+						const image_buffer = file_response.data;
+						const mime_type = mime.lookup(imgs[i]);
+						let image_b64 = image_buffer.toString("base64");
+						image_b64 = `data:${mime_type};base64,${image_b64}`;
+						processed_html_source = processed_html_source.replace(
+							imgs[i],
+							image_b64,
+						);
+					} else {
+						throw `Unexpected Status ${file_response.status}`;
+					}
+				} catch (err) {
+					console.error(
+						`Error downloading external source [${imgs[i]}] - ${err}`,
+					);
+				}
+			}
+		}
+
+		return processed_html_source;
+	};
+
+	exports.generate_pdf = async (
+		browser,
+		pdf_template_path,
+		pdf_template_content,
+		book_config,
+		html_source,
+		target_file,
+		css_templates,
+		verbose = false,
+	) => {
+		let pdf_size = 0;
+		// Cache footer
+		if (footer === "") footer = get_footer(pdf_template_path);
+
+		// Read svg logo file into buffer, convert to B64 string
+		if (hb_logo === "") {
+			const hb_logo_path = path.join(
+				pdf_template_path,
+				"images",
+				"hornbill-logo-full.svg",
+			);
+			try {
+				const hb_logo_file_buffer = fs.readFileSync(hb_logo_path);
+				hb_logo = hb_logo_file_buffer.toString("base64");
+				hb_logo = `data:image/svg+xml;base64,${hb_logo}`;
+			} catch (err) {
+				console.error("Error reading logo from template:", err);
+				return pdf_size;
+			}
+		}
+
+		// Cache header
+		if (header === "") {
+			header = get_header(pdf_template_path)
+				.replace("{{book_title}}", book_config.title)
+				.replace("{{hb_logo}}", hb_logo);
+		}
+
+		const processed_html_source = pdf_template_content
+			.replace("{{book_title}}", book_config.title)
+			.replace("{{document_content}}", html_source);
+
+		const page = await browser.newPage();
+
+		// To reflect CSS used for screens instead of print
+		await page.emulateMediaType("screen");
+
+		// Set HTML content from HTML source
+		await page.setContent(processed_html_source, {
+			waitUntil: "domcontentloaded",
+		});
+		for (let i = 0; i < css_templates.length; i++) {
+			try {
+				await page.addStyleTag({
+					content: css_templates[i],
+				});
+			} catch (e) {
+				console.error(`Error applying template for [${target_file}]: ${e}`);
+			}
+		}
+
+		try {
+			const pdf_gen = await page.pdf({
+				path: target_file,
+				printBackground: true,
+				format: "A4",
+				displayHeaderFooter: true,
+				headerTemplate: header,
+				footerTemplate: footer,
+				margin: {
+					top: "90px",
+					right: "30px",
+					bottom: "60px",
+					left: "30px",
+				},
+				timeout: 0,
+			});
+			const currdate = new Date();
+			const datetime = currdate.toISOString();
+			if (verbose)
+				console.log(`[${datetime}] PDF generation success: ${target_file}`);
+
+			pdf_size = pdf_gen.byteLength;
+		} catch (err) {
+			console.error(`Error generating PDF ${target_file} - ${err}`);
+		}
+		await page.close();
+		return pdf_size;
+	};
+})();