hdoc-tools 0.11.9 → 0.13.0

package/hdoc-build-db.js

@@ -33,6 +33,11 @@
             'name',
             'avatar UNINDEXED',
             'url UNINDEXED'
+        ],
+        hdoc_redirects: [
+            'resource_url',
+            'location_url',
+            'http_code INTEGER UNINDEXED'
         ]
     };
 
@@ -71,6 +76,31 @@
         return response;
     };
 
+    exports.populate_redirects = function (db, redirect_records, verbose = false) {
+        let response = {
+            success: true,
+            errors: [],
+            index_success_count: 0
+        };
+
+        for (let i = 0; i < redirect_records.length; i++) {
+            const index_vals = [
+                redirect_records[i].url,
+                redirect_records[i].location ? redirect_records[i].location : '',
+                redirect_records[i].code
+            ];
+            const index_response = hdoc_index.insert_record(db, 'hdoc_redirects', db_schema.hdoc_redirects, index_vals);
+            if (!index_response.success) {
+                response.success = false;
+                response.errors.push(`Redirect record creation failed - ${redirect_records[i].url}: ${index_response.error}`);
+            } else {
+                response.index_success_count++
+            }
+        }
+        console.log(`\nRedirect Index Build Complete: ${response.index_success_count} document records created.`);
+        return response;
+    };
+
     exports.populate_index = async function (db, doc_id, book_config, index_records, verbose = false) {
         let response = {
             success: false,
@@ -137,7 +167,7 @@
                             continue;
                         }
                         if (verbose) {
-                            console.log(`Inserted document contributor recordL ${cont_response.row_id}`);
+                            console.log(`Inserted document contributor record ${cont_response.row_id}`);
                         }
                     }
                     response.index_success_count++;

package/hdoc-build.js

@@ -54,6 +54,7 @@
         index_records = [],
         md_files = [],
         md_files_delete = [],
+        redirects = {},
         static_html_files = [],
         work_path_content = '',
         verbose = false;
@@ -214,6 +215,13 @@
                 });
             }
 
+            if (pdf_enable && !pdf_path_excluded(file_path.relativePath)) {
+                fm_headers.push({
+                    id: 'pdf-path',
+                    value: file_path.relativePath.replace(path.extname(file_path.relativePath), '.pdf')
+                })
+            }
+
             let fm_header_content = '<!--[[FRONTMATTER\n';
             if (fm_headers.length > 0) {
                 for (let i = 0; i < fm_headers.length; i++) {
@@ -228,13 +236,20 @@
 
             let doc_header = '';
             let pdf_header = '';
+            const inline_content = file_path.relativePath.startsWith(`${hdocbook_config.docId}/_inline/`);
             if (hdocbook_config.publicSource && hdocbook_config.publicSource.includes('github.com/Hornbill-Docs')) {
                 // Build doc header from template and frontmatter tags
-                doc_header = process_doc_header(fm_headers, file_path.relativePath, doc_header_template);
-                if (pdf_enable && !pdf_path_excluded(file_path.relativePath)) pdf_header = process_doc_header(fm_headers, file_path.relativePath, pdf_header_template);
+                if (!inline_content)
+                    doc_header = process_doc_header(fm_headers, file_path.relativePath, doc_header_template);
+
+                if (pdf_enable && !pdf_path_excluded(file_path.relativePath))
+                    pdf_header = process_doc_header(fm_headers, file_path.relativePath, pdf_header_template);
             } else {
-                doc_header = process_doc_header(fm_headers, file_path.relativePath, doc_header_template_non_git);
-                if (pdf_enable && !pdf_path_excluded(file_path.relativePath)) pdf_header = process_doc_header(fm_headers, file_path.relativePath, pdf_header_template_non_git);
+                if (!inline_content)
+                    doc_header = process_doc_header(fm_headers, file_path.relativePath, doc_header_template_non_git);
+
+                if (pdf_enable && !pdf_path_excluded(file_path.relativePath))
+                    pdf_header = process_doc_header(fm_headers, file_path.relativePath, pdf_header_template_non_git);
             }
 
             let pdf_size = 0;
@@ -248,7 +263,10 @@
             }
             if (pdf_size > 0) pdf_created++;
 
-            html_txt = `${fm_header_content}\n${doc_header}\n${html_txt}`;
+            if (inline_content)
+                html_txt = `${fm_header_content}\n${html_txt}`;
+            else
+                html_txt = `${fm_header_content}\n${doc_header}\n${html_txt}`;
 
             index_records.push({
                 relative_path: file_path.relativePath,
@@ -430,6 +448,13 @@
                 });
             }
 
