From: Paul Hänsch Date: Mon, 26 May 2025 19:30:20 +0000 (+0200) Subject: bugfix: prevent content duplication when deleting nonexist key X-Git-Url: http://git.plutz.net/?p=cgilite;a=commitdiff_plain;h=HEAD;hp=238f0f8a2932b5ba66f7139c227eaaeb5dd7a013 bugfix: prevent content duplication when deleting nonexist key --- diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..5c9950a --- /dev/null +++ b/.gitignore @@ -0,0 +1,3 @@ +cgilite +serverkey +users.db diff --git a/cgilite.awk b/cgilite.awk new file mode 100644 index 0000000..ebf4411 --- /dev/null +++ b/cgilite.awk @@ -0,0 +1,161 @@ +#!/bin/env awk -f + +function debug(t) { printf "%s\n", t >>"/dev/stderr"; } + +function PATH( str, seg, out ) { + while ( str ) { + seg = str; + sub( /\/.*$/, "", seg); + sub( /^[^\/]*\//, "", str); + + if ( seg == ".." ) sub(/\/[^\/]*\/?$/, "", out); + else if ( seg ~ /^\.?$/) sub(/\/?$/, "/", out); + else sub(/\/?$/, "/" seg, out); + + if (seg == str) break; + } + if (!(str && out)) sub(/\/?$/,"/" out); + return out; +} + +function HEX_DECODE( pfx, inp, out, n, k ) { + k = length(pfx); + gsub(/[].*+?^${}()|\\[]/,"\\\\&",pfx); + while ( inp ) if ( n = match(inp, pfx "[0-9a-fA-F][0-9a-fA-F]") ) { + out = out substr(inp, 1, n - 1); + inp = substr(inp, n + k); + if (inp ~ /^[0-9]/) n = 16 * substr(inp, 1, 1); + else if (inp ~ /^[aA]/) n = 160; + else if (inp ~ /^[bB]/) n = 176; + else if (inp ~ /^[cC]/) n = 192; + else if (inp ~ /^[dD]/) n = 208; + else if (inp ~ /^[eE]/) n = 224; + else if (inp ~ /^[fF]/) n = 240; + if (inp ~ /^.[0-9]/) n += substr(inp, 2, 1); + else if (inp ~ /^.[aA]/) n += 10; + else if (inp ~ /^.[bB]/) n += 11; + else if (inp ~ /^.[cC]/) n += 12; + else if (inp ~ /^.[dD]/) n += 13; + else if (inp ~ /^.[eE]/) n += 14; + else if (inp ~ /^.[fF]/) n += 15; + out = out sprintf("%c", n); + inp = substr(inp, 3); + } else { + out = out inp; + break; + } + return out; +} + +function HTML( text ) { + gsub( /&/, "\\&", text ); + gsub( //, "\\>", text ); + gsub( /"/, "\\"", text ); + gsub( /'/, "\\'", text ); + gsub( /\[/, "\\[", text ); + gsub( /\]/, "\\]", text ); + gsub( /\r/, "\\ ", text ); + gsub( /\n/, "\\ ", text ); + gsub( /\\/, "\\\", text ); + return text; +} + +function URL( text ) { + gsub( /&/, "%26", text ); + gsub( /"/, "%22", text ); + gsub( /'/, "%27", text ); + gsub( /`/, "%60", text ); + gsub( /\?/, "%3F", text ); + gsub( /#/, "%23", text ); + gsub( /\[/, "%5B", text ); + gsub( /\]/, "%5D", text ); + gsub( / /, "%20", text ); + gsub( /\t/, "%09", text ); + gsub( /\r/, "%0D", text ); + gsub( /\n/, "%0A", text ); + gsub( /%/, "%25", text ); + gsub( /\\/, "%5C", text ); + return text; +} + +function _cgilite_urldecode( str, arr, spl, form, k, n, key) { + if (! spl) spl="&" + split(str, form, spl); + for ( k in form ) { + key = form[k]; sub(/=.*$/, "", key); + sub(/^[^=]*=/, "", form[k]); + if ( key in arr ) { + n = 1; while ( (key, n) in arr ) n++; + arr[key,n] = HEX_DECODE( "%", form[k]); + } else { + arr[key] = HEX_DECODE( "%", form[k]); + } + } +} + +function _cgilite_request( key, val) { + # Read request from client connection + + # Read Headers + getline; REQUEST_METHOD = $1; REQUEST_URI = $2; SERVER_PROTOCOL = $3; + while ( getline ) { + if ($0 ~ /^\r?$/) break; + else if ($0 ~ /^[a-zA-Z][0-9a-zA-Z_-]+: .*/) { + key = toupper($0); + sub(/:.*$/, "", key); + gsub(/-/, "_", key); + _HEADER[key] = $0; + sub(/^[^:]:[\t ]*/, "", _HEADER[key]); + sub(/[\t ]*\r?$/, "", _HEADER[key]); + } + } + CONTENT_LENGTH = _HEADER["CONTENT_LENGTH"]; + CONTENT_TYPE = _HEADER["CONTENT_TYPE"]; + + PATH_INFO = REQUEST_URI; gsub(/\?.*$/, "", PATH_INFO) + PATH_INFO = PATH( HEX_DECODE( "%", PATH_INFO ) ); + QUERY_STRING = REQUEST_URI; + if ( !gsub(/^[^?]+\?/, "", QUERY_STRING) ) QUERY_STRING = ""; + + # Set up _GET[]-Array + _cgilite_urldecode(QUERY_STRING, _GET); + + if ( _HEADER["CONTENT_TYPE"] == "application/x-www-form-urlencoded" \ + && _HEADER["CONTENT_LENGTH"] ) { + # Set up _POST[]-Array + + val = ""; key = "head -c " _HEADER["CONTENT_LENGTH"]; + while (key |getline) val = val $0; close(key); + _cgilite_urldecode(val, _POST); + } + + if ( _HEADER["COOKIE"] ) { + # Set up _COOKIE[]-Array + _cgilite_urldecode(_HEADER["COOKIE"], _COOKIE, "; ?"); + } + + if ( _HEADER["REFERER"] ) { + key = HEADER["REFERER"]; + if (! sub(/^[^\?]+?/, "", key)) key = "" + _cgilite_urldecode(key, _REF); + } + +} + +function _cgilite_headers() { + # Import request data from webserver environment variables +} + +BEGIN { + REQUEST_METHOD=""; REQUEST_URI=""; SERVER_PROTOCOL=""; + PATH_INFO=""; QUERY_STRING=""; CONTENT_LENGTH=""; CONTENT_TYPE=""; + split("", _GET); split("", _POST); split("", _REF); + split("", _HEADER); split("", _COOKIE); + + if ( ENVIRON["REQUEST_METHOD"] ) { + _cgilite_headers(); + } else { + _cgilite_request(); + } +} diff --git a/cgilite.sh b/cgilite.sh index 2e53832..b2467c3 100755 --- a/cgilite.sh +++ b/cgilite.sh @@ -1,36 +1,64 @@ #!/bin/sh -# Copyright 2017 - 2020 Paul Hänsch -# # This is CGIlite. # A collection of posix shell functions for writing CGI scripts. + +# Copyright 2017 - 2023 Paul Hänsch # -# CGIlite is free software: you can redistribute it and/or modify -# it under the terms of the GNU Affero General Public License as published by -# the Free Software Foundation, either version 3 of the License, or -# (at your option) any later version. -# -# CGIlite is distributed in the hope that it will be useful, -# but WITHOUT ANY WARRANTY; without even the implied warranty of -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -# GNU Affero General Public License for more details. +# 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. # -# You should have received a copy of the GNU Affero General Public License -# along with CGIlite. If not, see . +# 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. + +[ -n "$include_cgilite" ] && return 0 +# guard set after webserver part # ksh and zsh workaround # set -o posix # ksh, not portable setopt -o OCTAL_ZEROES 2>&- +# Integrated webserver request timeout +cgilite_timeout=2 + +# General environment variables +# $_EXEC - directory containing application itself +# $_DATA - direcotry where application data may be stored +# $_BASE - optional prefix for http path, e.g. "/myapp" +# +# Programmers should take care to use those variables throughout the +# application. +# Variables may be set via CLI argument, in environment, or left as default. + +for cgilite_arg in "$@"; do case $cgilite_arg in + --exec=*) _EXEC="${cgilite_arg#*=}";; + --data=*) _DATA="${cgilite_arg#*=}";; + --base=*) _BASE="${cgilite_arg#*=}";; +esac; done +unset cgilite_arg + +_EXEC="${_EXEC:-${0%/*}}" +_DATA="${_DATA:-.}" +_EXEC="${_EXEC%/}" _DATA="${_DATA%/}" _BASE="${_BASE%/}" + +export _EXEC _DATA _BASE + +# Carriage Return and Line Break characters for convenience CR=" " BR=' ' -cgilite_timeout=2 - -debug(){ [ $# -gt 0 ] && printf '%s\n' "$@" >&2 || tee -a /dev/stderr; } PATH(){ local str seg out + # normalize path + # read from stdin if no arguments are provided + [ $# -eq 0 ] && str="$(cat)" || str="$*" while [ "$str" ]; do seg=${str%%/*}; str="${str#*/}" @@ -44,18 +72,65 @@ PATH(){ [ "${str}" -a "${out}" ] && printf %s "$out" || printf %s/ "${out%/}" } -HEX_DECODE=' - s;\\;\\\\;g; :HEXDECODE_X; s;%([^0-9A-F]);\\045\1;g; tHEXDECODE_X; - # Hexadecimal { %00 - %FF } will be transformed to octal { \000 - \377 } for posix printf - s;%[0123].;&\\0;g; s;%[4567].;&\\1;g; s;%[89AB].;&\\2;g; s;%[CDEF].;&\\3;g; - s;%[048C][0-7]\\.;&0;g; s;%[048C][89A-F]\\.;&1;g; s;%[159D][0-7]\\.;&2;g; s;%[159D][89A-F]\\.;&3;g; - s;%[26AE][0-7]\\.;&4;g; s;%[26AE][89A-F]\\.;&5;g; s;%[37BF][0-7]\\.;&6;g; s;%[37BF][89A-F]\\.;&7;g; - s;%.[08](\\..);\10;g; s;%.[19](\\..);\11;g; s;%.[2A](\\..);\12;g; s;%.[3B](\\..);\13;g; - s;%.[4C](\\..);\14;g; s;%.[5D](\\..);\15;g; s;%.[6E](\\..);\16;g; s;%.[7F](\\..);\17;g; -' - HEX_DECODE(){ - printf -- "$(printf %s "$1" |sed -E "$HEX_DECODE")" + local pfx="$1" in="$2" out + # Print out Data encoded as Hex + # + # Arguments: + # pfx - required, prefix for a hex tupel, e.g. "\x", "%" "\", may be empty + # in - required, string to be decoded + # + # anything that does not constitute a tupel of valid Hex numerals + # will be copied to the output literally + + while [ "$in" ]; do + [ "$pfx" ] || case $in in + [0-9a-fA-F][0-9a-fA-F]*):;; + ?*) out="${out}${in%%"${in#?}"}" + in="${in#?}"; continue;; + esac + + case $in in + "$pfx"[0-9a-fA-F][0-9a-fA-F]*) in="${in#"${pfx}"}";; + \\*) in="${in#?}"; out="${out}\\\\"; continue;; + %*) in="${in#?}"; out="${out}%%"; continue;; + *) att="${in%%"${pfx}"*}"; att="${att%%%*}"; att="${att%%\\*}" + out="${out}${att}"; in="${in#"${att}"}"; continue;; + esac; + + # Hex escapes for printf (e.g. \x41) are not portable + # The portable way for Hex output is transforming Hex to Octal + # (e.g. \x41 = \101) + case $in in + [0123]?*) out="${out}\\0";; + [4567]?*) out="${out}\\1";; + [89aAbB]?*) out="${out}\\2";; + [c-fC-F]?*) out="${out}\\3";; + esac + case $in in + [048cC][0-7]*) out="${out}0";; + [048cC][89a-fA-F]*) out="${out}1";; + [159dD][0-7]*) out="${out}2";; + [159dD][89a-fA-F]*) out="${out}3";; + [26aAeE][0-7]*) out="${out}4";; + [26aAeE][89a-fA-F]*) out="${out}5";; + [37bBfF][0-7]*) out="${out}6";; + [37bBfF][89a-fA-F]*) out="${out}7";; + esac + case $in in + ?[08]*) out="${out}0";; + ?[19]*) out="${out}1";; + ?[2aA]*) out="${out}2";; + ?[3bB]*) out="${out}3";; + ?[4cC]*) out="${out}4";; + ?[5dD]*) out="${out}5";; + ?[6eE]*) out="${out}6";; + ?[7fF]*) out="${out}7";; + esac + in="${in#?}" + in="${in#?}" + done + printf -- "$out" } if [ -z "$REQUEST_METHOD" ]; then @@ -74,15 +149,17 @@ if [ -z "$REQUEST_METHOD" ]; then (sleep $cgilite_timeout && kill $$) & cgilite_watchdog=$! while read REQUEST_METHOD REQUEST_URI SERVER_PROTOCOL; do + unset PATH_INFO QUERY_STRING cgilite_headers CONTENT_LENGTH CONTENT_TYPE + [ "${SERVER_PROTOCOL#HTTP/1.[01]${CR}}" ] && break kill $cgilite_watchdog SERVER_PROTOCOL="${SERVER_PROTOCOL%${CR}}" - PATH_INFO="$(HEX_DECODE "${REQUEST_URI%\?*}" |PATH)" + PATH_INFO="$(HEX_DECODE % "${REQUEST_URI%\?*}" |PATH)" [ "${REQUEST_URI}" = "${REQUEST_URI#*\?}" ] \ && QUERY_STRING='' \ || QUERY_STRING="${REQUEST_URI#*\?}" - cgilite_headers=''; while read -r hl; do + while read -r hl; do hl="${hl%${CR}}"; [ "$hl" ] || break case $hl in 'Content-Length: '*) CONTENT_LENGTH="${hl#*: }";; @@ -92,7 +169,7 @@ if [ -z "$REQUEST_METHOD" ]; then done export REMOTE_ADDR SERVER_NAME SERVER_PORT REQUEST_METHOD REQUEST_URI SERVER_PROTOCOL \ - PATH_INFO QUERY_STRING CONTENT_TYPE CONTENT_LENGTH + PATH_INFO QUERY_STRING CONTENT_TYPE CONTENT_LENGTH cgilite_headers # Try to serve multiple requests, provided that script serves a # Content-Length header. @@ -121,13 +198,20 @@ if [ -z "$REQUEST_METHOD" ]; then exit 0 fi +include_cgilite="$0" + if [ "${REQUEST_METHOD}" = POST -a "${CONTENT_LENGTH:-0}" -gt 0 -a \ "${CONTENT_TYPE}" = "application/x-www-form-urlencoded" ]; then cgilite_post="$(head -c "$CONTENT_LENGTH")" fi +PATH_INFO="$(PATH "/${PATH_INFO#${_BASE}}")" + +debug(){ [ $# -gt 0 ] && printf '%s\n' "$@" >&2 || tee -a /dev/stderr; } [ "${DEBUG+x}" ] && env >&2 +# general helper functions, see GET, POST, and REF below + cgilite_count(){ printf %s "&$1" \ | grep -oE '&'"$2"'=[^&]*' \ @@ -141,7 +225,7 @@ cgilite_value(){ str="${str#*&${name}=}" cnt=$((cnt - 1)) done - printf -- "$(printf %s "${str%%&*}" |sed -E 's;\+; ;g;'"$HEX_DECODE")" + HEX_DECODE % "$(printf %s "${str%%&*}" |tr + \ )" } cgilite_keys(){ @@ -153,15 +237,26 @@ cgilite_keys(){ | sort -u } -GET(){ cgilite_value "${QUERY_STRING}" $@; } +# Read arguments from GET, POST, or the query string of the referrer (REF). +# Example: +# GET varname n +# +# where n is number for the Nth occurence of a variable and defaults to 1 +# +# *_COUNT varname +# -> returns number of ocurences +# *_KEYS +# -> returns list of available varnames + +GET(){ cgilite_value "${QUERY_STRING}" "$@"; } GET_COUNT(){ cgilite_count "${QUERY_STRING}" $1; } GET_KEYS(){ cgilite_keys "${QUERY_STRING}"; } -POST(){ cgilite_value "${cgilite_post}" $@; } +POST(){ cgilite_value "${cgilite_post}" "$@"; } POST_COUNT(){ cgilite_count "${cgilite_post}" $1; } POST_KEYS(){ cgilite_keys "${cgilite_post}"; } -REF(){ cgilite_value "${HTTP_REFERER#*\?}" $@; } +REF(){ cgilite_value "${HTTP_REFERER#*\?}" "$@"; } REF_COUNT(){ cgilite_count "${HTTP_REFERER#*\?}" $1; } REF_KEYS(){ cgilite_keys "${HTTP_REFERER#*\?}"; } @@ -174,14 +269,15 @@ HEADER(){ str="${str#*${BR}${1}: }" printf %s "${str%%${BR}*}" else - local var="HTTP_$(printf %s "$1" |tr a-z- A-Z-)" + local var="HTTP_$(printf %s "$1" |tr a-z- A-Z_)" eval "[ \"\$$var\" ] && printf %s \"\$$var\" || return 1" # eval "printf %s \"\$HTTP_$(printf %s "${1}" |tr a-z A-Z |tr -c A-Z _)\"" fi } COOKIE(){ - HEX_DECODE "$( + # Read value of cookie + HEX_DECODE % "$( HEADER Cookie \ | grep -oE '(^|; ?)'"$1"'=[^;]*' \ | sed -En "${2:-1}"'{s;^[^=]+=;;; s;\+; ;g; p;}' @@ -193,20 +289,18 @@ HTML(){ # Also escape [, ], and \n for use in html-sh local str out [ $# -eq 0 ] && str="$(cat)" || str="$*" - while [ "$str" ]; do - case $str in - \&*) out="${out}&";; - \<*) out="${out}<";; - \>*) out="${out}>";; - \"*) out="${out}"";; - \'*) out="${out}'";; - \[*) out="${out}[";; - \]*) out="${out}]";; - "${BR}"*) out="${out} ";; - *) out="${out}${str%"${str#?}"}";; - esac - str="${str#?}" - done + while [ "$str" ]; do case $str in + \&*) out="${out}&"; str="${str#?}";; + \<*) out="${out}<"; str="${str#?}";; + \>*) out="${out}>"; str="${str#?}";; + \"*) out="${out}""; str="${str#?}";; + \'*) out="${out}'"; str="${str#?}";; + \[*) out="${out}["; str="${str#?}";; + \]*) out="${out}]"; str="${str#?}";; + "${CR}"*) out="${out} "; str="${str#?}";; + "${BR}"*) out="${out} "; str="${str#?}";; + *) out="${out}${str%%[]&<>\"\'${CR}${BR}[]*}"; str="${str#"${str%%[]&<>\"\'${CR}${BR}[]*}"}";; + esac; done printf %s "$out" } @@ -214,22 +308,22 @@ URL(){ # Escape pathes, so they can be used in link tags and HTTP Headers local str out [ $# -eq 0 ] && str="$(cat)" || str="$*" - while [ "$str" ]; do - case $str in - \&*) out="${out}%26";; - \"*) out="${out}%22";; - \'*) out="${out}%27";; - \?*) out="${out}%3F";; - \#*) out="${out}%23";; - \[*) out="${out}%5B";; - \]*) out="${out}%5D";; - \ *) out="${out}%20";; - "${BR}"*) out="${out}%0A";; - %*) out="${out}%25";; - *) out="${out}${str%"${str#?}"}";; - esac - str="${str#?}" - done + while [ "$str" ]; do case $str in + \&*) out="${out}%26"; str="${str#?}";; + \"*) out="${out}%22"; str="${str#?}";; + \'*) out="${out}%27"; str="${str#?}";; + \`*) out="${out}%60"; str="${str#?}";; + \?*) out="${out}%3F"; str="${str#?}";; + \#*) out="${out}%23"; str="${str#?}";; + \[*) out="${out}%5B"; str="${str#?}";; + \]*) out="${out}%5D"; str="${str#?}";; + \ *) out="${out}%20"; str="${str#?}";; + " "*) out="${out}%09"; str="${str#?}";; + "${CR}"*) out="${out}%0D"; str="${str#?}";; + "${BR}"*) out="${out}%0A"; str="${str#?}";; + %*) out="${out}%25"; str="${str#?}";; + *) out="${out}${str%%[]&\"\'\?# ${CR}${BR}%[]*}"; str="${str#"${str%%[]&\"\'\?# ${CR}${BR}%[]*}"}";; + esac; done printf %s "$out" } @@ -252,6 +346,7 @@ SET_COOKIE(){ } REDIRECT(){ + # Trigger redirct and terminate script printf '%s: %s\r\n' \ Status "303 See Other" \ Content-Length 0 \ diff --git a/common.css b/common.css new file mode 100644 index 0000000..16e99f2 --- /dev/null +++ b/common.css @@ -0,0 +1,191 @@ +/* ======= GENERIC HTML STYLES ======= */ + +* { + box-sizing: border-box; + position: relative; + font: inherit; + text-decoration: inherit; + color: inherit; background: transparent; + max-width: 100%; + margin: 0; padding: 0; + border: none; +} + +body { + font: normal normal normal medium/1.5em sans-serif; + color: #000; background: #FFF; +} + +ul, ol, dl, table, pre, p { margin-bottom: .5em; } +p:only-child { margin-bottom: 0; } + +table { + max-width: 100%; + overflow-x: auto; +} +th, td { padding: .25em .75em; } + +a { + font-style: italic; + text-decoration: underline; + color: #068; + word-break: break-word; +} +a.button, label.button { + font-style: inherit; + text-decoration: inherit; + color: inherit; +} + +sup { vertical-align: super; } +sub { vertical-align: sub; } +small { font-size: .75em; } +big { font-size: 1.25em; } +strike, del, s { text-decoration: line-through; } +u {text-decoration: underline; } +i, em { font-style: italic; } +b, strong { font-weight: bolder; } +tt, code, var, samp, kbd { font-family: monospace; } +kbd { font-style: italic; } + +blockquote { + background-color: #EEE; + margin: .5em 0; + padding: 1em 2em; + white-space: pre-line; +} + +ul, ol { padding-left: 1.5em; } +dl dt { font-weight: bolder; } +dl dd { + margin: 0 2em; + background-color: #EEE; +} +table th { font-weight: bold; } + +li p + ul, li p + ol { + margin-top: -.25em; +} + +hr { border-bottom: 1pt solid; } + +h1, h2, h3 { + font-weight: bold; + margin-top: .75em; + margin-bottom: .5em; +} + +h4, h5, h6, form legend { + font-weight: bolder; + margin-bottom: .25em; +} + +h1 { + text-align: center; + font-size: 1.5em; +} +h2 { font-size: 1.125em; } + +select, input, button, textarea, a.button, label.button { + display: inline-block; + color: #000; background-color: #FFF; + border: .5pt solid; + padding: .25em .75em; + vertical-align: text-bottom; + border: .5pt solid #000; + border-radius: 2pt; +} +select { padding: .375em 0; } +textarea { min-height: 7em; } + +input[type=radio], input[type=checkbox] { + vertical-align: baseline; +} +input[type=number] { text-align: right; padding-right: 0; } + +button, input[type=button], a.button, label.button { + box-shadow: .125em .125em .25em; + cursor: pointer; +} +input[type=radio], input[type=checkbox], label[for] { + cursor: pointer; +} + +label { margin-right: .75em; } +input + label { + margin-left: .375em; +} + +input[type="search"] + button.search, +input.search + button.search { + width: 2.5em; + color: transparent; + background-color: #CCC; + margin-left: -2pt; + border-left: none; + border-radius: 0 2pt 2pt 0; + white-space: nowrap; + overflow: hidden; +} +input[type="search"] + button.search:before, +input.search + button.search:before { + content: '\1f50d'; + color: #000; + font-weight: bold; +} + +@media print { + @page { margin: 20mm; } + + h1, h2, h3, h4, h5, h6, form legend { + page-break-inside: avoid; + page-break-after: avoid; + page-break-before: auto; + } + li { page-break-inside: avoid; } + th, dt { page-break-after: avoid; } +} + +/* ======= End Generic Styles ======= */ + +/* ======= Common Styles ======= */ + +*[tooltip]:hover:after { + display: block; + position: absolute; + min-width: 12em; + bottom: 100%; left: 50%; transform: translate(-50%, 0); + content: attr(tooltip); + padding: .5em; + color: #000; background-color: #FFC; + border: .5pt solid; + z-index: 1; +} + +input[type=radio].tab { display: none; } +input[type=radio].tab + label { + display: table-cell; + padding: .5em 1em; + color: #000; background-color: #EEE; + border: .5pt solid; +} +input[type=radio].tab:checked + label { + background-color: #FFF; + border-bottom: none; + box-shadow: .125em -.125em .125em #888; + z-index: 1; +} +input[type=radio].tab ~ *.tab { + display: none; + width: 100%; + margin-top: -.5pt; padding: .25em .75em; + border: .5pt solid; + border-radius: 0; + box-shadow: .125em .125em .125em #888; +} + +/* Markdown line-block */ +.line-block { white-space: pre-wrap; } +.line-block br { display: none; } + +/* ======= End Common Styles ======= */ diff --git a/db23.sh b/db23.sh new file mode 100755 index 0000000..b7ab548 --- /dev/null +++ b/db23.sh @@ -0,0 +1,122 @@ +#!/bin/sh + +# Copyright 2023, 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. + +[ -n "$include_db23" ] && return 0 +include_db23="$0" + +. "${_EXEC:-.}/cgilite/storage.sh" + +DB2() { + local call data file key val seq + data="${BR}${1}${BR}" call="$2" + shift 2 + + case $call in + new|discard) + printf '' + ;; + open|load) file="$1" + cat "$file" || return 1 + ;; + check|contains) key="$(STRING "$1")" seq="${2:-1}" + val="${data##*"${BR}${key}" }" val="${val%%"${BR}"*}" + [ "$val" = '' ] && return 1 || val="${val} " + while [ $seq -gt 1 ]; do + seq=$((seq - 1)) val="${val#* }" + done + [ "$val" = '' ] && return 1 + ;; + count) key="$(STRING "$1")" val='' seq=0 + val="${data##*"${BR}${key}" }" val="${val%%"${BR}"*}" + [ "$val" = '' ] || val="${val} " + while [ "$val" != '' ]; do + seq=$((seq + 1)) val="${val#* }" + done + printf "%i\n" "$seq" + [ $seq = 0 ] && return 1 + ;; + get) key="$(STRING "$1")" seq="${2:-1}" + val="${data##*"${BR}${key}" }" val="${val%%"${BR}"*}" + [ "$val" = '' ] && return 1 || val="${val} " + while [ $seq -gt 1 ]; do + seq=$((seq - 1)) val="${val#* }" + done + [ "$val" = '' ] && return 1 + UNSTRING "${val%% *}" + ;; + iterate|raw) key="$(STRING "$1")" + val="${data##*"${BR}${key}" }" val="${val%%"${BR}"*}" + [ "$val" = '' ] && return 1 + printf '%s\n' $val + ;; + delete|remove) key="$(STRING "$1")" + val="${data#*"${BR}${key}" *"${BR}"}" + key="${data%"${BR}${key}" *"${BR}"*}" + if [ "${val}" = "${data}" ]; then + printf %s\\n "${data}" + return 1 + else + printf '%s' "${key#"${BR}"}${BR}${val%"${BR}"}" + fi + ;; + set|store) key="$(STRING "$1")" val="" + shift 1 + val="$(for v in "$@"; do STRING "$v"; printf \\t; done)" + if [ "${data#*"${BR}${key}" *}" != "$data" ]; then + data="${data%"${BR}${key}" *"${BR}"*}${BR}${key} ${val% }${BR}${data#*"${BR}${key}" *"${BR}"}" + data="${data#"${BR}"}" data="${data%"${BR}"}" + else + data="${data#"${BR}"}${key} ${val% }${BR}" + data="${data#"${BR}"}" + fi + printf %s\\n "${data}" + ;; + append) key="$(STRING "$1")" val="" + val="${data##*"${BR}${key}" }" val="${val%%"${BR}"*}" + if [ "$val" = '' ]; then + printf %s\\n "${data}" + return 1 + else + shift 1 + val="${val}$(for v in "$@"; do printf \\t; STRING "$v"; done)" + data="${data%"${BR}${key}" *"${BR}"*}${BR}${key} ${val% }${BR}${data#*"${BR}${key}" *"${BR}"}" + data="${data#"${BR}"}" data="${data%"${BR}"}" + printf %s\\n "${data}" + fi + ;; + flush|save|write) file="$1" + data="${data#"${BR}"}" data="${data%"${BR}"}" + printf '%s\n' "$data" >"$file" || return 1 + ;; + esac + return 0 +} + +DB3() { + # wrapper function that allows easyer use of DB2 + # by always keeping file data in $db3_data + + case "$1" in + new|discard|open|load|delete|remove|set|store|append) + db3_data="$(DB2 "$db3_data" "$@")" + return "$?" + ;; + get|count|check|contains|iterate|raw|flush|save|write) + DB2 "$db3_data" "$@" + return "$?" + ;; + esac +} diff --git a/file.sh b/file.sh index 51ec245..c66b17d 100755 --- a/file.sh +++ b/file.sh @@ -1,64 +1,76 @@ #!/bin/sh -# Copyright 2016 - 2019 Paul Hänsch -# -# This file is part of cgilite. +# Copyright 2016 - 2024 Paul Hänsch # -# cgilite is free software: you can redistribute it and/or modify -# it under the terms of the GNU Affero General Public License as published by -# the Free Software Foundation, either version 3 of the License, or -# (at your option) any later version. +# 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. # -# cgilite is distributed in the hope that it will be useful, -# but WITHOUT ANY WARRANTY; without even the implied warranty of -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -# GNU Affero General Public License for more details. -# -# You should have received a copy of the GNU Affero General Public License -# along with cgilite. If not, see . +# 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. [ -n "$include_fileserve" ] && return 0 include_fileserve="$0" file_type(){ case ${1##*.} in - html|html) printf 'text/html';; css) printf 'text/css';; - js) printf 'text/javascript';; - txt) printf 'text/plain';; - sh) printf 'text/shellscript';; + gif) printf 'image/gif';; + html|html) printf 'text/html';; jpg|jpeg) printf 'image/jpeg';; + js) printf 'text/javascript';; + m3u8) printf 'application/x-mpegURL';; + m4a) printf 'audio/mp4';; + m4s) printf 'video/iso.segment';; + m4v|mp4) printf 'video/mp4';; + mpd) printf 'application/dash+xml';; + ogg) printf 'audio/ogg';; + pdf) printf 'application/pdf';; png) printf 'image/png';; + sh) printf 'text/x-shellscript';; svg) printf 'image/svg+xml';; - gif) printf 'image/gif';; + tex) printf 'text/x-tex';; + txt) printf 'text/plain';; + short) printf 'text/prs.shorthand';; + ts) printf 'video/MP2T';; webm) printf 'video/webm';; - mp4) printf 'video/mp4';; - ogg) printf 'audio/ogg';; xml) printf 'application/xml';; *) printf 'application/octet-stream';; esac } FILE(){ - local file file_size file_date http_date cachedate range mime - file="$1" mime="$2" + local file="$1" mime="$2" + local file_size file_date http_date cachedate range if ! [ -f "$file" ]; then printf 'Content-Length: 0\r\nStatus: 404 Not Found\r\n\r\n' - exit 0 + return 0 elif ! [ -r "$file" ]; then printf 'Content-Length: 0\r\nStatus: 403 Forbidden\r\n\r\n' - exit 0 + return 0 fi - file_size="$(stat -Lc %s "$file")" - file_date="$(stat -Lc %Y "$file")" - http_date="$(date -uRd @$file_date)" - http_date="${http_date%+0000}GMT" + read file_size file_date <<-EOF + $(stat -Lc "%s %Y" "$file") + EOF + http_date="$(date -ud "@$file_date" +"%a, %d %b %Y %T GMT")" + + [ ! "$HTTP_IF_MODIFIED_SINCE" -a "$cgilite_headers" ] \ + && HTTP_IF_MODIFIED_SINCE="$(HEADER If-Modified-Since)" + [ ! "$HTTP_RANGE" -a "$cgilite_headers" ] \ + && HTTP_RANGE="$(HEADER Range)" + cachedate="$( # Parse the allowable date formats from Section 3.3.1 of # https://www.w3.org/Protocols/rfc2616/rfc2616-sec3.html - HEADER If-Modified-Since \ + # HEADER If-Modified-Since \ + printf %s "$HTTP_IF_MODIFIED_SINCE" \ | sed -E 's;^[^ ]+, ([0-9]{2}) (...) ([0-9]{4}) (..:..:..) GMT$;\3-\2-\1 \4;; s;^[^ ]+, ([0-9]{2})-(...)-([789][0-9]) (..:..:..) GMT$;19\3-\2-\1 \4;; s;^[^ ]+, ([0-9]{2})-(...)-([0-6][0-9]) (..:..:..) GMT$;20\3-\2-\1 \4;; @@ -69,14 +81,25 @@ FILE(){ | xargs -r0 date +%s -ud 2>&- )" - range="$(HEADER Range |sed -nE 's;^bytes=([0-9]+-[0-9]*|-[0-9]+)$;\1;p;q;')" + range="${HTTP_RANGE#bytes=}" case "$range" in - *-) range="${range}$((file_size - 1))";; - -*) [ ${range#-} -le $file_size ] \ - && range="$((file_size - ${range#-}))-$((file_size - 1))" \ - || range="0-$((file_size - 1))";; - *-*) [ ${range#*-} -ge $file_size ] \ - && range="${range%-*}-$((file_size - 1))";; + *[!0-9]*-*|*-*[!0-9]*) + range="" + ;; + *-) + range="${range}$((file_size - 1))" + ;; + -*) + [ ${range#-} -le $file_size ] \ + && range="$((file_size - ${range#-}))-$((file_size - 1))" \ + || range="0-$((file_size - 1))" + ;; + *-*) + [ ${range#*-} -ge $file_size ] \ + && range="${range%-*}-$((file_size - 1))" + ;; + *) range="" + ;; esac if [ "$file_date" -lt "$cachedate" ] 2>&-; then diff --git a/html-sh.sed b/html-sh.sed index 8d7b61c..1a0f2b4 100755 --- a/html-sh.sed +++ b/html-sh.sed @@ -1,5 +1,19 @@ #!/bin/sed -nEf +# Copyright 2018 - 2019 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. + :Escapes s,\\\\,\\,g; s,\\&,\&,g; s,\\<,\<,g; s,\\>,\>,g; diff --git a/json.sh b/json.sh new file mode 100755 index 0000000..12afdc4 --- /dev/null +++ b/json.sh @@ -0,0 +1,360 @@ +#!/bin/sh + +[ -n "$include_json" ] && return 0 +include_json="$0" + +. "${_EXEC:-.}/cgilite/db23.sh" + +# debug(){ [ $# -gt 0 ] && printf '%s\n' "$@" >&2 || tee -a /dev/stderr; } + +json_except() { + printf '%s\n' "$@" >&2; + printf 'Exc: %s\n' "$json_document" >&2 +} + +json_space() { + while true; do case "$json_document" in + [" ${BR}${CR} "]*) json_document="${json_document#?}";; + *) break ;; + esac; done +} + +json_string() { + local string json_document="$json_document" end=0 + + json_space + case $json_document in + \"*) json_document="${json_document#?}" + ;; + *) json_except "Expected string specifyer starting with (\")" + return 1 + ;; + esac + while [ "$json_document" ]; do case $json_document in + \\?*) + string="${string}${json_document%"${json_document#??}"}" + json_document="${json_document#??}" + ;; + \"*) + json_document="${json_document#?}" + end=1 + break + ;; + *) + string="${string}${json_document%"${json_document#?}"}" + json_document="${json_document#?}" + ;; + esac; done + + if [ $end -eq 0 ]; then + json_except "Document ended mid-string" + return 1 + fi + + printf "%s %s\n" "$(STRING "$string")" "$json_document" +} + +json_key() { + local key json_document="$json_document" + + json_space + case $json_document in + \"*) + key="$(json_string)" || return 1 + json_document="${key#* }" + key="${key%% *}" + ;; + *) json_except "Expected key specifyer starting with '\"'" + return 1 + ;; + esac + json_space + case $json_document in + :*) json_document="${json_document#?}" + ;; + *) json_except "Expected value separator \":\"" + return 1 + ;; + esac + + printf '%s %s\n' "$key" "$json_document" +} + +json_number() { + local number json_document="$json_document" + + json_space + number="${json_document%%[" ${BR}${CR} ,}]"]*}" + json_document="${json_document#"$number"}" + if ! number="$(printf %f "$number")"; then + json_except "Invalid number format" + return 1 + fi + + printf '%s %s\n' "${number%.000000}" "$json_document" +} + +json_array() { + local struct="$(DB2 "" new)" value json_document="$json_document" + + json_space + case $json_document in + "["*) json_document="${json_document#?}" + ;; + *) json_except "Expected array starting with \"[\"" + return 1 + ;; + esac + + json_space + case $json_document in + "]"*) + printf "%s %s\n" "" "${json_document#?}" + return 0 + ;; + esac + + while :; do + json_space + + value="$(json_value)" || return 1 + json_document="${value#* }" + value="$(UNSTRING "${value%% *}")" + + struct="$(DB2 "$struct" append "@" "$value")" \ + || struct="$(DB2 "$struct" set "@" "$value")" + + json_space + case $json_document in + ,*) json_document="${json_document#?}" + ;; + "]"*) json_document="${json_document#?}" + break + ;; + *) json_except "Unexpected character mid-array" + return 1 + ;; + esac + done + + printf "%s %s\n" "$(STRING "$struct")" "$json_document" +} + +json_object() { + local struct="$(DB2 "" new)" key value json_document="$json_document" + + json_space + case $json_document in + "{"*) json_document="${json_document#?}" + ;; + *) json_except "Expected object starting with \"{\"" + return 1 + ;; + esac + + json_space + case $json_document in + "}"*) + printf "%s %s\n" "" "${json_document#?}" + return 0 + ;; + esac + + while :; do + json_space + + key="$(json_key)" || return 1 + json_document="${key#* }" + key="$(UNSTRING "${key%% *}")" + + value="$(json_value)" || return 1 + json_document="${value#* }" + value="$(UNSTRING "${value%% *}")" + + struct="$(DB2 "$struct" set "$key" "$value")" + + json_space + case $json_document in + ,*) json_document="${json_document#?}" + ;; + "}"*) json_document="${json_document#?}" + break + ;; + *) json_except "Unexpected character mid-object" + return 1 + ;; + esac + done + + printf "%s %s\n" "$(STRING "$struct")" "$json_document" +} + +json_value() { + local value json_document="$json_document" + json_type="" + + json_space + case $json_document in + \"*) + value="$(json_string)" || return 1 + json_document="${value#* }" + value="str:${value%% *}" + json_type=string + ;; + [+-.0-9]*) + value="$(json_number)" || return 1 + json_document="${value#* }" + value="num:${value%% *}" + json_type=number + ;; + "{"*) + value="$(json_object)" || return 1 + json_document="${value#* }" + value="obj:${value%% *}" + json_type=object + ;; + "["*) + value="$(json_array)" || return 1 + json_document="${value#* }" + value="arr:${value%% *}" + json_type=array + ;; + null*) + json_document="${json_document#null}" + value="null" + json_type=null + ;; + true*) + json_document="${json_document#true}" + value="true" + json_type=boolean + ;; + false*) + json_document="${json_document#false}" + value="false" + json_type=boolean + ;; + esac + + printf "%s %s\n" "$value" "$json_document" +} + +json_load() { + local json_document="$1" json + + json_value |UNSTRING +} + +json_get() { + local json="$1" jpath="${2#.}" key idx + json_type='' + + case $json in + str:*) json_type="string";; + arr:*) json_type="array";; + obj:*) json_type="object";; + num:*) json_type="number";; + true|false) + json_type="boolean";; + null) json_type="null";; + esac + + case $jpath in + "") + printf %s\\n "${json#???:}" + return 0 + ;; + "["[0-9]*"]"*) + idx="${jpath%%"]"*}" idx="${idx#"["}" + jpath="${jpath#"["*"]"}" + ;; + "['"*"']"*) + key="${jpath%%"']"*}" key="${key#"['"}" + jpath="${jpath#"['"*"']"}" + ;; + "$"*) + jpath="${jpath#?}" + ;; + *) key="${jpath%%[".["]*}" + jpath="${jpath#"$key"}" + ;; + esac + + if [ "$key" -a "$json_type" = object ]; then + if ! json="$(DB2 "${json#obj:}" get "$key")"; then + debug "Key not found: \"$key\"" + return 1 + fi + elif [ "$idx" -a "$json_type" = array ]; then + if ! json="$(DB2 "${json#arr:}" get @ "$(( idx + 1 ))")"; then + debug "Array index not found: \"$idx\"" + return 1 + fi + elif [ "$key" ]; then + debug "Cannot select key (\"$key\") from value of type \"$json_type\"" + return 1 + elif [ "$idx" ]; then + debug "Cannot select index ($idx) from value of type \"$json_type\"" + return 1 + fi + json_get "$json" "$jpath" + return $? +} + +json_dump_string() { + local in="$1" out='' + while [ "$in" ]; do case $in in + \\*) out="${out}\\\\"; in="${in#\\}" ;; + "$BR"*) out="${out}\\n"; in="${in#${BR}}" ;; + "$CR"*) out="${out}\\r"; in="${in#${CR}}" ;; + " "*) out="${out}\\t"; in="${in# }" ;; + \"*) out="${out}\\\""; in="${in#\"}" ;; + *) out="${out}${in%%[\\${CR}${BR} \"]*}"; in="${in#"${in%%[\\${BR}${CR} \"]*}"}" ;; + esac; done + printf '"%s"' "${out}" +} + +json_dump_array() { + local json="$1" value out='' + + for value in $(DB2 "$json" iterate @); do + out="${out},$(json_dump "$(UNSTRING "$value")")" + done + printf '[%s]' "${out#,}" +} + +json_dump_object() { + local json="$1" key value out='' + + while read -r key value; do + out="${out},$(json_dump_string "$(UNSTRING "$key")"):$(json_dump "$(UNSTRING "$value")")" + done <<-EOF + ${json} + EOF + printf '{%s}' "${out#,}" +} + +json_dump() { + local json="$1" + + case $json in + str:*) + json_dump_string "${json#str:}" + ;; + arr:*) + json_dump_array "${json#arr:}" + ;; + obj:*) + json_dump_object "${json#obj:}" + ;; + num:*) + printf "${json#num:}" + ;; + true|false|null) + printf %s\\n "$json" + ;; + *) + json_dump_string "${json}" + ;; + esac +} diff --git a/markdown.awk b/markdown.awk new file mode 100755 index 0000000..90dddbf --- /dev/null +++ b/markdown.awk @@ -0,0 +1,999 @@ +#!/bin/awk -f +#!/opt/busybox/awk -f + +# EXPERIMENTAL Markdown processor with minimal dependencies. +# Meant to support all features of John Grubers basic Markdown +# + a number of common extensions, mostly inspired by Pandoc Markdown + +# Copyright 2021 - 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. + +# Supported Features / TODO: +# ========================== +# [x] done [ ] todo [-] not planned ? unsure +# +# Basic Markdown - Block elements: +# ------------------------------- +# - [x] Paragraphs +# - [x] Double space line breaks +# - [x] Proper block element nesting +# - [x] Headings +# - [x] ATX-Style Headings +# - [x] Blockquotes +# - [x] Lists (ordered, unordered) +# - [x] Code blocks (using indention) +# - [x] Horizontal rules +# - [x] Verbatim HTML block (disabled by default) +# +# Basic Markdown - Inline elements: +# --------------------------------- +# - [x] Links +# - [x] Reference style links +# - [x] Emphasis *em*/**strong** (*Asterisk*, _Underscore_) +# - [x] `code`, also ``code containing `backticks` `` +# - [x] Images / reference style images +# - [x] +# - [x] backslash escapes +# - [x] Verbatim HTML inline (disabled by default) +# - [x] HTML escaping +# +# NOTE: Set the environment variable MD_HTML=true to enable verbatim HTML +# +# Extensions - Block elements: +# ---------------------------- +# - [x] Automatic
-wrapping (custom) +# - ? Heading identifiers (php md, pandoc) +# - [x] Heading attributes (custom) +# - [ ]
terminates section +# - [x] Automatic heading identifiers (custom) +# - [x] Fenced code blocks (php md, pandoc) +# - [x] Fenced code attributes +# - [x] Images (as block elements,
-wrapped) (custom) +# - [x] reference style block images +# - [/] Tables +# - ? Simple table (pandoc) +# - ? Multiline table (pandoc) +# - [x] Grid table (pandoc) +# - [x] Headerless +# - [x] Pipe table (php md, pandoc) +# - [x] Line blocks (pandoc) +# - [x] Task lists (pandoc, custom) +# - [x] Definition lists (php md, pandoc) +# - [-] Numbered example lists (pandoc) +# - [-] Metadata blocks (pandoc) +# - [x] Metadata blocks (custom) +# - [x] Fenced Divs (pandoc) +# +# Extensions - Inline elements: +# ---------------------------- +# - [x] Ignore embedded_underscores (php md, pandoc) +# - [x] ~~strikeout~~ (pandoc) +# - [x] ^Superscript^ ~Subscript~ (pandoc) +# - [-] Bracketed spans (pandoc) +# - [-] Inline attributes (pandoc) +# - [x] Image attributes (custom, pandoc inspired, not for reference style) +# - [x] Wiki style links [[PageName]] / [[PageName|Link Text]] +# - [-] TEX-Math (pandoc) +# - ? Footnotes (php md) +# - ? Abbreviations (php md) +# - ? "Curly quotes" (smartypants) +# - [ ] em-dashes (--) (smartypants old) +# - ? ... three-dot ellipsis (smartypants) +# - [-] en-dash (smartypants) +# - [ ] Automatic em-dash / en-dash +# - [x] Automatic -> Arrows <- (custom) + +function debug(text) { printf "\n---\n%s\n---\n", text > "/dev/stderr"; } + +function HTML ( text ) { + gsub( /&/, "\\&", text ); + gsub( //, "\\>", text ); + gsub( /"/, "\\"", text ); + gsub( /'/, "\\'", text ); + gsub( /\\/, "\\\", text ); + return text; +} + +function URL ( text, sharp ) { + gsub( /&/, "%26", text ); + gsub( /"/, "%22", text ); + gsub( /'/, "%27", text ); + gsub( /`/, "%60", text ); + gsub( /\?/, "%3F", text ); + if (sharp) gsub( /#/, "%23", text ); + gsub( /\[/, "%5B", text ); + gsub( /\]/, "%5D", text ); + gsub( / /, "%20", text ); + gsub( / /, "%09", text ); + gsub( /\\/, "%5C", text ); + return text; +} + +function inline( line, LOCAL, len, text, code, href, guard, ret ) { + ret = ""; + while (line !~ /^$/) { + # omit processing of escaped characters + if ( line ~ /^\\./) { + ret = ret HTML(substr(line, 2, 1)); line = substr(line, 3); + continue; + + # hard brakes + } else if ( match(line, /^ \n/) ) { + ret = ret "
\n"; line = substr(line, RLENGTH + 1); + continue; + + # ``code spans`` + } else if ( match( line, /^`+/) ) { + len = RLENGTH + guard = substr( line, 1, len ) + if ( match(line, guard ".*" guard) ) { + code = substr( line, len + 1, match( substr(line, len + 1), guard ) - 1) + len = 2 * length(guard) + length(code) + # strip single surrounding white spaces + gsub( /^ | $/, "", code) + # escape HTML within code span + gsub( /&/, "\\&", code ); gsub( //, "\\>", code ); + ret = ret "" code ""; line = substr( line, len + 1 ); + continue; + } + + # Macros + } else if ( match( line, /^<<([^>]|>[^>])+>>/ ) ) { + len = RLENGTH; + ret = ret "" HTML( substr( line, 3, len - 4 ) ) ""; line = substr(line, len + 1); + continue; + + # Wiki style links + } else if ( match( line, /^\[\[([^]|]+)(\|[^]]+)?\]\]/) ) { + len = RLENGTH; href = text = substr(line, 1, len); + sub(/^\[\[/, "", href); sub(/(\|([^]]+))?\]\].*$/, "", href); + sub(/^\[\[([^]|]+)/, "", text); sub(/\]\].*$/, "", text); sub(/^\|/, "", text); + # sub(/^\[\[([^]|]+)(\|([^]]+))?\]\]/, "\\1", href ); + # sub(/^\[\[([^]|]+)(\|([^]]+))?\]\]/, "\\3", text ); + if ( ! text ) text = href; + ret = ret "" HTML(text) ""; line = substr( line, len + 1); + continue; + + # quick links ("automatic links" in md doc) + } else if ( match( line, /^<[a-zA-Z]+:\/\/([-\.[:alnum:]]+)(:[0-9]*)?(\/[^>]*)?>/ ) ) { + len = RLENGTH; + href = HTML( substr( line, 2, len - 2) ); + ret = ret "" href ""; line = substr( line, len + 1); + continue; + + # quick link email + # } else if ( match( line, /^<[a-zA-Z0-9.!#$%&'\''*+\/=?^_`{|}~-]+@[a-zA-Z0-9]([a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(\.[a-zA-Z0-9]([a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)*>/ ) ) { + } else if ( match( line, /^<[a-zA-Z0-9.!#$%&'\''*+\/=?^_`{|}~-]+@([a-zA-Z0-9]\.[a-zA-Z0-9]|[a-zA-Z0-9-])+>/ ) ) { + len = RLENGTH; + href = HTML( substr( line, 2, len - 2) ); + ret = ret "" href ""; line = substr( line, len + 1); + continue; + + # Verbatim inline HTML + } else if ( AllowHTML && match( line, /^(|<\?([^\?]|\?[^>])*\?>|]*>|])*\]\]>|<\/[A-Za-z][A-Za-z0-9-]*[[:space:]]*>|<[A-Za-z][A-Za-z0-9-]*([[:space:]]+[A-Za-z_:][A-Za-z0-9_\.:-]*([[:space:]]*=[[:space:]]*([[:space:]"'=<>`]+|"[^"]*"|'[^']*'))?)*[[:space:]]*\/?>)/) ) { + len = RLENGTH; + ret = ret substr( line, 1, len); line =substr(line, len + 1); + continue; + + # inline links + } else if ( match(line, "^" lii "\\([\n\t ]*" lid "([\n\t ]+" lit ")?[\n\t ]*\\)") ) { + len = RLENGTH; + text = href = title = substr( line, 1, len); + sub("^\\[", "", text); sub("\\]\\([\n\t ]*" lid "([\n\t ]+" lit ")?[\n\t ]*\\)$", "", text); + sub("^" lii "\\([\n\t ]*", "", href); sub("([\n\t ]+" lit ")?[\n\t ]*\\)$", "", href); + sub("^" lii "\\([\n\t ]*" lid, "", title); sub("[\n\t ]*\\)$", "", title); sub("^[\n\t ]+", "", title); + + if ( match(href, /^<.*>$/) ) { sub(/^$/, "", href); } + if ( match(title, /^".*"$/) ) { sub(/^"/, "", title); sub(/"$/, "", title); } + else if ( match(title, /^'.*'$/) ) { sub(/^'/, "", title); sub(/'$/, "", title); } + else if ( match(title, /^\(.*\)$/) ) { sub(/^\(/, "", title); sub(/\)$/, "", title); } + + gsub(/\\/, "", href); gsub(/\\/, "", title); gsub(/[\n\t]+/, " ", title); + + ret = ret "" \ + inline( text ) ""; + line = substr( line, len + 1); + continue; + + # reference style links + } else if ( match(line, /^\[([^]]+)\] ?\[([^]]*)\]/ ) ) { + len = RLENGTH; text = id = substr(line, 1, len); + sub(/\n.*$/, "", text); sub(/^\[/, "", text); sub(/\] ?\[([^\n]*)\].*$/, "", text); + sub(/\n.*$/, "", id); sub(/^\[([^]]+)\] ?\[/, "", id); sub(/\].*$/, "", id); + # text = gensub(/^\[([^\n]+)\] ?\[([^\n]*)\].*/, "\\1", 1, text ); + # id = gensub(/^\[([^\n]+)\] ?\[([^\n]*)\].*/, "\\2", 1, id ); + if ( ! id ) id = text; + + if ( rl_href[id] && rl_title[id] ) { + ret = ret "" inline(text) ""; + line = substr( line, len + 1); + continue; + + } else if ( rl_href[id] ) { + ret = ret "" inline(text) ""; line = substr( line, len + 1); + continue; + + } else { + ret = ret "" HTML(substr(line, 1, len)); line = substr(line, len + 1); + continue; + } + + # inline images + } else if ( match(line, "^!" lix "\\([\n\t ]*" lid "([\n\t ]+" lit ")?[\n\t ]*\\)(\\{[a-zA-Z \t-]*\\})?") ) { + len = RLENGTH; text = href = title = attrib = substr( line, 1, len); + + sub("^!\\[", "", text); + sub("\\]\\([\n\t ]*" lid "([\n\t ]+" lit ")?[\n\t ]*\\)(\\{[a-zA-Z \t-]*\\})?$", "", text); + + sub("^!" lix "\\([\n\t ]*", "", href); + sub("([\n\t ]+" lit ")?[\n\t ]*\\)(\\{[a-zA-Z \t-]*\\})?$", "", href); + + sub("^!" lix "\\([\n\t ]*" lid, "", title); + sub("[\n\t ]*\\)(\\{[a-zA-Z \t-]*\\})?$", "", title); + sub("^[\n\t ]+", "", title); + + sub("^!" lix "\\([\n\t ]*" lid "([\n\t ]+" lit ")?[\n\t ]*\\)", "", attrib); + sub(/^\{[ \t]*/, "", attrib); sub(/[ \t]*\}$/, "", attrib); gsub(/[ \t]+/, " ", attrib); + + if ( match(href, /^<.*>$/) ) { sub(/^$/, "", href); } + if ( match(title, /^".*"$/) ) { sub(/^"/, "", title); sub(/"$/, "", title); } + else if ( match(title, /^'.*'$/) ) { sub(/^'/, "", title); sub(/'$/, "", title); } + else if ( match(title, /^\(.*\)$/) ) { sub(/^\(/, "", title); sub(/\)$/, "", title); } + + gsub(/^[\t ]+$/, "", text); gsub(/\\/, "", href); + gsub(/\\/, "", title); gsub(/[\n\t]+/, " ", title); + + ret = ret "\"""; + line = substr( line, len + 1); + continue; + + # reference style images + } else if ( match(line, /^!\[([^]]*)\] ?\[([^]]*)\]/ ) ) { + len = RLENGTH; text = id = substr(line, 1, len); + sub(/\n.*$/, "", text); sub(/^!\[/, "", text); sub(/\] ?\[([^\n]*)\].*$/, "", text); + sub(/\n.*$/, "", id); sub(/^!\[([^]]+)\] ?\[/, "", id); sub(/\].*$/, "", id); + # text = gensub(/^!\[([^\n]*)\] ?\[([^\n]*)\].*/, "\\1", 1, substr(line, 1, len) ); + # id = gensub(/^!\[([^\n]*)\] ?\[([^\n]*)\].*/, "\\2", 1, substr(line, 1, len) ); + if ( ! id ) id = text; + if ( rl_href[id] && rl_title[id] ) { + ret = ret "\"""; + line = substr( line, len + 1); + continue; + + } else if ( rl_href[id] ) { + ret = ret "\"""; + line = substr( line, len + 1); + continue; + + } else { + ret = ret "" HTML(substr(line, 1, len)); line = substr(line, len + 1); + continue; + } + + # ~~strikeout~~ (pandoc) + } else if ( match(line, /^~~([[:graph:]]|[[:graph:]]([^~]|~[^~])*[[:graph:]])~~/) ) { + len = RLENGTH; + ret = ret "" inline( substr( line, 3, len - 4 ) ) ""; line = substr( line, len + 1 ); + continue; + + # ^superscript^ (pandoc) + } else if ( match(line, /^\^([^[:space:]^]|\\[ ^])+\^/) ) { + len = RLENGTH; + ret = ret "" inline( substr( line, 2, len - 2 ) ) ""; line = substr( line, len + 1 ); + continue; + + # ~subscript~ (pandoc) + } else if ( match(line, /^~([^[:space:]~]|\\[ ~])+~/) ) { + len = RLENGTH; + ret = ret "" inline( substr( line, 2, len - 2 ) ) ""; line = substr( line, len + 1 ); + continue; + + # ignore embedded underscores (pandoc, php md) + } else if ( match(line, "^[[:alnum:]](__|_)") ) { + ret = ret HTML(substr( line, 1, RLENGTH)); line = substr(line, RLENGTH + 1); + continue; + + # strong / em matchers use pre match pattern to make processing cheaper + # __strong__$ + } else if ( match(line, "^__(([^_[:space:]]|" ieu ")|([^_[:space:]]|" ieu ")(" nu "|" ieu ")*([^_[:space:]]|" ieu "))__$") ) { + len = RLENGTH; + ret = ret "" inline( substr( line, 3, len - 4 ) ) ""; line = substr( line, len + 1 ); + continue; + + # __strong__ + } else if ( match(line, "^__(([^_[:space:]]|" ieu ")|([^_[:space:]]|" ieu ")(" nu "|" ieu ")*([^_[:space:]]|" ieu "))__[[:space:][:punct:]]") ) { + len = RLENGTH; + ret = ret "" inline( substr( line, 3, len - 5 ) ) ""; line = substr( line, len); + continue; + + # **strong** + } else if ( match(line, "^\\*\\*(([^*[:space:]]|" iea ")|([^*[:space:]]|" iea ")(" na "|" iea ")*([^*[:space:]]|" iea "))\\*\\*") ) { + len = RLENGTH; + ret = ret "" inline( substr( line, 3, len - 4 ) ) ""; line = substr( line, len + 1 ); + continue; + + # _em_$ + } else if ( match(line, "^_(([^_[:space:]]|" isu ")|([^_[:space:]]|" isu ")(" nu "|" isu ")*([^_[:space:]]|" isu "))_$") ) { + len = RLENGTH; + ret = ret "" inline( substr( line, 2, len - 2 ) ) ""; line = substr( line, len + 1 ); + continue; + + # _em_ + } else if ( match(line, "^_(([^_[:space:]]|" isu ")|([^_[:space:]]|" isu ")(" nu "|" isu ")*([^_[:space:]]|" isu "))_[[:space:][:punct:]]") ) { + len = RLENGTH; + ret = ret "" inline( substr( line, 2, len - 3 ) ) ""; line = substr( line, len ); + continue; + + # *em* + } else if ( match(line, "^\\*(([^*[:space:]]|" isa ")|([^*[:space:]]|" isa ")(" na "|" isa ")*([^*[:space:]]|" isa "))\\*") ) { + len = RLENGTH; + ret = ret "" inline( substr( line, 2, len - 2 ) ) ""; line = substr( line, len + 1 ); + continue; + + # Literal HTML entities + # } else if ( match( line, /^&([a-zA-Z]{2,32}|#[0-9]{1,7}|#[xX][0-9a-fA-F]{1,6});/) ) { + # mawk does not support repitition ranges + } else if ( match( line, /^&[a-zA-Z][a-zA-Z][a-zA-Z]?[a-zA-Z]?[a-zA-Z]?[a-zA-Z]?[a-zA-Z]?[a-zA-Z]?[a-zA-Z]?[a-zA-Z]?[a-zA-Z]?[a-zA-Z]?[a-zA-Z]?[a-zA-Z]?[a-zA-Z]?[a-zA-Z]?[a-zA-Z]?[a-zA-Z]?[a-zA-Z]?[a-zA-Z]?[a-zA-Z]?[a-zA-Z]?[a-zA-Z]?[a-zA-Z]?[a-zA-Z]?[a-zA-Z]?[a-zA-Z]?[a-zA-Z]?[a-zA-Z]?[a-zA-Z]?[a-zA-Z]?[a-zA-Z]?;/) ) { + len = RLENGTH; + ret = ret substr( line, 1, len ); line = substr(line, len + 1); + continue; + } else if ( match( line, /^&(#[0-9][0-9]?[0-9]?[0-9]?[0-9]?[0-9]?[0-9]?|#[xX][0-9a-fA-F][0-9a-fA-F]?[0-9a-fA-F]?[0-9a-fA-F]?[0-9a-fA-F]?[0-9a-fA-F]?);/) ) { + len = RLENGTH; + ret = ret substr( line, 1, len ); line = substr(line, len + 1); + continue; + + # Arrows + } else if ( line ~ /^-->( |$)/) { # ignore multidash-arrow + ret = ret "-->"; line = substr(line, 4); + continue; + } else if ( line ~ /^<-( |$)/) { + ret = ret "←"; line = substr(line, 3); + continue; + } else if ( line ~ /^->( |$)/) { + ret = ret "→"; line = substr(line, 3); + continue; + + # Escape lone HTML character + } else if ( match( line, /^[&<>"']/) ) { + ret = ret HTML(substr(line, 1, 1)); line = substr(line, 2); + continue; + + } # inline patterns end + + # continue walk over string + ret = ret substr(line, 1, 1); line = substr(line, 2); + } + return ret; +} + +function headline( hlvl, htxt, attrib, LOCAL, sec, n, HL) { + # match(hstack, /([0-9]+( [0-9]+){5})$/); split( substr(hstack, RSTART), HL); + match(hstack, /([0-9]+( [0-9]+)( [0-9]+)( [0-9]+)( [0-9]+)( [0-9]+))$/); split( substr(hstack, RSTART), HL); + + for ( n = hlvl; n <= 6; n++ ) { sec = sec (HL[n]?"
":""); } + HL[hlvl]++; for ( n = hlvl + 1; n <= 6; n++) { HL[n] = 0;} + + hid = ""; for ( n = 2; n <= blvl; n++) { hid = hid BL[n] "/"; } + hid = hid HL[1]; for ( n = 2; n <= hlvl; n++) { hid = hid "." HL[n] ; } + hid = hid ":" URL(htxt, 1); + + # sub(/([0-9]+( [0-9]+){5})$/, "", hstack); + sub(/([0-9]+( [0-9]+)( [0-9]+)( [0-9]+)( [0-9]+)( [0-9]+))$/, "", hstack); + hstack = hstack HL[1] " " HL[2] " " HL[3] " " HL[4] " " HL[5] " " HL[6]; + + return sec "
" \ + "" inline( htxt ) \ + "" \ + "\n"; +} + +# Nested Block, resets heading counters +function _nblock( block, LOCAL, sec, n ) { + hstack = hstack " 0 0 0 0 0 0"; + + # Block Level + blvl++; BL[blvl]++; + for ( n = blvl + 1; n in BL; n++) { delete BL[n]; } + + block = _block( block ); + match(hstack, /([0-9]+( [0-9]+)( [0-9]+)?( [0-9]+)?( [0-9]+)?( [0-9]+)?)$/); split( substr(hstack, RSTART), HL); + sec = ""; for ( n = 1; n <= 6; n++ ) { sec = sec (HL[n]?"
":""); } + + sub("( +[0-9]+)( +[0-9]+)?( +[0-9]+)?( +[0-9]+)?( +[0-9]+)?( +[0-9]+)? *$", "", hstack); blvl--; + return block sec; +} + +function _block( block, LOCAL, st, len, text, title, attrib, href, guard, code, indent, list, tmp, ret) { + ret = ""; + while ( block != "" ) { + gsub( "(^\n+|\n+$)", "", block ); + + # HTML #2 #3 #4 $5 + if ( AllowHTML && match( block, /(^|\n) ? ? ?(|$)|<\?([^\?]|\?[^>])*(\?>|$)|]*(>|$)|])*(\]\]>|$))/) ) { + len = RLENGTH; st = RSTART; + ret = ret _block(substr(block, 1, st - 1)) substr(block, st, len); block = substr(block, st + len); + continue; + + # HTML #6 (part1) + } else if ( AllowHTML && match( tolower(block), /(^|\n) ? ? ?<\/?(address|article|aside|base|basefont|blockquote|body|caption|center|col|colgroup|dd|details|dialog|dir|div|dl|dt|fieldset|figcaption|figure|footer|form|frame|frameset)([[:space:]\n>]|\/>)([^\n]|\n[ \t]*[^\n])*(\n[[:space:]]*\n|$)/) ) { + len = RLENGTH; st = RSTART; + ret = ret _block(substr(block, 1, st - 1)) substr(block, st, len); block = substr(block, st + len); + continue; + + # HTML #6 (part2) + } else if ( AllowHTML && match( tolower(block), /(^|\n) ? ? ?<\/?(h[123456]|head|header|hr|html|iframe|legend|li|link|main|menu|menuitem|nav|noframes|ol|optgroup|option|p|param|section|source|summary|table|tbody|td|tfoot|th|thead|title|tr|track|ul)([[:space:]\n>]|\/>)([^\n]|\n[ \t]*[^\n])*(\n[[:space:]]*\n|$)/) ) { + len = RLENGTH; st = RSTART; + ret = ret _block(substr(block, 1, st - 1)) substr(block, st, len); block = substr(block, st + len); + continue; + + # HTML #1 + } else if ( AllowHTML && match( tolower(block), /(^|\n) ? ? ?<(script|pre|style)([[:space:]\n>]).*(<\/script>|<\/pre>|<\/style>|$)/) ) { + len = RLENGTH; st = RSTART; + match( tolower(substr(block, st, len)), /(<\/script>|<\/pre>|<\/style>)/); + len = RSTART + RLENGTH; + ret = ret _block(substr(block, 1, st - 1)) substr(block, st, len); block = substr(block, st + len); + continue; + + # HTML #7 + } else if ( AllowHTML && match( block, /^ ? ? ?(<\/[A-Za-z][A-Za-z0-9-]*[[:space:]]*>|<[A-Za-z][A-Za-z0-9-]*([[:space:]]+[A-Za-z_:][A-Za-z0-9_\.:-]*([[:space:]]*=[[:space:]]*([[:space:]"'=<>`]+|"[^"]*"|'[^']*'))?)*[[:space:]]*\/?>)([[:space:]]*\n)([^\n]|\n[ \t]*[^\n])*(\n[[:space:]]*\n|$)/) ) { + len = RLENGTH; st = RSTART; + ret = ret substr(block, st, len); block = substr(block, st + len); + continue; + + # Metadata (custom, block starting with %something) + # Metadata is ignored but can be interpreted externally + } else if ( match(block, /^%[a-zA-Z-]+([[:space:]][^\n]*)?(\n|$)(%[a-zA-Z-]+([[:space:]][^\n]*)?(\n|$)|%([[:space:]][^\n]*)?(\n|$)|[ \t]+[^\n[:space:]][^\n]*(\n|$))*/) ) { + len = RLENGTH; st = RSTART; + block = substr( block, len + 1); + continue; + + # Blockquote (leading >) + } else if ( match( block, /^> /) ) { + match( block, /(^|\n)[[:space:]]*(\n|$)/ ) || match(block, /$/); + len = RLENGTH; st = RSTART; + text = substr(block, 1, st - 1); gsub( /(^|\n)> /, "\n", text ); + text = _nblock( text ); gsub( /^\n|\n$/, "", text ) + ret = ret "
" text "
\n\n"; block = substr(block, st + len); + continue; + + # Pipe Tables (pandoc / php md / gfm ) + } else if ( match(block, "^((\\|)?([^\n]+\\|)+[^\n]+(\\|)?)\n" \ + "((\\|)?(:?-+:?[\\|+])+:?-+:?(\\|)?)\n" \ + "((\\|)?([^\n]+\\|)+[^\n]+(\\|)?(\n|$))+" ) ) { + len = RLENGTH; st = RSTART; + #initialize empty arrays + split("", talign); split("", tarray); + cols = 0; cnt=0; ttext = ""; + + # table header and alignment + tmp = substr(block, 1, match(block, /(\n|$)/)); + gsub( /(^|[^\\])\\\|/, "\\1\\|", tmp ); + gsub( /(^\||\|$)/, "", tmp) + split( tmp, tarray, /\|/); + block = substr(block, match(block, /(\n|$)/) + 1 ); + tmp = substr(block, 1, match(block, /(\n|$)/)); + gsub( /(^\||\|$)/, "", tmp ); + cols = split( tmp , talign, /[+\|]/); + block = substr(block, match(block, /(\n|$)/) + 1 ); + + for( cnt = 1; cnt < cols; cnt++ ) { + if (match(talign[cnt], /:-+:/)) talign[cnt]="center"; + else if (match(talign[cnt], /-+:/)) talign[cnt]="right"; + else if (match(talign[cnt], /:-+/)) talign[cnt]="left"; + else talign[cnt]=""; + } + + ttext = "\n" + for (cnt = 1; cnt < cols; cnt++) + ttext = ttext "" inline(tarray[cnt]) "" + ttext = ttext "\n\n" + + while ( match(block, "^((\\|)?([^\n]+\\|)+[^\n]+(\\|)?(\n|$))+" ) ){ + tmp = substr(block, 1, match(block, /(\n|$)/)); + gsub( /(^|[^\\])\\\|/, "\\1\\|", tmp ); + gsub( /(^\||\|$)/, "", tmp ); + split( tmp, tarray, /\|/); + block = substr(block, match(block, /(\n|$)/) + 1 ); + + ttext = ttext "" + for (cnt = 1; cnt < cols; cnt++) + ttext = ttext "" inline(tarray[cnt]) "" + ttext = ttext "\n" + } + ret = ret "" ttext "
\n"; + continue; + + # Grid Tables (pandoc) + # (with, and without header) + } else if ( match( block, "^\\+(-+\\+)+\n" \ + "(\\|([^\n]+\\|)+\n)+" \ + "(\\+(:?=+:?\\+)+)\n" \ + "((\\|([^\n]+\\|)+\n)+" \ + "\\+(-+\\+)+(\n|$))+" \ + ) || \ + match( block, "^(\\+(:?-+:?\\+)+)\n" \ + "((\\|([^\n]+\\|)+\n)+" \ + "\\+(-+\\+)+(\n|$))+" \ + ) ) { + len = RLENGTH; st = RSTART; + #initialize empty arrays + split("", talign); split("", tarray); split("", tread); + cols = 0; cnt=0; ttext = ""; + + # Column Count + tmp = block; sub( "(\n.*)*$", "", tmp); + cols = split( tmp, tread, /\+/) - 2; + # debug(" Cols: " gensub( "^(\\+(:?-+:?\\+)+)(\n.*)*$", "\\1", 1, block )); + + # table alignment + match(block, "((:?=+:?\\+|(:-+|-+:|:-+:)\\+)+)"); + split( substr(block, RSTART, RLENGTH) , talign, /\+/ ); + # split( gensub( "^(.*\n)?\\+((:?=+:?\\+|(:-+|-+:|:-+:)\\+)+)(\n.*)$", "\\2", "g", block ), talign, /\+/ ); + # debug("Align: " gensub( "^(.*\n)?\\+((:?=+:?\\+|(:-+|-+:|:-+:)\\+)+)(\n.*)$", "\\2", "g", block )); + + for (cnt = 1; cnt <= cols; cnt++) { + if (match(talign[cnt], /:(-+|=+):/)) talign[cnt]="center"; + else if (match(talign[cnt], /(-+|=+):/)) talign[cnt]="right"; + else if (match(talign[cnt], /:(-+|=+)/ )) talign[cnt]="left"; + else talign[cnt]=""; + } + + if ( match(block, "^\\+(-+\\+)+\n" \ + "(\\|([^\n]+\\|)+\n)+" \ + "\\+(:?=+:?\\+)+\n" \ + "((\\|([^\n]+\\|)+\n)+" \ + "\\+(-+\\+)+(\n|$))+" \ + ) ) { + # table header + block = substr(block, match(block, /(\n|$)/) + 1 ); + while ( match(block, "^\\|([^\n]+\\|)+\n") ) { + tmp = substr(block, 1, match(block, /(\n|$)/)); + gsub( /\\\\/, "\\\", tmp); gsub(/\\\|/, "\\|", tmp); + gsub( /(^\||\|$)/, "", tmp ); + split(tmp, tread, /\|/); + block = substr(block, match(block, /(\n|$)/) + 1 ); + for (cnt = 1; cnt <= cols; cnt++) + tarray[cnt] = tarray[cnt] "\n" tread[cnt]; + } + + ttext = "\n" + for (cnt = 1; cnt <= cols; cnt++) + ttext = ttext "" _nblock(tarray[cnt]) "" + ttext = ttext "\n" + } + + # table body + block = substr(block, match(block, /(\n|$)/) + 1 ); + ttext = ttext "\n" + + while ( match(block, /^((\|([^\n]+\|)+\n)+\+(-+\+)+(\n|$))+/ ) ){ + split("", tarray); + while ( match(block, /^\|([^\n]+\|)+\n/) ) { + tmp = substr(block, 1, match(block, /(\n|$)/)); + gsub( /\\\\/, "\\\", tmp); gsub(/\\\|/, "\\|", tmp); + gsub( /(^\||\|$)/, "", tmp); + split( tmp, tread, /\|/); + block = substr(block, match(block, /(\n|$)/) + 1 ); + for (cnt = 1; cnt <= cols; cnt++) + tarray[cnt] = tarray[cnt] "\n" tread[cnt]; + } + block = substr(block, match(block, /(\n|$)/) + 1 ); + + ttext = ttext "" + for (cnt = 1; cnt <= cols; cnt++) + ttext = ttext "" _nblock(tarray[cnt]) "" + ttext = ttext "\n" + } + return ret "" ttext "
\n" _nblock(block); + + # Line Blocks (pandoc) + } else if ( match(block, /^\| [^\n]*(\n|$)(\| [^\n]*(\n|$)|[ \t]+[^\n[:space:]][^\n]*(\n|$))*/) ) { + len = RLENGTH; st = RSTART; + + text = substr(block, 1, len); gsub(/\n[[:space:]]+/, " ", text); + gsub(/\n\| /, "\n", text); gsub(/^\| |\n$/, "", text); + text = inline(text); gsub(/\n/, "
\n", text); + + ret = ret "
" text "
\n"; block = substr( block, len + 1); + continue; + + # Indented Code Block + } else if ( match(block, /^(( |\t)[^\n]*[^\n\t ][^\n]*(\n|$))(( |\t)[^\n]*(\n|$)|[\t ]*(\n|$))*/) ) { + len = RLENGTH; st = RSTART; + + code = substr(block, 1, len); + gsub(/(^|\n)( |\t)/, "\n", code); + gsub(/^\n|\n+$/, "", code); + ret = ret "
" HTML( code ) "
\n"; block = substr( block, len + 1 ); + continue; + + # Fenced Divs (pandoc, custom) + } else if ( match( block, /^(:::+)/ ) ) { + guard = substr( block, 1, RLENGTH ); attrib = code = block; + sub(/^[^\n]+\n/, "", code); + sub(/^:::+[ \t]*\{?[ \t]*/, "", attrib); sub(/\}?[ \t]*\n.*$/, "", attrib); + # attrib = gensub(/^:::+[ \t]*\{?[ \t]*([^\}\n]*)\}?[ \t]*\n.*$/, "\\1", 1, attrib); + gsub(/[^a-zA-Z0-9_-]+/, " ", attrib); + gsub(/(^ | $)/, "", attrib); + if ( match(code, "(^|\n)" guard "+(\n|$)" ) && attrib ) { + len = RLENGTH; st = RSTART; + ret = ret "
" _nblock( substr(code, 1, st - 1) ) "
\n"; + block = substr( code, st + len ); + continue; + + } else if ( match(code, "(^|\n)" guard "+(\n|$)" ) ) { + len = RLENGTH; st = RSTART; + ret = ret "
" _nblock( substr(code, 1, st - 1) ) "
\n"; block = substr( code, st + len ); + continue; + + } else { + match( block, /(^|\n)[[:space:]]*(\n|$)/ ) || match( block, /$/ ); + len = RLENGTH; st = RSTART; + ret = ret "

" inline( substr(block, 1, st - 1) ) "

\n"; block = substr(block, st + len); + continue; + } + + # Fenced Code Block (pandoc) + } else if ( match( block, /^(~~~+|```+)/ ) ) { + guard = substr( block, 1, RLENGTH ); attrib = code = block; + sub(/^[^\n]+\n/, "", code); + sub(/^(~~~+|```+)[ \t]*\{?[ \t]*/, "", attrib); sub(/\}?[ \t]*\n.*$/, "", attrib); + # attrib = gensub(/^(~~~+|```+)[ \t]*\{?[ \t]*([^\}\n]*)\}?[ \t]*\n.*$/, "\\2", 1, attrib); + gsub(/[^a-zA-Z0-9_-]+/, " ", attrib); + gsub(/(^ | $)/, "", attrib); + if ( match(code, "(^|\n)" guard "+(\n|$)" ) && attrib ) { + len = RLENGTH; st = RSTART; + ret = ret "
" HTML( substr(code, 1, st - 1) ) "
\n"; + block = substr( code, st + len ); + continue; + + } else if ( match(code, "(^|\n)" guard "+(\n|$)" ) ) { + len = RLENGTH; st = RSTART; + ret = ret "
" HTML( substr(code, 1, st - 1) ) "
\n"; + block = substr( code, st + len ); + continue; + + } else { + match( block, /(^|\n)[[:space:]]*(\n|$)/ ) || match( block, /$/ ); + len = RLENGTH; st = RSTART; + ret = ret "

" inline( substr(block, 1, st - 1) ) "

\n"; block = substr(block, st + len); + continue; + } + + # First Order Heading H1 + Attrib + } else if ( match( block, /^([^\n]+)([ \t]*\{([^\}\n]+)\})\n===+(\n|$)/ ) ) { + len = RLENGTH; text = attrib = block; + sub(/([ \t]*\{([^\}\n]+)\})\n===+(\n.*)?$/, "", text); + sub(/\}\n===+(\n.*)?$/, "", attrib); sub(/^([^\n]+)[ \t]*\{/, "", attrib); + gsub(/[^a-zA-Z0-9_-]+/, " ", attrib); gsub(/(^ | $)/, "", attrib); + + ret = ret headline(1, text, attrib) ; block = substr( block, len + 1 ); + continue; + + # First Order Heading H1 + } else if ( match( block, /^([^\n]+)\n===+(\n|$)/ ) ) { + len = RLENGTH; text = substr(block, 1, len); + sub(/\n===+(\n.*)?$/, "", text); + + ret = ret headline(1, text, 0) ; block = substr( block, len + 1 ); + continue; + + # Second Order Heading H2 + Attrib + } else if ( match( block, /^([^\n]+)([ \t]*\{([^\}\n]+)\})\n---+(\n|$)/ ) ) { + len = RLENGTH; text = attrib = block; + sub(/([ \t]*\{([^\}\n]+)\})\n---+(\n.*)?$/, "", text); + sub(/\}\n---+(\n.*)?$/, "", attrib); sub(/^([^\n]+)[ \t]*\{/, "", attrib); + gsub(/[^a-zA-Z0-9_-]+/, " ", attrib); gsub(/(^ | $)/, "", attrib); + + ret = ret headline(2, text, attrib) ; block = substr( block, len + 1); + continue; + + # Second Order Heading H2 + } else if ( match( block, /^([^\n]+)\n---+(\n|$)/ ) ) { + len = RLENGTH; text = substr(block, 1, len); + sub(/\n---+(\n.*)?$/, "", text); + + ret = ret headline(2, text, 0) ; block = substr( block, len + 1); + continue; + + # # Nth Order Heading H1 H2 H3 H4 H5 H6 + Attrib + # } else if ( match( block, /^(##?#?#?#?#?)[ \t]*(([^ \t\n]+|[ \t]+[^ \t\n#]|[ \t]+#+[ \t]*[^ \t\n#])+)[ \t]*#*[ \t]*\{[a-zA-Z \t-]*\}(\n|$)/ ) ) { + } else if ( match( block, /^##?#?#?#?#?[^#\n]([^\n#]|#[^\t\n# ]|#[\t ]+[^\t\n ])+#*[\t ]*\{[\ta-zA-Z -]*\}(\n|$)/ ) ) { + len = RLENGTH; text = attrib = substr(block, 1, len); + match(block, /^##?#?#?#?#?[^#]/); n = RLENGTH - 1; + # sub(/^(##?#?#?#?#?)[ \t]*/, "", text); # not working in mawk + text = substr(text, n + 1); sub(/^[ \t]*/, "", text); + sub(/[ \t]*#*([ \t]*\{([a-zA-Z \t-]*)\})(\n.*)?$/, "", text); + + sub(/^##?#?#?#?#?[^#\n]([^\n#]|#[^\t\n# ]|#[\t ]+[^\t\n ])+#*[\t ]*\{/, "", attrib); + sub(/\}(\n.*)?$/, "", attrib); + gsub(/[^a-zA-Z0-9_-]+/, " ", attrib); gsub(/(^ | $)/, "", attrib); + + ret = ret headline( n, text, attrib ); block = substr( block, len + 1); + continue; + + # Nth Order Heading H1 H2 H3 H4 H5 H6 + # } else if ( match( block, /^(##?#?#?#?#?)[ \t]*(([^ \t\n]+|[ \t]+[^ \t\n#]|[ \t]+#+[ \t]*[^ \t\n#])+)[ \t]*#*(\n|$)/ ) ) { + } else if ( match( block, /^##?#?#?#?#?[^#\n]([^\n#]|#[^\t\n# ]|#[\t ]+[^\t\n ])+#*(\n|$)/ ) ) { + len = RLENGTH; text = substr(block, 1, len); + match(block, /^##?#?#?#?#?[^#]/); n = RLENGTH - 1; + # sub(/^(##?#?#?#?#?)[ \t]+/, "", text); # not working in mawk + text = substr(text, n + 1); sub(/^[ \t]*/, "", text); + sub(/[ \t]*#*(\n.*)?$/, "", text); + + ret = ret headline( n, text, 0 ) ; block = substr( block, len + 1); + continue; + + # block images (wrapped in
) + } else if ( match(block, "^!" lix "\\([\n\t ]*" lid "([\n\t ]+" lit ")?[\n\t ]*\\)(\\{[a-zA-Z \t-]*\\})?(\n|$)") ) { + len = RLENGTH; text = href = title = attrib = substr( block, 1, len); + + sub("^!\\[", "", text); + sub("\\]\\([\n\t ]*" lid "([\n\t ]+" lit ")?[\n\t ]*\\)(\\{[a-zA-Z \t-]*\\})?(\n.*)?$", "", text); + + sub("^!" lix "\\([\n\t ]*", "", href); + sub("([\n\t ]+" lit ")?[\n\t ]*\\)(\\{[a-zA-Z \t-]*\\})?(\n.*)?$", "", href); + + sub("^!" lix "\\([\n\t ]*" lid, "", title); + sub("[\n\t ]*\\)(\\{[a-zA-Z \t-]*\\})?(\n.*)?$", "", title); + sub("^[\n\t ]+", "", title); + + sub("^!" lix "\\([\n\t ]*" lid "([\n\t ]+" lit ")?[\n\t ]*\\)", "", attrib); + sub("(\n.*)?$", "", attrib); + sub(/^\{[ \t]*/, "", attrib); sub(/[ \t]*\}$/, "", attrib); gsub(/[ \t]+/, " ", attrib); + + if ( match(href, /^<.*>$/) ) { sub(/^$/, "", href); } + if ( match(title, /^".*"$/) ) { sub(/^"/, "", title); sub(/"$/, "", title); } + else if ( match(title, /^'.*'$/) ) { sub(/^'/, "", title); sub(/'$/, "", title); } + else if ( match(title, /^\(.*\)$/) ) { sub(/^\(/, "", title); sub(/\)$/, "", title); } + + gsub(/^[\t ]+$/, "", text); gsub(/\\/, "", href); + + ret = ret "
" \ + "\""" \ + (title?"
" inline(title) "
":"") \ + "
\n\n"; + block = substr( block, len + 1); + continue; + + } else if ( match(block, /^!\[([^]]*)\] ?\[([^]]*)\](\n|$)/ ) ) { + len = RLENGTH; text = id = block; + sub(/(\n.*)?$/, "", text); sub( /^!\[/, "", text); sub(/\] ?\[([^\n]*)\]$/, "", text); + sub(/(\n.*)?$/, "", id); sub( /^!\[([^\n]*)\] ?\[/, "", id); sub(/\]$/, "", id); + # text = gensub(/^!\[([^\n]*)\] ?\[([^\n]*)\](\n.*)?$/, "\\1", 1, block); + # id = gensub(/^!\[([^\n]*)\] ?\[([^\n]*)\](\n.*)?$/, "\\2", 1, block); + if ( ! id ) id = text; + if ( rl_href[id] && rl_title[id] ) { + ret = ret "
" \ + "\""" \ + "
" inline(rl_title[id]) "
" \ + "
\n\n"; + block = substr( block, len + 1); + continue; + + } else if ( rl_href[id] ) { + ret = ret "
" \ + "\""" \ + "
\n\n"; + block = substr( block, len + 1); + continue; + } else { + ret = ret "

" HTML(substr(block, 1, len)) "

\n" ; block = substr(block, len + 1); + continue; + } + + # Macros (standalone <> calls handled as block, so they are not wrapped in paragraph) + } else if ( match( block, /^<<(([^>]|>[^>])+)>>(\n|$)/ ) ) { + len = RLENGTH; text = block; + sub(/^<>(\n.*)?$/, "", text); + # text = gensub(/^<<(([^>]|>[^>])+)>>(\n.*)?$/, "\\1", 1, block); + ret = ret "" HTML(text) "" ; block = substr(block, len + 1); + continue; + + # Definition list + } else if (match( block, "^(([ \t]*\n)*[^:\n \t][^\n]+\n" \ + "([ \t]*\n)* ? ? ?:[ \t][^\n]+(\n|$)" \ + "(([ \t]*\n)* ? ? ?:[ \t][^\n]+(\n|$)" \ + "|[^:\n \t][^\n]+(\n|$)" \ + "|( ? ? ?\t| +)[^\n]+(\n|$)" \ + "|([ \t]*\n)+( ? ? ?\t| +)[^\n]+(\n|$))*)+" \ + )) { + list = substr( block, 1, RLENGTH); block = substr( block, RLENGTH + 1); + ret = ret "
\n" _dlist( list ) "
\n"; + continue; + + # Unordered list types + } else if ( text = _startlist( block, "ul", "-", "([+*•]|[0-9]+\\.|#\\.|[0-9]+\\)|#\\))") ) { + return ret text; + } else if ( text = _startlist( block, "ul", "\\+", "([-*•]|[0-9]+\\.|#\\.|[0-9]+\\)|#\\))") ) { + return ret text; + } else if ( text = _startlist( block, "ul", "\\*", "([-+•]|[0-9]+\\.|#\\.|[0-9]+\\)|#\\))") ) { + return ret text; + } else if ( text = _startlist( block, "ul", "•", "([-+*]|[0-9]+\\.|#\\.|[0-9]+\\)|#\\))") ) { + return ret text; + + # Ordered list types + } else if ( text = _startlist( block, "ol", "[0-9]+\\.", "([-+*•]|#\\.|[0-9]+\\)|#\\))") ) { + return ret text; + } else if ( text = _startlist( block, "ol", "[0-9]+\\)", "([-+*•]|[0-9]+\\.|#\\.|#\\))") ) { + return ret text; + } else if ( text = _startlist( block, "ol", "#\\.", "([-+*•]|[0-9]+\\.|[0-9]+\\)|#\\))") ) { + return ret text; + } else if ( text = _startlist( block, "ol", "#\\)", "([-+*•]|[0-9]+\\.|#\\.|[0-9]+\\))") ) { + return ret text; + + # Split paragraphs + } else if ( match( block, /(^|\n)[[:space:]]*(\n|$)/) ) { + len = RLENGTH; st = RSTART; + ret = ret _block( substr(block, 1, st - 1) ) "\n"; block = substr(block, st + len); + continue; + + # Horizontal rule + # } else if ( match( block, /(^|\n) ? ? ?((\* *){3,}|(- *){3,}|(_ *){3,})($|\n)/) ) { + } else if ( match( block, /(^|\n) ? ? ?((\* *)(\* *)(\* *)(\* *)*|(- *)(- *)(- *)(- *)*|(_ *)(_ *)(_ *)(_ *)*)($|\n)/) ) { + len = RLENGTH; st = RSTART; + ret = ret _block(substr(block, 1, st - 1)) "
\n"; block = substr(block, st + len); + continue; + + } # block patterns end + + # Plain paragraph + return ret "

" inline(block) "

\n"; + } + return ret; +} + +function _startlist(block, type, mark, exclude, LOCAL, st, len, list, indent, it, text) { + if (match( block, "(^|\n) ? ? ?" mark "[ \t][^\n]+(\n|$)" \ + "(([ \t]*\n)* ? ? ?" mark "[ \t][^\n]+(\n|$)" \ + "|([ \t]*\n)*( ? ? ?\t| +)[^\n]+(\n|$)" \ + "|[^\n \t][^\n]+(\n|$))*" ) ) { + st = RSTART; len = RLENGTH; list = substr( block, st, len); + + sub("^\n", "", list); match(list, "^( | | )?"); indent = RLENGTH; + # gsub( "(^|\n) {0," indent "}", "\n", list); sub("^\n", "", list); + # emulate greedy range matcher for mawk + it = "("; while ( indent > 0 ) { for (k = indent; k > 0; k--) { it = it " "; } it = it "|"; indent--; } + sub(/\|$/, ")?", it); sub(/^\($/, "", it); + gsub( "(^|\n)" it, "\n", list ); sub("^\n", "", list); + + text = substr(block, 1, st - 1); block = substr(block, st + len); + if (match(text, /\n[[:space:]]*\n/)) return 0; + if (match(text, "(^|\n) ? ? ?" exclude "[ \t][^\n]+")) return 0; + if (match( list, "\n" exclude "[ \t]" )) { + block = substr(list, RSTART + 1) block; + list = substr(list, 1, RSTART); + } + + return _block( text ) "<" type ">\n" _list( list, mark ) "\n" _block( block ); + } else return 0; +} + +function _list (block, mark, p, LOCAL, len, st, text, indent, it, task) { + if ( match(block, "^([ \t]*\n)*$")) return; + + match(block, "^" mark "[ \t]"); indent = RLENGTH; + + sub("^" mark "[ \t]", "", block); + + if (match(block, /\n[ \t]*\n/)) p = 1; + + match( block, "\n" mark "[ \t][^\n]+(\n|$)" ); + st = (RLENGTH == -1) ? length(block) + 1 : RSTART; + text = substr(block, 1, st); block = substr(block, st + 1); + + # gsub("\n {0," indent "}", "\n", text); + # emulate greedy range matcher for mawk + it = "("; while ( indent > 0 ) { for (k = indent; k > 0; k--) { it = it " "; } it = it "|"; indent--; } + sub(/\|$/, ")?", it); sub(/^\($/, "", it); + gsub("\n" it, "\n", text); + + task = match( text, /^\[ \]/ ) ? "
  • " : \ + match( text, /^\[-\]/ ) ? "
  • " : \ + match( text, /^\[\/\]/ ) ? "
  • " : \ + match( text, /^\[\?\]/ ) ? "
  • " : \ + match( text, /^\[[xX]\]/) ? "
  • " : "
  • "; + sub(/^\[[-? \/xX]\]/, "", text); + + text = _nblock( text ); + if ( ! p && match( text, "^

    (]|\n$" )) + gsub( "(^

    |

    \n$)", "", text); + + return task text "
  • \n" _list(block, mark, p); +} + +function _dlist (block, LOCAL, len, st, text, indent, it, p) { + if (match( block, "^([ \t]*\n)*[^:\n \t][^\n]+\n" )) { + len = RLENGTH; text = substr(block, 1, len); + gsub( "(^\n*|\n*$)", "", text ); + return "
    " inline( text ) "
    \n" _dlist( substr(block, len + 1) ); + } else if (match( block, "^([ \t]*\n)* ? ? ?:[ \t][^\n]+(\n|$)" \ + "([^:\n \t][^\n]+(\n|$)" \ + "|( ? ? ?\t| +)[^\n]+(\n|$)" \ + "|([ \t]*\n)+( ? ? ?\t| +)[^\n]+(\n|$))*" \ + )) { + len = RLENGTH; text = substr(block, 1, len); + sub( "^([ \t]*\n)*", "", text); + match(text, "^ ? ? ?:(\t| +)"); indent = RLENGTH; + sub( "^ ? ? ?:(\t| +)", "", text); + # gsub( "(^|\n) {0," indent "}", "\n", text ); + # emulate greedy range matcher for mawk + it = "("; while ( indent > 0 ) { for (k = indent; k > 0; k--) { it = it " "; } it = it "|"; indent--; } + sub(/\|$/, ")?", it); sub(/^\($/, "", it); + gsub( "(^|\n)" it, "\n", text ); + + text = _nblock(text); + if (match( text, "^

    (]|\n$" )) + gsub( "(^

    |

    \n$)", "", text); + + return "
    " text "
    \n" _dlist( substr(block, len + 1) ); + } +} + +BEGIN { + # Global Vars + file = ""; rl_href[""] = ""; rl_title[""] = ""; + if (ENVIRON["MD_HTML"] == "true") { AllowHTML = "true"; } + HL[1] = 0; HL[2] = 0; HL[3] = 0; HL[4] = 0; HL[5] = 0; HL[6] = 0; + # hls = "0 0 0 0 0 0"; + + # Universal Patterns + nu = "([^_\\\\]|\\\\.|_[[:alnum:]])" # not underline (except when escaped, or inside a word) + na = "([^*\\\\]|\\\\.)" # not asterisk (except when escaped) + ieu = "_([^_[:space:]]|[^_[:space:]]" nu "*[^_[:space:]])_" # inner (underline) + isu = "__([^_[:space:]]|[^_[:space:]]" nu "*[^_[:space:]])__" # inner (underline) + iea = "\\*([^*[:space:]]|[^*[:space:]]" na "*[^*[:space:]])\\*" # inner (asterisk) + isa = "\\*\\*([^*[:space:]]|[^*[:space:]]" na "*[^*[:space:]])\\*\\*" # inner (asterisk) + + lix="\\[(\\\\[^\n]|[^]\n\\\\[])*\\]" # link text + lid="(<(\\\\[^\n]|[^\n<>\\\\])*>|(\\\\.|[^()\"'\\\\])+|([^<\n\t ()\\\\]|\\\\[^\n])(\\\\[\n]|[^\n\t \\(\\)\\\\])*)" # link dest + lit="(\"(\\\\.|[^\"\\\\])*\"|'(\\\\.|[^'\\\\])*'|\\((\\\\.|[^\\(\\)\\\\])*\\))" # link text + # link text with image def + lii="\\[(\\\\[^\n]|[^]\n\\\\[])*(!" lix "\\([\n\t ]*" lid "([\n\t ]+" lit ")?[\n\t ]*\\))?(\\\\[^\n]|[^]\n\\\\[])*\\]" + + # Buffering of full file ist necessary, e.g. to find reference links + while (getline) { file = file $0 "\n"; } + # Clean up MS-DOS line breaks + gsub(/\r\n/, "\n", file); + + # Fill array of reference links + f = file; rl_id; + re_reflink = "(^|\n) ? ? ?\\[([^]\n]+)\\]: ([^ \t\n]+)(\n?[ \t]+(\"([^\"]+)\"|'([^']+)'|\\(([^)]+)\\)))?(\n|$)"; + # /(^|\n) ? ? ?\[([^]\n]+)\]: ([^ \t\n]+)(\n?[ \t]+("([^"]+)"|'([^']+)'|\(([^)]+)\)))?(\n|$)/ + while ( match(f, re_reflink ) ) { + tt = th = ti = substr(f, RSTART, RLENGTH); f = substr(f, RSTART + RLENGTH); + sub("(^|\n) ? ? ?\\[", "", ti); sub("\\]: ([^ \t\n]+)(\n?[ \t]+(\"([^\"]+)\"|'([^']+)'|\\(([^)]+)\\)))?(\n.*)?$", "", ti); + sub("(^|\n) ? ? ?\\[([^]\n]+)\\]: ", "", th); sub("(\n?[ \t]+(\"([^\"]+)\"|'([^']+)'|\\(([^)]+)\\)))?(\n.*)?$", "", th); + if (match(tt, "(^|\n) ? ? ?\\[([^]\n]+)\\]: ([^ \t\n]+)(\n?[ \t]+(\"([^\"]+)\"|'([^']+)'|\\(([^)]+)\\)))(\n|$)")) { + sub("(^|\n) ? ? ?\\[([^]\n]+)\\]: ([^ \t\n]+)", "", tt); sub("^\n?[ \t]+", "", tt); sub("(\n.*)?$", "", tt); + } else { tt = ""; } + rl_id = ti; rl_href[rl_id] = th; rl_title[rl_id] = tt; + # rl_id = gensub( re_reflink, "\\2", 1, substr(f, RSTART, RLENGTH) ); + # rl_href[rl_id] = gensub( re_reflink, "\\3", 1, substr(f, RSTART, RLENGTH) ); + # rl_title[rl_id] = gensub( re_reflink, "\\5", 1, substr(f, RSTART, RLENGTH) ); + # f = substr(f, RSTART + RLENGTH); + rl_title[rl_id] = substr( rl_title[rl_id], 2, length(rl_title[rl_id]) - 2 ); + if ( rl_href[rl_id] ~ /<.*>/ ) rl_href[rl_id] = substr( rl_href[rl_id], 2, length(rl_href[rl_id]) - 2 ); + } + # Clear reflinks from File + while( gsub(re_reflink, "\n", file ) ); + # for (n in rl_href) { debug(n " | " rl_href[n] " | " rl_title[n] ); } + + # Run Block Processing -> The Actual Markdown! + printf "%s", _nblock( file ); +} diff --git a/session.sh b/session.sh index ee5c499..c3a44e8 100755 --- a/session.sh +++ b/session.sh @@ -1,11 +1,47 @@ #!/bin/sh +# Copyright 2018 - 2022 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. + [ -n "$include_session" ] && return 0 include_session="$0" -_DATE="$(date +%s)" +export _DATE="$(date +%s)" SESSION_TIMEOUT="${SESSION_TIMEOUT:-7200}" +if ! which uuencode >/dev/null; then + uuencode() { busybox uuencode "$@"; } +fi +if ! which sha256sum >/dev/null; then + sha256sum() { busybox sha256sum "$@"; } +fi + +if which openssl >/dev/null; then + session_mac(){ { [ $# -gt 0 ] && printf %s "$*" || cat; } | openssl dgst -sha1 -hmac "$(server_key)" -binary |slopecode; } +else + # Gonzo MAC if openssl is unavailable + session_mac(){ + { server_key | dd status=none bs=256 count=1 skip=1 + { server_key | dd status=none bs=256 count=1 + [ $# -gt 0 ] && printf %s "$*" || cat + } \ + | sha256sum -; + } \ + | sha256sum | cut -d\ -f1 + } +fi + server_key(){ IDFILE="${IDFILE:-${_DATA:-.}/serverkey}" if [ "$(stat -c %s "$IDFILE")" -ne 512 ] || ! cat "$IDFILE"; then @@ -18,7 +54,8 @@ slopecode(){ # 6-Bit Code that retains sort order of input data, while beeing safe to use # in ascii transmissions, unix file names, HTTP URLs, and HTML attributes - uuencode -m - | sed ' + { [ $# -gt 0 ] && printf %s "$*" || cat; } \ + | uuencode -m - | sed ' 1d;$d; y;ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/;0123456789:=ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz; ' @@ -42,42 +79,74 @@ timeid(){ } | slopecode } -checkid(){ grep -m 1 -xE '[0-9a-zA-Z:=]{16}'; } - transid(){ # transaction ID to modify a given file local file="$1" - { stat -c %F%i%n%N%s%Y "$file" 2>&- - printf %s "$SESSION_ID" - server_key - } | sha256sum | cut -d\ -f1 + session_mac "$(stat -c %F%i%n%N%s%Y "$file" 2>&-)" "$SESSION_ID" } +checkid(){ { [ $# -gt 0 ] && printf %s "$*" || cat; } | grep -m 1 -xE '[0-9a-zA-Z:=]{16}'; } + update_session(){ - local session sid time sig serverkey checksig + local session sid time sig checksig + unset SESSION_KEY SESSION_ID - IFS=- read -r sid time sig <<-END - $(COOKIE session) + read -r sid time sig <<-END + $(POST session_key || COOKIE session) END - serverkey="$(server_key)" - checksig="$(printf %s "$sid" "$time" "$serverkey" | sha256sum)" - checksig="${checksig%% *}" + checksig="$(session_mac "$sid" "$time")" - if ! [ "$checksig" = "$sig" \ - -a "$time" -ge "$_DATE" \ - -a "$(printf %s "$sid" |checkid)" ] 2>&- + if [ "$checksig" = "$sig" \ + -a "$time" -ge "$_DATE" \ + -a "$(checkid "$sid")" ] 2>&- then - debug Setting up new session - sid="$(randomid)" + time=$(( $_DATE + $SESSION_TIMEOUT )) + sig="$(session_mac "$sid" "$time")" + + SESSION_KEY="${sid} ${time} ${sig}" + SESSION_ID="${sid}" + return 0 + else + return 1 fi +} + +new_session(){ + local sid time sig + + debug "Setting up new session" + sid="$(randomid)" time=$(( $_DATE + $SESSION_TIMEOUT )) - sig="$(printf %s "$sid" "$time" "$serverkey" |sha256sum)" - sig="${sig%% *}" - printf %s\\n "${sid}-${time}-${sig}" + sig="$(session_mac "$sid" "$time")" + + SESSION_KEY="${sid} ${time} ${sig}" + SESSION_ID="${sid}" +} + +SESSION_BIND() { + # Set tamper-proof authenticated cookie + local key="$1" value="$2" + SET_COOKIE session "$key"="${value} $(session_mac "$value" "$SESSION_ID")" Path="/${_BASE#/}" SameSite=Strict HttpOnly +} + +SESSION_VAR() { + # read authenticated cookie + # fail if value has been tampered with + local key="$1" value sig + value="$(COOKIE "$key")" + sig="${value##* }" value="${value% *}" + if [ "$sig" = "$(session_mac "$value" "$SESSION_ID")" ]; then + printf %s\\n "$value" + else + return 1 + fi +} + +SESSION_COOKIE() { + [ "$1" = new ] && new_session + SET_COOKIE 0 session="$SESSION_KEY" Path="/${_BASE#/}" SameSite=Strict HttpOnly } -SESSION_ID="$(update_session)" -SET_COOKIE 0 session="$SESSION_ID" Path=/ SameSite=Strict HttpOnly -SESSION_ID="${SESSION_ID%%-*}" +update_session || new_session diff --git a/storage.sh b/storage.sh index 7f70e64..5c61df0 100755 --- a/storage.sh +++ b/storage.sh @@ -1,21 +1,18 @@ #!/bin/sh -# Copyright 2018, 2019 Paul Hänsch -# -# This is a file format helper, part of CGIlite. +# Copyright 2018 - 2021 Paul Hänsch # -# CGIlite is free software: you can redistribute it and/or modify -# it under the terms of the GNU Affero General Public License as published by -# the Free Software Foundation, either version 3 of the License, or -# (at your option) any later version. +# 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. # -# CGIlite is distributed in the hope that it will be useful, -# but WITHOUT ANY WARRANTY; without even the implied warranty of -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -# GNU Affero General Public License for more details. -# -# You should have received a copy of the GNU Affero General Public License -# along with CGIlite. If not, see . +# 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. [ -n "$include_storage" ] && return 0 include_storage="$0" @@ -25,62 +22,47 @@ BR=' ' LOCK(){ - local lock timeout block - lock="${1}.lock" - timeout="${2-20}" - if [ \! -w "${lock%/*}" ] || [ -e "$lock" -a \! -d "$lock" ]; then - printf 'Impossible to get lock: %s\n' "$lock" >&2 + local lock="${1}.lock" timeout="${2-20}" block + + if [ \! -w "${lock%/*}" ] || [ -e "$lock" -a \! -f "$lock" ]; then + debug "Impossible to get lock: $lock" return 1 fi - while ! mkdir "$lock" 2>&-; do - block="$(cat "$lock/pid" || printf 1)" - if ! { ps -eo pid |grep -qwF "$block"; }; then - printf 'Overriding stale lock: %s\n' "$lock" >&2 - break - fi - if [ $timeout -le 0 ]; then - printf 'Timeout while trying to get lock: %s\n' "$lock" >&2 - return 1 + while [ $timeout -gt 0 ]; do + printf '%i\n' $$ >>"${lock}" + read block <"$lock" + if [ "$block" = $$ ]; then + return 0 + elif ! { ps -eo pid |grep -qwF "$block"; }; then + debug "Trying to override stale lock: $lock" + if LOCK "$lock" 1; then + rm -- "$lock" + RELEASE "$lock" + fi + else + timeout=$((timeout - 1)) + [ $timeout -gt 0 ] && sleep 1 fi - timeout=$((timeout - 1)) - sleep 1 done - printf '%i\n' $$ >"${lock}/pid" - return 0 + + debug "Timeout while trying to get lock: $lock" + return 1 } RELEASE(){ - local lock - lock="${1}.lock" - if [ "$(cat "$lock/pid")" = "$$" ]; then - rm "$lock/pid" - if ! rmdir "$lock"; then - printf 'Cannot remove tainted lock: %s\n' "$lock" >&2 - printf '%i\n' $$ >"${lock}/pid" - return 1 - fi + local lock="${1}.lock" block + + read block <"$lock" + if [ "$block" = $$ ]; then + rm -- "$lock" return 0 else - printf 'Refusing to release foreign lock: %s\n' "$lock" >&2 + debug "Refusing to release foreign lock: $lock" return 1 fi } -STRING=' - s;\\;\\\\;g; - s;\n;\\n;g; - s;\t;\\t;g; - s;\r;\\r;g; - s;\+;\\+;g; - s; ;+;g; -' - -STRING_OLD(){ - { [ $# -eq 0 ] && cat || printf %s "$*"; } \ - | sed -E ':X; $!{N;bX;}'"$STRING" -} - STRING(){ local in out='' [ $# -gt 0 ] && in="$*" || in="$(cat)" @@ -93,24 +75,9 @@ STRING(){ " "*) out="${out}+"; in="${in# }" ;; *) out="${out}${in%%[\\${CR}${BR} + ]*}"; in="${in#"${in%%[\\${BR}${CR} + ]*}"}" ;; esac; done - printf '%s' "$out" + printf '%s' "${out:-\\}" } - -UNSTRING=' - :UNSTRING_X - s;((^|[^\\])(\\\\)*)\\n;\1\n;g; - s;((^|[^\\])(\\\\)*)\\t;\1\t;g; - s;((^|[^\\])(\\\\)*)\\r;\1\r;g; - s;((^|[^\\])(\\\\)*)\+;\1 ;g; - tUNSTRING_X; - s;((^|[^\\])(\\\\)*)\\\+;\1+;g; - s;\\\\;\\;g; -' -UNSTRING_OLD(){ - { [ $# -eq 0 ] && cat || printf %s "$*"; } \ - | sed -E "$UNSTRING" -} UNSTRING(){ local in out='' [ $# -gt 0 ] && in="$*" || in="$(cat)" @@ -119,11 +86,118 @@ UNSTRING(){ \\n*) out="${out}${BR}"; in="${in#\\n}" ;; \\r*) out="${out}${CR}"; in="${in#\\r}" ;; \\t*) out="${out} "; in="${in#\\t}" ;; - \\+) out="${out}+"; in="${in#\\+}" ;; + \\+*) out="${out}+"; in="${in#\\+}" ;; +*) out="${out} "; in="${in#+}" ;; \\*) in="${in#\\}" ;; *) out="${out}${in%%[\\+]*}"; in="${in#"${in%%[\\+]*}"}" ;; esac; done - printf '%s' "$out" + printf '%s\n' "$out" +} + +RXLITERAL(){ + # sed -E 's;[].*+?^${}()|\[];\\&;g' + local in out='' + [ $# -gt 0 ] && in="$*" || in="$(cat)" + while [ "$in" ]; do case $in in + [.+^\$\{\}\(\)\[\]\*\?\|\\]*) + out="${out}\\${in%"${in#?}"}"; in="${in#?}"; + ;; + *)out="${out}${in%%[.+^\$\{\}\(\)\[\]\*\?\|\\]*}" + in="${in#"${in%%[.+^\$\{\}\(\)\[\]\*\?\|\\]*}"}" + ;; + esac; done + printf '%s\n' "$out" } +DBM() { + local file="$1" cmd="$2" + local k v key value + shift 2; + + case "$cmd" in + check|contains) + key="$(STRING "$1")" + while read -r k v; do if [ "$k" = "$key" ]; then + return 0 + fi; done <"$file" 2>&- + return 1 + ;; + get) + key="$(STRING "$1")" + while read -r k v; do if [ "$k" = "$key" ]; then + UNSTRING "$v" + return 0 + fi; done <"$file" 2>&- + return 1 + ;; + set|store) + key="$(STRING "$1")" value="$(STRING "$2")" + LOCK "$file" || return 1 + { while read -r k v; do + [ "$k" = "$key" ] || printf '%s\t%s\n' "$k" "$v" + done <"$file" 2>&- + printf '%s\t%s\n' "$key" "$value" + } >"${file}.$$.tmp" + mv "${file}.$$.tmp" "${file}" + RELEASE "$file" + return 0 + ;; + add|insert) + k="$1" key="$(STRING "$1")" value="$(STRING "$2")" + LOCK "$file" || return 1 + if DBM "$file" check "$k"; then + RELEASE "$file" + return 1 + else + printf '%s\t%s\n' "$key" "$value" >>"${file}" + RELEASE "$file" + return 0 + fi + ;; + update|replace) + k="$1" key="$(STRING "$1")" value="$(STRING "$2")" + LOCK "$file" || return 1 + if ! DBM "$file" check "$k"; then + RELEASE "$file" + return 1 + fi + { while read -r k v; do + [ "$k" = "$key" ] \ + && printf '%s\t%s\n' "$key" "$value" \ + || printf '%s\t%s\n' "$k" "$v" + done <"$file" 2>&- + } >"${file}.$$.tmp" + mv "${file}.$$.tmp" "${file}" + RELEASE "$file" + return 0 + ;; + append) + key="$(STRING "$1")" value="$(STRING "$2")" + LOCK "$file" || return 1 + if ! DBM "$file" check "$1"; then + RELEASE "$file" + return 1 + fi + { while read -r k v; do + [ "$k" = "$key" ] \ + && printf '%s\t%s\n' "$key" "$v$value" \ + || printf '%s\t%s\n' "$k" "$v" + done <"$file" 2>&- + } >"${file}.$$.tmp" + mv "${file}.$$.tmp" "${file}" + RELEASE "$file" + return 0 + ;; + delete|remove) + key="$(STRING "$1")" + LOCK "$file" || return 1 + { while read -r k v; do + [ "$k" = "$key" ] || printf '%s\t%s\n' "$k" "$v" + done <"$file" 2>&- + } >"${file}.$$.tmp" + mv "${file}.$$.tmp" "${file}" + RELEASE "$file" + return 0 + ;; + esac +} diff --git a/tests-markdown.sh b/tests-markdown.sh new file mode 100755 index 0000000..6df4224 --- /dev/null +++ b/tests-markdown.sh @@ -0,0 +1,1234 @@ +#!/bin/sh + +runtimes="gawk busybox mawk goawk" + +BR=' +' +CR="$(printf \r)" +fail() { printf '%s\n' "$@"; exit 1; } + +awk() { /bin/awk "$@"; } +md_gawk() { gawk -f markdown.awk "$@"; } +md_busybox() { busybox awk -f markdown.awk "$@"; } +md_mawk() { mawk -f markdown.awk "$@"; } +md_goawk() { goawk -f markdown.awk "$@"; } + +acnt=1 # assertion count +assert() { + local md comp="$2" msg="$3" ex + printf "%3i: %s ... " $acnt "$msg" + + for proc in $runtimes; do + printf '%s ' $proc + md="$(printf '%s' "$1" |md_"$proc")"; ex=$? + if [ "$ex" != 0 ]; then + printf "Fail!\nExit Code: %i\n" $ex + exit 1 + fi + if [ "$md" != "$comp" ]; then + printf "Fail!\n:\n%s\n:\n%s\n" "$md" "$comp" + exit 1 + fi + done + printf 'OK\n' + acnt=$((acnt + 1)) +} + +# Inline checks +printf '## Testing Inline markup ##\n' + +# strong / em / ... +assert '~~strikeout~~' '

    strikeout

    ' "strikeout" +assert '~~~strikeout~~' '

    ~strikeout

    ' "strikeout" +assert '^super^' '

    super

    ' "superscript" +assert '~sub~' '

    sub

    ' "subscript" + +assert "foo ${BR}bar" "

    foo
    ${BR}bar

    " 'double space line break' +assert '```©```' "

    &copy;

    " "code span escape" +assert '````' "
    ````
    " "empty code span" + +assert '_emphasized text_' '

    emphasized text

    ' "em" +assert '_emphasized_text_' '

    emphasized_text

    ' "em" +assert 'empha*sized* text_' '

    emphasized text_

    ' "em" +assert '__empha*sized* text__' '

    emphasized text

    ' "strong em" +assert '***strem***' '

    strem

    ' "strong em" +assert '***str**em*' '

    strem

    ' "em strong" +assert '_**strem**_' '

    strem

    ' "em strong" + +assert '*foo**str**bar**str**qua*' '

    foostrbarstrqua

    ' 'em strong asterisk' +assert '**foo*em*bar*em*qua**' '

    fooembaremqua

    ' 'strong em asterisk' + +assert '_foo__str__bar__str__qua_' '

    foo__str__bar__str__qua

    ' 'em embedded underscore' +assert '__foo_em_bar_em_qua__' '

    foo_em_bar_em_qua

    ' 'strong embedded underscore' +assert '_**str**foo**str**_' '

    strfoostr

    ' 'em strong mixed' + +assert '_foo_-> bar' '

    foo→ bar

    ' 'arrow' +assert '`_foo_-> bar`' '

    _foo_-> bar

    ' 'arrow' +assert ' <- comment' '

    <!-- comment --> ← comment

    ' 'arrow' + +# Escaping +assert '©' "

    ©

    " "escape" +assert '\©' "

    &copy;

    " "escape" +assert 'AT&T' "

    AT&T

    " "escape" +assert '`©`' "

    &copy;

    " "code span escape" + +# Wiki Links +assert '[[Link/]]' '

    Link/

    ' "Wiki Link" +assert '[[Link/|Linked Page]]' '

    Linked Page

    ' "Wiki Link" + +# Automatic Links +assert '' "

    https://de.wikipedia.org

    " "automatic link" +assert '' "

    http://de.wikipedia.org

    " "automatic link" +# assert '' "

    http://de.wikipedia.org

    " "automatic link" + +assert '' "

    hello&goodbye@sub-test.example.com

    " "automatic link, email" +# assert '' "

    hällö&guttbei@sub-test.example.com

    " "automatic link, email" + +# Inline Links +assert '[Wikipedia](http://de.wikipedia.org)' "

    Wikipedia

    " "inline link" +assert '[Wikipedia](http://de.wikipedia.org "Online Encyclopedia")' "

    Wikipedia

    " "inline link" +assert '[Wikipedia]( "Online Encyclopedia")' "

    Wikipedia

    " "inline link" + +# Inline Images (note leading white space) +assert ' ![Testbild](Test Bild.jpg)' '

    Testbild

    ' "inline image" +assert ' ![Testbild](Test Bild.jpg "German Television *test* image ca. 1994")' '

    Testbild

    ' "inline image" +assert ' ![Testbild *ARD*](Test Bild.jpg){tv ard function-check}' '

    Testbild *ARD*

    ' "inline image" +# assert ' ![Testbild *ARD*](Test Bild.jpg){#tv .ard .function-check}' '

    Testbild *ARD*

    ' "inline image id/classes" + +assert '[![Wikipedia](wikilogo.png)]()'\ + '

    Wikipedia

    '\ + "Image Link" + +assert ' <" _foo_>>' '

    macro /test -- "* weird <args>" _foo_

    ' "Macros" + +# Block checks +printf '\n## Testing Block markup ##\n' + +assert \ +'foo + +bar' \ +'

    foo

    + +

    bar

    ' \ +'paragraphs' + +assert '%meta *data block* + ignored `no` __formatting__ +regular *data*' \ +'

    regular data

    ' \ +"meta data block" + +assert '> text in a block +> quote can be *emphasized* +and quotes continued + +until they end' \ +'

    text in a block +quote can be emphasized +and quotes continued

    + +

    until they end

    ' \ +'block quote' + +assert '| text in a line +| block can be *emphasized* +but not continued + +until they end' \ +'
    text in a line
    +block can be emphasized
    +

    but not continued

    + +

    until they end

    ' \ +'pandoc line block' + +assert ' indented code will + not be + *formatted* + but ­ ' \ +'
    indented code will
    +not be
    +*formatted*
    +but &shy; <escaped>
    ' \ +"indented code block" + +assert ' indented code will + not be + + *formatted* + but ­ ' \ +'
    indented code will
    +not be
    +
    +*formatted*
    +but &shy; <escaped>
    ' \ +"indented code block" + +assert ':::: tag +fenced _divs_ are regular text + +::: +and can contain another div +::: +::::' \ +'

    fenced divs are regular text

    + +

    and can contain another div

    +
    +
    ' \ +"pandoc fenced divs" + +assert '``` tag,code +fenced code will +not be +*formatted* +but ­ +```' \ +'
    fenced code will
    +not be
    +*formatted*
    +but &shy; <escaped>
    ' \ +"fenced code block" + +assert 'foobar +```` +foobar' \ +'

    foobar +```` +foobar

    ' \ +"Open Fence" + +# Block Images +assert '![Testbild](Test Bild.jpg)' \ +'
    Testbild
    ' \ +"block image" + +assert '![Testbild](Test Bild.jpg "German Television *test* image ca. 1994")' \ +'
    Testbild
    German Television test image ca. 1994
    ' \ +"block image" + +assert '![Testbild *ARD*](Test Bild.jpg){tv ard function-check}' \ +'
    Testbild *ARD*
    ' \ +"block image tagged" + +# assert '![Testbild *ARD*](Test Bild.jpg){#tv .ard .function-check}' \ +# '
    Testbild *ARD*
    ' \ +# "block image tagged" + +# Headings +assert 'Heading first Order +============' \ +'

    Heading first Order

    +
    ' \ +'Heading h1' + +assert 'Heading first Order {.foo #bar} +============' \ +'

    Heading first Order

    +
    ' \ +'Heading h1 + attributes' + +assert 'Heading second Order +------------' \ +'

    Heading second Order

    +
    ' \ +'Heading h2' + +assert 'Heading second Order {.foo #bar} +------------' \ +'

    Heading second Order

    +
    ' \ +'Heading h2 + attributes' + +assert '#### Heading four' \ +'

    Heading four

    +
    ' \ +'Heading arbitrary' + +assert '###Heading three ######' \ +'

    Heading three

    +
    ' \ +'Heading arbitrary' + +assert '### Heading three ## {foo bar}' \ +'

    Heading three

    +
    ' \ +'Heading arbitrary + attributes' + +assert '# Heading \# # {foo bar}' \ +'

    Heading #

    +
    ' \ +'Heading arbitrary + attributes' + +assert 'Definition +: term +with line continuation + +: second term + +foo +: bar' \ +'
    +
    Definition
    +
    term +with line continuation
    +
    second term
    +
    foo
    +
    bar
    +
    ' \ +'Definition List' + +assert ' * list +* item + 1. sub list +* three +- new list' \ +'
      +
    • list
    • +
    • item

      +
        +
      1. sub list
      2. +
      +
    • +
    • three
    • +
    +
      +
    • new list
    • +
    ' \ +'Lists' + +assert '::: outer div +Nesting paragraph + +------- + +> ``` +> quoted code +> ``` +> +> > quoted quote +::: +' \ +'

    Nesting paragraph

    + +
    + +
    quoted code
    +

    quoted quote

    +
    + +
    ' \ +"Nesting" + +assert ' +| Col 1 | Col 2| Col 3 | +|-------|-------|------:| +| foo | *bar* | `qua` | +| 23 | 47 | 11 | +' \ +' + + + + +
    Col 1 Col 2 Col 3
    foo bar qua
    23 47 11
    ' \ +'Pipe Tables' + +# assert ' +# Col 1 | Col 2| Col 3 +# :-----:|-------|------: +# foo | *bar* | `qua` +# 23 | 47 | 11 | +# ' \ +# ' +# +# +# +# +#
    Col 1 Col 2 Col 3
    foo bar qua
    23 47 11
    ' \ +# 'Pipe Tables' + +assert '+---+---+---+ +|Col 1\\| Col\|2 | Col 3| ++===+:==:+===+ +| * foo1 | *bar* |```| +| * foo2 | **qua** |code | +| - foo3 | `quux` |```| ++-------+-----+----+ +| 23 | 47 | 11 | ++-------+-----+----+ +' \ +' + + + + +

    Col 1\

    +

    Col|2

    +

    Col 3

    +
      +
    • foo1
    • +
    • foo2
    • +
    +
      +
    • foo3
    • +
    +

    bar + qua + quux

    +
    code 
    +

    23

    +

    47

    +

    11

    +
    ' \ +'Grid Tables' + +assert '## foo + +# bar + +sub bar +------- + +### sub sub sub ### + +##sub2 bar {x} +' \ +'

    foo

    +

    bar

    +

    sub bar

    +

    sub sub sub

    +

    sub2 bar

    +
    ' \ +'Headline Nesting' + +# Reference syntax checks +printf '\n## Testing reference syntax ##\n' + +assert 'Foo bar [Link] [1] for show + +The same in [en][] + +[en]: +[1]: http://de.wikipedia.org "Online Encyclopedia"' \ +'

    Foo bar Link for show

    + +

    The same in en

    ' \ +"Reference Links" + +assert 'Foo bar [Link] [1] for show + +[en]: +[1]: http://de.wikipedia.org + "Online Encyclopedia"' \ +'

    Foo bar Link for show

    ' \ +"Reference Links" + +assert 'Foo bar ![Image] [1] for show + +The same as ![PNG][] + +[PNG]: +[1]: http://de.wikipedia.org/logo.jpg "Online Encyclopedia"' \ +'

    Foo bar Image for show

    + +

    The same as PNG

    ' \ +"Reference images" + +assert '![Image] [1] + +[PNG]: +[1]: http://de.wikipedia.org/logo.jpg "Online Encyclopedia"' \ +'
    Image
    Online Encyclopedia
    ' \ +"Reference images (block)" + +assert '<" _foo_>>' 'macro /test -- "* weird <args>" _foo_' "Macros/Block" + + +printf '\n## Testing example pages ##\n' + +assert 'Markdown.awk +============ + +Supported Features / TODO: +-------------------------- +- [x] done +- [ ] todo +- [-] not planned +- ? unsure (whether to implement) +- [/] partial + +### Basic Markdown - Block elements: ### +- [x] Paragraphs + - [x] Double space line breaks +- [x] Proper block element nesting +- [x] Headings +- [x] ATX-Style Headings +- [x] Blockquotes +- [x] Lists (ordered, unordered) +- [x] Code blocks (using indention) +- [x] Horizontal rules +- [x] Verbatim HTML block (disabled by default) + +### Basic Markdown - Inline elements: ### +- [x] Links +- [x] Reference style links +- [x] Emphasis *em*/**strong** (*Asterisk*, _Underscore_) +- [x] `code`, also ``code containing `backticks` `` +- [x] Images / reference style images +- [x] +- [x] backslash escapes +- [x] Verbatim HTML inline (disabled by default) +- [x] HTML escaping + +NOTE: Set the environment variable `MD_HTML=true` to enable verbatim HTML + +### Extensions - Block elements: ### +- [x] Automatic
    -wrapping (custom) +- ? Heading identifiers (php md, pandoc) + - [x] Heading attributes (custom) +- [x] Automatic heading identifiers (custom) +- [x] Fenced code blocks (php md, pandoc) + - [x] Fenced code attributes +- [x] Images (as block elements,
    -wrapped) (custom) + - [x] reference style block images +- [/] Tables + - ? Simple table (pandoc) + - ? Multiline table (pandoc) + - [x] Grid table (pandoc) + - [x] Headerless + - [x] Pipe table (php md, pandoc) +- [x] Line blocks (pandoc) +- [x] Task lists (pandoc, custom) +- [x] Definition lists (php md, pandoc) +- [-] Numbered example lists (pandoc) +- [-] Metadata blocks (pandoc) +- [x] Metadata blocks (custom) +- [x] Fenced Divs (pandoc) + +### Extensions - Inline elements: ### +- [x] Ignore embedded_underscores (php md, pandoc) +- [x] ~~strikeout~~ (pandoc) +- [x] ^Superscript^ ~Subscript~ (pandoc) +- [-] Bracketed spans (pandoc) + - [-] Inline attributes (pandoc) +- [x] Image attributes (custom, pandoc inspired, not for reference style) +- [x] Wiki style links [[PageName]] / [[PageName|Link Text]] +- [-] TEX-Math (pandoc) +- ? Footnotes (php md) +- ? Abbreviations (php md) +- ? "Curly quotes" (smartypants) +- [ ] em-dashes (--) (smartypants old) +- ? ... three-dot ellipsis (smartypants) +- [-] en-dash (smartypants) +- [ ] Automatic em-dash / en-dash +- [x] Automatic -> Arrows <- (custom) + +Compatibility +------------- +Markdown.awk can run in GNU awk (`gawk`) and in Busybox awk. It is _not_ fully POSIX compliant and does not run in `mawk` or `nawk`. In particular it makes heavy use of the `gensub()` function and its ability to use paranthesized subexpressions in the replacement text. This feature is not available in the POSIX specified `sub()` and `gsub()` functions. Hence it cannot be replaced without effort. + +Tests +----- +[Link with Title](https://en.wikipedia.org/wiki/Markdown "Markdown in Wikipedia"), *emphasis*, **strong**, **strong containing *emphasis***, `inline code`, `` code with `backticks` ``. See more tests [here](./tests/).' \ +'

    Markdown.awk

    +

    Supported Features / TODO:

    +
      +
    • done
    • +
    • todo
    • +
    • not planned
    • +
    • ? unsure (whether to implement)
    • +
    • partial
    • +
    +

    Basic Markdown - Block elements:

    +
      +
    • Paragraphs

      +
        +
      • Double space line breaks
      • +
      +
    • +
    • Proper block element nesting
    • +
    • Headings
    • +
    • ATX-Style Headings
    • +
    • Blockquotes
    • +
    • Lists (ordered, unordered)
    • +
    • Code blocks (using indention)
    • +
    • Horizontal rules
    • +
    • Verbatim HTML block (disabled by default)
    • +
    +

    Basic Markdown - Inline elements:

    +
      +
    • Links
    • +
    • Reference style links
    • +
    • Emphasis em/strong (Asterisk, Underscore)
    • +
    • code, also code containing `backticks`
    • +
    • Images / reference style images
    • +
    • <automatic links>
    • +
    • backslash escapes
    • +
    • Verbatim HTML inline (disabled by default)
    • +
    • HTML escaping
    • +
    +

    NOTE: Set the environment variable MD_HTML=true to enable verbatim HTML

    + +

    Extensions - Block elements:

    +
      +
    • Automatic <section>-wrapping (custom)
    • +
    • ? Heading identifiers (php md, pandoc)

      +
        +
      • Heading attributes (custom)
      • +
      +
    • +
    • Automatic heading identifiers (custom)
    • +
    • Fenced code blocks (php md, pandoc)

      +
        +
      • Fenced code attributes
      • +
      +
    • +
    • Images (as block elements, <figure>-wrapped) (custom)

      +
        +
      • reference style block images
      • +
      +
    • +
    • Tables

      +
        +
      • ? Simple table (pandoc)
      • +
      • ? Multiline table (pandoc)
      • +
      • Grid table (pandoc)

        +
          +
        • Headerless
        • +
        +
      • +
      • Pipe table (php md, pandoc)
      • +
      +
    • +
    • Line blocks (pandoc)
    • +
    • Task lists (pandoc, custom)
    • +
    • Definition lists (php md, pandoc)
    • +
    • Numbered example lists (pandoc)
    • +
    • Metadata blocks (pandoc)
    • +
    • Metadata blocks (custom)
    • +
    • Fenced Divs (pandoc)
    • +
    +

    Extensions - Inline elements:

    +
      +
    • Ignore embedded_underscores (php md, pandoc)
    • +
    • strikeout (pandoc)
    • +
    • Superscript Subscript (pandoc)
    • +
    • Bracketed spans (pandoc)

      +
        +
      • Inline attributes (pandoc)
      • +
      +
    • +
    • Image attributes (custom, pandoc inspired, not for reference style)
    • +
    • Wiki style links PageName / Link Text
    • +
    • TEX-Math (pandoc)
    • +
    • ? Footnotes (php md)
    • +
    • ? Abbreviations (php md)
    • +
    • ? "Curly quotes" (smartypants)
    • +
    • em-dashes (--) (smartypants old)
    • +
    • ? ... three-dot ellipsis (smartypants)
    • +
    • en-dash (smartypants)
    • +
    • Automatic em-dash / en-dash
    • +
    • Automatic → Arrows ← (custom)
    • +
    +

    Compatibility

    +

    Markdown.awk can run in GNU awk (gawk) and in Busybox awk. It is not fully POSIX compliant and does not run in mawk or nawk. In particular it makes heavy use of the gensub() function and its ability to use paranthesized subexpressions in the replacement text. This feature is not available in the POSIX specified sub() and gsub() functions. Hence it cannot be replaced without effort.

    + +

    Tests

    +

    Link with Title, emphasis, strong, strong containing emphasis, inline code, code with `backticks`. See more tests here.

    +
    ' \ +'Full Page (cgilite markdown)' + +assert 'Headline First Order +==================== + +Headline Second Order +--------------------- + + Code Block + with indentation + +> Blockquote +> ---------- +> like in an email + +### Headline 3rd order + +- unordered List +1. with sub points + + sometimes longer ones + +2. which are ordered +3. [ ] and have a Todo item +- more list points + - and a sublist +- [x] some of which ae done + +---------- ++ A lazy, lazy, list +item. + ++ Another one; this looks +bad but is legal. + + Second paragraph of second +list item. + +--------- + +~~~ {.blue} +Fenced Code Block +# with verbatim Text +`and an attribute` +~~~ + +| The limerick packs laughs anatomical +| In space that is quite economical. +| But the *good* ones I'\''ve seen +| So seldom are *clean* +| And the clean ones so seldom are comical + +| The Right Honorable Most Venerable and Righteous Samuel L. + Constable, Jr. +| 200 Main St. +| Berkeley, CA 94718 + +Term 1 + +: This is a definition with two paragraphs. Lorem ipsum + dolor sit amet, consectetuer adipiscing elit. Aliquam + hendrerit mi posuere lectus. + + Vestibulum enim wisi, viverra nec, fringilla in, laoreet + vitae, risus. + +: Second definition for term 1, also wrapped in a paragraph + because of the blank line preceding it. + +Term 2 + +: This definition has a code block, a blockquote and a list. + + code block. + + > block quote + > on two lines. + + 1. first list item + 2. second list item' \ +'

    Headline First Order

    +

    Headline Second Order

    +
    Code Block
    +with indentation
    +

    Blockquote

    +

    like in an email

    +
    + +

    Headline 3rd order

    +
      +
    • unordered List
    • +
    +
      +
    1. with sub points

      + +

      sometimes longer ones

      +
    2. +
    3. which are ordered

      +
    4. +
    5. and have a Todo item

      +
    6. +
    +
      +
    • more list points

      +
        +
      • and a sublist
      • +
      +
    • +
    • some of which ae done
    • +
    +
    +
      +
    • A lazy, lazy, list +item.

      +
    • +
    • Another one; this looks +bad but is legal.

      + +

      Second paragraph of second +list item.

      +
    • +
    +
    + +
    Fenced Code Block
    +# with verbatim Text
    +`and an attribute`
    +
    The limerick packs laughs anatomical
    +In space that is quite economical.
    + But the good ones I've seen
    + So seldom are clean
    +And the clean ones so seldom are comical
    +
    The Right Honorable Most Venerable and Righteous Samuel L. Constable, Jr.
    +200 Main St.
    +Berkeley, CA 94718
    +
    +
    Term 1
    +

    This is a definition with two paragraphs. Lorem ipsum +dolor sit amet, consectetuer adipiscing elit. Aliquam +hendrerit mi posuere lectus.

    + +

    Vestibulum enim wisi, viverra nec, fringilla in, laoreet +vitae, risus.

    +
    +
    Second definition for term 1, also wrapped in a paragraph +because of the blank line preceding it.
    +
    Term 2
    +

    This definition has a code block, a blockquote and a list.

    + +
    code block.
    +

    block quote +on two lines.

    + +
      +
    1. first list item
    2. +
    3. second list item
    4. +
    +
    +
    +
    ' \ +'Full Page (MD Tests)' + +assert '%css shellwiki.css + +Shellwiki +========= +Shellwiki is a Wiki and Content Management System with minimal dependencies. It can run on embedded devices, as well as full size web servers. Its goals are: + + - **easy deployment** + + *ShellWiki* can run on any Unix-Like web server. It requires no + scripting languages beyound the regular (Bourne style) Unix + shell, `awk`, and `sed`, all of which can be providede by + `busybox`. It can be launched via `netcat`, `inetd`, `systemd`, + or any cgi capable webserver like `apache` or `lighttpd`. + *ShellWiki* can run easily on embedded systems like OpenWRT or + RaspberryPi, and just as easily on internet web servers + providing multisite setups. + + - **accessibility** + + *ShellWiki* requires no browserside scripting. It aims to be rendered + in all web browsers including `w3m` and `links` besides graphical + browsers like `chromium` or `firefox`. It is as accessible on mobile + screens as on desktop computers. + *ShellWiki* uses the well known `markdown` syntax for formatting and + aims to provide consistent UI controls for various use cases. + + - **adaptability** + + *ShellWiki* is extensible through plugins and provides theming and + styling capabilities that make it suitable not only as a wiki, but + also as a CMS, including access scopes for different authors and + stylisticly distinct subpages. + + - **simplicity** + + *ShellWiki* avoids complexity in both software design and user + interface. It aims to be secure and predictable. Extensions can + be written and modified by system administrators. + +<> + +Features +-------- + - **Markdown Wiki Syntax** + + The wiki syntax is based on [John Grubers Markdown](https://daringfireball.net/projects/markdown/) + with extensions inspired by [Pandoc](https://pandoc.org/MANUAL.html#pandocs-markdown), + [PHP Markdown Extra](https://michelf.ca/projects/php-markdown/extra/), and + [Github Flavored Markdown](https://github.github.com/gfm/). + Additional Macros are provided to enable functions like an automatic table of contents, listing of + sub pages, etc. + + See [Markdown](/software/cgilite/markdown/) + and [Macros](macros/) + + - **Plain file Storage** + + Pages and attachments are stored as plain files on disk. There is no need for a separate database + system. + + - **Git revisioning** + + If `git` is available on the web server, pages can be revisioned so that past versions can be + revisited. Optionally attachments can be revisioned too. Server administrators may use the git + archives to synchronise sites across servers by adding their own mechanics. + + - **Multisite Installation** + + Code and data directories are stricly separate on the server. Directory pathes are obtained from + environment variables, so that multiple sites can be served from the same installation directory. + + See also: [Installation](installation/) + + - **Semantic HTML5** + + for accessible rendering of pages + + - **Descriptive Page Names** + + URLs of pages can be freely provided by the user. User access can be constrained to specific sub + pages. Within their access permissions users can move and rename pages as they like. + + - **File Upload / Attachment** + + While pages are merely text documents themselves, users can upload additional attachments and + link to them in a page. Images and media files can be embedded directly into a page. + + - **Image scaling** + + If `ImageMagick` is available on the web server, huge attachment images are automatically compressed + and scaled to HD resolution when referred to in a page. + Of course the original version can still be linked to. + + - **Permissions via ACL** + + Grant read/write access for pages and sub-pages + + - **User provided CSS** + + Aside from full theming in the installation directory, pages can be styled using CSS files + uploaded as attachments. + + - **No reliance on Javascript** + + Authors and visitors can use the site without being forced to run untrusted code. + The main theme still provides collapsible menus and a responsive layout. + + - **Complete GDPR Compliance** without consent walls + + Because shellwiki does not track page visitors and does not + serve cookies to visitors by default it does not need to coerce + visitors into handling GDPR "consent" forms. + + (Login for authors still requires a session cookie) + + - **True multilanguage capability** + + - Pages can be translated + - Switching language does not require a cookie + - Fallback language for missing translations + - Users stay on a translated version, even if single page translations are missing + + - **Full text indexing and search** + + Shellwiki contains its own basic text indexer without external dependencies. + + - **Extensibility** through + + - [Themes](themes/) + - [Macros](macros/) + - [URL Handlers](handlers/) + - [Custom Syntax parsers](parsers/) + +Dependencies +------------ +Shellwiki is based on [cgilite](/software/cgilite/), which is included in the installation. It is written in posix compliant shell script, and the markdown renderer is written in ~~posix compliant~~ AWK. The entire wiki system can run with nothing more than a busybox. In fact it can be served from the rescue shell in a Debian initrd, or from an OpenWRT router. + +**Its precise requirements are:** + + - A Posix Shell (as provided by busybox, but bash is OK) + - An AWK interpreter (as provided by busybox, but GNU AWK is OK) + - `mawk` and `nawk` will currently not work + - inetd (as provided by busybox) + + **or** any CGI-Capable web server + + - _Optional:_ GIT for revisioning + - _Optional:_ ImageMagick for image compression + - _Optional:_ Sendmail for sending password reminders, etc. + +Installation +------------ +Also see -> [[installation/]] + +You can try out shellwiki right now using busybox: + + ~$ git clone https://git.plutz.net/git/shellwiki ~/shellwiki + ~$ _DATA=~/wikidata busybox nc -llp 1080 -e ~/shellwiki/index.cgi + +For additional examples, regarding permanent installation and configuration in webservers see [[installation/]]. + +Syntax +------ +The wiki syntax is based on John Grubers [Markdown](https://daringfireball.net/projects/markdown/) with extensions borrowed from [Pandoc](https://pandoc.org/MANUAL%202.html#pandocs-markdown) and [PHP Markdown Extra](https://michelf.ca/projects/php-markdown/extra/). The Markdown parser is provided by [Cgilite](/software/cgilite/) and its full documentation can be looked at [here](/software/cgilite/markdown/). + +<> + +Macros +------ +Also see -> [[macros/]] + +In addition to the Markdown syntax, wiki pages can include Macros, which perform additional functions on a page, like generating an image gallery, including parts of other pages, etc. Macros make Shellwiki truly dynamic and flexible. + +For example you can include a table of content for the current page by including the line + + <> + +in your page. Macros can receive additional parameters, which modify their behaviour. + +Macros are the most easy to write type of extension. See [Macros](macros/) for a full list of available macros. + +Themes +------ +Also see -> [[theming/]] + +While Shellwiki supports plugins for [theming](dev-theming/), it'\''s apearance can mostly be configured by the user. Pages can be configured to use custom CSS files. In addition page headers and footers are themselves wiki pages which can be modified to add menus, custom logos, links, etc. The same goes for error pages. + +For an example, see the [technical pages](/[wiki]/) for this wiki. + +Multiple Languages +------------------ +To enable a multilingual setup you must set a default language in your configuration environment: + +``` +export LANGUAGE_DEFAULT=en +``` + +Once this is the case, pagenames starting with a colon (`:`) will be considered translated versions of their parent pages. I.e. the pages `/`, `/:de`, and `/:fr` will serve as the default, german, and french home page respectively. + +The names of the languages can be arbitrary, but I recommend using [ISO-639](https://en.wikipedia.org/wiki/ISO_639-1) codes, because the code is used in the `lang=""` attribute of the pages top level html element. You can however make up non-standardised or fantastic language names as well. + +Links on each page will automatically be suffixed with the same language tag, so a visitor keeps browsing the same language without needing a cookie. Attachments should only be uploaded to the default language page, and attachment links in the translated pages will correctly point to the main page attachments. You can create a language menu on the header page, simply by linking to `./:en`, `./:es` , `./:fr`, etc. + +Header, footer, and error pages will be included from their respective language version, as will all macro includes, etc. Should a page not exist in a given language, the default page will be displayed instead. However, included elements will still be taken from the respective language version, possibly mixing languages between the selected user language and the default. + +### Constraints of the current implementation + - There can be only one default language, with no priority of different fallback languages + - Page URLs can currently not be translated. Doing so would require a model for manually assigning translated page names and would not be trivial to use. + +Developer Documentation +----------------------- +How to write: + + - [Themes](dev-theming/) + - [Macros](dev-macros/) + - [Handlers](dev-handlers/) + - [Parsers](dev-parsers/)' \ +'

    Shellwiki

    +

    Shellwiki is a Wiki and Content Management System with minimal dependencies. It can run on embedded devices, as well as full size web servers. Its goals are:

    +
      +
    • easy deployment

      + +

      ShellWiki can run on any Unix-Like web server. It requires no +scripting languages beyound the regular (Bourne style) Unix +shell, awk, and sed, all of which can be providede by +busybox. It can be launched via netcat, inetd, systemd, +or any cgi capable webserver like apache or lighttpd.
      +ShellWiki can run easily on embedded systems like OpenWRT or +RaspberryPi, and just as easily on internet web servers +providing multisite setups.

      +
    • +
    • accessibility

      + +

      ShellWiki requires no browserside scripting. It aims to be rendered +in all web browsers including w3m and links besides graphical +browsers like chromium or firefox. It is as accessible on mobile +screens as on desktop computers.
      +ShellWiki uses the well known markdown syntax for formatting and +aims to provide consistent UI controls for various use cases.

      +
    • +
    • adaptability

      + +

      ShellWiki is extensible through plugins and provides theming and +styling capabilities that make it suitable not only as a wiki, but +also as a CMS, including access scopes for different authors and +stylisticly distinct subpages.

      +
    • +
    • simplicity

      + +

      ShellWiki avoids complexity in both software design and user +interface. It aims to be secure and predictable. Extensions can +be written and modified by system administrators.

      +
    • +
    +toc 2 2

    Features

    +
      +
    • Markdown Wiki Syntax

      + +

      The wiki syntax is based on John Grubers Markdown +with extensions inspired by Pandoc, +PHP Markdown Extra, and +Github Flavored Markdown. +Additional Macros are provided to enable functions like an automatic table of contents, listing of +sub pages, etc.

      + +

      See Markdown
      +and Macros

      +
    • +
    • Plain file Storage

      + +

      Pages and attachments are stored as plain files on disk. There is no need for a separate database +system.

      +
    • +
    • Git revisioning

      + +

      If git is available on the web server, pages can be revisioned so that past versions can be +revisited. Optionally attachments can be revisioned too. Server administrators may use the git +archives to synchronise sites across servers by adding their own mechanics.

      +
    • +
    • Multisite Installation

      + +

      Code and data directories are stricly separate on the server. Directory pathes are obtained from +environment variables, so that multiple sites can be served from the same installation directory.

      + +

      See also: Installation

      +
    • +
    • Semantic HTML5

      + +

      for accessible rendering of pages

      +
    • +
    • Descriptive Page Names

      + +

      URLs of pages can be freely provided by the user. User access can be constrained to specific sub +pages. Within their access permissions users can move and rename pages as they like.

      +
    • +
    • File Upload / Attachment

      + +

      While pages are merely text documents themselves, users can upload additional attachments and +link to them in a page. Images and media files can be embedded directly into a page.

      +
    • +
    • Image scaling

      + +

      If ImageMagick is available on the web server, huge attachment images are automatically compressed +and scaled to HD resolution when referred to in a page. +Of course the original version can still be linked to.

      +
    • +
    • Permissions via ACL

      + +

      Grant read/write access for pages and sub-pages

      +
    • +
    • User provided CSS

      + +

      Aside from full theming in the installation directory, pages can be styled using CSS files +uploaded as attachments.

      +
    • +
    • No reliance on Javascript

      + +

      Authors and visitors can use the site without being forced to run untrusted code. +The main theme still provides collapsible menus and a responsive layout.

      +
    • +
    • Complete GDPR Compliance without consent walls

      + +

      Because shellwiki does not track page visitors and does not +serve cookies to visitors by default it does not need to coerce +visitors into handling GDPR "consent" forms.

      + +

      (Login for authors still requires a session cookie)

      +
    • +
    • True multilanguage capability

      +
        +
      • Pages can be translated
      • +
      • Switching language does not require a cookie
      • +
      • Fallback language for missing translations
      • +
      • Users stay on a translated version, even if single page translations are missing
      • +
      +
    • +
    • Full text indexing and search

      + +

      Shellwiki contains its own basic text indexer without external dependencies.

      +
    • +
    • Extensibility through

      + +
    • +
    +

    Dependencies

    +

    Shellwiki is based on cgilite, which is included in the installation. It is written in posix compliant shell script, and the markdown renderer is written in posix compliant AWK. The entire wiki system can run with nothing more than a busybox. In fact it can be served from the rescue shell in a Debian initrd, or from an OpenWRT router.

    + +

    Its precise requirements are:

    +
      +
    • A Posix Shell (as provided by busybox, but bash is OK)

      +
    • +
    • An AWK interpreter (as provided by busybox, but GNU AWK is OK)

      +
        +
      • mawk and nawk will currently not work
      • +
      +
    • +
    • inetd (as provided by busybox)

      + +

      or any CGI-Capable web server

      +
    • +
    • Optional: GIT for revisioning

      +
    • +
    • Optional: ImageMagick for image compression

      +
    • +
    • Optional: Sendmail for sending password reminders, etc.

      +
    • +
    +

    Installation

    +

    Also see → installation/

    + +

    You can try out shellwiki right now using busybox:

    + +
    ~$ git clone https://git.plutz.net/git/shellwiki ~/shellwiki
    +~$ _DATA=~/wikidata busybox nc -llp 1080 -e ~/shellwiki/index.cgi
    +

    For additional examples, regarding permanent installation and configuration in webservers see installation/.

    + +

    Syntax

    +

    The wiki syntax is based on John Grubers Markdown with extensions borrowed from Pandoc and PHP Markdown Extra. The Markdown parser is provided by Cgilite and its full documentation can be looked at here.

    + +include --nolink /[wiki]/editorhelp/

    Macros

    +

    Also see → macros/

    + +

    In addition to the Markdown syntax, wiki pages can include Macros, which perform additional functions on a page, like generating an image gallery, including parts of other pages, etc. Macros make Shellwiki truly dynamic and flexible.

    + +

    For example you can include a table of content for the current page by including the line

    + +
    <<toc>>
    +

    in your page. Macros can receive additional parameters, which modify their behaviour.

    + +

    Macros are the most easy to write type of extension. See Macros for a full list of available macros.

    + +

    Themes

    +

    Also see → theming/

    + +

    While Shellwiki supports plugins for theming, it's apearance can mostly be configured by the user. Pages can be configured to use custom CSS files. In addition page headers and footers are themselves wiki pages which can be modified to add menus, custom logos, links, etc. The same goes for error pages.

    + +

    For an example, see the technical pages for this wiki.

    + +

    Multiple Languages

    +

    To enable a multilingual setup you must set a default language in your configuration environment:

    + +
    export LANGUAGE_DEFAULT=en
    +

    Once this is the case, pagenames starting with a colon (:) will be considered translated versions of their parent pages. I.e. the pages /, /:de, and /:fr will serve as the default, german, and french home page respectively.

    + +

    The names of the languages can be arbitrary, but I recommend using ISO-639 codes, because the code is used in the lang="" attribute of the pages top level html element. You can however make up non-standardised or fantastic language names as well.

    + +

    Links on each page will automatically be suffixed with the same language tag, so a visitor keeps browsing the same language without needing a cookie. Attachments should only be uploaded to the default language page, and attachment links in the translated pages will correctly point to the main page attachments. You can create a language menu on the header page, simply by linking to ./:en, ./:es , ./:fr, etc.

    + +

    Header, footer, and error pages will be included from their respective language version, as will all macro includes, etc. Should a page not exist in a given language, the default page will be displayed instead. However, included elements will still be taken from the respective language version, possibly mixing languages between the selected user language and the default.

    + +

    Constraints of the current implementation

    +
      +
    • There can be only one default language, with no priority of different fallback languages
    • +
    • Page URLs can currently not be translated. Doing so would require a model for manually assigning translated page names and would not be trivial to use.
    • +
    +

    Developer Documentation

    +

    How to write:

    + +
    ' \ +'Full Page (ShellWiki)' + +printf '\nAll tests passed!\n' diff --git a/users.sh b/users.sh new file mode 100755 index 0000000..32299ff --- /dev/null +++ b/users.sh @@ -0,0 +1,661 @@ +#!/bin/sh + +# Copyright 2021 - 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. + +[ -n "$include_users" ] && return 0 +include_users="$0" + +. "${_EXEC:-.}/cgilite/session.sh" +. "${_EXEC:-.}/cgilite/storage.sh" + +SENDMAIL=${SENDMAIL-sendmail} + +USER_REGISTRATION="${USER_REGISTRATION-true}" +USER_REQUIREEMAIL="${USER_REQUIREEMAIL-true}" +USER_ACCOUNTPAGE="${USER_ACCOUNTPAGE}" + +USER_ACCOUNTEXPIRE="${USER_ACCOUNTEXPIRE:-$((86400 * 730))}" +USER_CONFIRMEXPIRE="${USER_CONFIRMEXPIRE:-86400}" + +HTTP_HOST="$(HEADER Host)" +MAILFROM="noreply@${HTTP_HOST%:*}" + +[ "$HTTPS" ] && SCHEMA=https || SCHEMA=http + +# == FILE FORMAT == +# UID UNAME STATUS EMAIL PWSALT PWHASH EXPIRE DEVICES FUTUREUSE +# (pending|active|deleted) + +# == GLOBALS == +UNSET_USER='unset \ + USER_ID USER_NAME USER_STATUS USER_EMAIL USER_PWSALT USER_PWHASH \ + USER_EXPIRE USER_DEVICES USER_FUTUREUSE +' + +LOCAL_USER='local \ + USER_ID USER_NAME USER_STATUS USER_EMAIL USER_PWSALT USER_PWHASH \ + USER_EXPIRE USER_DEVICES USER_FUTUREUSE +' + +# == TRANSLATIONS == +# override all functions marked with "TRANSLATION" +# sed -n '/TRANSLATION$/,/^}/p;' "${user_db}.$$" + mv -- "${user_db}.$$" "$user_db" + RELEASE "$user_db" + else + return 1 + fi +} + +new_user(){ + local user="${1:-$(timeid)}" + shift 1 + + if LOCK "$user_db"; then + if grep -q "^${user} " "$user_db"; then + RELEASE "$user_db" + return 1 + fi + printf '%s \\ %s \\ \\ \\ %i \\ \\\n' \ + "$user" "pending" "$(( _DATE + USER_CONFIRMEXPIRE ))" >>"$user_db" + else + return 1 + fi + + if [ $# -eq 0 ]; then + RELEASE "$user_db" + return 0 + elif update_user "$user" "$@"; then + return 0 + else + RELEASE "$user_db" + return 1 + fi +} + +user_idmap(){ + local uid="$1" ret + eval "$LOCAL_USER" + + if [ ! "$USER_IDMAP" ]; then + while read_user; do + USER_IDMAP="${USER_IDMAP}${USER_ID} ${USER_NAME}${BR}" + done <"$user_db" + fi + if [ "$uid" -a "$USER_IDMAP" != "${USER_IDMAP##*${uid} }" ]; then + ret="${USER_IDMAP##*${uid} }"; ret="${ret%%${BR}*}"; + printf '%s\n' "$ret" + return 0 + elif [ "$uid" ]; then + return 1 + else + printf '%s' "$USER_IDMAP" + return 0 + fi +} + +user_idof(){ + local name="$(STRING "$1")" ret + [ "$USER_IDMAP" ] || user_idmap >/dev/null + + if [ "${name%\\}" -a "$USER_IDMAP" != "${USER_IDMAP% ${name}${BR}*}" ]; then + ret="${USER_IDMAP% ${name}${BR}*}"; ret="${ret##*${BR}}" + printf '%s\n' "$ret" + return 0 + else + return 1 + fi +} + +user_checkname(){ + { [ $# -gt 0 ] && printf %s "$*" || cat; } \ + | sed -nE ' + :X; $!{N;bX;} + s;[ \t\r\n]+; ;g; + s;^ ;;; s; $;;; + /@/d; + /^[a-zA-Z][a-zA-Z0-9 -~]{2,127}$/!d; + p; + ' +} + +user_checkemail(){ + { [ $# -gt 0 ] && printf %s "$*" || cat; } \ + | sed -nE ' + # W3C recommended email regex + # https://html.spec.whatwg.org/multipage/input.html#email-state-(type=email) + /^[a-zA-Z0-9.!#$%&'\''*+\/=?^_`{|}~-]+@[a-zA-Z0-9]([a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(\.[a-zA-Z0-9]([a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)*$/p; + ' +} + +user_nameexist(){ + local uname="$(STRING "$1")" + local UID_ UNAME STATUS EMAIL PWSALT PWHASH EXPIRE DEVICES FUTUREUSE + [ -f "$user_db" -a -r "$user_db" ] \ + && while read -r UID_ UNAME STATUS EMAIL PWSALT PWHASH EXPIRE DEVICES FUTUREUSE; do + [ "$EXPIRE" -gt "$_DATE" -a "$UNAME" = "$uname" ] && return 0 + done <"$user_db" + return 1 +} + +user_emailexist(){ + local email="$(STRING "$1")" + local UID_ UNAME STATUS EMAIL PWSALT PWHASH EXPIRE DEVICES FUTUREUSE + [ -f "$user_db" -a -r "$user_db" ] \ + && while read -r UID_ UNAME STATUS EMAIL PWSALT PWHASH EXPIRE DEVICES FUTUREUSE; do + [ "$EXPIRE" -gt "$_DATE" -a "$EMAIL" = "$email" ] && return 0 + done <"$user_db" + return 1 +} + +user_pwhash(){ + local salt="$1" secret="$2" hash + hash="$(printf '%s\n%s\n' "$secret" "$salt" |sha256sum)" + printf '%s\n' "${hash%% *}" +} + +user_register_email() { # TRANSLATION + "$SENDMAIL" -t -f "$MAILFROM" <<-EOF + From: ${MAILFROM} + To: ${email} + Subject: Your account registration at ${HTTP_HOST%:*} + + Someone tried to sign up for a user account using this email address. + + You can activate your account using this link: + + ${SCHEMA}://${HTTP_HOST}${_BASE}${PATH_INFO}?user_confirm=${uid}+$(session_mac "$uid") + + This registration link will expire after $((USER_CONFIRMEXPIRE / 3600)) hours. + + If you did not request an account at ${HTTP_HOST%:*}, then someone else + probably entered your email address by accident. In this case you shoud + simply ignore this message and we will remove your email address from + our database within the next day. + + This is an automatic email. Any direct reply will not be received. + Your Account Registration Robot. + EOF +} + +user_register(){ + # reserve account, send registration mail + # preliminary uid, expiration, signature + local uid="$(timeid)" + local uname="$(POST uname |user_checkname)" + local email="$(POST email |user_checkemail)" + local pwsalt="$(randomid)" + local pw="$(POST pw |grep -m1 -xE '.{6,}' )" pwconfirm="$(POST pwconfirm)" + + if [ "$USER_REGISTRATION" != true -a -s "$user_db" ]; then + REDIRECT "${_BASE}${PATH_INFO}#ERROR_REGISTRATION_DISABLED" + fi + + if [ "$USER_REQUIREEMAIL" = true ]; then + if [ ! "$email" ]; then + REDIRECT "${_BASE}${PATH_INFO}#ERROR_EMAIL_INVALID" + elif user_emailexist "$email"; then + REDIRECT "${_BASE}${PATH_INFO}#ERROR_EMAIL_EXISTS" + elif new_user "$uid" status=pending email="$email" expire="$((_DATE + USER_CONFIRMEXPIRE))"; then + debug "Sending Activation Link:" \ + "${SCHEMA}://${HTTP_HOST}${_BASE}${PATH_INFO}?user_confirm=${uid}+$(session_mac "$uid")" + user_register_email + REDIRECT "${_BASE}${PATH_INFO}#USER_REGISTER_CONFIRM" + else + REDIRECT "${_BASE}${PATH_INFO}#ERROR_USER_NOLOCK" + fi + + elif [ "$USER_REQUIREEMAIL" != true ]; then + if [ ! "$uname" ]; then + REDIRECT "${_BASE}${PATH_INFO}#ERROR_UNAME_INVALID" + elif user_nameexist "$uname"; then + REDIRECT "${_BASE}${PATH_INFO}#ERROR_UNAME_EXISTS" + elif [ ! "$pw" ]; then + REDIRECT "${_BASE}${PATH_INFO}#ERROR_PW_EMPTYTOOSHORT" + elif [ "$pw" != "$pwconfirm" ]; then + REDIRECT "${_BASE}${PATH_INFO}#ERROR_PW_MISMATCH" + elif new_user "$uid" uname="$uname" status=active email="$email" password="$pw" expire="$((_DATE + USER_ACCOUNTEXPIRE))"; then + SESSION_COOKIE new + SESSION_BIND user_id "$uid" + + if [ "$USER_ACCOUNTPAGE" ]; then + REDIRECT "${USER_ACCOUNTPAGE}" + else + REDIRECT "${_BASE}${PATH_INFO}#USER_REGISTER_CONFIRM" + fi + else + REDIRECT "${_BASE}${PATH_INFO}#ERROR_USER_NOLOCK" + fi + fi +} + +user_invite_email(){ # TRANSLATION + "$SENDMAIL" -t -f "$MAILFROM" <<-EOF + From: ${MAILFROM} + To: ${email} + Subject: You have been invited to ${HTTP_HOST%:*} + + ${USER_NAME:-Someone} has offered an invitation to this email address. + + ${message} + + You can create your account using this link: + + ${SCHEMA}://${HTTP_HOST}${_BASE}${PATH_INFO}?user_confirm=${uid}+$(session_mac "$uid") + + This registration link will expire after $((USER_CONFIRMEXPIRE / 3600)) hours. + + If you do not know what this is about, then someone else probably + entered your email address by accident. In this case you shoud + simply ignore this message and we will remove your email address from + our database within the next day. + + This is an automatic email. Any direct reply will not be received. + Your Account Registration Robot. + EOF +} + +user_invite(){ + local uid="$(timeid)" + local email="$(POST email |user_checkemail)" + local message="$(POST message)" + + if [ ! "$email" ]; then + REDIRECT "${_BASE}${PATH_INFO}#ERROR_EMAIL_INVALID" + elif user_emailexist "$email"; then + REDIRECT "${_BASE}${PATH_INFO}#ERROR_EMAIL_EXISTS" + elif new_user "$uid" status=pending email="$email" expire="$((_DATE + USER_CONFIRMEXPIRE))"; then + debug "Sending Invitation Link:" \ + "${SCHEMA}://${HTTP_HOST}${_BASE}${PATH_INFO}?user_confirm=${uid}+$(session_mac "$uid")" + user_invite_email + REDIRECT "${_BASE}${PATH_INFO}#USER_REGISTER_CONFIRM" + else + REDIRECT "${_BASE}${PATH_INFO}#ERROR_USER_NOLOCK" + fi +} + +user_confirm(){ + # enable account + eval "$LOCAL_USER" + local uid="$(POST uid |checkid || printf invalid)" + local signature="$(POST signature)" + local uname="$(POST uname |user_checkname)" + local pwsalt="$(randomid)" + local pw="$(POST pw |grep -m1 -xE '.{6,}' )" pwconfirm="$(POST pwconfirm)" + + read_user "${uid}" + + if [ "$signature" != "$(session_mac "$uid")" ]; then + REDIRECT "${_BASE}${PATH_INFO}?${QUERY_STRING}#ERROR_LINK_INVALID" + elif [ ! "$uname" ]; then + REDIRECT "${_BASE}${PATH_INFO}?${QUERY_STRING}#ERROR_UNAME_INVALID" + elif user_nameexist "$uname"; then + REDIRECT "${_BASE}${PATH_INFO}?${QUERY_STRING}#ERROR_UNAME_EXISTS" + elif [ ! "$pw" ]; then + REDIRECT "${_BASE}${PATH_INFO}?${QUERY_STRING}#ERROR_PW_EMPTYTOOSHORT" + elif [ "$pw" != "$pwconfirm" ]; then + REDIRECT "${_BASE}${PATH_INFO}?${QUERY_STRING}#ERROR_PW_MISMATCH" + elif [ "$USER_STATUS" != pending -o \! "$USER_EXPIRE" -gt "$_DATE" ]; then + REDIRECT "${_BASE}${PATH_INFO}?${QUERY_STRING}#ERROR_LINK_INVALID" + elif update_user "$USER_ID" uname="$uname" status=active password="$pw"; then + SESSION_COOKIE new + SESSION_BIND user_id "$USER_ID" + if [ "$USER_ACCOUNTPAGE" ]; then + REDIRECT "${USER_ACCOUNTPAGE}" + else + REDIRECT "${_BASE}${PATH_INFO}?user_register=confirm#USER_REGISTER_CONFIRM" + fi + else + REDIRECT "${_BASE}${PATH_INFO}#ERROR_USER_NOLOCK" + fi +} + +user_login(){ + # set cookie + # keep logged in - device cookie? + # initialize new session! + local UID_ UNAME STATUS EMAIL PWSALT PWHASH EXPIRE DEVICES FUTUREUSE + local uname="$(POST uname |STRING)" pw="$(POST pw)" + + [ -f "$user_db" -a -r "$user_db" ] \ + && while read -r UID_ UNAME STATUS EMAIL PWSALT PWHASH EXPIRE DEVICES FUTUREUSE; do + if [ "$UNAME" = "$uname" -o "$EMAIL" = "$uname" ]; then + if [ "$STATUS" = active -a "$EXPIRE" -gt "$_DATE" -a "$PWHASH" = "$(user_pwhash "$PWSALT" "$pw")" ]; then + SESSION_COOKIE new + SESSION_BIND user_id "$UID_" + REDIRECT "${_BASE}${PATH_INFO}#USER_LOGGED_IN" + fi + fi + done <"$user_db" + REDIRECT "${_BASE}${PATH_INFO}#ERROR_INVALID_LOGIN" +} + +user_logout(){ + # destroy cookie, destroy session + # keep device cookie + new_session + SESSION_COOKIE new + SET_COOKIE 0 user_id="" Path="/${_BASE#/}" SameSite=Strict HttpOnly + REDIRECT "${_BASE}${PATH_INFO}#USER_LOGGED_OUT" +} + +user_update(){ + # todo: username update, email update / email confirm + local UID_ UNAME STATUS EMAIL PWSALT PWHASH EXPIRE DEVICES FUTUREUSE + # local uname="$(POST uname |STRING)" + local uid oldpw pw pwconfirm + + uid="$(POST uid)" + oldpw="$(POST oldpw)" + pw="$(POST pw |grep -m1 -xE '.{6,}')" + pwconfirm="$(POST pwconfirm)" + + + read -r UID_ UNAME STATUS EMAIL PWSALT PWHASH EXPIRE DEVICES FUTUREUSE <<-EOF + $(grep "^${uid} " "$user_db") + EOF + + if [ "$UID_" = "$USER_ID" -a "$PWHASH" = "$(user_pwhash "$PWSALT" "$oldpw")" ]; then + if [ "$pw" -a "$pw" = "$pwconfirm" ]; then + update_user "${uid}" password="$pw" + REDIRECT "${_BASE}${PATH_INFO}#UPDATE_SUCCESS" + else + REDIRECT "${_BASE}${PATH_INFO}#ERROR_PW_MISMATCH" + fi + elif [ "$UID_" = "$USER_ID" ]; then + REDIRECT "${_BASE}${PATH_INFO}#ERROR_INVALID_AUTH_PASSWORD" + else + REDIRECT "${_BASE}${PATH_INFO}#ERROR_NOTLOGGEDIN" + fi +} + +user_recover(){ + # send recover link + : +} +user_disable(){ + : +} + +read_user "$(SESSION_VAR user_id)" +[ "$USER_STATUS" -a "$USER_STATUS" != active ] && eval $UNSET_USER + +[ "$REQUEST_METHOD" = POST ] && case "$(POST action)" in + user_register) user_register ;; + user_confirm) user_confirm ;; + user_invite) user_invite ;; + user_login) user_login ;; + user_logout) user_logout ;; + user_update) user_update ;; + user_recover) + :;; + user_disable) + :;; +esac + +export USER_ID USER_NAME USER_STATUS USER_EMAIL USER_PWSALT USER_PWHASH \ + USER_EXPIRE USER_DEVICES USER_FUTUREUSE + + +w_user_update(){ + if [ ! "$USER_ID" ]; then + cat <<-EOF + [div #user_update .nouser + This page can only be used by registered users + ] + EOF + else + cat <<-EOF + [form #user_update method=POST + [hidden "uid" "$USER_ID"] + [p .username Logged in as $USER_NAME] + [input type=password name=oldpw placeholder="Current Passphrase"] + [input type=password name=pw placeholder="New Passphrase" pattern=".{6,}"] + [input type=password name=pwconfirm placeholder="Confirm New Passphrase" pattern=".{6,}"] + [submit "action" "user_update" Update Passphrase] + ] + EOF + fi +} + +w_user_register_disabled(){ # TRANSLATION + cat <<-EOF + [div #user_register .disabled + User Registration is disabled. + ] + EOF +} +w_user_register_sendmail(){ # TRANSLATION + cat <<-EOF + [form #user_register .registeremail method=POST + [p We will send an activation mail to your email address. + You can continue the signup process when you click on the + activation link in this email.] + [input type=email name=email placeholder="Email"] + [submit "action" "user_register" Sign Up] + ] + EOF +} +w_user_register_direct(){ # TRANSLATION + cat <<-EOF + [form #user_register .registername method=POST + [input name=uname placeholder="Choose Username" tooltip="Your username may contain any character but the @ sign. It must be at least 3 characters long, and it must start with a letter." pattern="^\[\\\\p{L}\]\[\\\\p{L}0-9 -~\]{2,127}$" autocomplete=off] + [input type=password name=pw placeholder="Choose Passphrase" pattern=".{6,}"] + [input type=password name=pwconfirm placeholder="Confirm Passphrase" pattern=".{6,}"] + [submit "action" "user_register" Sign Up] + ] + EOF +} + +w_user_register(){ + if [ "$(GET user_confirm)" ]; then + w_user_confirm + elif [ "$USER_REGISTRATION" != true -a -s "$user_db" ]; then + w_user_register_disabled + elif [ "$USER_REQUIREEMAIL" = true ]; then + w_user_register_sendmail + elif [ "$USER_REQUIREEMAIL" != true ]; then + w_user_register_direct + fi +} + +w_user_confirm_proceed(){ # TRANSLATION + cat <<-EOF + [form #user_confirm method=POST + [input type=hidden name=uid value="${uid}"] + [input type=hidden name=signature value="${signature}"] + $([ "$EMAIL" != '\' ] && printf \ + '[input disabled=disabled value="%s" placeholder="Email"]' "$(UNSTRING "$EMAIL" |HTML)" + ) + [input name=uname placeholder="Choose Username" tooltip="Your username may contain any character but the @ sign. It must be at least 3 characters long, and it must start with a letter." pattern="^\[\\\\p{L}\]\[\\\\p{L}0-9 -~\]{2,127}$" autocomplete=off] + [input type=password name=pw placeholder="Choose Passphrase" pattern=".{6,}"] + [input type=password name=pwconfirm placeholder="Confirm Passphrase" pattern=".{6,}"] + [submit "action" "user_confirm" Finish Registration] + ] + EOF +} +w_user_confirm_expired(){ # TRANSLATION + cat <<-EOF + [div #user_confirm .expired + [p This activation link is not valid anymore.] + ] + EOF +} +w_user_confirm_invalid(){ # TRANSLATION + cat <<-EOF + [div #user_confirm .invalid + [p This activation link is invalid. Make sure you copied the whole activation link from your email and be careful not to include any line breaks.] + ] + EOF +} + +w_user_confirm(){ + local UID_ UNAME STATUS EMAIL PWSALT PWHASH EXPIRE DEVICES FUTUREUSE + local user_confirm="$(GET user_confirm)" + local uid="${user_confirm% *}" signature="${user_confirm#* }" + + if [ "$signature" = "$(session_mac "$uid")" ]; then + read -r UID_ UNAME STATUS EMAIL PWSALT PWHASH EXPIRE DEVICES FUTUREUSE <<-EOF + $(grep "^${uid} " "$user_db") + EOF + if [ "$STATUS" = pending -a "$EXPIRE" -gt "$_DATE" ]; then + w_user_confirm_proceed + else + w_user_confirm_expired + fi + else + w_user_confirm_invalid + fi +} + +w_user_invite_email(){ # TRANSLATION + cat <<-EOF + [form #user_invite method=POST + [input placeholder="Email Recipient" name=email autocomplete=off] + [textarea name="message" placeholder="Message to recipient" . ] + [submit "action" "user_invite" Send Invitation] + ] + EOF +} +w_user_invite_link(){ # TRANSLATION + cat <<-EOF + [div #user_invite .link + [p An anonymous user account has been set up. Send the following link to the intended user, so they may claim their account. The link will remain valid for $((USER_CONFIRMEXPIRE / 3600)) hours.] + [a href="$(HTML "$invlink")" . $(HTML "$invlink")] + + [p [a href="#" . Set up another account]] + ] + EOF +} +w_user_invite_deny(){ # TRANSLATION + cat <<-EOF + [div #user_invite .notallowed + Only registered users may send an invitation to another user. + ] + EOF +} + +w_user_invite(){ + local uid invlink + + if [ "$(GET user_confirm)" ]; then + w_user_confirm + elif [ "$USER_ID" -a "$USER_REQUIREEMAIL" = true ]; then + w_user_invite_email + elif [ "$USER_ID" ]; then + uid="$(timeid)" + new_user "$uid" status=pending expire="$((_DATE + USER_CONFIRMEXPIRE))" + invlink="${SCHEMA}://${HTTP_HOST}${_BASE}${PATH_INFO}?user_confirm=${uid}+$(session_mac "$uid")" + debug "New Invitation Link: $invlink" + w_user_invite_link + else + w_user_invite_deny + fi +} + +w_user_login_logon(){ # TRANSLATION + cat <<-EOF + [form #user_login .login method=POST + [input name=uname placeholder="Username or Email"] + [input type=password name=pw placeholder="Passphrase"] + [submit "action" "user_login" Login] + ] + EOF +} +w_user_login_logoff(){ # TRANSLATION + cat <<-EOF + [form #user_login .logout method=POST + [p Logged in as [span . $(HTML ${USER_NAME})]] + [submit "action" "user_logout" Logout] + ] + EOF +} + +w_user_login(){ + if [ ! "$USER_ID" ]; then + w_user_login_logon + elif [ "$USER_ID" ]; then + w_user_login_logoff + fi +}