git.plutz.net Git - cgilite/blob - cgilite.sh

   1 #!/bin/sh
   2
   3 # Copyright 2017 - 2018 Paul Hänsch
   4 #
   5 # This is CGIlite.
   6 # A collection of posix shell functions for writing CGI scripts.
   7 #
   8 # CGIlite is free software: you can redistribute it and/or modify
   9 # it under the terms of the GNU Affero General Public License as published by
  10 # the Free Software Foundation, either version 3 of the License, or
  11 # (at your option) any later version.
  12 #
  13 # CGIlite is distributed in the hope that it will be useful,
  14 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  15 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16 # GNU Affero General Public License for more details.
  17 #
  18 # You should have received a copy of the GNU Affero General Public License
  19 # along with CGIlite.  If not, see <http://www.gnu.org/licenses/>.
  20
  21 # ksh and zsh workaround
  22 # set -o posix # ksh, not portable
  23 setopt -o OCTAL_ZEROES 2>&-
  24
  25 BR="$(printf '\n')"
  26 CR="$(printf '\r')"
  27 cgilite_timeout=2
  28
  29 HEADER(){
  30   # Read value of header line. Use this instead of
  31   # referencing HTTP_* environment variables.
  32   if [ -n "${cgilite_headers+x}" ]; then
  33     printf %s "$cgilite_headers" \
  34     | sed -rn 's;^'"${1}"': ([^\r]+)\r?$;\1;i; tX; d; :X;p;q;'
  35   else
  36     eval "printf %s \"\$HTTP_$(printf %s "${1}" |tr a-z A-Z |tr -c A-Z _)\""
  37   fi
  38 }
  39
  40 HEX_DECODE(){
  41   printf "$(printf %s "$1" \
  42   | sed -r '
  43     s;\\;\\\\;g; :x; s;%([^0-9A-F]);\\045\1;g; tx;
  44     # Hexadecimal { %00 - %FF } will be transformed to octal { \000 - \377 } for posix printf
  45     s;%[0123].;&\\0;g; s;%[4567].;&\\1;g; s;%[89AB].;&\\2;g; s;%[CDEF].;&\\3;g;
  46     s;%[048C][0-7]\\.;&0;g; s;%[048C][89A-F]\\.;&1;g; s;%[159D][0-7]\\.;&2;g; s;%[159D][89A-F]\\.;&3;g;
  47     s;%[26AE][0-7]\\.;&4;g; s;%[26AE][89A-F]\\.;&5;g; s;%[37BF][0-7]\\.;&6;g; s;%[37BF][89A-F]\\.;&7;g;
  48     s;%.[08](\\..);\10;g; s;%.[19](\\..);\11;g; s;%.[2A](\\..);\12;g; s;%.[3B](\\..);\13;g;
  49     s;%.[4C](\\..);\14;g; s;%.[5D](\\..);\15;g; s;%.[6E](\\..);\16;g; s;%.[7F](\\..);\17;g;
  50   ')"
  51 }
  52
  53 if [ -z "$REQUEST_METHOD" -a -z "$SERVER_PROTOCOL" ]; then
  54   # no webserver variables means we are running via inetd / ncat
  55   # so use builtin web server
  56
  57   # Use env from inetd as webserver variables
  58   REMOTE_ADDR="${TCPREMOTEIP}"
  59   SERVER_NAME="${TCPLOCALIP}"
  60   SERVER_PORT="${TCPLOCALPORT}"
  61
  62   # Wait 2 seconds for request or kill connection through watchdog.
  63   # Once Request is received the watchdog will be suspended (killed).
  64   # At the end of the loop the watchdog will be restarted to enable
  65   # timeout for the subsequent request.
  66
  67   (sleep $cgilite_timeout && kill $$) & cgilite_watchdog=$!
  68   while read REQUEST_METHOD REQUEST_URI SERVER_PROTOCOL; do
  69     kill $cgilite_watchdog
  70     PATH_INFO="$(HEX_DECODE "${REQUEST_URI%\?*}")"
  71     QUERY_STRING="${REQUEST_URI#*\?}"
  72     cgilite_headers="$(sed -u '/^\r\?$/q')"
  73
  74     HTTP_CONTENT_LENGTH="$(HEADER Content-Length |grep -xE '[0-9]+')"
  75
  76     export REMOTE_ADDR SERVER_NAME SERVER_PORT REQUEST_METHOD REQUEST_URI SERVER_PROTOCOL \
  77            PATH_INFO QUERY_STRING HTTP_CONTENT_LENGTH
  78
  79     # Try to serve multiple requests, provided that script serves a
  80     # Content-Length header.
  81     # Without Content-Length header, connection will terminate after
  82     # script.
  83
  84     . "$0" |sed '1{s;^Status: ;HTTP/1.1 ;; t; s;^;HTTP/1.1 200 OK\r\n;;}' \
  85     | while read -r l; do case $l in
  86       Content-Length:*) printf '%s\n' "$l"; cat;;
  87       $CR) printf 'Connection: close\r\n\r\n'; cat; exit 1;;
  88       *) printf '%s\n' "$l";;
  89     esac; done || exit 0;
  90     (sleep $cgilite_timeout && kill $$) & cgilite_watchdog=$!
  91   done
  92 fi
  93
  94 if [ "$REQUEST_METHOD" = POST -a "${HTTP_CONTENT_LENGTH:=${CONTENT_LENGTH:=0}}" -gt 0 ]; then
  95   cgilite_post="$(head -c "$HTTP_CONTENT_LENGTH")"
  96 fi
  97
  98 [ -n "${DEBUG+x}" ] && env
  99
 100 cgilite_count(){
 101   case $1 in
 102     GET)  printf %s "&${QUERY_STRING}";;
 103     POST) printf %s "&${cgilite_post}";;
 104     REF)  printf %s "&${HTTP_REFERER#*\?}";;
 105   esac \
 106   | grep -Eo '&'"$2"'=[^&]*' \
 107   | wc -l
 108 }
 109
 110 cgilite_value(){
 111   HEX_DECODE "$(
 112     case $1 in
 113       GET)  printf %s "&${QUERY_STRING}";;
 114       POST) printf %s "&${cgilite_post}";;
 115       REF)  printf %s "&${HTTP_REFERER#*\?}";;
 116     esac \
 117     | grep -Eo '&'"$2"'=[^&]*' \
 118     | sed -rn "${3:-1}"'{s;^[^=]+=;;; s;\+; ;g; p;}'
 119   )"
 120 }
 121
 122 GET(){ cgilite_value GET $@; }
 123 GET_COUNT(){ cgilite_count GET $1; }
 124
 125 POST(){ cgilite_value POST $@; }
 126 POST_COUNT(){ cgilite_count POST $1; }
 127
 128 REF(){ cgilite_value REF $@; }
 129 REF_COUNT(){ cgilite_count REF $1; }
 130
 131 COOKIE(){
 132   HEX_DECODE "$(
 133     HEADER Cookie \
 134     | grep -oE '(^|; ?)'"$1"'=[^;]*' \
 135     | sed -rn "${2:-1}"'{s;^[^=]+=;;; s;\+; ;g; p;}'
 136   )"
 137 }
 138
 139 HTML(){
 140   # HTML Entity Coding
 141   # Prints UTF-8 string as decimal Unicode Code Points
 142   # Useful for escaping user input for use in HTML text and attributes
 143   printf %s "$*" \
 144   | hexdump -ve '/1 "%03o\n"' \
 145   | while read n; do
 146     case $n in
 147       # bitbanging octal UTF-8 chains into singular 7 digit octal numbers
 148       [01]??) printf '0000%s' $n;; # 7 bit ASCII character, nothing to do
 149       2??)    printf '%s' ${n#2};; # tail fragment, append 6 bit
 150       3[0123]?) printf '000%s' ${n#3};; # 2 octet (11 bit) chain start
 151       34?) printf '00%s' ${n#34};; # 3 octet (16 bit) chain start
 152       35?) printf '01%s' ${n#35};; # 3 octet chain start, high
 153       36?) printf '%s' ${n#36};;   # 4 octet (21 bit) chain start
 154     esac
 155   done \
 156   | sed -r 's;.{7};&\n;g;' \
 157   | while read n; do
 158     printf '&#%d;' $((0$n))
 159   done
 160 }
 161
 162 URL(){
 163   # Code every character in URL escape hex format
 164   # except alphanumeric ascii
 165
 166   printf %s "$*" \
 167   | hexdump -v -e '/1 ",%02X"' \
 168   | tr , %
 169 }
 170
 171 SET_COOKIE(){
 172   case "$1" in
 173     ''|0|session) expire='';;
 174     [+-][0-9]*)   expire="$(date -R -d @$(($(date +%s) + $1)))";;
 175     *)            expire="$(date -R -d "$1")";;
 176   esac
 177   cookie="$2"
 178
 179   printf 'Set-Cookie: %s' "$cookie"
 180   [ -n "$expire" ] && printf '; Expires=%s' "$expire"
 181   [ $# -ge 3 ] && shift 2 && printf '; %s' "$@"
 182   printf '\r\n'
 183 }
 184
 185 REDIRECT(){
 186   printf 'Status: 303 See Other\r\nLocation: %s\r\n\r\n' "$*"
 187   exit 0
 188 }
 189