+            if (pdf_enable && !pdf_path_excluded(file_path.relativePath)) {
+                fm_headers.push({
+                    id: 'pdf-path',
+                    value: file_path.relativePath.replace(path.extname(file_path.relativePath), '.pdf')
+                })
+            }
+
             // Add frontmatter tags as comment
             let fm_header = '<!--[[FRONTMATTER\n';
             if (fm_headers.length > 0) {
@@ -441,14 +466,21 @@
 
             let doc_header = '';
             let pdf_header = '';
+            const inline_content = file_path.relativePath.startsWith(`${hdocbook_config.docId}/_inline/`);
             if (hdocbook_config.publicSource && hdocbook_config.publicSource.includes('github.com/Hornbill-Docs')) {
                 // Build doc header from template and frontmatter tags
-                doc_header = process_doc_header(fm_headers, file_path.relativePath, doc_header_template);
-                if (pdf_enable && !pdf_path_excluded(file_path.relativePath)) pdf_header = process_doc_header(fm_headers, file_path.relativePath, pdf_header_template);
+                if (!inline_content)
+                    doc_header = process_doc_header(fm_headers, file_path.relativePath, doc_header_template);
+
+                if (pdf_enable && !pdf_path_excluded(file_path.relativePath))
+                    pdf_header = process_doc_header(fm_headers, file_path.relativePath, pdf_header_template);
             } else {
                 // Build doc header from template and frontmatter tags
-                doc_header = process_doc_header(fm_headers, file_path.relativePath, doc_header_template_non_git);
-                if (pdf_enable && !pdf_path_excluded(file_path.relativePath)) pdf_header = process_doc_header(fm_headers, file_path.relativePath, pdf_header_template_non_git);
+                if (!inline_content)
+                    doc_header = process_doc_header(fm_headers, file_path.relativePath, doc_header_template_non_git);
+
+                if (pdf_enable && !pdf_path_excluded(file_path.relativePath))
+                    pdf_header = process_doc_header(fm_headers, file_path.relativePath, pdf_header_template_non_git);
             }
 
             let pdf_size = 0;
@@ -461,7 +493,11 @@
                 pdf_size = await hdoc_build_pdf.generate_pdf(browser, pdf_template_path, pdf_template, hdocbook_config, pdf_txt, pdf_file_path, css_templates, verbose);
             }
             if (pdf_size > 0) pdf_created++;
-            html_txt = `${fm_header}\n${doc_header}\n${html_txt}`;
+
+            if (inline_content)
+                html_txt = `${fm_header}\n${html_txt}`;
+            else
+                html_txt = `${fm_header}\n${doc_header}\n${html_txt}`;
 
             // Save HTML into HTML file
             const target_file = file_path.path.replace(path.extname(file_path.path), '.html');
@@ -528,7 +564,14 @@
         let bc_tags = '\n';
         if (bc_for_path) {
             for (let i = 0; i < bc_for_path.length - 1; i++) {
-                const bc_link = bc_for_path[i].link.startsWith('/') ? bc_for_path[i].link : `/${bc_for_path[i].link}`;
+                let bc_link = '/';
+                if (redirects[bc_for_path[i].link]) {
+                    if (redirects[bc_for_path[i].link].location) {
+                        bc_link += redirects[bc_for_path[i].link].location;
+                    }
+                } else {
+                    bc_link = bc_for_path[i].link.startsWith('/') ? bc_for_path[i].link : `/${bc_for_path[i].link}`;
+                }
                 bc_tags += `\t\t\t\t<li class="mt-0 nav-bar-item"><a href="${bc_link}" class="ps-0 pe-0 text-decoration-none">${bc_for_path[i].text}</a></li>\n`;
             }
         } else {
@@ -622,6 +665,12 @@
             pdf_enable = hdocbook_project.pdfGeneration.enable;
         }
 
