hdoc-tools 0.11.6 → 0.11.7

package/hdoc-build-db.js

@@ -1,153 +1,153 @@
-(function () {
-    'use strict';
-
-    const path = require('path'),
-        hdoc_index = require(path.join(__dirname, 'hdoc-db.js')),
-        database = require('better-sqlite3');
-
-    const db_schema = {
-        hdoc_index: [
-            'resource_url UNINDEXED',
-            'book_id',
-            'book_audience UNINDEXED',
-            'book_tags',
-            'doc_title',
-            'doc_content',
-            'doc_preview UNINDEXED',
-            'doc_family_id',
-            'doc_md5_hash UNINDEXED',
-            'doc_lastmod'
-        ],
-        hdoc_meta: [
-            'resource_url',
-            'book_id',
-            'contributor_count INTEGER UNINDEXED',
-            'edit_url UNINDEXED',
-            'last_commit UNINDEXED',
-            'pdf_size INTEGER UNINDEXED'
-        ],
-        hdoc_contributors: [
-            'resource_url',
-            'book_id',
-            'login',
-            'name',
-            'avatar UNINDEXED',
-            'url UNINDEXED'
-        ]
-    };
-
-    exports.create_table = function (db, table, cols, virtual, fts5) {
-        const table_created = hdoc_index.create_table(db, table, cols, virtual, fts5);
-        if (table_created !== null) {
-            return `\nError creating table: ${table_created}`;
-        } else {
-            console.log(`\nTable created: ${table}`);
-        }
-        return null;
-    };
-
-    exports.create_db = function (db_path, doc_id) {
-        let response = {
-            error: null,
-            db: null
-        };
-        console.log('\nPerforming SQlite index creation...');
-        let db_name = path.join(db_path, doc_id, 'index.db');
-        response.db = new database(db_name);
-        response.db.pragma('encoding="UTF-8"');
-        console.log(`\nDatabase created: ${db_name}`);
-
-        // Create tables
-        for (const key in db_schema) {
-            if (db_schema.hasOwnProperty(key)) {
-                const virtual = key === 'hdoc_index' ? true : false;
-                const fts5 = key === 'hdoc_index' ? true : false;
-                const table_created_error = this.create_table(response.db, key, db_schema[key], virtual, fts5);
-                if (table_created_error !== null) {
-                    console.log(table_created_error);
-                }
-            }
-        }
-        return response;
-    };
-
-    exports.populate_index = async function (db, doc_id, book_config, index_records, verbose = false) {
-        let response = {
-            success: false,
-            index_success_count: 0,
-            error: ''
-        };
-
-        if (!book_config.tags) book_config.tags = [];
-
-        let indexPromises = [];
-        for (let i = 0; i < index_records.length; i++) {
-            indexPromises.push(index_records[i]);
-        }
-        await Promise.all(indexPromises.map(async (file) => {
-            let index_path_name = file.relative_path.replace('\\', '/');
-            index_path_name = '/' + index_path_name.replace(path.extname(file.relative_path), '');
-            const index_vals = [
-                index_path_name,
-                doc_id,
-                book_config.audience.join(','),
-                book_config.tags.join(','),
-                file.index_html.fm_props.title,
-                file.index_html.text,
-                file.index_html.preview,
-                book_config.productFamily,
-                file.md5,
-                file.lastmod
-            ];
-            const index_response = hdoc_index.insert_record(db, 'hdoc_index', db_schema.hdoc_index, index_vals);
-            if (!index_response.success) {
-                console.log(`Index record creation failed - ${doc_id}/${file.index_html.fm_props.title}: ${index_response.error}`);
-            } else {
-                // Now add metadata
-                const meta_vals = [
-                    index_path_name,
-                    doc_id,
-                    file.metadata.contributor_count,
-                    file.metadata.edit_url,
-                    file.metadata.last_commit,
-                    file.pdf_size
-                ];
-                const meta_response = await hdoc_index.insert_record(db, 'hdoc_meta', db_schema.hdoc_meta, meta_vals);
-                if (!meta_response.success) {
-                    console.log(`Index metadata record creation failed - ${doc_id}/${index_response.row_id}/${file.index_html.fm_props.title}: ${meta_response.error}`);
-                } else {
-                    if (verbose) {
-                        console.log(`Inserted index record ${index_response.row_id}: ${doc_id} - ${file.index_html.fm_props.title}`);
-                        console.log(`Inserted index metadata record for index ID: ${meta_response.row_id}`);
-                    }
-
-                    // Now add contributor records
-                    for (let j = 0; j < file.contributors.length; j++) {
-                        const contrib_vals = [
-                            index_path_name,
-                            doc_id,
-                            file.contributors[j].login,
-                            file.contributors[j].name,
-                            file.contributors[j].avatar_url,
-                            file.contributors[j].html_url
-                        ];
-                        const cont_response = await hdoc_index.insert_record(db, 'hdoc_contributors', db_schema.hdoc_contributors, contrib_vals);
-                        if (!cont_response.success) {
-                            console.log(`Index document contributor record creation failed - ${doc_id}/${index_response.row_id}/${file.index_html.fm_props.title}: ${cont_response.error}`);
-                            continue;
-                        }
-                        if (verbose) {
-                            console.log(`Inserted document contributor recordL ${cont_response.row_id}`);
-                        }
-                    }
-                    response.index_success_count++;
-                }
-            }
-
-        }));
-
-        response.success = true;
-        console.log(`\nIndex Build Complete: ${response.index_success_count} document index records created.`);
-        return response;
-    };
+(function () {
+    'use strict';
+
+    const path = require('path'),
+        hdoc_index = require(path.join(__dirname, 'hdoc-db.js')),
+        database = require('better-sqlite3');
+
+    const db_schema = {
+        hdoc_index: [
+            'resource_url UNINDEXED',
+            'book_id',
+            'book_audience UNINDEXED',
+            'book_tags',
+            'doc_title',
+            'doc_content',
+            'doc_preview UNINDEXED',
+            'doc_family_id',
+            'doc_md5_hash UNINDEXED',
+            'doc_lastmod'
+        ],
+        hdoc_meta: [
+            'resource_url',
+            'book_id',
+            'contributor_count INTEGER UNINDEXED',
+            'edit_url UNINDEXED',
+            'last_commit UNINDEXED',
+            'pdf_size INTEGER UNINDEXED'
+        ],
+        hdoc_contributors: [
+            'resource_url',
+            'book_id',
+            'login',
+            'name',
+            'avatar UNINDEXED',
+            'url UNINDEXED'
+        ]
+    };
+
+    exports.create_table = function (db, table, cols, virtual, fts5) {
+        const table_created = hdoc_index.create_table(db, table, cols, virtual, fts5);
+        if (table_created !== null) {
+            return `\nError creating table: ${table_created}`;
+        } else {
+            console.log(`\nTable created: ${table}`);
+        }
+        return null;
+    };
+
+    exports.create_db = function (db_path, doc_id) {
+        let response = {
+            error: null,
+            db: null
+        };
+        console.log('\nPerforming SQlite index creation...');
+        let db_name = path.join(db_path, doc_id, 'index.db');
+        response.db = new database(db_name);
+        response.db.pragma('encoding="UTF-8"');
+        console.log(`\nDatabase created: ${db_name}`);
+
+        // Create tables
+        for (const key in db_schema) {
+            if (db_schema.hasOwnProperty(key)) {
+                const virtual = key === 'hdoc_index' ? true : false;
+                const fts5 = key === 'hdoc_index' ? true : false;
+                const table_created_error = this.create_table(response.db, key, db_schema[key], virtual, fts5);
+                if (table_created_error !== null) {
+                    console.log(table_created_error);
+                }
+            }
+        }
+        return response;
+    };
+
+    exports.populate_index = async function (db, doc_id, book_config, index_records, verbose = false) {
+        let response = {
+            success: false,
+            index_success_count: 0,
+            error: ''
+        };
+
+        if (!book_config.tags) book_config.tags = [];
+
+        let indexPromises = [];
+        for (let i = 0; i < index_records.length; i++) {
+            indexPromises.push(index_records[i]);
+        }
+        await Promise.all(indexPromises.map(async (file) => {
+            let index_path_name = file.relative_path.replace('\\', '/');
+            index_path_name = '/' + index_path_name.replace(path.extname(file.relative_path), '');
+            const index_vals = [
+                index_path_name,
+                doc_id,
+                book_config.audience.join(','),
+                book_config.tags.join(','),
+                file.index_html.fm_props.title,
+                file.index_html.text,
+                file.index_html.preview,
+                book_config.productFamily,
+                file.md5,
+                file.lastmod
+            ];
+            const index_response = hdoc_index.insert_record(db, 'hdoc_index', db_schema.hdoc_index, index_vals);
+            if (!index_response.success) {
+                console.log(`Index record creation failed - ${doc_id}/${file.index_html.fm_props.title}: ${index_response.error}`);
+            } else {
+                // Now add metadata
+                const meta_vals = [
+                    index_path_name,
+                    doc_id,
+                    file.metadata.contributor_count,
+                    file.metadata.edit_url,
+                    file.metadata.last_commit,
+                    file.pdf_size
+                ];
+                const meta_response = await hdoc_index.insert_record(db, 'hdoc_meta', db_schema.hdoc_meta, meta_vals);
+                if (!meta_response.success) {
+                    console.log(`Index metadata record creation failed - ${doc_id}/${index_response.row_id}/${file.index_html.fm_props.title}: ${meta_response.error}`);
+                } else {
+                    if (verbose) {
+                        console.log(`Inserted index record ${index_response.row_id}: ${doc_id} - ${file.index_html.fm_props.title}`);
+                        console.log(`Inserted index metadata record for index ID: ${meta_response.row_id}`);
+                    }
+
+                    // Now add contributor records
+                    for (let j = 0; j < file.contributors.length; j++) {
+                        const contrib_vals = [
+                            index_path_name,
+                            doc_id,
+                            file.contributors[j].login,
+                            file.contributors[j].name,
+                            file.contributors[j].avatar_url,
+                            file.contributors[j].html_url
+                        ];
+                        const cont_response = await hdoc_index.insert_record(db, 'hdoc_contributors', db_schema.hdoc_contributors, contrib_vals);
+                        if (!cont_response.success) {
+                            console.log(`Index document contributor record creation failed - ${doc_id}/${index_response.row_id}/${file.index_html.fm_props.title}: ${cont_response.error}`);
+                            continue;
+                        }
+                        if (verbose) {
+                            console.log(`Inserted document contributor recordL ${cont_response.row_id}`);
+                        }
+                    }
+                    response.index_success_count++;
+                }
+            }
+
+        }));
+
+        response.success = true;
+        console.log(`\nIndex Build Complete: ${response.index_success_count} document index records created.`);
+        return response;
+    };
 })();

package/hdoc-build-pdf.js

@@ -1,173 +1,173 @@
-(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.log(`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.log(`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.log('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.log(`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.log('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.log(`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.log(`Error generating PDF ${target_file} - ${err}`);
-        }
-        await page.close();
-        return pdf_size;
-    };
+(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.log(`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.log(`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.log('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.log(`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.log('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.log(`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.log(`Error generating PDF ${target_file} - ${err}`);
+        }
+        await page.close();
+        return pdf_size;
+    };
 })();