From 664ddc6737d20b218371ce638d7716ccdbd53ac8 Mon Sep 17 00:00:00 2001
From: Unrud <unrud@outlook.com>
Date: Sun, 5 Dec 2021 13:26:36 +0100
Subject: [PATCH] Insert branches into <select> in template

---
 assets/document-branches.js           | 23 +++++-----
 documentation-generator/run.py        | 62 ++++++++++++---------------
 documentation-generator/template.html | 14 +++---
 3 files changed, 46 insertions(+), 53 deletions(-)

diff --git a/assets/document-branches.js b/assets/document-branches.js
index 7edf0fda..1fb68829 100644
--- a/assets/document-branches.js
+++ b/assets/document-branches.js
@@ -1,15 +1,16 @@
 window.addEventListener("load", function() {
-    let select = document.querySelector("header .documentBranch select");
-    while (select.length > 0) {
-        select.remove(0);
-    }
-    for (let branch of documentBranches) {
-        select.add(new Option(branch, branch, branch === documentBranch, branch === documentBranch), 0);
-    }
-    select.addEventListener("change", function() {
-        if (select.value !== documentBranch) {
-            location.assign(encodeURIComponent(select.value + ".html"));
-            select.value = documentBranch;
+    function resetSelect(select) {
+        for (let option of select.options) {
+            option.selected = option.defaultSelected;
         }
+    }
+    let select = document.querySelector("header .documentBranch select");
+    resetSelect(select);
+    select.addEventListener("change", function() {
+        let option = select.selectedOptions.item(0);
+        if (option && !option.defaultSelected) {
+            location.assign(option.value);
+        }
+        resetSelect(select);
     });
 });
diff --git a/documentation-generator/run.py b/documentation-generator/run.py
index 4b095da1..6aeb180e 100755
--- a/documentation-generator/run.py
+++ b/documentation-generator/run.py
@@ -9,7 +9,6 @@ Gracefully handles conflicting commits.
 
 import contextlib
 import glob
-import html
 import json
 import os
 import re
@@ -17,7 +16,7 @@ import shutil
 import subprocess
 import sys
 import urllib.parse
-from tempfile import TemporaryDirectory
+from tempfile import NamedTemporaryFile, TemporaryDirectory
 
 REMOTE = "origin"
 GIT_CONFIG = {"protocol.version": "2",
@@ -41,41 +40,34 @@ PANDOC_SHA256 = ("2001d93463c003f8fee6c36b1bfeccd5"
 BRANCH_ORDERING = [  # Format: (REGEX, ORDER, DEFAULT)
     (r"v?\d+(?:\.\d+)*(?:\.x)*", 0, True),
     (r".*", 1, False)]
-
-
-def escape_js(s):
-    return s.translate(str.maketrans({
-        "\t": "\\t",
-        "\v": "\\v",
-        "\0": "\\0",
-        "\b": "\\b",
-        "\f": "\\f",
-        "\n": "\\n",
-        "\r": "\\r",
-        "\'": "\\'",
-        "\"": "\\\"",
-        "\\": "\\\\"}))
+PROG = "documentation-generator"
 
 
 def convert_doc(src_path, to_path, branch, branches):
-    raw_html = subprocess.run([
-        PANDOC_EXE,
-        "--sandbox",
-        "--from=gfm",
-        "--to=html5",
-        os.path.abspath(src_path),
-        "--toc",
-        "--template=%s" % os.path.basename(TEMPLATE_PATH),
-        "--metadata=document-css=false",
-        "--section-divs",
-        "--shift-heading-level-by=%d" % SHIFT_HEADING,
-        "--toc-depth=%d" % (TOC_DEPTH+SHIFT_HEADING),
-        "--filter=%s" % os.path.abspath(FILTER_EXE),
-        "--variable=branch_html=%s" % html.escape(branch),
-        "--variable=branch_js=%s" % escape_js(branch),
-        *("--variable=branches_js=%s" % escape_js(b) for b in branches)],
-        cwd=os.path.dirname(TEMPLATE_PATH),
-        stdout=subprocess.PIPE, check=True).stdout
+    with NamedTemporaryFile(mode="w", prefix="%s-" % PROG,
+                            suffix=".json") as metadata_file:
+        json.dump({
+            "document-css": False,
+            "branch": branch,
+            "branches": [{"default": b == branch,
+                          "href": urllib.parse.quote_plus("%s.html" % b),
+                          "name": b} for b in branches]}, metadata_file)
+        metadata_file.flush()
+        raw_html = subprocess.run([
+            PANDOC_EXE,
+            "--sandbox",
+            "--from=gfm",
+            "--to=html5",
+            os.path.abspath(src_path),
+            "--toc",
+            "--template=%s" % os.path.basename(TEMPLATE_PATH),
+            "--metadata-file=%s" % os.path.abspath(metadata_file.name),
+            "--section-divs",
+            "--shift-heading-level-by=%d" % SHIFT_HEADING,
+            "--toc-depth=%d" % (TOC_DEPTH+SHIFT_HEADING),
+            "--filter=%s" % os.path.abspath(FILTER_EXE)],
+            cwd=os.path.dirname(TEMPLATE_PATH),
+            stdout=subprocess.PIPE, check=True).stdout
     raw_html = subprocess.run([POSTPROCESSOR_EXE], input=raw_html,
                               stdout=subprocess.PIPE, check=True).stdout
     with open(to_path, "wb") as f:
@@ -153,7 +145,7 @@ def main():
     run_git_fetch_and_restart_if_changed(remote_commits, target_branch)
     branches = [ref[len("refs/remotes/%s/" % REMOTE):] for ref in run_git(
         "rev-parse", "--symbolic-full-name", "--remotes=%s" % REMOTE)]
-    with TemporaryDirectory() as temp:
+    with TemporaryDirectory(prefix="%s-" % PROG) as temp:
         branch_docs = {}
         for branch in branches[:]:
             checkout(branch)
diff --git a/documentation-generator/template.html b/documentation-generator/template.html
index 077aa9a2..3f6572f3 100644
--- a/documentation-generator/template.html
+++ b/documentation-generator/template.html
@@ -15,24 +15,24 @@ $endif$
 <noscript><link href="assets/screen-noscript.css" media="screen" rel="stylesheet"></noscript>
 <link href="https://github.com/Kozea/Radicale/releases.atom" type="application/atom+xml" rel="alternate" title="Radicale Releases">
 <link href="assets/icon.png" type="image/png" rel="icon">
-<title>Radicale $branch_html$ Documentation</title>
+<title>Radicale $branch$ Documentation</title>
 <meta name="description" content="Free and Open-Source CalDAV and CardDAV Server">
 <script src="assets/navigation.js"></script>
 <script src="assets/document-branches.js"></script>
 <script src="assets/narrow-menu.js"></script>
 <script src="assets/navigation-scroll-fix.js"></script>
-<script>
-    const documentBranch = "$branch_js$";
-    const documentBranches = ["$branches_js[", "]$"];
-</script>
 
 <header>
     <div class="logoContainer">
         <h1>
             Radicale
             <span class="documentBranch">
-                <span>$branch_html$</span>
-                <select></select>
+                <span>$branch$</span>
+                <select>
+$for(branches)$
+                    <option value="$it.href$"$if(it.default)$ selected$endif$>$it.name$</option>
+$endfor$
+                </select>
             </span>
         </h1>
         <p>Free and Open-Source CalDAV and CardDAV Server</p>