home · contact · privacy
Move work so far into repo.
authorChristian Heller <c.heller@plomlompom.de>
Sat, 19 Nov 2016 13:51:23 +0000 (14:51 +0100)
committerChristian Heller <c.heller@plomlompom.de>
Sat, 19 Nov 2016 13:51:23 +0000 (14:51 +0100)
18 files changed:
add_dir.sh [new file with mode: 0755]
all.do [new file with mode: 0644]
author.do [new file with mode: 0644]
default.html.do [new file with mode: 0644]
default.intermediate.do [new file with mode: 0644]
default.uuid.do [new file with mode: 0644]
feed.xml.do [new file with mode: 0644]
helpers.sh [new file with mode: 0644]
index.html.do [new file with mode: 0644]
intermediate.tmpl [new file with mode: 0644]
test.sh [new file with mode: 0755]
test/test_files/bar baz.md [new file with mode: 0644]
test/test_files/foo.rst [new file with mode: 0644]
test/test_files/index.html [new file with mode: 0644]
test/test_files/test.md [new file with mode: 0644]
title.do [new file with mode: 0644]
url.do [new file with mode: 0644]
uuid.do [new file with mode: 0644]

diff --git a/add_dir.sh b/add_dir.sh
new file mode 100755 (executable)
index 0000000..116e891
--- /dev/null
@@ -0,0 +1,12 @@
+#!/bin/sh
+
+set -e
+
+curdir=`pwd`
+mkdir -p "$1"
+cd "$1"
+for file in "$curdir"/*.do "$curdir"/helpers.sh "$curdir"/intermediate.tmpl; do
+  set +e
+  ln -s "$file"
+  set -e
+done 
diff --git a/all.do b/all.do
new file mode 100644 (file)
index 0000000..edd2b47
--- /dev/null
+++ b/all.do
@@ -0,0 +1,41 @@
+#!/bin/sh
+
+# Remove target files for which no sources files can be found.
+for file in *.intermediate; do
+  if   test -f "$file" &&
+     ! test -f "${file%.intermediate}.md" &&
+     ! test -f "${file%.intermediate}.rst"; then
+    rm "$file"
+  fi
+done
+for file in *.uuid; do
+  if   test -f "$file" &&
+     ! test -f "${file%.uuid}.md" &&
+     ! test -f "${file%.uuid}.rst"; then
+    rm "$file"
+  fi
+done
+for file in *.html; do
+  if   test -f "$file" &&
+     ! test "$file" = "index.html" &&
+     ! test -f "${file%.html}.intermediate"; then
+    rm "$file"
+  fi
+done
+
+# Determine target files from the sources files present, declare dependencies
+# of the all.do script on them / build them if necessary.
+for file in *.rst *.md; do
+  if test -f "$file"; then
+    redo-ifchange "${file%.*}.intermediate"
+  fi
+done
+for file in *.intermediate; do
+  if test -f "$file"; then
+    redo-ifchange "${file%.*}.html"
+  fi
+done
+
+# Regenerate feed and index pages. Always.
+redo "feed.xml"
+redo "index.html"
diff --git a/author.do b/author.do
new file mode 100644 (file)
index 0000000..ed14e3f
--- /dev/null
+++ b/author.do
@@ -0,0 +1,5 @@
+#!/bin/sh
+
+if [ ! -f "$1" ]; then
+  printf "Joe Sixpack"
+fi
diff --git a/default.html.do b/default.html.do
new file mode 100644 (file)
index 0000000..3ff4132
--- /dev/null
@@ -0,0 +1,27 @@
+#!/bin/sh
+
+# Pull in global dependencies.
+. ./helpers.sh
+intermediate_file="${1%.html}.intermediate"
+redo-ifchange title
+redo-ifchange "$intermediate_file"
+
+# Build entry data.
+blog_title=`read_and_escape_file title | head -1`
+title_html=`cat "$intermediate_file" | head -1`
+title_plaintext=`echo "$title_html" | html2text`
+title_plaintext_escaped=`escape_html "$title_plaintext"`
+body=`cat "$intermediate_file" | sed 1d`
+
+# Write first part of entry head.
+cat << EOF
+<!DOCTYPE html>
+<html>
+<head>
+EOF
+
+# Write remaining entry head and body. 
+printf "<title>%s – %s</title>\n</head>\n<body>\n" "$blog_title" "$title_plaintext_escaped"
+#printf "<title>%s – %s</title>\n</head>\n<body>\n" "$blog_title" "$entry_title"
+printf "<h1>%s</h1>\n" "$title_html"
+printf "<section>\n%s\n</section>\n</body>\n</html>" "$body"
diff --git a/default.intermediate.do b/default.intermediate.do
new file mode 100644 (file)
index 0000000..7470c3c
--- /dev/null
@@ -0,0 +1,15 @@
+#!/bin/sh
+
+template=intermediate.tmpl
+uuidfile="${1%.intermediate}.uuid"
+redo-ifchange "$uuidfile"
+redo-ifchange "$template"
+mdfile="${1%.intermediate}.md"
+rstfile="${1%.intermediate}.rst"
+if [ -f "$rstfile" ]; then
+  redo-ifchange "$rstfile"
+  pandoc -f rst --template="$template" --mathml -t html5 "$rstfile" > "$3"
+elif [ -f "$mdfile" ]; then
+  redo-ifchange "$mdfile"
+  pandoc -f markdown --template="$template" --mathml -t html5 "$mdfile" > "$3"
+fi
diff --git a/default.uuid.do b/default.uuid.do
new file mode 100644 (file)
index 0000000..5efffc8
--- /dev/null
@@ -0,0 +1,5 @@
+#!/bin/sh
+
+if [ ! -f "$1" ]; then
+  uuidgen > "$1"
+fi
diff --git a/feed.xml.do b/feed.xml.do
new file mode 100644 (file)
index 0000000..2cdb7b2
--- /dev/null
@@ -0,0 +1,70 @@
+#!/bin/sh
+
+# Pull in global dependencies.
+. ./helpers.sh
+redo-ifchange url
+redo-ifchange author
+redo-ifchange uuid
+redo-ifchange title 
+
+# Build some variables. XML-escape even file contents that should not contain
+# dangerous characters, just to avoid any XML trouble.
+base_url=`cat url | head -1`
+url_protocol=`echo $base_url | cut -d ':' -f 1`
+url_basepath=`echo $base_url | cut -d '/' -f 3-`
+url_basepath_escaped=`escape_url "$url_basepath"`
+basepath="$url_protocol""://""$url_basepath_escaped"
+title=`read_and_escape_file title | head -1`
+author=`read_and_escape_file author | head -1`
+uuid=`read_and_escape_file uuid | head -1`
+
+# Write majority of feed head.
+cat << EOF
+<?xml version="1.0" encoding="utf-8"?>
+<feed xmlns="http://www.w3.org/2005/Atom">
+EOF
+printf "<link href=\"%s\" />\n" "$basepath"
+printf "<link href=\"%sfeed.xml\" rel=\"self\" />\n" "$basepath"
+printf "<title type=\"html\">%s</title>\n" "$title"
+printf "<author><name>%s</name></author>\n" "$author"
+printf "<id>urn:uuid:%s</id>\n" "$uuid"
+
+# Iterate through most recent entries (go by lastmod date of source files) to
+# build feed head "updated" element, and individual entries.
+first_run=0
+files=`ls -1t *.rst *.md | head -10 | tr '\n' $'\0'`
+oldIFS="$IFS"
+IFS=$'\0'
+for file in $files; do
+  lastmod=`stat -c%y "$file"`
+  lastmod_rfc3339=`date -u "+%Y-%m-%dT%TZ" -d "$lastmod"`
+  if [ "$first_run" -lt "1" ]; then
+    IFS="$oldIFS"
+    printf "<updated>%s</updated>\n\n" "$lastmod_rfc3339" 
+    first_run=1
+  fi
+
+  # Build some variables and dependencies.
+  intermediate_file="${file%.*}.intermediate"
+  htmlfile=`escape_url "${file%.*}.html"`
+  redo-ifchange "$intermediate_file"
+  redo-ifchange "$uuidfile"
+  title=`read_and_escape_file "$intermediate_file" | head -1`
+  uuidfile="${file%.*}.uuid"
+  uuid=`read_and_escape_file "$uuidfile" | head -1`
+  body=`read_and_escape_file "$intermediate_file" | sed 1d`
+  published=`stat -c%y "$uuidfile"`
+  published_rfc3339=`date -u "+%Y-%m-%dT%TZ" -d "$published"`
+
+  # Write entry.
+  printf "<entry>\n"
+  printf "<title type=\"html\">%s</title>\n" "$title"
+  printf "<id>urn:uuid:%s</id>\n" "$uuid" 
+  printf "<updated>%s</updated>\n" "$lastmod_rfc3339" 
+  printf "<published>%s</published>\n" "$published_rfc3339" 
+  printf "<link href=\"%s%s\" />\n" "$basepath" "$htmlfile"
+  printf "<content type=\"html\">\n%s\n</content>\n" "$body"
+  printf "</entry>\n\n"
+done
+
+printf "</feed>"
diff --git a/helpers.sh b/helpers.sh
new file mode 100644 (file)
index 0000000..c90e077
--- /dev/null
@@ -0,0 +1,19 @@
+#!/bin/sh
+
+escape_html()
+{
+out=`python3 -c 'import sys, html; print(html.escape(sys.argv[1]))' "$1"`
+printf "%s" "$out"
+}
+
+read_and_escape_file()
+{
+in=`cat "$1"`
+escape_html "$in"
+}
+
+escape_url()
+{
+out=`python3 -c 'import sys, urllib.parse; print(urllib.parse.quote(sys.argv[1]))' "$1"`
+printf "%s" "$out"
+}
diff --git a/index.html.do b/index.html.do
new file mode 100644 (file)
index 0000000..8bf6751
--- /dev/null
@@ -0,0 +1,37 @@
+#!/bin/sh
+
+# Pull in global dependencies.
+. ./helpers.sh
+redo-ifchange title
+
+# Write index head.
+cat << EOF
+<!DOCTYPE html>
+<html>
+<head>
+EOF
+blog_title=`read_and_escape_file title | head -1`
+printf "<title>%s</title>\n</head>\n<body>\n" "$blog_title"
+printf "<h1>%s</h1>\n<ul>\n" "$blog_title"
+
+# Iterate through entries sorted by lastmod of their source files, write entry
+# list. 
+first_run=0
+files=`ls -1t *.rst *.md | tr '\n' $'\0'`
+oldIFS="$IFS"
+IFS=$'\0'
+for file in $files; do
+  if [ "$first_run" -lt "1" ]; then
+    IFS="$oldIFS"
+    first_run=1
+  fi
+  intermediate_file="${file%.*}.intermediate"
+  html_file="${file%.*}.html"
+  redo-ifchange "$intermediate_file"
+  redo-ifchange "$html_file"
+  title_html=`cat "$intermediate_file" | head -1`
+  html_file_escaped=`escape_url "$html_file"`
+  printf "<li><a href=\"%s\" />%s</a></li>\n" "$html_file_escaped" "$title_html"
+done
+
+printf "</ul>\n</body>\n</html>"
diff --git a/intermediate.tmpl b/intermediate.tmpl
new file mode 100644 (file)
index 0000000..2357009
--- /dev/null
@@ -0,0 +1,2 @@
+$title$
+$body$
diff --git a/test.sh b/test.sh
new file mode 100755 (executable)
index 0000000..00194ba
--- /dev/null
+++ b/test.sh
@@ -0,0 +1,17 @@
+#!/bin/sh
+
+rm -rf test/test_dir
+./add_dir.sh test/test_dir
+cp test/test_files/test.md test/test_dir/
+cp test/test_files/foo.rst test/test_dir/
+cp test/test_files/bar\ baz.md test/test_dir/
+cd test/test_dir
+redo
+cd ../..
+echo "== index.html diff test =="
+diff test/test_files/index.html test/test_dir/index.html
+if [ "$?" = "0" ]; then
+  echo "== test SUCCESS =="
+else
+  echo "== test FAILURE =="
+fi
diff --git a/test/test_files/bar baz.md b/test/test_files/bar baz.md
new file mode 100644 (file)
index 0000000..423430d
--- /dev/null
@@ -0,0 +1,2 @@
+% foo
+bar 
diff --git a/test/test_files/foo.rst b/test/test_files/foo.rst
new file mode 100644 (file)
index 0000000..951861b
--- /dev/null
@@ -0,0 +1,6 @@
+a title with some nasty characters: &<>"'
+=========================================
+
+this text contains some special characters: '"><&
+
+and more than one paragraph
diff --git a/test/test_files/index.html b/test/test_files/index.html
new file mode 100644 (file)
index 0000000..f5b755c
--- /dev/null
@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+<title>Yet another blog</title>
+</head>
+<body>
+<h1>Yet another blog</h1>
+<ul>
+<li><a href="bar%20baz.html" />foo</a></li>
+<li><a href="foo.html" />a title with some nasty characters: &amp;&lt;&gt;&quot;'</a></li>
+<li><a href="test.html" />foo <em>bar</em> <strong>baz</strong></a></li>
+</ul>
+</body>
+</html>
\ No newline at end of file
diff --git a/test/test_files/test.md b/test/test_files/test.md
new file mode 100644 (file)
index 0000000..3dd09f7
--- /dev/null
@@ -0,0 +1,2 @@
+% foo *bar* **baz**
+bar
diff --git a/title.do b/title.do
new file mode 100644 (file)
index 0000000..082accf
--- /dev/null
+++ b/title.do
@@ -0,0 +1,5 @@
+#!/bin/sh
+
+if [ ! -f "$1" ]; then
+  printf "Yet another blog"
+fi
diff --git a/url.do b/url.do
new file mode 100644 (file)
index 0000000..4e4079f
--- /dev/null
+++ b/url.do
@@ -0,0 +1,5 @@
+#!/bin/sh
+
+if [ ! -f "$1" ]; then
+  printf "http://example.org/"
+fi
diff --git a/uuid.do b/uuid.do
new file mode 100644 (file)
index 0000000..ba9e919
--- /dev/null
+++ b/uuid.do
@@ -0,0 +1,5 @@
+#!/bin/sh
+
+if [ ! -f "$1" ]; then
+  uuidgen
+fi