#!/usr/bin/env zsh
+# zk.zsh -- zettelkästen/wiki/static website helper/generator
+# Copyright (C) 2022-2024 Sergey Matveev <stargrave@stargrave.org>
set -e
+ZK_VERSION=ZKZSH1
usage() {
- cat >&2 <<EOF
+ >&2 <<EOF
Usage:
\$ $0:t links PAGE
- Print the PAGE's links
+ Print PAGE's links
\$ $0:t backs PAGE
- Print who backlinks to the PAGE
+ Print PAGE's backlinks
\$ $0:t htmls DIR
Generate HTMLs in DIR
EOF
[[ $# -eq 2 ]] || usage
-# Collect all pages
+separator="------------------------ >8 ------------------------"
setopt GLOB_STAR_SHORT
zmodload -F zsh/stat b:zstat
typeset -A pages
+typeset -A sizes
for p (**(.)) {
- zstat -A reply -F "%F %T" +mtime $p
- pages[$p]=${reply[1]}
+ [[ $p:t == "index" ]] && {
+ echo unacceptable filename: $p >&2
+ exit 1
+ }
+ zstat -A mtime -F "%F %T" +mtime $p
+ zstat -A size +size $p
+ pages[$p]=${mtime[1]}
+ sizes[$p]=${size[1]}
}
+typeset -A cats
+for p (**(/)) cats[$p]=1
-# Determine the links between them
+zmodload zsh/mapfile
+zmodload -F zsh/files b:zf_mkdir
typeset -A links
typeset -A backs
+typeset -A cached
+typeset -aU ws
for p (${(k)pages}) {
- for w (`< $p`) {
- [[ $w =~ "\[(.*)\]" ]] || continue
+ [[ $ZK_CACHE ]] && {
+ zstat -A inode +inode $p
+ zstat -A ctime +ctime $p
+ cache=(${(f)mapfile[$ZK_CACHE/$p]})
+ if [[ ( ${cache[1]} = $ZK_VERSION ) &&
+ ( ${cache[2]} = ${inode[1]} ) &&
+ ( ${cache[3]} = ${ctime[1]} ) ]]; then
+ ws=(${cache[4,-1]})
+ [[ $ws ]] && links[$p]=${(j: :)ws}
+ cached[$p]=1
+ continue
+ fi
+ }
+ ws=()
+ for w (${=mapfile[$p]}) {
+ [[ $w =~ "\[([^] ]+)\]" ]] || continue
w=${match[1]}
+ [[ ( $w =~ "/$" ) && ( ${cats[$w[1,-2]]} ) ]] && {
+ ws=($ws $w)
+ continue
+ }
[[ ${pages[$w]} ]] || {
- [[ $ZK_SHOW_MISSING ]] && print "Missing $w"
+ [[ $ZK_SHOW_MISSING ]] && print "missing $w"
continue
}
- links[$p]="$w ${links[$p]}"
+ ws=($ws $w)
}
+ [[ $ZK_CACHE ]] && {
+ zf_mkdir -p $ZK_CACHE/$p:h
+ ws=($ZK_VERSION ${inode[1]} ${ctime[1]} $ws)
+ print -l $ws > $ZK_CACHE/$p
+ ws=(${ws[4,-1]})
+ }
+ [[ $ws ]] && links[$p]=${(j: :)ws}
}
-
-# Deduplicate all references
-for p w (${(kv)links}) {
- local ws=(${(u)=w})
- links[$p]=${(j: :)ws}
- for w ($ws) backs[$w]="$p ${backs[$w]}"
-}
-for p w (${(kv)backs}) {
- local ws=(${(u)=w})
- backs[$p]=${(j: :)ws}
+unset cache ws
+for p ws (${(kv)links}) {
+ for w (${=ws}) backs[$w]="$p ${backs[$w]}"
}
+for p ws (${(kv)backs}) backs[$p]=${(j: :)${(u)=ws}}
-autoload -U relative
getrel() {
# nearly the copy-paste of Functions/Misc/relative
local dst=$2:a
REPLY=$src${dst:+/$dst}
}
-genhtml() {
+genHTML() {
local page=$1
- local data
- [[ $# -eq 1 ]] && data=`< $page` || data=$2
- data="${data//&/&}"
- data="${data//</<}"
- data="${data//>/>}"
- for p (${(k)pages}) {
- [[ $p = index ]] && continue
- getrel $page $p
- data="${data//${p}/<a href=\"${REPLY}.html\">$p</a>}"
+ local data p
+ [[ $# -eq 1 ]] && data=${mapfile[$page]} || data=$2
+ local _links=(${(oi)=links[$page]})
+ if [[ ( ${cached[$page]} ) && ( -s $ZK_CACHE/${page}.html ) ]]; then
+ < $ZK_CACHE/${page}.html
+ else
+ data=${data//&/&}
+ data=${data//</<}
+ data=${data//>/>}
+ for p ($_links) {
+ getrel $page $p
+ [[ -d $p ]] && REPLY=$REPLY/index
+ data="${data//\[${p}\]/<a href=\"${REPLY}.html\">[$p]</a>}"
+ }
+ data="<!DOCTYPE html>
+<html><head>
+<title>$page (${pages[$page]})</title>
+<meta http-equiv=\"Content-Type\" content=\"text/html; charset=utf-8\">
+</head><body><pre>
+$data</pre>"
+ if [[ $ZK_CACHE ]]; then
+ print -r "$data" > $ZK_CACHE/${page}.html
+ < $ZK_CACHE/${page}.html
+ else
+ print -r "$data"
+ fi
+ fi
+ if [[ $_links ]]; then
+ print "<hr/>Links:<ul>"
+ for p ($_links) {
+ getrel $page $p
+ print "<li><a href=\"${REPLY}.html\">$p</a> <sup>${pages[$p]}</sup></li>"
+ }
+ print "</ul>"
+ fi
+ local bs=(${(oi)=${backs[$page]}})
+ if [[ $bs ]]; then
+ print "<hr/>Backlinks:<ul>"
+ for p ($bs) {
+ getrel $page $p
+ print "<li><a href=\"${REPLY}.html\">$p</a> <sup>${pages[$p]}</sup></li>"
+ }
+ print "</ul>"
+ fi
+ print "</body></html>"
+}
+
+zmodload -F zsh/datetime b:strftime
+strftime -s now "%F %T"
+
+genIndex() {
+ local p
+ local entries=()
+ local _links=()
+ typeset -aU _cats=()
+ local curdepth=${#${(s:/:)1}}
+ (( curdepth = curdepth + 1 ))
+ for p (${(k)pages[(I)$1*]}) {
+ case ${#${(As:/:)p}} in
+ ($curdepth) _links=($p $_links) ;;
+ ( $(( $curdepth + 1 )) ) _cats=(${1}${${p#$1}%%/*} $_cats) ;;
+ (*) continue ;;
+ esac
}
- print "<\!DOCTYPE html>
-<html><head><title>$page (${pages[$page]})</title></head><body><pre>
-$data
-</pre><hr/><ul>"
- for p (${(oi)=${backs[$page]}}) {
+ local page=${1}index
+ print "<!DOCTYPE html>
+<html><head>
+<meta http-equiv=\"Content-Type\" content=\"text/html; charset=utf-8\">
+<title>$page ($now)</title>
+</head><body><ul>"
+ for p (${(oi)_links}) {
getrel $page $p
- print "<li><a href=\"${REPLY}.html\">$p</a> <sup>${pages[$p]}</sup></li>"
+ print "<li><a href=\"${REPLY}.html\">$p</a> <sup>${pages[$p]}</sup> (${sizes[$p]} bytes)</li>"
}
- print "</ul></body></html>"
+ print "</ul>"
+ if [[ $_cats ]]; then
+ print "<hr/>Subdirectories:<ul>"
+ for p (${(oi)_cats}) {
+ getrel $page $p/index
+ print "<li><a href=\"${REPLY}.html\">$p</a></li>"
+ }
+ print "</ul>"
+ fi
+ local bs=(${(oi)=${backs[$1]}})
+ if [[ $bs ]]; then
+ print "<hr/>Backlinks:<ul>"
+ for p ($bs) {
+ getrel $page $p
+ print "<li><a href=\"${REPLY}.html\">$p</a> <sup>${pages[$p]}</sup></li>"
+ }
+ print "</ul>"
+ fi
+ print "</body></html>"
}
case $1 in
(links) for w (${(oi)=${links[$2]}}) print $w ;;
(backs) for w (${(oi)=${backs[$2]}}) print $w ;;
-(html) genhtml $2 ;;
+(html) genHTML $2 ;;
+(html-index) genIndex $2 ;;
(htmls)
for p (${(k)pages}) {
- local subdir=$p:h
- mkdir -p $2/$subdir
- genhtml $p > $2/$p.html
+ zf_mkdir -p $2/$p:h
+ genHTML $p > $2/$p.html
+ touch -r $p $2/$p.html
}
- local all=()
- for p (${(Oi)${(k)pages}}) all=("$p (${pages[$p]})" $all)
- zmodload -F zsh/datetime b:strftime
- pages[ALL]=$(strftime "%F %T")
- genhtml ALL ${(j:\n:)all} > $2/ALL.html
+ for p (${(k)cats}) genIndex $p/ > $2/$p/index.html
+ genIndex "" > $2/index.html
+ for p ("" ${(k)cats}) touch -d ${now/ /T} $2/$p/index.html
;;
(*) usage ;;
esac