hdoc-tools 0.19.8 → 0.20.0

package/hdoc-serve.js

@@ -1,361 +1,390 @@
-(function () {
-   'use strict';
-
-   const express = require('express'),
-      fs = require('fs'),
-      path = require('path'),
-      hdoc = require(path.join(__dirname, 'hdoc-module.js')),
-      stream = require('stream');
-
-   const yaml = require('js-yaml');
-   const mdfm = require('markdown-it-front-matter');
-
-   let port = 3000;
-   let docId;
-   let hdocbook_config,
-      hdocbook_project,
-      inline_content = {},
-      global_source_path = '';
-
-   exports.run = async function (ui_path, source_path) {
-
-      global_source_path = source_path;
-      for (let x = 0; x < process.argv.length; x++) {
-         // First two arguments are command, and script
-         if (x == 0 || x == 1)
-            continue;
-
-         if (process.argv[x] == '-port') {
-            x++;
-            if (x < process.argv.length) {
-               port = process.argv[x];
-            }
-         }
-      }
-
-      console.log('Hornbill HDocBook Preview/Dev Server', '\r\n');
-      console.log('   UI Root Path:', ui_path);
-      console.log('  Document Path:', source_path, '\r\n');
-      console.log('    Server Port:', port);
-
-      if (fs.existsSync(path.join(source_path, 'hdocbook-project.json')) == false) {
-         console.error("No hdocbook-project.json file found in working folder. Unable to continue.");
-         return -1;
-      }
-
-      // In the root of the project there is a hdocbook.json file which includes
-      // the id of the hdocbook we are working with
-      const hdocbook_project_config_path = path.join(source_path, 'hdocbook-project.json');
-
-      // Load the hdocbook config  file
-      try {
-         hdocbook_project = require(hdocbook_project_config_path);
-      } catch (e) {
-         console.error(`\nFailed to load hdocbook-project.json:\n${e}\n`);
-         process.exit(1);
-      }
-
-      // Get the ID of the hdocbook we are serving
-      docId = hdocbook_project.docId;
-
-      // Get inline content for nav
-      const inline_path = path.join(source_path, docId, '_inline');
-      let nav_inline = {};
-      if (fs.existsSync(inline_path)) {
-         const inline_files = fs.readdirSync(inline_path);
-         nav_inline = {
-            text: 'Inline Help Items',
-            expand: true,
-            inline: true,
-            items: []
-         };
-         inline_files.forEach(file => {
-            nav_inline.items.push({
-               text: file.replace(path.extname(file), ''),
-               link: `${docId}/_inline/${file.replace(path.extname(file), '')}`
-            });
-         });
-      }
-      // Get an express server instance   
-      var app = express();
-
-      // Get the path of the book.json file
-      const hdocbook_path = path.join(source_path, docId, 'hdocbook.json');
-
-      // Pull in the book config file
-      try {
-         hdocbook_config = require(hdocbook_path);
-      } catch (e) {
-         console.error(`\nFailed to load hdocbook.json:${e}\n`);
-         process.exit(1);
-      }
-
-      app.get('/_books/library.json', function (req, res) {
-         let library = {
-            books: [{
-               docId: hdocbook_config.docId,
-               title: hdocbook_config.title,
-               nav_inline: nav_inline
-            }]
-         };
-         res.setHeader('Content-Type', 'application/json');
-         res.send(JSON.stringify(library, null, 3));
-      });
-
-      async function transform_markdown_and_send_html(req, res, file_path) {
-
-         if (fs.existsSync(file_path)) {
-            // we have a markdown representation of the requested HTML file, transform and return
-            // it to the caller
-
-            // Load markdown file
-            let md_txt = hdoc.expand_variables(fs.readFileSync(file_path).toString(), docId);
-
-            // Pull in external includes
-            const includes_processed = await hdoc.process_includes(file_path, md_txt, global_source_path);
-            md_txt = includes_processed.body;
-            if (includes_processed.errors && includes_processed.errors.length > 0) {
-               console.error(`Error(s) when processing includes in ${file_path}`);
-               for (let i = 0; i < includes_processed.errors.length; i++) {
-                  console.error(includes_processed.errors[i]);
-               }
-            } else {
-               if (includes_processed.success > 0) {
-                  console.log(`Includes injected into document: ${includes_processed.success}`);
-               }
-            }
-
-            const md = require('markdown-it')({
-               // enable everything
-               html: true,
-               linkify: true,
-               typographer: true
-            });
-
-            md.linkify.set({
-               fuzzyEmail: false,
-               fuzzyLink: false,
-               fuzzyIP: false
-            });
-            var frontmatter_content = "";
-            md.use(mdfm, function (fm) {
-               frontmatter_content = fm;
-            });
-
-            const tips = require(__dirname + '/custom_modules/tips.js');
-            md.use(tips, {
-               links: true
-            });
-
-            // Render markdown into HTML
-            var html_txt = md.render(md_txt.toString());
-
-            if (frontmatter_content.length) {
-
-               const obj = yaml.load(frontmatter_content);
-
-               const buff = Buffer.from(JSON.stringify(obj), 'utf-8');
-
-               const base64 = buff.toString('base64');
-
-               res.setHeader('X-frontmatter', base64);
-            }
-
-            res.setHeader('Content-Type', 'text/html');
-            res.send(html_txt);
-            return true;
-         }
-         return false;
-      }
-
-      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));
-
-         if (path.extname(file_path) == '.md') {
-            res.setHeader('Content-Disposition', 'inline');
-         }
-
-         res.setHeader('Content-Type', contentType);
-
-         res.send(content_txt);
-      }
-
-      function send_file(req, res, file_path) {
-         // Need to set the content type here??
-         let contentType = hdoc.content_type_for_ext(path.extname(file_path));
-         res.setHeader('Content-Type', contentType);
-
-         const r = fs.createReadStream(file_path);
-         const ps = new stream.PassThrough();
-         stream.pipeline(
-            r,
-            ps,
-            (err) => {
-               if (err) {
-                  console.error(err); // No such file or any other kind of error
-                  return res.sendStatus(400).send('Unexpected error');
-               }
-            });
-         ps.pipe(res);
-      }
-
-      function send_content_resource_404(req, res) {
-         res.setHeader('Content-Type', 'text/html');
-         res.status(404).send('Content resource not found');
-      }
-
-      // 1. If we request a file with a .html file extension, and that file DOES NOT exist,
-      // we will look for the same file but with a .md extension. If we find that 
-      // corresponding markdown file, we will transform that markdown file to HTML and 
-      // return the HTML content
-      //
-      // 2. If we request a file, without any file extension then we will look for that file
-      // with a .md extension, and if that file exists, we will transform that markdown 
-      // file to HTML and return that file. 
-      //
-      // For all other requests, we are going to look on the filesystem.  If we request 
-      // a specific file with its extension (including .md files), then we will simply 
-      // return the file verbatim as a static file.
-      //
-      // If we request a file without an extension and that file does not exist, we will
-      // assume that is a folder, will append index.html and look for that file, if present
-      // we will send it, if not present we will look for index.md, and if thats present 
-      // we will transform to HTML and return that
-      //
-      // Anything else in this handler will return a 404 error
-
-      app.get('/_books/*', function (req, res) {
-
-         let url = req.url.replace('/_books/', '/');
-
-         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 : `/${url}`;
-            hdocbook_project.redirects.forEach(function (redir) {
-               redir.url = redir.url.indexOf('/') === 0 ? redir.url : `/${redir.url}`
-               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') {
-            // 1a. check for html files, and send/transform as required
-            if (fs.existsSync(file_path)) {
-               // HTML file exists on disk, just return it verbatim
-               res.setHeader('Content-Type', 'text/html');
-               send_file(req, res, file_path);
-               return true;
-            }
-            if (fs.existsSync(file_path.replace('.html', '.md'))) {
-               if (transform_markdown_and_send_html(req, res, file_path.replace('.html', '.md'))) {
-                  return;
-               }
-            }
-
-         } else if (path.extname(file_path) == '.md') {
-            // If the markdown file exists, just send to caller as is
-            if (fs.existsSync(file_path)) {
-               send_content_file(req, res, file_path);
-               return true;
-            }
-
-         } else if (path.extname(file_path).length == 0) {
-            // 2. If we request a file, without any file extension
-            if (fs.existsSync(file_path + '.md')) {
-               if (transform_markdown_and_send_html(req, res, file_path + '.md')) {
-                  return;
-               }
-            } else if (fs.existsSync(path.join(file_path + 'index.md'))) {
-               if (transform_markdown_and_send_html(req, res, path.join(file_path, 'index.md'))) {
-                  return;
-               }
-            } else if (fs.existsSync(path.join(file_path + 'index.html'))) {
-               res.setHeader('Content-Type', 'text/html');
-               send_content_file(req, res, path.join(file_path + 'index.html'));
-               return;
-            } else if (fs.existsSync(file_path + '/index.md')) {
-               if (transform_markdown_and_send_html(req, res, file_path + '/index.md')) {
-                  return;
-               }
-            } else if (fs.existsSync(path.join(file_path + '/index.html'))) {
-               res.setHeader('Content-Type', 'text/html');
-               send_content_file(req, res, path.join(file_path + '/index.html'));
-               return;
-            } else if (fs.existsSync(path.join(file_path + '.html'))) {
-               res.setHeader('Content-Type', 'text/html');
-               send_content_file(req, res, path.join(file_path + '.html'));
-               return;
-            } else if (fs.existsSync(path.join(file_path + '.htm'))) {
-               res.setHeader('Content-Type', 'text/html');
-               send_content_file(req, res, path.join(file_path + '.htm'));
-               return;
-            }
-         } else if (fs.existsSync(file_path)) {
-            if (file_path.endsWith('hdocbook.json') || file_path.endsWith('hdocbook_project.json')) {
-               try {
-                  // Read & parse file
-                  JSON.parse(fs.readFileSync(file_path));
-               } catch (e) {
-                  console.error(`Error parsing hdocbook.json: ${e}`);
-
-               }
-            }
-            send_file(req, res, file_path);
-            return;
-         }
-
-         // Return a 404 error here
-         send_content_resource_404(req, res);
-      });
-
-      // Catch all
-      app.get('/*', function (req, res) {
-
-         let segs = req.url.split('/');
-
-         let ui_file_path = path.join(ui_path, req.url);
-
-         // To support the SPA application behavior, if there is no file extension present, then
-         // we simply return the /index.html file content to the client
-         if (path.extname(ui_file_path).length == 0) {
-            send_content_file(req, res, path.join(ui_path, 'index.html'));
-            return;
-         }
-
-         // If the file exists, send it.
-         if (fs.existsSync(ui_file_path) == true) {
-            send_content_file(req, res, ui_file_path);
-            return;
-         }
-
-         // All else fails, we have not file to return, so return a 404 error here
-         send_content_resource_404(req, res);
-      });
-
-      var server = app.listen(port, '0.0.0.0', function () {
-         var host = server.address().address;
-         var port = server.address().port;
-
-         console.log('Server listening at http://127.0.0.1:%s', port);
-         console.log('Document source path is: ' + source_path);
-
-         let _vars = ['{{DOC_ID}}', '{{BUILD_NUMBER}}', '{{BUILD_DATE}}'];
-         console.log("Server Vars:");
-         for (let x = 0; x < _vars.length; x++) {
-            let name = _vars[x];
-            console.log("   ", name, " = ", hdoc.expand_variables(name, docId));
-         }
-      });
-
-   };
-})();
+(() => {
+	const express = require("express");
+	const fs = require("node:fs");
+	const path = require("node:path");
+	const hdoc = require(path.join(__dirname, "hdoc-module.js"));
+	const stream = require("node:stream");
+
+	const yaml = require("js-yaml");
+	const mdfm = require("markdown-it-front-matter");
+
+	let port = 3000;
+	let docId;
+	let hdocbook_config;
+	let hdocbook_project;
+	let global_source_path = "";
+
+	exports.run = async (ui_path, source_path) => {
+		global_source_path = source_path;
+		for (let x = 0; x < process.argv.length; x++) {
+			// First two arguments are command, and script
+			if (x === 0 || x === 1) continue;
+
+			if (process.argv[x].toLowerCase() === "-port") {
+				x++;
+				if (x < process.argv.length) {
+					port = process.argv[x];
+				}
+			}
+		}
+
+		console.log("Hornbill HDocBook Preview/Dev Server", "\r\n");
+		console.log("   UI Root Path:", ui_path);
+		console.log("  Document Path:", source_path, "\r\n");
+		console.log("    Server Port:", port);
+
+		if (!fs.existsSync(path.join(source_path, "hdocbook-project.json"))) {
+			console.error(
+				"No hdocbook-project.json file found in working folder. Unable to continue.",
+			);
+			return -1;
+		}
+
+		// In the root of the project there is a hdocbook.json file which includes
+		// the id of the hdocbook we are working with
+		const hdocbook_project_config_path = path.join(
+			source_path,
+			"hdocbook-project.json",
+		);
+
+		// Load the hdocbook config  file
+		try {
+			hdocbook_project = require(hdocbook_project_config_path);
+		} catch (e) {
+			console.error(`\nFailed to load hdocbook-project.json:\n${e}\n`);
+			process.exit(1);
+		}
+
+		// Get the ID of the hdocbook we are serving
+		docId = hdocbook_project.docId;
+
+		// Get inline content for nav
+		const inline_path = path.join(source_path, docId, "_inline");
+		let nav_inline = {};
+		if (fs.existsSync(inline_path)) {
+			const inline_files = fs.readdirSync(inline_path);
+			nav_inline = {
+				text: "Inline Help Items",
+				expand: true,
+				inline: true,
+				items: [],
+			};
+			for (const file of inline_files) {
+				nav_inline.items.push({
+					text: file.replace(path.extname(file), ""),
+					link: `${docId}/_inline/${file.replace(path.extname(file), "")}`,
+				});
+			}
+		}
+		// Get an express server instance
+		const app = express();
+
+		// Get the path of the book.json file
+		const hdocbook_path = path.join(source_path, docId, "hdocbook.json");
+
+		// Pull in the book config file
+		try {
+			hdocbook_config = require(hdocbook_path);
+		} catch (e) {
+			console.error(`\nFailed to load hdocbook.json:${e}\n`);
+			process.exit(1);
+		}
+
+		app.get("/_books/library.json", (req, res) => {
+			const library = {
+				books: [
+					{
+						docId: hdocbook_config.docId,
+						title: hdocbook_config.title,
+						nav_inline: nav_inline,
+					},
+				],
+			};
+			res.setHeader("Content-Type", "application/json");
+			res.send(JSON.stringify(library, null, 3));
+		});
+
+		async function transform_markdown_and_send_html(req, res, file_path) {
+			if (fs.existsSync(file_path)) {
+				// we have a markdown representation of the requested HTML file, transform and return
+				// it to the caller
+
+				// Load markdown file
+				let md_txt = hdoc.expand_variables(
+					fs.readFileSync(file_path).toString(),
+					docId,
+				);
+
+				// Pull in external includes
+				const includes_processed = await hdoc.process_includes(
+					file_path,
+					md_txt,
+					global_source_path,
+				);
+				md_txt = includes_processed.body;
+				if (includes_processed.errors && includes_processed.errors.length > 0) {
+					console.error(`Error(s) when processing includes in ${file_path}`);
+					for (let i = 0; i < includes_processed.errors.length; i++) {
+						console.error(includes_processed.errors[i]);
+					}
+				} else {
+					if (includes_processed.success > 0) {
+						console.log(
+							`Includes injected into document: ${includes_processed.success}`,
+						);
+					}
+				}
+
+				const md = require("markdown-it")({
+					// enable everything
+					html: true,
+					linkify: true,
+					typographer: true,
+				});
+
+				md.linkify.set({
+					fuzzyEmail: false,
+					fuzzyLink: false,
+					fuzzyIP: false,
+				});
+				let frontmatter_content = "";
+				md.use(mdfm, (fm) => {
+					frontmatter_content = fm;
+				});
+
+				const tips = require(`${__dirname}/custom_modules/tips.js`);
+				md.use(tips, {
+					links: true,
+				});
+
+				// Render markdown into HTML
+				const html_txt = md.render(md_txt.toString());
+
+				if (frontmatter_content.length) {
+					const obj = yaml.load(frontmatter_content);
+
+					const buff = Buffer.from(JSON.stringify(obj), "utf-8");
+
+					const base64 = buff.toString("base64");
+
+					res.setHeader("X-frontmatter", base64);
+				}
+
+				res.setHeader("Content-Type", "text/html");
+				res.send(html_txt);
+				return true;
+			}
+			return false;
+		}
+
+		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}`;
+
+			const contentType = hdoc.content_type_for_ext(path.extname(file_path));
+
+			if (path.extname(file_path) === ".md") {
+				res.setHeader("Content-Disposition", "inline");
+			}
+
+			res.setHeader("Content-Type", contentType);
+
+			res.send(content_txt);
+		}
+
+		function send_file(req, res, file_path) {
+			// Need to set the content type here??
+			const contentType = hdoc.content_type_for_ext(path.extname(file_path));
+			res.setHeader("Content-Type", contentType);
+
+			const r = fs.createReadStream(file_path);
+			const ps = new stream.PassThrough();
+			stream.pipeline(r, ps, (err) => {
+				if (err) {
+					console.error(err); // No such file or any other kind of error
+					return res.sendStatus(400).send("Unexpected error");
+				}
+			});
+			ps.pipe(res);
+		}
+
+		function send_content_resource_404(req, res) {
+			res.setHeader("Content-Type", "text/html");
+			res.status(404).send("Content resource not found");
+		}
+
+		// 1. If we request a file with a .html file extension, and that file DOES NOT exist,
+		// we will look for the same file but with a .md extension. If we find that
+		// corresponding markdown file, we will transform that markdown file to HTML and
+		// return the HTML content
+		//
+		// 2. If we request a file, without any file extension then we will look for that file
+		// with a .md extension, and if that file exists, we will transform that markdown
+		// file to HTML and return that file.
+		//
+		// For all other requests, we are going to look on the filesystem.  If we request
+		// a specific file with its extension (including .md files), then we will simply
+		// return the file verbatim as a static file.
+		//
+		// If we request a file without an extension and that file does not exist, we will
+		// assume that is a folder, will append index.html and look for that file, if present
+		// we will send it, if not present we will look for index.md, and if thats present
+		// we will transform to HTML and return that
+		//
+		// Anything else in this handler will return a 404 error
+
+		app.get("/_books/*", (req, res) => {
+			let url = req.url.replace("/_books/", "/");
+
+			console.log("URL Requested:", url);
+
+			// Process redirect
+			if (
+				hdocbook_project.redirects &&
+				Array.isArray(hdocbook_project.redirects) &&
+				hdocbook_project.redirects.length > 0
+			) {
+				const source_url = url.indexOf("/") === 0 ? url : `/${url}`;
+				for (const redir of hdocbook_project.redirects) {
+					redir.url =
+						redir.url.indexOf("/") === 0 ? redir.url : `/${redir.url}`;
+					if (
+						redir.url === source_url &&
+						redir.location &&
+						redir.location !== ""
+					) {
+						url = `${redir.location}`;
+						console.log(`Redirecting to ${url}`);
+					}
+				}
+			}
+
+			const file_path = path.join(source_path, url);
+
+			if (path.extname(file_path) === ".html") {
+				// 1a. check for html files, and send/transform as required
+				if (fs.existsSync(file_path)) {
+					// HTML file exists on disk, just return it verbatim
+					res.setHeader("Content-Type", "text/html");
+					send_file(req, res, file_path);
+					return true;
+				}
+				if (fs.existsSync(file_path.replace(".html", ".md"))) {
+					if (
+						transform_markdown_and_send_html(
+							req,
+							res,
+							file_path.replace(".html", ".md"),
+						)
+					) {
+						return;
+					}
+				}
+			} else if (path.extname(file_path) === ".md") {
+				// If the markdown file exists, just send to caller as is
+				if (fs.existsSync(file_path)) {
+					send_content_file(req, res, file_path);
+					return true;
+				}
+			} else if (path.extname(file_path).length === 0) {
+				// 2. If we request a file, without any file extension
+				if (fs.existsSync(`${file_path}.md`)) {
+					if (transform_markdown_and_send_html(req, res, `${file_path}.md`)) {
+						return;
+					}
+				} else if (fs.existsSync(path.join(`${file_path}index.md`))) {
+					if (
+						transform_markdown_and_send_html(
+							req,
+							res,
+							path.join(file_path, "index.md"),
+						)
+					) {
+						return;
+					}
+				} else if (fs.existsSync(path.join(`${file_path}index.html`))) {
+					res.setHeader("Content-Type", "text/html");
+					send_content_file(req, res, path.join(`${file_path}index.html`));
+					return;
+				} else if (fs.existsSync(`${file_path}/index.md`)) {
+					if (
+						transform_markdown_and_send_html(req, res, `${file_path}/index.md`)
+					) {
+						return;
+					}
+				} else if (fs.existsSync(path.join(`${file_path}/index.html`))) {
+					res.setHeader("Content-Type", "text/html");
+					send_content_file(req, res, path.join(`${file_path}/index.html`));
+					return;
+				} else if (fs.existsSync(path.join(`${file_path}.html`))) {
+					res.setHeader("Content-Type", "text/html");
+					send_content_file(req, res, path.join(`${file_path}.html`));
+					return;
+				} else if (fs.existsSync(path.join(`${file_path}.htm`))) {
+					res.setHeader("Content-Type", "text/html");
+					send_content_file(req, res, path.join(`${file_path}.htm`));
+					return;
+				}
+			} else if (fs.existsSync(file_path)) {
+				if (
+					file_path.endsWith("hdocbook.json") ||
+					file_path.endsWith("hdocbook_project.json")
+				) {
+					try {
+						// Read & parse file
+						JSON.parse(fs.readFileSync(file_path));
+					} catch (e) {
+						console.error(`Error parsing hdocbook.json: ${e}`);
+					}
+				}
+				send_file(req, res, file_path);
+				return;
+			}
+
+			// Return a 404 error here
+			send_content_resource_404(req, res);
+		});
+
+		// Catch all
+		app.get("/*", (req, res) => {
+			const segs = req.url.split("/");
+
+			const ui_file_path = path.join(ui_path, req.url);
+
+			// To support the SPA application behavior, if there is no file extension present, then
+			// we simply return the /index.html file content to the client
+			if (path.extname(ui_file_path).length === 0) {
+				send_content_file(req, res, path.join(ui_path, "index.html"));
+				return;
+			}
+
+			// If the file exists, send it.
+			if (fs.existsSync(ui_file_path)) {
+				send_content_file(req, res, ui_file_path);
+				return;
+			}
+
+			// All else fails, we have not file to return, so return a 404 error here
+			send_content_resource_404(req, res);
+		});
+
+		const server = app.listen(port, "0.0.0.0", () => {
+			const host = server.address().address;
+			const port = server.address().port;
+
+			console.log("Server listening at http://127.0.0.1:%s", port);
+			console.log(`Document source path is: ${source_path}`);
+
+			const _vars = ["{{DOC_ID}}", "{{BUILD_NUMBER}}", "{{BUILD_DATE}}"];
+			console.log("Server Vars:");
+			for (let x = 0; x < _vars.length; x++) {
+				const name = _vars[x];
+				console.log("   ", name, " = ", hdoc.expand_variables(name, docId));
+			}
+		});
+	};
+})();