hdoc-tools 0.11.7 → 0.11.8

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;
+    };
 })();

package/hdoc-build.js

@@ -179,6 +179,7 @@
 
             // Get contributor data from Github, if exists
             let contribs = [];
+            let last_commit = null;
             if (hdocbook_config.publicSource && hdocbook_config.publicSource !== '' && hdocbook_config.publicSource.includes('github.com/Hornbill-Docs')) {
 
                 const github_paths = hdoc.get_github_api_path(hdocbook_config.publicSource, file_path.relativePath);
@@ -187,6 +188,7 @@
                 if (!contributors.success) {
                     console.log(`Error retrieving contributors from Github: ${contributors.error}`);
                 } else {
+                    last_commit = contributors.last_commit_date;
                     metadata.last_commit = contributors.last_commit_date;
                     metadata.contributor_count = contributors.contributor_count;
                     metadata.edit_url = github_paths.edit_path;
@@ -254,7 +256,8 @@
                 metadata: metadata,
                 contributors: contribs,
                 pdf_size: pdf_size,
-                md5: file_path.hash
+                md5: file_path.hash,
+                lastmod: last_commit !== null ? last_commit : file_path.hb_lastmod
             });
             // Save HTML into HTML file
             try {
@@ -387,6 +390,7 @@
 
             // Get contributor data from Github, if exists
             let contribs = [];
+            let last_commit = null;
             if (hdocbook_config.publicSource && hdocbook_config.publicSource !== '' && hdocbook_config.publicSource.includes('github.com/Hornbill-Docs')) {
 
                 const github_paths = hdoc.get_github_api_path(hdocbook_config.publicSource, file_path.relativePath);
@@ -395,6 +399,7 @@
                 if (!contributors.success) {
                     console.log(`Error retrieving contributors from Github: ${contributors.error}`);
                 } else {
+                    last_commit = contributors.last_commit_date;
                     metadata.last_commit = contributors.last_commit_date;
                     metadata.contributor_count = contributors.contributor_count;
                     metadata.edit_url = github_paths.edit_path;
@@ -475,7 +480,7 @@
                 contributors: contribs,
                 pdf_size: pdf_size,
                 md5: file_path.hash,
-                lastmod: file_path.hb_lastmod
+                lastmod: last_commit !== null ? last_commit : file_path.hb_lastmod
             });
 
             // Add MD file to delete queue

package/hdoc-bump.js

@@ -1,109 +1,109 @@
-(function () {
-    'use strict';
-
-    const fs = require('fs'),
-        path = require('path');
-
-    exports.run = function (source_path, bump_type) {
-        if (bump_type !== 'patch' && bump_type !== 'minor' && bump_type !== 'major') {
-            console.log(`Unsupported bump type: ${bump_type}`);
-            process.exit(1);
-        }
-        console.log(`Bumping ${bump_type} book version...\n`);
-
-        // Get document ID
-        const hdocbook_project_config_path = path.join(source_path, 'hdocbook-project.json');
-        let hdocbook_project;
-        try {
-            hdocbook_project = require(hdocbook_project_config_path);
-        } catch (e) {
-            console.log('File not found: hdocbook-project.json:');
-            console.log(e, '\n');
-            console.log('hdoc bump needs to be run in the root of a HDoc Book.\n');
-            process.exit(1);
-        }
-        const doc_id = hdocbook_project.docId;
-
-        const book_path = path.join(source_path, doc_id),
-            hdocbook_path = path.join(book_path, 'hdocbook.json');
-
-        let hdocbook_config;
-        try {
-            hdocbook_config = require(hdocbook_path);
-        } catch (e) {
-            console.log('File not found: hdocbook.json');
-            console.log(e, '\n');
-            console.log('hdoc bump needs to be run in the root of a HDoc Book.\n');
-            process.exit(1);
-        }
-        const initial_version = hdocbook_config.version;
-        let hdocbook_version = hdocbook_config.version.split('.');
-        if (hdocbook_version.length !== 3) {
-            console.log(`Book version does not appear to be in a semantic versioning format: ${initial_version}`);
-            process.exit(1);
-        }
-
-        if (isNaN(hdocbook_version[0])) {
-            console.log(`Existing major version is not a number: ${hdocbook_version[0]}`);
-            process.exit(1);
-        }
-        if (isNaN(hdocbook_version[1])) {
-            console.log(`Existing minor version is not a number: ${hdocbook_version[1]}`);
-            process.exit(1);
-        }
-        if (isNaN(hdocbook_version[2])) {
-            console.log(`Existing patch version is not a number: ${hdocbook_version[2]}`);
-            process.exit(1);
-        }
-
-        switch (bump_type) {
-            case 'major':
-                try {
-                    hdocbook_version[0] = parseInt(hdocbook_version[0], 10) + 1;
-                    hdocbook_version[1] = 0;
-                    hdocbook_version[2] = 0;
-                } catch (e) {
-                    console.log('Failed to update major version:');
-                    console.log(e);
-                    process.exit(1);
-                }
-                break;
-            case 'minor':
-                try {
-                    hdocbook_version[0] = parseInt(hdocbook_version[0], 10);
-                    hdocbook_version[1] = parseInt(hdocbook_version[1], 10) + 1;
-                    hdocbook_version[2] = 0;
-                } catch (e) {
-                    console.log('Failed to update minor version:');
-                    console.log(e);
-                    process.exit(1);
-                }
-                break;
-            case 'patch':
-            default:
-                try {
-                    hdocbook_version[0] = parseInt(hdocbook_version[0], 10);
-                    hdocbook_version[1] = parseInt(hdocbook_version[1], 10);
-                    hdocbook_version[2] = parseInt(hdocbook_version[2], 10) + 1;
-                } catch (e) {
-                    console.log('Failed to update patch version:');
-                    console.log(e);
-                    process.exit(1);
-                }
-                break;
-        }
-
-        hdocbook_config.version = hdocbook_version.join('.');
-
-        try {
-            fs.writeFileSync(hdocbook_path, JSON.stringify(hdocbook_config, null, 2));
-        } catch (e) {
-            console.log('Error writing bumped version to book config:', e);
-            process.exit(1);
-        }
-
-        console.log(`Book version updated from ${initial_version} to ${hdocbook_config.version}\n`);
-        return true;
-    };
-
+(function () {
+    'use strict';
+
+    const fs = require('fs'),
+        path = require('path');
+
+    exports.run = function (source_path, bump_type) {
+        if (bump_type !== 'patch' && bump_type !== 'minor' && bump_type !== 'major') {
+            console.log(`Unsupported bump type: ${bump_type}`);
+            process.exit(1);
+        }
+        console.log(`Bumping ${bump_type} book version...\n`);
+
+        // Get document ID
+        const hdocbook_project_config_path = path.join(source_path, 'hdocbook-project.json');
+        let hdocbook_project;
+        try {
+            hdocbook_project = require(hdocbook_project_config_path);
+        } catch (e) {
+            console.log('File not found: hdocbook-project.json:');
+            console.log(e, '\n');
+            console.log('hdoc bump needs to be run in the root of a HDoc Book.\n');
+            process.exit(1);
+        }
+        const doc_id = hdocbook_project.docId;
+
+        const book_path = path.join(source_path, doc_id),
+            hdocbook_path = path.join(book_path, 'hdocbook.json');
+
+        let hdocbook_config;
+        try {
+            hdocbook_config = require(hdocbook_path);
+        } catch (e) {
+            console.log('File not found: hdocbook.json');
+            console.log(e, '\n');
+            console.log('hdoc bump needs to be run in the root of a HDoc Book.\n');
+            process.exit(1);
+        }
+        const initial_version = hdocbook_config.version;
+        let hdocbook_version = hdocbook_config.version.split('.');
+        if (hdocbook_version.length !== 3) {
+            console.log(`Book version does not appear to be in a semantic versioning format: ${initial_version}`);
+            process.exit(1);
+        }
+
+        if (isNaN(hdocbook_version[0])) {
+            console.log(`Existing major version is not a number: ${hdocbook_version[0]}`);
+            process.exit(1);
+        }
+        if (isNaN(hdocbook_version[1])) {
+            console.log(`Existing minor version is not a number: ${hdocbook_version[1]}`);
+            process.exit(1);
+        }
+        if (isNaN(hdocbook_version[2])) {
+            console.log(`Existing patch version is not a number: ${hdocbook_version[2]}`);
+            process.exit(1);
+        }
+
+        switch (bump_type) {
+            case 'major':
+                try {
+                    hdocbook_version[0] = parseInt(hdocbook_version[0], 10) + 1;
+                    hdocbook_version[1] = 0;
+                    hdocbook_version[2] = 0;
+                } catch (e) {
+                    console.log('Failed to update major version:');
+                    console.log(e);
+                    process.exit(1);
+                }
+                break;
+            case 'minor':
+                try {
+                    hdocbook_version[0] = parseInt(hdocbook_version[0], 10);
+                    hdocbook_version[1] = parseInt(hdocbook_version[1], 10) + 1;
+                    hdocbook_version[2] = 0;
+                } catch (e) {
+                    console.log('Failed to update minor version:');
+                    console.log(e);
+                    process.exit(1);
+                }
+                break;
+            case 'patch':
+            default:
+                try {
+                    hdocbook_version[0] = parseInt(hdocbook_version[0], 10);
+                    hdocbook_version[1] = parseInt(hdocbook_version[1], 10);
+                    hdocbook_version[2] = parseInt(hdocbook_version[2], 10) + 1;
+                } catch (e) {
+                    console.log('Failed to update patch version:');
+                    console.log(e);
+                    process.exit(1);
+                }
+                break;
+        }
+
+        hdocbook_config.version = hdocbook_version.join('.');
+
+        try {
+            fs.writeFileSync(hdocbook_path, JSON.stringify(hdocbook_config, null, 2));
+        } catch (e) {
+            console.log('Error writing bumped version to book config:', e);
+            process.exit(1);
+        }
+
+        console.log(`Book version updated from ${initial_version} to ${hdocbook_config.version}\n`);
+        return true;
+    };
+
 })();