Merge commit '6bc502434737d7f08379e79b94fc6fda424ef779'

[shellwiki] / tools.sh

diff --git a/tools.sh b/tools.sh
index 4e93d3f4229049ef70ed84adf81eb20d81da3ffa..b19a83d92c5c87be2005c6e3035982275aa69548 100755 (executable)
--- a/tools.sh
+++ b/tools.sh
@@ -3,6 +3,26 @@
 [ "$include_tools" ] && return 0
 include_tools="$0"
 
+# 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
 
@@ -41,6 +61,34 @@ mdfile(){
   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
+}
+
 size_human(){
   local size="$1"
 
@@ -133,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;^.*<h1[^>]*>(.*>)?([^<]+)(<.*)?</h1>.*$;\2;; tQ;
+        s;^.*<h2[^>]*>(.*>)?([^<]+)(<.*)?</h2>.*$;\2;; tQ;
+        b; :Q
+        # reverse escapes of cgilite HTML function,
+        # to prevent later double escaping
+        # later escaping must not be omited
+        s/&lt;/</g; s/&gt;/>/g;  s/&quot;/'\"'/g; s/&#x27;/'\''/g;
+        s/&#x5B;/[/g; s/&#x5D;/]/g;  s/&#x0D;/\r/g; s/&amp;/\&/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"
+}