Merge pull request #27 from Klemek/dev

GitBlog v1.2.8

.travis.yml

@@ -11,5 +11,6 @@ install:
 before_script:
   - npm install -g jshint
 script:
-  - jest --silent --coverage --coverageReporters=text-lcov | coveralls
+  - jest --coverage --silent
   - jshint ./src
+  - cat ./coverage/lcov.info | coveralls

README.md

@@ -1,8 +1,9 @@
-# GitBlog.md
-
-
 [![Build Status](https://img.shields.io/travis/Klemek/GitBlog.md.svg?branch=master)](https://travis-ci.org/Klemek/GitBlog.md)
 [![Coverage Status](https://img.shields.io/coveralls/github/Klemek/GitBlog.md.svg?branch=master)](https://coveralls.io/github/Klemek/GitBlog.md?branch=master)
+[![Language grade: JavaScript](https://img.shields.io/lgtm/grade/javascript/g/Klemek/GitBlog.md.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/Klemek/GitBlog.md/context:javascript)
+[![Total alerts](https://img.shields.io/lgtm/alerts/g/Klemek/GitBlog.md.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/Klemek/GitBlog.md/alerts/)
+
+# GitBlog.md
 
 A static blog using Markdown pulled from your git repository.
 
@@ -125,6 +126,34 @@ Resources are located on the `data` folder and can be referenced as the root of
 /styles/main.css => data/styles/main.css
 ```
 
+In your template, the following data is sent :
+
+<details>
+<summary>details (click)</summary>
+<p>
+
+* `info`  (every pages)
+  * `title` :  the blog's title as in the config
+  * `description` the blog's description as in the config
+  * `host` : the specified or guessed host with the protocol
+  * `version` : the GitBlog.md current running version
+  * `request` : the Express request object
+  * `config` : the content of the config
+* `article` (article pages only)
+  * `title` : the full title
+  * `thumbnail` the URL path of the thumbnail
+  * `url` : the URL path for this article (with the title)
+  * `date` : a JS date
+  * `year`
+  * `month`
+  * `day`
+  * `path` : the URL path for the folder of the article (without the title)
+  * `realPath` : the system's path for the folder
+  * `escapedTitle` : the code with alphanumeric and underscore characters only
+* `error` (error pages only) : the error code
+</p>
+</details>
+
 #### 5. Create and init your git source
 
 You need to [create a new repository](https://github.com/new) on your favorite Git service.
@@ -168,6 +197,14 @@ Here are the steps for Github, if you use another platform adapt it your way (he
 * Update your webhook on github to include the secret
 * Check if Github successfully reached the endpoint
 
+#### 8. Keep your server always up and running (optionnal)
+
+This project `package.json` comes with a [nodemon](https://github.com/remy/nodemon) config. 
+
+After installing (`npm i -g nodemon`) you can then run the app with juste the `nodemon` command in the working directory.
+
+With this method, you can do a simple `git pull` to update your server.
+
 ## Writing an article
 [back to top](#gitblog-md)
 
@@ -209,16 +246,24 @@ Any URL like `/year/month/day/anything/` will redirect to this article (and link
   It allows you to add math equations to your articles by simply writing LaTeX between `$$` for full size (and between $ for inline) (more info [here](https://www.mathjax.org/))
 * **PlantUML**  
   It allows you to add UML diagrams with PlantUML Syntax between `@startuml` and `@enduml` (more info [here](http://www.plantuml.com))
+* **fa-diagrams**  
+  It allows you to define SVG diagrams with Font-Awesome icons in [TOML](https://github.com/toml-lang/toml) between `@startfad` and `@endfad` (more info [here](https://github.com/Klemek/fa-diagrams))
+
 
 ## Configuration
 [back to top](#gitblog-md)
 
 *  `node_port` (default: 3000)  
   the port the server is listening to
+*  `host` (default: none)  
+  if set (like `https://mywebsite.com`, it will be used as reference for creating links  
+  by default, host is guessed based on first request
 * `data_dir` (default: data)  
   the directory where will be located the git repo with templates and articles
 * `view_engine` (default: ejs)  
   the Express view engine used to render pages from templates
+* `rate_limit` (default: 100)  
+  number of requests allowed in a time-frame of 15 minutes
 * `access_log` (default: access.log)  
   log file where to save access requests (empty to disable)
 * `error_log` (default: error.log)  
@@ -234,6 +279,8 @@ Any URL like `/year/month/day/anything/` will redirect to this article (and link
      activate MathJax equations formatting
    * `plantuml` (default: true)  
      activate PlantUML diagram rendering
+   * `fa-diagrams` (default: true)  
+     activate fa-diagrams rendering
 * `home`
    * `title` (default: GitBlog.md)  
      the title of your blog, **strongly advised to be changed**  
@@ -247,11 +294,13 @@ Any URL like `/year/month/day/anything/` will redirect to this article (and link
    * `error` (default: error.ejs)  
      the name of the error page template on the data directory  
      it will receive `error`, the error code
-   * `hidden` (default: `[.ejs]`)  
-     file extensions to be returned 404 when reached
+   * `hidden` (default: `[*.ejs,/.git*]`)  
+     path matches to be returned 404 when reached
 * `article`
    * `index` (default: index.md)  
      the name of the Markdown page of the article on the `/year/month/day/` directory
+   * `draft` (default: draft.md)  
+     the name of the Markdown page of an article not shown on the list
    * `template` (default: template.ejs)  
      the name of the article page template on the data directory
    * `thumbnail_tag`: (default: thumbnail)  

lgtm.yml

@@ -0,0 +1,7 @@
+path_classifiers:
+  test:
+    - test
+  docs:
+    - uml
+  library:
+    - src/lib

package.json

@@ -1,13 +1,15 @@
 {
   "name": "gitblog.md",
-  "version": "1.2.0",
+  "version": "1.2.8",
   "description": "A static blog using Markdown pulled from your git repository.",
   "main": "src/server.js",
   "dependencies": {
+    "@iarna/toml": "^2.2.3",
     "body-parser": "^1.19.0",
-    "crypto": "^1.0.1",
     "ejs": "^2.6.2",
     "express": "^4.17.1",
+    "express-rate-limit": "^5.0.0",
+    "fa-diagrams": "^1.0.3",
     "mathjax-node": "^2.1.1",
     "ncp": "^2.0.0",
     "node-prismjs": "^0.1.2",
@@ -16,8 +18,6 @@
     "showdown": "^1.9.0"
   },
   "devDependencies": {
-    "babel-cli": "^6.26.0",
-    "babel-preset-env": "^1.7.0",
     "coveralls": "^3.0.4",
     "jest": "^24.8.0",
     "superagent": "^5.1.0",
@@ -46,5 +46,16 @@
       "!src/postinstall.js",
       "!src/lib/*.js"
     ]
+  },
+  "nodemonConfig": {
+    "verbose": true,
+    "ignore": [
+      "test/*",
+      "sample_data/*",
+      "data/*",
+      "uml/*",
+      "*.log",
+      "README.md"
+    ]
   }
 }

sample_data/article/index.md

@@ -19,6 +19,7 @@ If you see this page, that means it's working
 * [Spoilers](#spoilers)
 * [Math Equations](#mathequations)
 * [UML](#uml)
+* [Diagrams](#diagrams)
 * [Youtube Videos](#youtubevideos)
 
 ### Headers
@@ -253,6 +254,34 @@ showdown -left-> express : 4. html
 express -up-> web : 5. html
 @enduml
 
+### Diagrams
+[Back to top](#top)
+
+You can use [fa-diagrams](https://github.com/Klemek/fa-diagrams) with `@startfad` and `@endfad` tags and using [TOML](https://github.com/toml-lang/toml) inside
+
+@startfad
+[[nodes]]
+name = "node1"
+icon = "laptop-code"
+color = "#4E342E"
+bottom = "my app"
+
+[[nodes]]
+name = "node2"
+icon = "globe"
+color = "#455A64"
+bottom = "world"
+
+[[links]]
+from = "node1"
+to = "node2"
+color = "#333333"
+bottom = '"hello"'
+
+  [links.top]
+  icon = "envelope"
+@endfad
+
 ### Youtube Videos
 [Back to top](#top)
 

sample_data/home/error.ejs

@@ -1,9 +1,8 @@
 <!DOCTYPE html>
 <html lang="en">
 <head>
-    <meta charset="UTF-8">
-    <title><%= info.title %> - Error <%= error %></title>
     <%- include('head'); %>
+    <title><%= info.title %> - Error <%= error %></title>
 </head>
 <body>
 <main>

sample_data/home/head.ejs

@@ -1,21 +1,26 @@
+<meta charset="UTF-8">
+<meta http-equiv="content-type" content="text/html;charset=UTF-8">
+<META NAME="ROBOTS" CONTENT="INDEX, FOLLOW">
+
 <meta name="twitter:card" content="summary_large_image">
-<% if(locals.article){ %>
-    <%- `<meta property="og:title" content="${info.title} - ${article.title}">` %>
-    <%- `<meta property="twitter:title" content="${info.title} - ${article.title}">` %>
 <%- `<meta property="og:description" content="${info.description}">` %>
 <%- `<meta property="twitter:description" content="${info.description}">` %>
+<% if(locals.article){ %>
     <%- `<meta property="org:url" content="${info.host + article.url}">` %>
+    <%- `<meta property="og:title" content="${info.title} - ${article.title}">` %>
+    <%- `<meta property="twitter:title" content="${info.title} - ${article.title}">` %>
     <% if (article.thumbnail) { %>
         <%- `<meta property="og:image" content="${info.host}/${article.thumbnail}">` %>
         <%- `<meta property="twitter:image" content="${info.host}/${article.thumbnail}">` %>
     <% } %>
-    <link rel="stylesheet" type="text/css" href="/prism.css">
+
+    <link rel="stylesheet" type="text/css" href="/css/prism.css">
 <% } else { %>
+    <%- `<meta property="org:url" content="${info.host}/">` %>
     <%- `<meta property="og:title" content="${info.title} - Home">` %>
     <%- `<meta property="twitter:title" content="${info.title} - Home">` %>
-    <%- `<meta property="og:description" content="${info.description}">` %>
-    <%- `<meta property="twitter:description" content="${info.description}">` %>
-    <%- `<meta property="org:url" content="${info.host}/">` %>
+
+    <%- `<meta property="description" content="${info.description}">` %>
 <% } %>
 
 <link rel="alternate" type="application/rss+xml" title="RSS feed" href="/rss"/>

sample_data/home/index.ejs

@@ -1,22 +1,23 @@
 <!DOCTYPE html>
 <html lang="en">
 <head>
-    <meta charset="UTF-8">
-    <title><%= info.title %> - Home</title>
     <%- include('head'); %>
+    <title><%= info.title %> - Home</title>
 </head>
 <body>
 <main>
-    <h1><%= info.title %></h1>
+    <h1 class="title"><%= info.title %></h1>
     <%= info.description %>
     <h2>Articles in this blog :</h2>
     <% articles.forEach((article) => { %>
         <div class="article">
-            <h3><%- `<a href="${article.url}">${article.title}</a>` %></h3>
-            <span class="time"><span>Published on</span> <%= article.year + '-' + article.month + '-' + article.day %></span>
+            <%- `<a href="${article.url}">` %>
+            <h3><%- `${article.title}` %></h3>
+            <span class="time"><span>Published on</span>&nbsp;&nbsp;<%= article.year + '-' + ('0' + article.month).slice(-2) + '-' + ('0' + article.day).slice(-2) %></span>
             <% if(article.thumbnail){ %>
                 <%- `<img alt="thumbnail" src=${article.thumbnail}>` %>
             <% } %>
+            <%- `</a>` %>
         </div>
     <% }); %>
     <%- include('footer'); %>

sample_data/home/style.css

@@ -16,7 +16,7 @@ body {
 }
 
 main {
-    max-width: 42rem;
+    max-width: 45rem;
     padding: 2rem;
     margin: auto;
     background-color: #F0F0F0;
@@ -54,6 +54,13 @@ pre {
     padding: 10px 16px;
 }
 
+:not(pre) > code {
+    padding: 0.25em 0.5em;
+    border-radius: 0.25em;
+    background: #DDD;
+    font-size: 90%;
+}
+
 blockquote {
     border-left: 0.5em solid #ccc;
     padding-left: 1em;
@@ -108,10 +115,11 @@ main.article div.header a.link-home {
     line-height: 2.4;
 }
 
-main.article div.header h1, main.article div.header h2 {
+main.article div.header h1, main.article div.header h2, .title {
     margin-top: 0.85em;
     margin-bottom: 0.25em;
     font-size: 2em;
+    font-weight: bold;
 }
 
 main.article div.header h1 a, main.article div.header h2 a, div.article h3 a {
@@ -129,6 +137,12 @@ div.article {
 div.article h3 {
     font-size: 1.3em;
     margin:0;
+    color: #3C3CA1;
+}
+
+div.article a {
+    text-decoration: none;
+    color: inherit;
 }
 
 div.article img{
@@ -138,6 +152,15 @@ div.article img{
     margin-top:0.25em;
 }
 
+div.article:hover {
+    opacity: 0.9;
+}
+
+div.article:active {
+    opacity: 0.8;
+}
+
+
 #text {
     text-align: justify;
     hyphens: auto;
@@ -147,7 +170,7 @@ div.article img{
     text-align: left;
 }
 
-#text img {
+#text img, #text svg {
     max-width: 100%;
     height: auto;
 }

sample_data/home/template.ejs

@@ -1,16 +1,15 @@
 <!DOCTYPE html>
 <html lang="en">
 <head>
-    <meta charset="UTF-8">
-    <title><%= info.title %> - <%= article.title %></title>
     <%- include('head'); %>
+    <title><%= info.title %> - <%= article.title %></title>
 </head>
 <body>
 <main class="article">
     <div class="header">
         <a class="link-home" href="/">↑</a>
         <h1><%= article.title %></h1>
-        <span class="time"><span>Published on</span> <%= article.year + '-' + article.month + '-' + article.day %></span>
+        <span class="time"><span><%= article.draft ? 'Drafted on' : 'Published on' %></span>&nbsp;&nbsp;<%= article.year + '-' + ('0' + article.month).slice(-2) + '-' + ('0' + article.day).slice(-2) %></span>
     </div>
     <div id="text"><%- article.content %></div>
     <br>

src/app.js

@@ -3,6 +3,7 @@ const app = express();
 const fs = require('fs');
 const path = require('path');
 const pjson = require('../package.json');
+const rateLimit = require('express-rate-limit');
 
 app.enable('trust proxy');
 
@@ -26,6 +27,28 @@ const cons = {
 };
 
 module.exports = (config) => {
+  /**
+   * Fetch articles from the data folder and send success as a response
+   * @param success
+   * @param error
+   */
+  let reload;
+  /**
+   * Render the page with the view engine and catch errors
+   * @param req
+   * @param res
+   * @param vPath - path of the view
+   * @param data - data to pass to the view
+   * @param code - code to send along the page
+   */
+  let render;
+  /**
+   * Show an error with the correct page
+   * @param req
+   * @param res
+   * @param code - error code
+   */
+  let showError;
   const fw = require('./file_walker')(config);
   const renderer = require('./renderer')(config);
 
@@ -36,14 +59,9 @@ module.exports = (config) => {
 
   const articles = {};
   let lastRSS = '';
-  let host;
+  let host = config['host'];
 
-  /**
-   * Fetch articles from the data folder and send success as a response
-   * @param success
-   * @param error
-   */
-  const reload = (success, error) => {
+  reload = (success, error) => {
     fw.fetchArticles((err, dict) => {
       if (err) {
         console.error(cons.error, 'error loading articles : ' + err);
@@ -52,8 +70,9 @@ module.exports = (config) => {
       Object.keys(articles).forEach((key) => delete articles[key]);
       Object.keys(dict).forEach((key) => articles[key] = dict[key]);
       const nb = Object.keys(articles).length;
+      const dnb = Object.values(articles).filter(a => a.draft).length;
       if (nb > 0)
-        console.log(cons.ok, `loaded ${nb} article${nb > 1 ? 's' : ''}`);
+        console.log(cons.ok, `loaded ${nb} article${nb > 1 ? 's' : ''} (${dnb} drafted)`);
       else
         console.log(cons.warn, `no articles loaded, check your configuration`);
 
@@ -65,42 +84,34 @@ module.exports = (config) => {
   if (config['test'])
     app.reload = reload;
 
-  /**
-   * Render the page with the view engine and catch errors
-   * @param res
-   * @param vPath - path of the view
-   * @param data - data to pass to the view
-   * @param code - code to send along the page
-   */
-  const render = (res, vPath, data, code = 200) => {
+  render = (req, res, vPath, data, code = 200) => {
     data.info = {
       title: config['home']['title'],
       description: config['home']['description'],
       host: host,
-      version: pjson.version
+      version: pjson.version,
+      request: req,
+      config: config
     };
     res.render(vPath, data, (err, html) => {
-      if (err) {
+      if (err && vPath !== path.join(config['data_dir'], config['home']['error'])) {
+        console.log(cons.error, `failed to render page ${vPath} : ${err}`);
+        showError(req, res, 500);
+      } else if (err) {
         res.sendStatus(500);
-        console.log(cons.error, `failed to render ${vPath} : ${err}`);
+        console.log(cons.error, `failed to render error page : ${err}`);
       } else
         res.status(code).send(html);
     });
   };
 
-  /**
-   * Show an error with the correct page
-   * @param resPath - the page of the original error
-   * @param code - error code
-   * @param res
-   */
-  const showError = (resPath, code, res) => {
+  showError = (req, res, code) => {
     const errorPath = path.join(config['data_dir'], config['home']['error']);
     fs.access(errorPath, fs.constants.R_OK, (err) => {
       if (err)
         res.sendStatus(code);
       else
-        render(res, errorPath, {error: code, path: resPath}, code);
+        render(req, res, errorPath, {error: code}, code);
     });
   };
 
@@ -112,6 +123,13 @@ module.exports = (config) => {
     next();
   });
 
+  //rate limit for safer server
+  const limiter = rateLimit({
+    windowMs: 15 * 60 * 1000, // 15 minutes
+    max: config['rate_limit']
+  });
+  app.use(limiter);
+
   //log request at result end
   app.use((req, res, next) => {
     if (config['access_log']) {
@@ -133,9 +151,13 @@ module.exports = (config) => {
     const homePath = path.join(config['data_dir'], config['home']['index']);
     fs.access(homePath, fs.constants.R_OK, (err) => {
       if (err)
-        showError(req.path, 404, res);
+        showError(req, res, 404);
       else
-        render(res, homePath, {articles: Object.values(articles).sort((a, b) => ('' + b.path).localeCompare(a.path))});
+        render(req, res, homePath,
+          {
+            articles: Object.values(articles)
+              .filter(d => !d.draft).sort((a, b) => ('' + b.path).localeCompare(a.path))
+          });
     });
   });
 
@@ -146,15 +168,15 @@ module.exports = (config) => {
         const feed = new Rss({
           'title': config['rss']['title'],
           'description': config['rss']['description'],
-          'feed_url': 'http://' + req.headers.host + req.url,
-          'site_url': 'http://' + req.headers.host
+          'feed_url': host + req.url,
+          'site_url': host
         });
         Object.values(articles)
           .slice(0, config['rss']['length'])
           .forEach((article) => {
             feed.item({
               title: article.title,
-              url: 'http://' + req.headers.host + article.url,
+              url: host + article.url,
               date: article.date
             });
           });
@@ -162,7 +184,7 @@ module.exports = (config) => {
       }
       res.type(req.headers['user-agent'].match(/Mozilla/) ? 'text/xml' : 'rss').send(lastRSS);
     } else {
-      showError(req.path, 404, res);
+      showError(req, res, 404);
     }
   });
 
@@ -205,21 +227,21 @@ module.exports = (config) => {
       const articlePath = req.path.substr(1, 10);
       const article = articles[articlePath];
       if (!article)
-        showError(req.path, 404, res);
+        showError(req, res, 404);
       else {
-        renderer.render(path.join(article.realPath, config['article']['index']), (err, html) => {
+        renderer.render(article.realPath, (err, html) => {
           if (err) {
             console.log(cons.error, `failed to render article ${req.path} : ${err}`);
-            return showError(req.path, 500, res);
+            return showError(req, res, 500);
           }
           article.content = html;
           const templatePath = path.join(config['data_dir'], config['article']['template']);
           fs.access(templatePath, fs.constants.R_OK, (err) => {
             if (err) {
               console.log(cons.error, `no template found at ${templatePath}`);
-              showError(req.path, 500, res);
+              showError(req, res, 500);
             } else
-              render(res, templatePath, {article: article});
+              render(req, res, templatePath, {article: article});
           });
         });
       }
@@ -229,18 +251,17 @@ module.exports = (config) => {
   });
 
   // catch all hidden file type and return 404
-  app.get('*', (req, res, next) => {
-    if (config['home']['hidden'].includes(path.extname(req.path)))
-      showError(req.path, 404, res);
-    else
-      next();
+  config['home']['hidden'].forEach(pathMatcher => {
+    app.get(pathMatcher, (req, res) => {
+      showError(req, res, 404);
+    });
   });
 
   // serve all static files via get
   app.get('*', express.static(path.join(__dirname, '..', config['data_dir'])));
   // catch express.static errors (mostly not found) by displaying 404
   app.get('*', (req, res) => {
-    showError(req.path, 404, res);
+    showError(req, res, 404);
   });
 
   // catch all other methods and return 400

src/config.default.json

@@ -1,7 +1,9 @@
 {
   "node_port": 3000,
+  "host": "",
   "data_dir": "data",
   "view_engine": "ejs",
+  "rate_limit": 100,
   "access_log": "access.log",
   "error_log": "error.log",
   "modules": {
@@ -9,7 +11,8 @@
     "webhook": true,
     "prism": true,
     "mathjax": true,
-    "plantuml": true
+    "plantuml": true,
+    "fa-diagrams": true
   },
   "home": {
     "title": "GitBlog.md",
@@ -17,11 +20,13 @@
     "index": "index.ejs",
     "error": "error.ejs",
     "hidden": [
-      ".ejs"
+      "*.ejs",
+      "/.git*"
     ]
   },
   "article": {
     "index": "index.md",
+    "draft": "draft.md",
     "template": "template.ejs",
     "thumbnail_tag": "thumbnail",
     "default_title": "Untitled",

src/file_walker.js

@@ -72,7 +72,7 @@ module.exports = (config) => {
           return cb(err);
         const paths = fileList
           .map((p) => p.substr(config['data_dir'].length + 1).split(path.sep))
-          .filter((p) => p.length === 4 && p[3] === config['article']['index'] &&
+          .filter((p) => p.length === 4 && (p[3] === config['article']['index'] || p[3] === config['article']['draft']) &&
             /^\d{4}$/.test(p[0]) && /^\d{2}$/.test(p[1]) && /^\d{2}$/.test(p[2]));
         if (paths.length === 0)
           cb(null, {});
@@ -81,7 +81,8 @@ module.exports = (config) => {
         paths.forEach((p) => {
           const article = {
             path: joinUrl(p[0], p[1], p[2]),
-            realPath: path.join(config['data_dir'], p[0], p[1], p[2]),
+            draft: p[3] === config['article']['draft'],
+            realPath: path.join(config['data_dir'], p[0], p[1], p[2], p[3]),
             year: parseInt(p[0]),
             month: parseInt(p[1]),
             day: parseInt(p[2])
@@ -89,13 +90,14 @@ module.exports = (config) => {
           article.date = new Date(article.year, article.month, article.day);
           article.date.setUTCHours(0);
           remaining++;
-          readIndexFile(path.join(article.realPath, config['article']['index']), config['article']['thumbnail_tag'], (err, info) => {
+          readIndexFile(article.realPath, config['article']['thumbnail_tag'], (err, info) => {
             if (err)
               return cb(err);
             article.title = info.title || config['article']['default_title'];
             article.thumbnail = info.thumbnail ? joinUrl(article.path, info.thumbnail) : config['article']['default_thumbnail'];
             article.escapedTitle = article.title.toLowerCase().replace(/[^\w]/gm, ' ').trim().replace(/ /gm, '_');
             article.url = '/' + joinUrl(article.path, article.escapedTitle) + '/';
+            if (!articles[article.path] || !article.draft)
               articles[article.path] = article;
             remaining--;
             if (remaining === 0)

src/renderer.js

@@ -5,6 +5,54 @@ const showdown = require('showdown');
 module.exports = (config) => {
   const converter = new showdown.Converter(config['showdown']);
 
+  /**
+   * get parts outside of codes/scripts
+   * @param {string} data
+   * @returns {{index:number, end:number, text:string}[]} parts
+   */
+  const getParts = (data) => {
+    let parts = [];
+    let match;
+    let i = 0;
+    while ((match = /```/m.exec(data.slice(i)))) {
+      parts.push({
+        index: i,
+        text: data.slice(i, i + match.index),
+      });
+      i += match.index + match[0].length;
+    }
+    if (i < data.length)
+      parts.push({
+        index: i,
+        text: data.slice(i, data.length),
+      });
+
+    parts = parts.filter((p, i) => i % 2 === 0); //filter out code parts
+
+    // detect scripts outside of code
+    parts.forEach((p, pi) => {
+      let i = 0;
+      const subParts = [];
+      while ((match = /(<script>((?:(?!<\/script>)[\s\S])*)<\/script>)/gm.exec(p.text.slice(i)))) {
+        subParts.push({
+          index: p.index + i,
+          text: p.text.slice(i, i + match.index),
+        });
+        i += match.index + match[0].length;
+      }
+      if (i < p.text.length)
+        subParts.push({
+          index: p.index + i,
+          text: p.text.slice(i, p.text.length),
+        });
+      parts.splice(pi, 1, ...subParts);
+    });
+
+    parts.forEach(part => part.end = part.index + part.text.length);
+
+    return parts;
+  };
+
   const renderShowDown = (data, cb) => {
     const html = converter.makeHtml(data);
     cb(html);
@@ -35,15 +83,19 @@ module.exports = (config) => {
   const renderPlantUML = (data, cb) => {
     if (!config['modules']['plantuml'])
       return cb(data);
+    const parts = getParts(data);
     const umlRegex = /@startuml\r?\n((?:(?!@enduml)[\s\S])*)\r?\n@enduml/m;
     let match;
-    while ((match = umlRegex.exec(data))) {
+    parts.forEach(part => {
+      while ((match = umlRegex.exec(part.text))) {
         const code = match[1].trim();
         const s = unescape(encodeURIComponent(code)); // jshint ignore:line
         const compressed = global['zip_deflate'](s);
         const url = `http://www.plantuml.com/plantuml/${config['plantuml']['output_format']}/${encode64(compressed)}`;// jshint ignore:line
-      data = data.slice(0, match.index) + `<img alt="generated PlantUML diagram" src="${url}">` + data.slice(match.index + match[0].length);
+        part.text = part.text.slice(0, match.index) + `<img alt="generated PlantUML diagram" src="${url}">` + part.text.slice(match.index + match[0].length);
       }
+      data = data.slice(0, part.index) + part.text + data.slice(part.end);
+    });
     cb(data);
   };
 
@@ -64,7 +116,9 @@ module.exports = (config) => {
     if (!config['modules']['mathjax'])
       return cb(data);
 
-    const doMJ = (match, format) => {
+    const parts = getParts(data);
+
+    const doMJ = (match, format, i) => {
       const eq = match[1].trim();
       const output = config['mathjax']['output_format'];
       const mjConf = {
@@ -74,7 +128,7 @@ module.exports = (config) => {
       };
       mjConf[output] = true;
       mjAPI.typeset(mjConf, (res) => {
-        data = data.slice(0, match.index) + res[output] + data.slice(match.index + match[0].length);
+        data = data.slice(0, parts[i].index + match.index) + res[output] + data.slice(parts[i].index + match.index + match[0].length);
         renderMathJax(data, (data2) => {
           cb(data2);
         });
@@ -84,29 +138,72 @@ module.exports = (config) => {
     const eqRegex = /\$\$((?:(?!\$\$)[\s\S])*)\$\$/m;
     const inlineEqRegex = /\$([^$\n]*)\$/;
 
+    for (let i = 0; i < parts.length; i++) {
       let match;
-    if ((match = eqRegex.exec(data))) {
-      doMJ(match, 'TeX');
-    } else if ((match = inlineEqRegex.exec(data))) {
-      doMJ(match, 'inline-TeX');
-    } else {
-      cb(data);
+      if ((match = eqRegex.exec(parts[i].text))) {
+        return doMJ(match, 'TeX', i);
+      } else if ((match = inlineEqRegex.exec(parts[i].text))) {
+        return doMJ(match, 'inline-TeX', i);
       }
+    }
+    cb(data);
+  };
+
+  let faDiagrams;
+  let toml;
+  if (config['modules']['fa-diagrams']) {
+    faDiagrams = require('fa-diagrams');
+    toml = require('@iarna/toml');
+  }
+
+  const renderFaDiagrams = (data, cb) => {
+    if (!config['modules']['fa-diagrams'])
+      return cb(data);
+    const parts = getParts(data);
+    const diagramsRegex = /@startfad\r?\n((?:(?!@endfad)[\s\S])*)\r?\n@endfad/m;
+    let match;
+    parts.forEach(part => {
+      while ((match = diagramsRegex.exec(part.text))) {
+        const code = match[1].trim();
+        let output;
+        try {
+          const diagData = toml.parse(code);
+          const findLineBreaks = (data) => {
+            Object.keys(data).forEach(key => {
+              if (typeof data[key] === 'object')
+                findLineBreaks(data[key]);
+              else if (typeof data[key] === 'string')
+                data[key] = data[key].replace(/\\n/gm, '\n');
+            });
+          };
+          findLineBreaks(diagData);
+          output = faDiagrams.compute(diagData);
+        } catch (err) {
+          output = `<b style="color:red">${err.toString()}</b>`;
+        }
+        part.text = part.text.slice(0, match.index) + output + part.text.slice(match.index + match[0].length);
+      }
+      data = data.slice(0, part.index) + part.text + data.slice(part.end);
+    });
+    cb(data);
   };
 
   return {
+    getParts: config['test'] ? getParts : undefined,
     renderShowDown: config['test'] ? renderShowDown : undefined,
     renderPrism: config['test'] ? renderPrism : undefined,
     renderPlantUML: config['test'] ? renderPlantUML : undefined,
     renderMathJax: config['test'] ? renderMathJax : undefined,
+    renderFaDiagrams: config['test'] ? renderFaDiagrams : undefined,
     render: (file, cb) => {
       fs.readFile(file, {encoding: 'UTF-8'}, (err, data) => {
         if (err)
           return cb(err);
 
-        renderPrism(data, (data) => {
         renderPlantUML(data, (data) => {
+          renderFaDiagrams(data, (data) => {
             renderMathJax(data, (data) => {
+              renderPrism(data, (data) => {
                 renderShowDown(data, (html) => {
                   cb(null, html);
                 });
@@ -114,6 +211,7 @@ module.exports = (config) => {
             });
           });
         });
+      });
     }
   };
 };

test/app.test.js

@@ -16,16 +16,15 @@ config['data_dir'] = dataDir;
 config['webhook']['endpoint'] = '/webhooktest';
 config['rss']['endpoint'] = '/rsstest';
 config['rss']['length'] = 2;
-config['home']['index'] = testIndex;
 config['home']['error'] = testError;
 config['article']['template'] = testTemplate;
 
 const app = require('../src/app')(config);
 
 beforeEach((done, fail) => {
+  config['home']['index'] = testIndex;
   config['data_dir'] = dataDir;
   config['article']['index'] = 'index.md';
-  config['home']['hidden'] = ['.ejs', '.test'];
   config['access_log'] = '';
   config['error_log'] = '';
   config['modules']['rss'] = true;
@@ -93,20 +92,20 @@ describe('Test request logging', () => {
 
 describe('Test error logging', () => {
   test('test no log', (done) => {
-    config['home']['hidden'] = null;
-    request(app).get('/somefile.txt').then(() => {
+    config['home']['index'] = null;
+    request(app).get('/').then(() => {
       expect(fs.existsSync(path.join(dataDir, 'error.log'))).toBe(false);
       done();
     });
   });
   test('test null error ', (done) => {
-    config['home']['hidden'] = null;
+    config['home']['index'] = null;
     config['error_log'] = path.join(dataDir, 'error.log');
-    request(app).get('/somefile.txt').then(() => {
+    request(app).get('/').then(() => {
       fs.readFile(path.join(dataDir, 'error.log'), {encoding: 'UTF-8'}, (err, data) => {
         expect(err).toBeNull();
         const start = data.split('\n').slice(0, 2).join('\n');
-        const expected = '500 GET /somefile.txt ' + new Date().toUTCString() + ' ::ffff:127.0.0.1\nTypeError: Cannot read property \'includes\' of null';
+        const expected = '500 GET / ' + new Date().toUTCString() + ' ::ffff:127.0.0.1\nTypeError [ERR_INVALID_ARG_TYPE]: The "path" argument must be of type string. Received type object';
         expect(start).toBe(expected);
         done();
       });
@@ -122,10 +121,10 @@ describe('Test root path', () => {
     });
   });
   test('404 no index but error page', (done) => {
-    fs.writeFileSync(path.join(dataDir, testError), 'error <%= error %> at <%= path %>');
+    fs.writeFileSync(path.join(dataDir, testError), 'error <%= error %>');
     request(app).get('/').then((response) => {
       expect(response.statusCode).toBe(404);
-      expect(response.text).toBe('error 404 at /');
+      expect(response.text).toBe('error 404');
       done();
     });
   });
@@ -136,6 +135,23 @@ describe('Test root path', () => {
       done();
     });
   });
+  test('500 render error with page', (done) => {
+    fs.writeFileSync(path.join(dataDir, testIndex), 'articles <%= null.length %>');
+    fs.writeFileSync(path.join(dataDir, testError), 'error <%= error %>');
+    request(app).get('/').then((response) => {
+      expect(response.statusCode).toBe(500);
+      expect(response.text).toBe('error 500');
+      done();
+    });
+  });
+  test('500 render error with failing page', (done) => {
+    fs.writeFileSync(path.join(dataDir, testIndex), 'articles <%= null.length %>');
+    fs.writeFileSync(path.join(dataDir, testError), 'error <%= null.error %>');
+    request(app).get('/').then((response) => {
+      expect(response.statusCode).toBe(500);
+      done();
+    });
+  });
   test('200 no articles', (done) => {
     fs.writeFileSync(path.join(dataDir, testIndex), 'articles <%= articles.length %>');
     request(app).get('/').then((response) => {
@@ -144,14 +160,17 @@ describe('Test root path', () => {
       done();
     });
   });
-  test('200 2 articles', (done, fail) => {
+  test('200 2 articles 1 drafted', (done, fail) => {
     utils.createEmptyDirs([
       path.join(dataDir, '2019', '05', '05'),
-      path.join(dataDir, '2018', '05', '05')
+      path.join(dataDir, '2018', '05', '05'),
+      path.join(dataDir, '2017', '05', '05')
     ]);
     utils.createEmptyFiles([
-      path.join(dataDir, '2019', '05', '05', 'index.md'),
-      path.join(dataDir, '2018', '05', '05', 'index.md')
+      path.join(dataDir, '2019', '05', '05', 'draft.md'),
+      path.join(dataDir, '2018', '05', '05', 'index.md'),
+      path.join(dataDir, '2018', '05', '05', 'draft.md'),
+      path.join(dataDir, '2017', '05', '05', 'index.md'),
     ]);
     fs.writeFileSync(path.join(dataDir, testIndex), 'articles <%= articles.length %>');
     app.reload(() => {
@@ -303,12 +322,11 @@ describe('Test articles rendering', () => {
     });
   });
 
-  test('500 no index', (done, fail) => {
+  test('500 fail to render', (done, fail) => {
     utils.createEmptyDirs([path.join(dataDir, '2019', '05', '05'),]);
     fs.writeFileSync(path.join(dataDir, '2019', '05', '05', 'index.md'), '# Hello');
-    fs.writeFileSync(path.join(dataDir, testTemplate), '<%- article.content %><%- `<a href="${article.url}">reload</a>` %>');
+    fs.writeFileSync(path.join(dataDir, testTemplate), '<%- articl.content %><%- `<a href="${article.url}">reload</a>` %>');
     app.reload(() => {
-      config['article']['index'] = 'invalid.md';
       request(app).get('/2019/05/05/hello/').then((response) => {
         expect(response.statusCode).toBe(500);
         done();
@@ -340,6 +358,19 @@ describe('Test articles rendering', () => {
     }, fail);
   });
 
+  test('200 rendered draft', (done, fail) => {
+    utils.createEmptyDirs([path.join(dataDir, '2019', '05', '05'),]);
+    fs.writeFileSync(path.join(dataDir, '2019', '05', '05', 'draft.md'), '# Hello');
+    fs.writeFileSync(path.join(dataDir, testTemplate), '<%- article.content %><%- `<a href="${article.url}">reload</a>` %>');
+    app.reload(() => {
+      request(app).get('/2019/05/05/hello/').then((response) => {
+        expect(response.statusCode).toBe(200);
+        expect(response.text).toBe('<h1 id="hello">Hello</h1><a href="/2019/05/05/hello/">reload</a>');
+        done();
+      });
+    }, fail);
+  });
+
   test('200 other url', (done, fail) => {
     utils.createEmptyDirs([path.join(dataDir, '2019', '05', '05'),]);
     utils.createEmptyFiles([
@@ -378,16 +409,25 @@ describe('Test static files', () => {
     });
   });
   test('404 invalid file but error page', (done) => {
-    fs.writeFileSync(path.join(dataDir, testError), 'error <%= error %> at <%= path %>');
+    fs.writeFileSync(path.join(dataDir, testError), 'error <%= error %>');
     request(app).get('/somefile.txt').then((response) => {
       expect(response.statusCode).toBe(404);
-      expect(response.text).toBe('error 404 at /somefile.txt');
+      expect(response.text).toBe('error 404');
       done();
     });
   });
   test('404 hidden file', (done) => {
-    fs.writeFileSync(path.join(dataDir, 'somefile.test'), '');
-    request(app).get('/somefile.test').then((response) => {
+    utils.createEmptyDirs([path.join(dataDir, 'tmp')]);
+    fs.writeFileSync(path.join(dataDir, 'tmp', 'somefile.ejs'), '');
+    request(app).get('/tmp/somefile.ejs').then((response) => {
+      expect(response.statusCode).toBe(404);
+      done();
+    });
+  });
+  test('404 hidden folder', (done) => {
+    utils.createEmptyDirs([path.join(dataDir, '.git')]);
+    fs.writeFileSync(path.join(dataDir, '.git', 'file.txt'), '');
+    request(app).get('/.git/file.txt').then((response) => {
       expect(response.statusCode).toBe(404);
       done();
     });

test/config.test.js

@@ -77,5 +77,5 @@ test('array fix', () => {
   fs.writeFileSync(configFile, '{"home":{"hidden":{}}}');
   const config = require('../src/config')();
   expect(config).toBeDefined();
-  expect(config['home']['hidden']).toEqual(['.ejs']);
+  expect(config['home']['hidden']).toEqual(['*.ejs', '/.git*']);
 });

test/file_walker.test.js

@@ -13,6 +13,7 @@ const config = {
   'data_dir': dataDir,
   'article': {
     'index': testIndex,
+    'draft': 'draft.md',
     'default_title': 'Untitled',
     'default_thumbnail': 'default.png',
     'thumbnail_tag': 'thumbnail'
@@ -235,9 +236,10 @@ describe('Test article fetching', () => {
       expect(Object.keys(dict).length).toBe(1);
       expect(dict[joinUrl('2019', '05', '05')]).toEqual({
         path: joinUrl('2019', '05', '05'),
-        realPath: dir,
+        realPath: file,
         year: 2019,
         month: 5,
+        draft: false,
         day: 5,
         date: date,
         title: 'Untitled',
@@ -265,10 +267,11 @@ describe('Test article fetching', () => {
       expect(Object.keys(dict).length).toBe(1);
       expect(dict[joinUrl('2019', '05', '05')]).toEqual({
         path: joinUrl('2019', '05', '05'),
-        realPath: dir,
+        realPath: file,
         year: 2019,
         month: 5,
         day: 5,
+        draft: false,
         date: date,
         title: 'Title with : info !',
         thumbnail: joinUrl('2019', '05', '05', './thumbnail.jpg'),
@@ -278,5 +281,64 @@ describe('Test article fetching', () => {
       done();
     });
   });
+  test('correct draft file', (done) => {
+    const dir = path.join(dataDir, '2019', '05', '05');
+    const file = path.join(dir, 'draft.md');
+    utils.createEmptyDirs([dir]);
+    fs.writeFileSync(file, `
+           # Title with : info !
+           ![thumbnail](./thumbnail.jpg)
+           this is some text
+           `);
+    const date = new Date(2019, 5, 5);
+    date.setUTCHours(0);
+    fw.fetchArticles((err, dict) => {
+      expect(err).toBeNull();
+      expect(dict).toBeDefined();
+      expect(Object.keys(dict).length).toBe(1);
+      expect(dict[joinUrl('2019', '05', '05')]).toEqual({
+        path: joinUrl('2019', '05', '05'),
+        realPath: file,
+        year: 2019,
+        month: 5,
+        day: 5,
+        draft: true,
+        date: date,
+        title: 'Title with : info !',
+        thumbnail: joinUrl('2019', '05', '05', './thumbnail.jpg'),
+        escapedTitle: 'title_with___info',
+        url: '/' + joinUrl('2019', '05', '05', 'title_with___info') + '/',
+      });
+      done();
+    });
+  });
+  test('index file override draft', (done) => {
+    const dir = path.join(dataDir, '2019', '05', '05');
+    const file = path.join(dir, testIndex);
+    const file2 = path.join(dir, 'draft.md');
+    utils.createEmptyDirs([dir]);
+    utils.createEmptyFiles([file, file2]);
+    const date = new Date(2019, 5, 5);
+    date.setUTCHours(0);
+    fw.fetchArticles((err, dict) => {
+      expect(err).toBeNull();
+      expect(dict).toBeDefined();
+      expect(Object.keys(dict).length).toBe(1);
+      expect(dict[joinUrl('2019', '05', '05')]).toEqual({
+        path: joinUrl('2019', '05', '05'),
+        realPath: file,
+        year: 2019,
+        month: 5,
+        draft: false,
+        day: 5,
+        date: date,
+        title: 'Untitled',
+        thumbnail: 'default.png',
+        escapedTitle: 'untitled',
+        url: '/' + joinUrl('2019', '05', '05', 'untitled') + '/',
+      });
+      done();
+    });
+  });
 });
 

test/renderer.test.js

@@ -11,7 +11,8 @@ const config = {
   'modules': {
     'prism': true,
     'mathjax': true,
-    'plantuml': true
+    'plantuml': true,
+    'fa-diagrams': true,
   },
   'showdown': {
     'simplifiedAutoLink': true,
@@ -32,6 +33,7 @@ beforeEach(() => {
   config['modules']['prism'] = true;
   config['modules']['mathjax'] = true;
   config['modules']['plantuml'] = true;
+  config['modules']['fa-diagrams'] = true;
   utils.deleteFolderSync(dataDir);
   fs.mkdirSync(dataDir);
 });
@@ -42,6 +44,47 @@ afterAll(() => {
   }
 });
 
+describe('get parts', () => {
+  test('normal', () => {
+    const data = 'Hello\nthere\ngeneral\nkenobi';
+    const parts = renderer.getParts(data);
+    expect(parts.map(p => p.text)).toEqual([
+      'Hello\nthere\ngeneral\nkenobi'
+    ]);
+  });
+  test('lot of stuff', () => {
+    const data = 'Hello\nthere\n```code```\ngeneral<script>script</script>\n<script>script2</script>\n```<script>script3</script>```kenobi';
+    const parts = renderer.getParts(data);
+    expect(parts).toEqual([
+      {
+        index: 0,
+        end: 12,
+        text: 'Hello\nthere\n'
+      },
+      {
+        index: 22,
+        end: 30,
+        text: '\ngeneral'
+      },
+      {
+        index: 53,
+        end: 54,
+        text: '\n'
+      },
+      {
+        index: 78,
+        end: 79,
+        text: '\n'
+      },
+      {
+        index: 109,
+        end: 115,
+        text: 'kenobi'
+      },
+    ]);
+  });
+});
+
 describe('Test Showdown', () => {
   test('normal', (done) => {
     renderer.renderShowDown('# Hello', (html) => {
@@ -112,6 +155,13 @@ describe('Test PlantUML', () => {
     });
   });
 
+  test('plantuml ignored in code', (done) => {
+    renderer.renderPlantUML('code:\n```@startuml\nBob -> Alice : hello\n@enduml```\n ```@startuml``` @enduml', (data) => {
+      expect(data).toBe('code:\n```@startuml\nBob -> Alice : hello\n@enduml```\n ```@startuml``` @enduml');
+      done();
+    });
+  });
+
   test('plantuml multiple uml', (done) => {
     renderer.renderPlantUML('@startuml\nBob -> Alice : hello\n@enduml\n@startuml\nBob -> Alice : hello\n@enduml', (data) => {
       expect(data).toBe('<img alt="generated PlantUML diagram" src="http://www.plantuml.com/plantuml/svg/SyfFKj2rKt3CoKnELR1Io4ZDoSa70000">\n<img alt="generated PlantUML diagram" src="http://www.plantuml.com/plantuml/svg/SyfFKj2rKt3CoKnELR1Io4ZDoSa70000">');
@@ -157,6 +207,12 @@ describe('Test MathJax', () => {
       done();
     });
   });
+  test('no eq in code / script', (done) => {
+    renderer.renderMathJax('this code is ```start $a$ end $$hello$$``` beautiful <script>$A$</script>\n```$no eq$```', (data) => {
+      expect(data).toBe('this code is ```start $a$ end $$hello$$``` beautiful <script>$A$</script>\n```$no eq$```');
+      done();
+    });
+  });
   test('multiple eq', (done) => {
     renderer.renderMathJax('$$\n\nA\n\n$$\nstart $a$ end\n$$\n\nA\n\n$$', (data) => {
       expect(data).toBe('' +
@@ -182,6 +238,37 @@ describe('Test MathJax', () => {
   });
 });
 
+describe('Test fa-diagrams', () => {
+  test('no fa-diagrams', (done) => {
+    config['modules']['fa-diagrams'] = false;
+    renderer.renderFaDiagrams('@startfad\noptions.rendering.color=\'red\'\n@endfad', (data) => {
+      expect(data).toBe('@startfad\noptions.rendering.color=\'red\'\n@endfad');
+      done();
+    });
+  });
+  test('no fa-diagrams in code', (done) => {
+    renderer.renderFaDiagrams('code:\n```\n@startfad\noptions.rendering.color=\'red\'\n@endfad\n```', (data) => {
+      expect(data).toBe('code:\n```\n@startfad\noptions.rendering.color=\'red\'\n@endfad\n```');
+      done();
+    });
+  });
+  test('valid fa-diagrams', (done) => {
+    renderer.renderFaDiagrams('before\n@startfad\noptions.rendering.color=\'red\'\n@endfad\nafter', (data) => {
+      expect(data).toBe('before\n<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 0 0" width="0" height="0" font-family="Arial" font-size="15" fill="red" stroke-width="0"></svg>\nafter');
+      done();
+    });
+  });
+  test('invalid toml', (done) => {
+    renderer.renderFaDiagrams('before\n@startfad\noptions.rendering.color=red\n@endfad\nafter', (data) => {
+      expect(data).toBe('before\n<b style="color:red">TomlError: Unexpected character, expecting string, number, datetime, boolean, inline array or inline table at row 1, col 26, pos 25:\n' +
+        '1> options.rendering.color=red\n' +
+        '                            ^\n' +
+        '\n</b>\nafter');
+      done();
+    });
+  });
+});
+
 describe('Test render', () => {
   test('invalid file', (done) => {
     renderer.render('invalid file', (err, html) => {

uml/article.txt

@@ -10,6 +10,7 @@ node nodejs {
 }
 
 package data {
+    [template.ejs]
     package "2019/06/18" {
         component index [
             index.md
@@ -22,6 +23,7 @@ package data {
 web -down-> TCP : 1. /2019/06/18/title
 express -down-> index : 2. fetch
 index -up-> showdown : 3. markdown
+template.ejs -up-> express : 4
 showdown -left-> express : 4. html
 express -up-> web : 5. html