zk.zsh

   1 #!/usr/bin/env zsh
   2 # zk.zsh -- zettelkästen/wiki/static website helper/generator
   3 # Copyright (C) 2022-2024 Sergey Matveev <stargrave@stargrave.org>
   4
   5 set -e
   6 ZK_VERSION=ZKZSH1
   7
   8 usage() {
   9     >&2 <<EOF
  10 Usage:
  11   \$ $0:t links PAGE
  12     Print PAGE's links
  13   \$ $0:t backs PAGE
  14     Print PAGE's backlinks
  15   \$ $0:t htmls DIR
  16     Generate HTMLs in DIR
  17 EOF
  18     exit 1
  19 }
  20
  21 [[ $# -eq 2 ]] || usage
  22
  23 separator="------------------------ >8 ------------------------"
  24 setopt GLOB_STAR_SHORT
  25 zmodload -F zsh/stat b:zstat
  26 typeset -A pages
  27 typeset -A sizes
  28 for p (**(.)) {
  29     [[ $p:t == "index" ]] && {
  30         echo unacceptable filename: $p >&2
  31         exit 1
  32     }
  33     zstat -A mtime -F "%F %T" +mtime $p
  34     zstat -A size +size $p
  35     pages[$p]=${mtime[1]}
  36     sizes[$p]=${size[1]}
  37 }
  38 typeset -A cats
  39 for p (**(/)) cats[$p]=1
  40
  41 zmodload zsh/mapfile
  42 zmodload -F zsh/files b:zf_mkdir
  43 typeset -A links
  44 typeset -A backs
  45 typeset -A cached
  46 typeset -aU ws
  47 for p (${(k)pages}) {
  48     [[ $ZK_CACHE ]] && {
  49         zstat -A inode +inode $p
  50         zstat -A ctime +ctime $p
  51         cache=(${(f)mapfile[$ZK_CACHE/$p]})
  52         if [[ ( ${cache[1]} = $ZK_VERSION ) &&
  53               ( ${cache[2]} = ${inode[1]} ) &&
  54               ( ${cache[3]} = ${ctime[1]} ) ]]; then
  55             ws=(${cache[4,-1]})
  56             [[ $ws ]] && links[$p]=${(j: :)ws}
  57             cached[$p]=1
  58             continue
  59         fi
  60     }
  61     ws=()
  62     for w (${=mapfile[$p]}) {
  63         [[ $w =~ "\[([^] ]+)\]" ]] || continue
  64         w=${match[1]}
  65         [[ ( $w =~ "/$" ) && ( ${cats[$w[1,-2]]} ) ]] && {
  66             ws=($ws $w)
  67             continue
  68         }
  69         [[ ${pages[$w]} ]] || {
  70             [[ $ZK_SHOW_MISSING ]] && print "missing $w"
  71             continue
  72         }
  73         ws=($ws $w)
  74     }
  75     [[ $ZK_CACHE ]] && {
  76         zf_mkdir -p $ZK_CACHE/$p:h
  77         ws=($ZK_VERSION ${inode[1]} ${ctime[1]} $ws)
  78         print -l $ws > $ZK_CACHE/$p
  79         ws=(${ws[4,-1]})
  80     }
  81     [[ $ws ]] && links[$p]=${(j: :)ws}
  82 }
  83 unset cache ws
  84 for p ws (${(kv)links}) {
  85     for w (${=ws}) backs[$w]="$p ${backs[$w]}"
  86 }
  87 for p ws (${(kv)backs}) backs[$p]=${(j: :)${(u)=ws}}
  88
  89 getrel() {
  90     # nearly the copy-paste of Functions/Misc/relative
  91     local dst=$2:a
  92     local src=$1:h:a
  93     local -a cur abs
  94     cur=(${(s:/:)src})
  95     abs=(${(s:/:)dst:h} $dst:t)
  96     integer i=1
  97     while [[ i -le $#abs && $abs[i] == $cur[i] ]] ; do
  98         ((++i > $#cur)) && {
  99             REPLY=${(j:/:)abs[i,-1]}
 100             return
 101         }
 102     done
 103     src=${(j:/:)cur[i,-1]/*/..}
 104     dst=${(j:/:)abs[i,-1]}
 105     REPLY=$src${dst:+/$dst}
 106 }
 107
 108 genHTML() {
 109     local page=$1
 110     local data p
 111     [[ $# -eq 1 ]] && data=${mapfile[$page]} || data=$2
 112     local _links=(${(oi)=links[$page]})
 113     if [[ ( ${cached[$page]} ) && ( -s $ZK_CACHE/${page}.html ) ]]; then
 114         < $ZK_CACHE/${page}.html
 115     else
 116         data=${data//&/&amp;}
 117         data=${data//</&lt;}
 118         data=${data//>/&gt;}
 119         for p ($_links) {
 120             getrel $page $p
 121             [[ -d $p ]] && REPLY=$REPLY/index
 122             data="${data//\[${p}\]/<a href=\"${REPLY}.html\">[$p]</a>}"
 123         }
 124         data="<!DOCTYPE html>
 125 <html><head>
 126 <title>$page (${pages[$page]})</title>
 127 <meta http-equiv=\"Content-Type\" content=\"text/html; charset=utf-8\">
 128 </head><body><pre>
 129 $data</pre>"
 130         if [[ $ZK_CACHE ]]; then
 131             print -r "$data" > $ZK_CACHE/${page}.html
 132             < $ZK_CACHE/${page}.html
 133         else
 134             print -r "$data"
 135         fi
 136     fi
 137     if [[ $_links ]]; then
 138         print "<hr/>Links:<ul>"
 139         for p ($_links) {
 140             getrel $page $p
 141             print "<li><a href=\"${REPLY}.html\">$p</a> <sup>${pages[$p]}</sup></li>"
 142         }
 143         print "</ul>"
 144     fi
 145     local bs=(${(oi)=${backs[$page]}})
 146     if [[ $bs ]]; then
 147         print "<hr/>Backlinks:<ul>"
 148         for p ($bs) {
 149             getrel $page $p
 150             print "<li><a href=\"${REPLY}.html\">$p</a> <sup>${pages[$p]}</sup></li>"
 151         }
 152         print "</ul>"
 153     fi
 154     print "</body></html>"
 155 }
 156
 157 zmodload -F zsh/datetime b:strftime
 158 strftime -s now "%F %T"
 159
 160 genIndex() {
 161     local p
 162     local entries=()
 163     local _links=()
 164     typeset -aU _cats=()
 165     local curdepth=${#${(s:/:)1}}
 166     (( curdepth = curdepth + 1 ))
 167     for p (${(k)pages[(I)$1*]}) {
 168         case ${#${(As:/:)p}} in
 169         ($curdepth) _links=($p $_links) ;;
 170         ( $(( $curdepth + 1 )) ) _cats=(${1}${${p#$1}%%/*} $_cats) ;;
 171         (*) continue ;;
 172         esac
 173     }
 174     local page=${1}index
 175     print "<!DOCTYPE html>
 176 <html><head>
 177 <meta http-equiv=\"Content-Type\" content=\"text/html; charset=utf-8\">
 178 <title>$page ($now)</title>
 179 </head><body><ul>"
 180     for p (${(oi)_links}) {
 181         getrel $page $p
 182         print "<li><a href=\"${REPLY}.html\">$p</a> <sup>${pages[$p]}</sup> (${sizes[$p]} bytes)</li>"
 183     }
 184     print "</ul>"
 185     if [[ $_cats ]]; then
 186         print "<hr/>Subdirectories:<ul>"
 187         for p (${(oi)_cats}) {
 188             getrel $page $p/index
 189             print "<li><a href=\"${REPLY}.html\">$p</a></li>"
 190         }
 191         print "</ul>"
 192     fi
 193     local bs=(${(oi)=${backs[$1]}})
 194     if [[ $bs ]]; then
 195         print "<hr/>Backlinks:<ul>"
 196         for p ($bs) {
 197             getrel $page $p
 198             print "<li><a href=\"${REPLY}.html\">$p</a> <sup>${pages[$p]}</sup></li>"
 199         }
 200         print "</ul>"
 201     fi
 202     print "</body></html>"
 203 }
 204
 205 case $1 in
 206 (links) for w (${(oi)=${links[$2]}}) print $w ;;
 207 (backs) for w (${(oi)=${backs[$2]}}) print $w ;;
 208 (html) genHTML $2 ;;
 209 (html-index) genIndex $2 ;;
 210 (htmls)
 211     for p (${(k)pages}) {
 212         zf_mkdir -p $2/$p:h
 213         genHTML $p > $2/$p.html
 214         touch -r $p $2/$p.html
 215     }
 216     for p (${(k)cats}) genIndex $p/ > $2/$p/index.html
 217     genIndex "" > $2/index.html
 218     for p ("" ${(k)cats}) touch -d ${now/ /T} $2/$p/index.html
 219     ;;
 220 (*) usage ;;
 221 esac