+        if (hdocbook_project.redirects && hdocbook_project.redirects instanceof Array) {
+            for (let i = 0; i < hdocbook_project.redirects.length; i++) {
+                redirects[hdocbook_project.redirects[i].url] = hdocbook_project.redirects[i];
+            }
+        }
+
         console.log(`Loading hdocbook config...`);
 
         const book_path = path.join(source_path, doc_id),
@@ -777,7 +826,6 @@
             }));
         }
 
-
         if (pdf_enable) {
             // Close the Chromium browser instance
             await browser.close();
@@ -796,7 +844,7 @@
         }
 
         // Validate content
-        const validation_success = await hdoc_validate.run(work_path, doc_id, verbose, hdocbook_config, hdocbook_project, bc, prod_families, prods_supported, gen_exclude);
+        const validation_success = await hdoc_validate.run(work_path, doc_id, verbose, hdocbook_config, hdocbook_project, bc, prod_families, prods_supported, gen_exclude, redirects);
         if (!validation_success) {
             const end_time = Date.now();
             console.log(`\nTime Taken: ${get_duration(start_time, end_time)}\n`);
@@ -835,14 +883,22 @@
             console.log(db.error);
             process.exit(1);
         }
-
+        // Populate primary index tables
         const index = await hdoc_build_db.populate_index(db.db, doc_id, hdocbook_config, index_records, verbose);
         if (!index.success) {
             console.log(index.error);
             process.exit(1);
         }
