X-Git-Url: https://git.plutz.net/?a=blobdiff_plain;f=tools.sh;h=b19a83d92c5c87be2005c6e3035982275aa69548;hb=HEAD;hp=1b7e6773dac5cfe6c6bdf961e8df3ef74d980d2c;hpb=2afc48aa56da563dd73ffb4bfa98fcd5776ef63f;p=shellwiki diff --git a/tools.sh b/tools.sh index 1b7e677..b19a83d 100755 --- a/tools.sh +++ b/tools.sh @@ -3,23 +3,89 @@ [ "$include_tools" ] && return 0 include_tools="$0" -if [ "$(which awk)" ]; then - md() { awk -f "$_EXEC/md_macros.awk" -f "$_EXEC/cgilite/markdown.awk"; } -elif [ "$(which busybox)" ]; then - md() { busybox awk -f "$_EXEC/md_macros.awk" -f "$_EXEC/cgilite/markdown.awk"; } -else - md() { cat; } -fi +# Copyright 2022 - 2024 Paul Hänsch +# +# Permission to use, copy, modify, and/or distribute this software for any +# purpose with or without fee is hereby granted, provided that the above +# copyright notice and this permission notice appear in all copies. +# +# THE SOFTWARE IS PROVIDED “AS IS” AND THE AUTHOR DISCLAIMS ALL WARRANTIES +# WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF +# MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY +# SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES +# WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN +# ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR +# IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. + +. "${_EXEC}/cgilite/storage.sh" + +CACHE_AGE=${CACHE_AGE:-300} +export MD_MACROS="$_EXEC/macros" +export MD_HTML="${MD_HTML:-false}" + +md(){ + local parser + + if [ "$#" = 0 ]; then + md "${_EXEC}"/parsers/* + elif [ "$#" = 1 ]; then + "$1" + else + parser="$1" + shift 1 + "$parser" |md "$@" + fi +} mdfile(){ + # Check if page exists, if possible fall + # back to default page from installation local page="$(PATH "$1")" + page="${page%/}" - if [ -f "$_DATA/pages/$page/#page.md" ]; then + # Regular processing, keep in sync with tools.sh + if [ -f "$_DATA/pages/$page/:$LANGUAGE/#page.md" ]; then + printf %s\\n "$_DATA/pages/$page/:$LANGUAGE/#page.md" + elif [ -f "$_DATA/pages/$page/#page.md" ]; then printf %s\\n "$_DATA/pages/$page/#page.md" + elif [ -f "$_EXEC/pages/$page/:$LANGUAGE/#page.md" ]; then + printf %s\\n "$_EXEC/pages/$page/:$LANGUAGE/#page.md" elif [ -f "$_EXEC/pages/$page/#page.md" ]; then printf %s\\n "$_EXEC/pages/$page/#page.md" else return 1 + fi 2>&- + # ^^ suppress error messages produced + # by printf when stdout was closed + + return 0 +} + +wiki() { + # Print content of a wiki page + # Get page from data or underlay dir, handle caching + local page="$(PATH "$1")" mdfile cache cachetime + + cache="$_DATA/pages/$page/#page:${LANGUAGE}.${USER_ID}.cache" + + mdfile="$(mdfile "$page")" || return 4 + acl_read "$page" || return 3 + + cachetime="$(stat -c %Y -- "$mdfile" "$cache" 2>/dev/null)" + + if [ "${cachetime#*${BR}}" -gt "${cachetime%${BR}*}" \ + -a "${cachetime#*${BR}}" -gt "$((_DATE - CACHE_AGE))" ]; then + cat "${cache}" + else + mkdir -p -- "$_DATA/pages/$page/" + # Macros expect to find page directory as working dir + ( cd -- "$_DATA/pages/$page/"; + md <"$mdfile" \ + | tee -- "${cache}.$$" + ) + grep -q '^%nocache' "$mdfile" \ + && rm -- "${cache}.$$" \ + || mv -- "${cache}.$$" "${cache}" fi } @@ -43,57 +109,68 @@ size_human(){ fi } -page_glob(){ - local pattern="${1%/}/" IFS='' +attachment_glob(){ + local pattern="${1%/}" IFS='' local glob page pagedir - case $pattern in + page="${pattern%/*}" + [ "$page" = "$pattern" ] && page=. + [ ! "$page" ] && page=/ + pattern="${pattern##*/}" + [ ! "$pattern" ] && pattern="*" + + case $page in /*) - for glob in "$_DATA/pages"$pattern; do printf '%s\n' "${glob#"$_DATA/pages"}"; done - for glob in "$_EXEC/pages"$pattern; do printf '%s\n' "${glob#"$_EXEC/pages"}"; done + for glob in "$_DATA/pages/$page/#attachments"/$pattern; do printf '%s\n' "${glob#"$_DATA/pages"}"; done + for glob in "$_EXEC/pages/$page/#attachments"/$pattern; do printf '%s\n' "${glob#"$_EXEC/pages"}"; done ;; *) - for glob in "$_DATA/pages/$PATH_INFO"/$pattern; do printf '%s\n' "${glob#"$_DATA/pages/$PATH_INFO/"}"; done - for glob in "$_EXEC/pages/$PATH_INFO"/$pattern; do printf '%s\n' "${glob#"$_EXEC/pages/$PATH_INFO/"}"; done + for glob in "$_DATA/pages/$PATH_INFO/$page/#attachments"/$pattern; do printf '%s\n' "${glob#"$_DATA/pages/$PATH_INFO/"}"; done + for glob in "$_EXEC/pages/$PATH_INFO/$page/#attachments"/$pattern; do printf '%s\n' "${glob#"$_EXEC/pages/$PATH_INFO/"}"; done ;; esac \ | sort -u \ - | while read -r page; do - case $page in - \#*|*/\#*) continue;; - *) pagedir="$(page_abs "$page")";; - esac + | while read -r glob; do + [ -e "$glob" ] || continue + pagedir="$(page_abs "${glob%%/#attachments/*}/")" [ -d "$_DATA/pages/$pagedir" -o -d "$_EXEC/pages/$pagedir" ] \ - && printf '%s\n' "$page" + && printf '%s\n' "${glob%%/#attachments/*}/${glob#*/#attachments/}" done } -page_children(){ - local page="${1:-${PATH_INFO}}" depth="${2:-1}" - local glob pagedir IFS='' - page="${page%/}/" - - [ "$depth" -eq 0 ] && return 0 +page_glob(){ + local pattern="${1%/}/" depth="${2:-0}" IFS='' + local glob page pagedir - case $page in + case $pattern in /*) - for glob in "$_DATA/pages/${page}"*/; do printf '%s\n' "${glob#"$_DATA/pages"}"; done - for glob in "$_EXEC/pages/${page}"*/; do printf '%s\n' "${glob#"$_EXEC/pages"}"; done + for glob in "$_DATA/pages"$pattern; do printf '%s\n' "${glob#"$_DATA/pages"}"; done + for glob in "$_EXEC/pages"$pattern; do printf '%s\n' "${glob#"$_EXEC/pages"}"; done ;; *) - for glob in "$_DATA/pages/$PATH_INFO/${page}"*/; do printf '%s\n' "${glob#"$_DATA/pages/$PATH_INFO/"}"; done - for glob in "$_EXEC/pages/$PATH_INFO/${page}"*/; do printf '%s\n' "${glob#"$_EXEC/pages/$PATH_INFO/"}"; done + for glob in "$_DATA/pages/$PATH_INFO"/$pattern; do printf '%s\n' "${glob#"$_DATA/pages/$PATH_INFO/"}"; done + for glob in "$_EXEC/pages/$PATH_INFO"/$pattern; do printf '%s\n' "${glob#"$_EXEC/pages/$PATH_INFO/"}"; done ;; esac \ | sort -u \ | while read -r page; do - case $page in - \#*|*/\#*) continue;; - *) pagedir="$(page_abs "$page")";; - esac + # Not a page directory (just a metadata dir) + [ ! "${page%%#*}" -o ! "${page%%*/#*}" ] && continue + + # Omit "system" pages unless explicitly wanted + [ ! "${page%%\[*\]/*}" -o ! "${page%%*/\[*\]/*}" ] && [ "$glob_system_pages" != true ] && continue + + # Omit translation pages if translations are enabled + [ ! "${page%%:*}" -o ! "${page%%*/:*}" ] && [ "$LANGUAGE_DEFAULT" ] && continue + + pagedir="$(page_abs "$page")" + if [ -d "$_DATA/pages/$pagedir" -o -d "$_EXEC/pages/$pagedir" ]; then - printf %s\\n "$page" - page_children "$page" "$((depth - 1))" + printf '%s\n' "$page" + if ! [ "$depth" -eq 0 ]; then + PATH_INFO="$pagedir" page_glob "*" "$((depth - 1))" \ + | while read -r glob; do printf %s%s\\n "$page" "$glob"; done + fi fi done } @@ -104,3 +181,74 @@ page_abs(){ *) PATH "${PATH_INFO%/*}/${1%/}/";; esac } + +has_tags() { + # true if PAGE is tagges with all TAGS + local page="$(page_abs "$1")"; shift 1; + local tdir="$_DATA/tags" tag dt df + + for tag in "$@"; do + tag="$(printf %s "$tag" |awk '{ sub(/^[#!]/, ""); gsub(/[^[:alnum:]]/, "_"); print toupper($0); }')" + dt="$(DBM "${tdir}/${tag}" get "${page}")" || return 1 + df="$(stat -c %Y "$(mdfile "$page")")" || return 1 + if [ "$df" -gt "$dt" ]; then + DBM "${tdir}/${tag}" remove "${page}" + return 1 + fi + done + return 0 +} + +has_tag() { + # true if PAGE is tagged with any of TAGS + local page="$(page_abs "$1")"; shift 1; + local tdir="$_DATA/tags" tag dt df + + for tag in "$@"; do + tag="$(printf %s "$tag" |awk '{ sub(/^[#!]/, ""); gsub(/[^[:alnum:]]/, "_"); print toupper($0); }')" + dt="$(DBM "${tdir}/${tag}" get "${page}")" || continue + df="$(stat -c %Y "$(mdfile "$page")")" || return 1 + if [ "$df" -gt "$dt" ]; then + DBM "${tdir}/${tag}" remove "${page}" + continue + else + return 0 + fi + done + return 1 +} + +page_title() { + local mdfile='' PAGE_TITLE='' + + if mdfile="$(mdfile "${1}")"; then + PAGE_TITLE="$( + # pick title from %title pragma + sed -nE ' + s;^%title[ \t]+([[:graph:]][[:print:]]+)\r?$;\1;p; tQ; + b; :Q q; + ' "$mdfile" + )" + [ ! "${PAGE_TITLE}" ] && PAGE_TITLE="$( + # pick title from first h1/h2 headline + MD_MACROS="" md <"$mdfile" \ + | sed -nE ' + s;^.*]*>(.*>)?([^<]+)(<.*)?.*$;\2;; tQ; + s;^.*]*>(.*>)?([^<]+)(<.*)?.*$;\2;; tQ; + b; :Q + # reverse escapes of cgilite HTML function, + # to prevent later double escaping + # later escaping must not be omited + s/<//g; s/"/'\"'/g; s/'/'\''/g; + s/[/[/g; s/]/]/g; s/ /\r/g; s/&/\&/g; + p; q; + ' + )" + fi + if [ ! "${PAGE_TITLE}" ]; then + # use last part of page URL as title + PAGE_TITLE="${1%/}" + PAGE_TITLE="${PAGE_TITLE##*/}" + fi + printf %s\\n "$PAGE_TITLE" +}