3 # Copyright 2017 - 2018 Paul Hänsch
6 # A collection of posix shell functions for writing CGI scripts.
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.
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.
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/>.
21 # ksh and zsh workaround
22 # set -o posix # ksh, not portable
23 setopt -o OCTAL_ZEROES 2>&-
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;'
36 eval "printf %s \"\$HTTP_$(printf %s "${1}" |tr a-z A-Z |tr -c A-Z _)\""
41 s;\\;\\\\;g; :HEXDECODE_X; s;%([^0-9A-F]);\\045\1;g; tHEXDECODE_X;
42 # Hexadecimal { %00 - %FF } will be transformed to octal { \000 - \377 } for posix printf
43 s;%[0123].;&\\0;g; s;%[4567].;&\\1;g; s;%[89AB].;&\\2;g; s;%[CDEF].;&\\3;g;
44 s;%[048C][0-7]\\.;&0;g; s;%[048C][89A-F]\\.;&1;g; s;%[159D][0-7]\\.;&2;g; s;%[159D][89A-F]\\.;&3;g;
45 s;%[26AE][0-7]\\.;&4;g; s;%[26AE][89A-F]\\.;&5;g; s;%[37BF][0-7]\\.;&6;g; s;%[37BF][89A-F]\\.;&7;g;
46 s;%.[08](\\..);\10;g; s;%.[19](\\..);\11;g; s;%.[2A](\\..);\12;g; s;%.[3B](\\..);\13;g;
47 s;%.[4C](\\..);\14;g; s;%.[5D](\\..);\15;g; s;%.[6E](\\..);\16;g; s;%.[7F](\\..);\17;g;
51 printf "$(printf %s "$1" |sed -r "$HEX_DECODE")"
54 if [ -z "$REQUEST_METHOD" ]; then
55 # no webserver variables means we are running via inetd / ncat
56 # so use builtin web server
58 # Use env from inetd as webserver variables
59 REMOTE_ADDR="${TCPREMOTEIP}"
60 SERVER_NAME="${TCPLOCALIP}"
61 SERVER_PORT="${TCPLOCALPORT}"
63 # Wait 2 seconds for request or kill connection through watchdog.
64 # Once Request is received the watchdog will be suspended (killed).
65 # At the end of the loop the watchdog will be restarted to enable
66 # timeout for the subsequent request.
68 (sleep $cgilite_timeout && kill $$) & cgilite_watchdog=$!
69 while read REQUEST_METHOD REQUEST_URI SERVER_PROTOCOL; do
70 kill $cgilite_watchdog
71 PATH_INFO="$(HEX_DECODE "${REQUEST_URI%\?*}")"
72 QUERY_STRING="${REQUEST_URI#*\?}"
73 cgilite_headers="$(sed -u '/^\r\?$/q')"
75 HTTP_CONTENT_LENGTH="$(HEADER Content-Length |grep -xE '[0-9]+')"
77 export REMOTE_ADDR SERVER_NAME SERVER_PORT REQUEST_METHOD REQUEST_URI SERVER_PROTOCOL \
78 PATH_INFO QUERY_STRING HTTP_CONTENT_LENGTH
80 # Try to serve multiple requests, provided that script serves a
81 # Content-Length header.
82 # Without Content-Length header, connection will terminate after
85 cgilite_status='200 OK'; cgilite_response=''; cgilite_cl="Connection: close${CR}";
86 . "$0" | while read -r l; do case $l in
87 Status:*) cgilite_status="${l#Status: }";;
88 Content-Length:*) cgilite_cl="${l}";;
89 $CR) printf '%s %s\r\n%s\n%s\n\r\n' \
90 'HTTP/1.1' "${cgilite_status%${CR}}" \
91 "$cgilite_response" "${cgilite_cl}"
93 [ "${cgilite_cl#Connection}" = "${cgilite_cl}" ]; exit;;
94 *) cgilite_response="$cgilite_response${BR}$l";;
96 (sleep $cgilite_timeout && kill $$) & cgilite_watchdog=$!
100 if [ "$REQUEST_METHOD" = POST -a "${HTTP_CONTENT_LENGTH:=${CONTENT_LENGTH:=0}}" -gt 0 ]; then
101 cgilite_post="$(head -c "$HTTP_CONTENT_LENGTH")"
104 [ -n "${DEBUG+x}" ] && env
108 | grep -oE '&'"$2"'=[^&]*' \
113 local str="&$1" name="$2" cnt="${3:-1}"
114 while [ $cnt -gt 0 ]; do
115 str=${str#*&${name}=}
118 printf "$(printf %s "${str%%&*}" |sed -r 's;\+; ;g;'"$HEX_DECODE")"
121 GET(){ cgilite_value "${QUERY_STRING}" $@; }
122 GET_COUNT(){ cgilite_count "${QUERY_STRING}" $1; }
124 POST(){ cgilite_value "${cgilite_post}" $@; }
125 POST_COUNT(){ cgilite_count "${cgilite_post}" $1; }
127 REF(){ cgilite_value "${HTTP_REFERER#*\?}" $@; }
128 REF_COUNT(){ cgilite_count "${HTTP_REFERER#*\?}" $1; }
133 | grep -oE '(^|; ?)'"$1"'=[^;]*' \
134 | sed -rn "${2:-1}"'{s;^[^=]+=;;; s;\+; ;g; p;}'
140 # Prints UTF-8 string as decimal Unicode Code Points
141 # Useful for escaping user input for use in HTML text and attributes
142 { [ $# -eq 0 ] && cat || printf %s "$*"; } \
143 | hexdump -ve '/1 "%03o\n"' \
146 # bitbanging octal UTF-8 chains into singular 7 digit octal numbers
147 [01]??) printf '0000%s' $n;; # 7 bit ASCII character, nothing to do
148 2??) printf '%s' ${n#2};; # tail fragment, append 6 bit
149 3[0123]?) printf '000%s' ${n#3};; # 2 octet (11 bit) chain start
150 34?) printf '00%s' ${n#34};; # 3 octet (16 bit) chain start
151 35?) printf '01%s' ${n#35};; # 3 octet chain start, high
152 36?) printf '%s' ${n#36};; # 4 octet (21 bit) chain start
155 | sed -r 's;.{7};&\n;g;' \
157 printf '&#%d;' $((0$n))
162 # Code every character in URL escape hex format
163 # except alphanumeric ascii
165 { [ $# -eq 0 ] && cat || printf %s "$*"; } \
166 | hexdump -v -e '/1 ",%02X"' \
167 | sed 's;,;%;g; s;%2F;/;g;'
171 { [ $# -eq 0 ] && cat || printf %s "$*"; } \
172 | sed -r 's;^.*$;/&/;; s;/+;/;g;
174 s;^/\.\./;/;; s;/\./;/;g;
185 ''|0|session) expire='';;
186 [+-][0-9]*) expire="$(date -R -d @$(($(date +%s) + $1)))";;
187 *) expire="$(date -R -d "$1")";;
191 printf 'Set-Cookie: %s' "$cookie"
192 [ -n "$expire" ] && printf '; Expires=%s' "${expire%+????}${expire:+GMT}"
193 [ $# -ge 3 ] && shift 2 && printf '; %s' "$@"
198 printf '%s: %s\r\n' \
199 Status "303 See Other" \