-        if (verbose) {
-            console.log(`Index Build Complete`);
+
+        // Populate redirect index table records
+        if (hdocbook_project.redirects && hdocbook_project.redirects instanceof Array && hdocbook_project.redirects.length > 0) {
+            const redirects_index = hdoc_build_db.populate_redirects(db.db, hdocbook_project.redirects, verbose);
+            if (!redirects_index.success) {
+                for (let i = 0; i < index.errors.length; i++) {
+                    console.log(index.errors[i]);
+                }
+                process.exit(1);
+            }
         }
 
         if (!validate) {

package/hdoc-serve.js

@@ -12,7 +12,8 @@
 
    let port = 3000;
    let docId;
-   let hdocbook_config;
+   let hdocbook_config,
+      hdocbook_project;
 
    exports.run = async function (ui_path, source_path, md) {
 
@@ -35,7 +36,7 @@
       console.log('    Server Port:', port);
 
       if (fs.existsSync(path.join(source_path, 'hdocbook-project.json')) == false) {
-         console.log("No hdocbook-project.js file found in working folder. Unable to continue.");
+         console.log("No hdocbook-project.json file found in working folder. Unable to continue.");
          return -1;
       }
 
@@ -47,7 +48,7 @@
       const hdocbook_project_config_path = path.join(source_path, 'hdocbook-project.json');
 
       // Load the hdocbook config  file
-      var hdocbook_project = require(hdocbook_project_config_path);
+      hdocbook_project = require(hdocbook_project_config_path);
 
       // Get the ID of the hdocbook we are serving
       docId = hdocbook_project.docId;
@@ -134,8 +135,10 @@
          return false;
       }
 
-      function send_content_file(req, res, file_path) {
+      function send_content_file(req, res, file_path, redirected = false) {
          let content_txt = hdoc.expand_variables(fs.readFileSync(file_path).toString(), docId);
+         if (redirected)
+            content_txt = `Redirected from ${redirected}\n\n${content_txt}`;
 
          let contentType = hdoc.content_type_for_ext(path.extname(file_path));
 
@@ -198,6 +201,17 @@
 
          console.log('URL Requested:', url);
 
+         // Process redirect
+         if (hdocbook_project.redirects && hdocbook_project.redirects instanceof Array && hdocbook_project.redirects.length > 0) {
+            const source_url = url.indexOf('/') === 0 ? url.replace('/', '') : url;
+            hdocbook_project.redirects.forEach(function (redir) {
+               if (redir.url === source_url && redir.location && redir.location !== '') {
+                  url = `/${redir.location}`;
+                  console.log(`Redirecting to ${url}`);
+               }
+            });
+         }
+
          let file_path = path.join(source_path, url);
 
          if (path.extname(file_path) == '.html') {

package/hdoc-validate.js

@@ -27,6 +27,7 @@
         md_to_validate = [],
         exclude_links = {},
         exclude_spellcheck = {},
+        redirects = {},
         exclude_h1_count = {},
         exclude_spellcheck_output = [];
 
@@ -97,6 +98,17 @@
                 const key_split = key.split('#');
                 const key_no_hash = key_split[0];
 
+                // See if there's a redirect in place
+                let redirected = false;
+                let redirect_errored = false;
+                const redir = await checkRedirect(source_path, key_no_hash);
+                if (redir.exists && redir.error !== null) {
+                    nav_errors.push(redir.error);
+                    redirect_errored = true;
+                } else if (redir.exists && redir.error === null) {
+                    redirected = true;
+                }
+
                 // Validate path exists - key should be a html file at this point
                 let file_exists = true;
                 let file_name = path.join(source_path, key_no_hash + '.html');
@@ -108,13 +120,19 @@
                             file_name = path.join(source_path, key_no_hash, 'index.htm');
                             if (!fs.existsSync(file_name)) {
                                 file_exists = false;
-                                nav_errors.push(`Navigation path [${key_no_hash}] file does not exist.`);
+                                if (!redirected && !redirect_errored)
+                                    nav_errors.push(`Navigation path [${key_no_hash}] file does not exist.`);
                             }
                         }
                     }
                 }
 
                 if (file_exists) {
+                    // File exists - but is there a redirect? If so, we want to flag this as an error
+                    if (redirected)
+                        nav_errors.push(`Navigation path [${key_no_hash}] is redirected, but path still exists.`);
+
+                    // Check file path case match
                     const true_file = trueCasePathSync(file_name).replace(source_path, '').replaceAll('\\', '/');
                     const relative_file = file_name.replace(source_path, '').replaceAll('\\', '/');
                     if (true_file !== relative_file) {
@@ -175,6 +193,33 @@
         return nav_errors;
     };
 
+    const checkRedirect = async function (source_path, nav_path) {
+        let response = {
+            exists: false,
+            error: null
+        }
+        if (redirects[nav_path]) {
+            response.exists = true;
+            if (redirects[nav_path].location) {
+                // We have a redirect, check if it's a valid location
+                let file_path = path.join(source_path, redirects[nav_path].location + '.html');
+                if (!fs.existsSync(file_path)) {
+                    file_path = path.join(source_path, redirects[nav_path].location + '.htm');
+                    if (!fs.existsSync(file_path)) {
+                        file_path = path.join(source_path, redirects[nav_path].location, 'index.html');
+                        if (!fs.existsSync(file_path)) {
+                            file_path = path.join(source_path, redirects[nav_path].location, 'index.htm');
+                            if (!fs.existsSync(file_path)) {
+                                response.error = `Redirect path for [${nav_path}] does not exist: ${redirects[nav_path].location}`;
+                            }
+                        }
+                    }
+                }
+            }
+        }
+        return response;
+    }
+
     const checkLinks = async function (source_path, htmlFile, links, hdocbook_config) {
         for (let i = 0; i < links.length; i++) {
 
@@ -369,8 +414,9 @@
         return links;
     };
 
-    exports.run = async function (source_path, doc_id, verbose, hdocbook_config, hdocbook_project, nav_items, prod_families, prods_supported, gen_exclude) {
+    exports.run = async function (source_path, doc_id, verbose, hdocbook_config, hdocbook_project, nav_items, prod_families, prods_supported, gen_exclude, gen_redirects) {
         console.log(`Performing Validation and Building SEO Link List...`);
+        redirects = gen_redirects;
 
         // Get a list of HTML files in source_path
         dree.scan(source_path, dreeOptions, fileCallback);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "hdoc-tools",
-  "version": "0.11.9",
+  "version": "0.13.0",
   "description": "Hornbill HDocBook Development Support Tool",
   "main": "hdoc.js",
   "bin": {