3 # Copyright 2017 - 2020 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>&-
32 [ $# -eq 0 ] && str="$(cat)" || str="$*"
34 seg=${str%%/*}; str="${str#*/}"
36 ..) out="${out%/}"; out="${out%/*}/";;
37 .|'') out="${out%/}/";;
38 *) out="${out%/}/${seg}";;
40 [ "$seg" = "$str" ] && break
42 [ "${str}" -a "${out}" ] && printf %s "$out" || printf %s/ "${out%/}"
46 s;\\;\\\\;g; :HEXDECODE_X; s;%([^0-9A-F]);\\045\1;g; tHEXDECODE_X;
47 # Hexadecimal { %00 - %FF } will be transformed to octal { \000 - \377 } for posix printf
48 s;%[0123].;&\\0;g; s;%[4567].;&\\1;g; s;%[89AB].;&\\2;g; s;%[CDEF].;&\\3;g;
49 s;%[048C][0-7]\\.;&0;g; s;%[048C][89A-F]\\.;&1;g; s;%[159D][0-7]\\.;&2;g; s;%[159D][89A-F]\\.;&3;g;
50 s;%[26AE][0-7]\\.;&4;g; s;%[26AE][89A-F]\\.;&5;g; s;%[37BF][0-7]\\.;&6;g; s;%[37BF][89A-F]\\.;&7;g;
51 s;%.[08](\\..);\10;g; s;%.[19](\\..);\11;g; s;%.[2A](\\..);\12;g; s;%.[3B](\\..);\13;g;
52 s;%.[4C](\\..);\14;g; s;%.[5D](\\..);\15;g; s;%.[6E](\\..);\16;g; s;%.[7F](\\..);\17;g;
56 printf -- "$(printf %s "$1" |sed -E "$HEX_DECODE")"
59 if [ -z "$REQUEST_METHOD" ]; then
60 # no webserver variables means we are running via inetd / ncat
61 # so use builtin web server
63 # Use env from inetd as webserver variables
64 REMOTE_ADDR="${TCPREMOTEIP}"
65 SERVER_NAME="${TCPLOCALIP}"
66 SERVER_PORT="${TCPLOCALPORT}"
68 # Wait 2 seconds for request or kill connection through watchdog.
69 # Once Request is received the watchdog will be suspended (killed).
70 # At the end of the loop the watchdog will be restarted to enable
71 # timeout for the subsequent request.
73 (sleep $cgilite_timeout && kill $$) & cgilite_watchdog=$!
74 while read REQUEST_METHOD REQUEST_URI SERVER_PROTOCOL; do
75 [ "${SERVER_PROTOCOL#HTTP/1.[01]${CR}}" ] && break
76 kill $cgilite_watchdog
78 SERVER_PROTOCOL="${SERVER_PROTOCOL%${CR}}"
79 PATH_INFO="$(HEX_DECODE "${REQUEST_URI%\?*}" |PATH)"
80 [ "${REQUEST_URI}" = "${REQUEST_URI#*\?}" ] \
82 || QUERY_STRING="${REQUEST_URI#*\?}"
83 cgilite_headers=''; while read -r hl; do
84 hl="${hl%${CR}}"; [ "$hl" ] || break
86 'Content-Length: '*) CONTENT_LENGTH="${hl#*: }";;
87 'Content-Type: '*) CONTENT_TYPE="${hl#*: }";;
89 cgilite_headers="${cgilite_headers}${hl}${BR}"
92 export REMOTE_ADDR SERVER_NAME SERVER_PORT REQUEST_METHOD REQUEST_URI SERVER_PROTOCOL \
93 PATH_INFO QUERY_STRING CONTENT_TYPE CONTENT_LENGTH
95 # Try to serve multiple requests, provided that script serves a
96 # Content-Length header.
97 # Without Content-Length header, connection will terminate after
100 cgilite_status='200 OK'; cgilite_response=''; cgilite_cl="Connection: close${CR}${BR}";
101 . "$0" | while read -r l; do case $l in
103 cgilite_status="${l#Status: }";;
106 cgilite_response="${cgilite_response:+${cgilite_response}${BR}}${l}";;
108 cgilite_cl="${l}${BR}";;
109 $CR) printf '%s %s\r\n%s%s\r\n' \
110 'HTTP/1.1' "${cgilite_status%${CR}}" \
111 "${cgilite_response}${cgilite_response:+${BR}}" "${cgilite_cl}"
113 [ "${cgilite_cl#Connection}" = "${cgilite_cl}" ]; exit;;
114 *) cgilite_response="${cgilite_response:+${cgilite_response}${BR}}${l}";;
115 esac; done || exit 0;
116 (sleep $cgilite_timeout && kill $$) & cgilite_watchdog=$!
118 kill $cgilite_watchdog
122 if [ "${REQUEST_METHOD}" = POST -a "${CONTENT_LENGTH:-0}" -gt 0 -a \
123 "${CONTENT_TYPE}" = "application/x-www-form-urlencoded" ]; then
124 cgilite_post="$(head -c "$CONTENT_LENGTH")"
127 [ "${DEBUG+x}" ] && env >&2
131 | grep -oE '&'"$2"'=[^&]*' \
136 local str="&$1" name="$2" cnt="${3:-1}"
137 while [ $cnt -gt 0 ]; do
138 [ "${str}" = "${str#*&${name}=}" ] && return 1
139 str="${str#*&${name}=}"
142 printf -- "$(printf %s "${str%%&*}" |sed -E 's;\+; ;g;'"$HEX_DECODE")"
147 while [ "${str#*&}" != "${str}" ]; do
149 printf '%s\n' "${str%%=*}"
154 GET(){ cgilite_value "${QUERY_STRING}" $@; }
155 GET_COUNT(){ cgilite_count "${QUERY_STRING}" $1; }
156 GET_KEYS(){ cgilite_keys "${QUERY_STRING}"; }
158 POST(){ cgilite_value "${cgilite_post}" $@; }
159 POST_COUNT(){ cgilite_count "${cgilite_post}" $1; }
160 POST_KEYS(){ cgilite_keys "${cgilite_post}"; }
162 REF(){ cgilite_value "${HTTP_REFERER#*\?}" $@; }
163 REF_COUNT(){ cgilite_count "${HTTP_REFERER#*\?}" $1; }
164 REF_KEYS(){ cgilite_keys "${HTTP_REFERER#*\?}"; }
167 # Read value of header line. Use this instead of
168 # referencing HTTP_* environment variables.
169 if [ -n "${cgilite_headers+x}" ]; then
170 local str="${BR}${cgilite_headers}"
171 [ "${str}" = "${str#*${BR}${1}: }" ] && return 1
172 str="${str#*${BR}${1}: }"
173 printf %s "${str%%${BR}*}"
175 local var="HTTP_$(printf %s "$1" |tr a-z- A-Z-)"
176 eval "[ \"\$$var\" ] && printf %s \"\$$var\" || return 1"
177 # eval "printf %s \"\$HTTP_$(printf %s "${1}" |tr a-z A-Z |tr -c A-Z _)\""
184 | grep -oE '(^|; ?)'"$1"'=[^;]*' \
185 | sed -En "${2:-1}"'{s;^[^=]+=;;; s;\+; ;g; p;}'
191 # Prints UTF-8 string as decimal Unicode Code Points
192 # Useful for escaping user input for use in HTML text and attributes
193 { [ $# -eq 0 ] && cat || printf %s "$*"; } \
194 | hexdump -ve '/1 "%03o\n"' \
197 # bitbanging octal UTF-8 chains into singular 7 digit octal numbers
198 [01]??) printf '0000%s' $n;; # 7 bit ASCII character, nothing to do
199 2??) printf '%s' ${n#2};; # tail fragment, append 6 bit
200 3[0123]?) printf '000%s' ${n#3};; # 2 octet (11 bit) chain start
201 34?) printf '00%s' ${n#34};; # 3 octet (16 bit) chain start
202 35?) printf '01%s' ${n#35};; # 3 octet chain start, high
203 36?) printf '%s' ${n#36};; # 4 octet (21 bit) chain start
206 | sed -E 's;.{7};&\n;g;' \
208 printf '&#%d;' $((0$n))
213 # Code every character in URL escape hex format
214 # except alphanumeric ascii
216 { [ $# -eq 0 ] && cat || printf %s "$*"; } \
217 | hexdump -v -e '/1 ",%02X"' \
218 | sed 's;,;%;g; s;%2F;/;g;'
222 # Param: session | +seconds | [date]
224 # Param: Path= | Domain= | Secure
227 ''|0|session) expire='';;
228 [+-][0-9]*) expire="$(date -R -d @$(($(date +%s) + $1)))";;
229 *) expire="$(date -R -d "$1")";;
233 printf 'Set-Cookie: %s; HttpOnly; SameSite=Lax' "$cookie"
234 [ -n "$expire" ] && printf '; Expires=%s' "${expire%+????}${expire:+GMT}"
235 [ $# -ge 3 ] && shift 2 && printf '; %s' "$@"
240 printf '%s: %s\r\n' \
241 Status "303 See Other" \