]> git.plutz.net Git - cgilite/blob - cgilite.sh
min-height for textarea
[cgilite] / cgilite.sh
1 #!/bin/sh
2
3 # Copyright 2017 - 2021 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 [ -n "$include_cgilite" ] && return 0
22 # guard set after webserver part
23
24 # ksh and zsh workaround
25 # set -o posix # ksh, not portable
26 setopt -o OCTAL_ZEROES 2>&-
27
28 # Integrated webserver request timeout
29 cgilite_timeout=2
30
31 # General environment variables
32 # $_EXEC - directory containing application itself
33 # $_DATA - direcotry where application data may be stored
34 # $_BASE - optional prefix for http path, e.g. "/myapp"
35 #
36 # Programmers should take care to use those variables throughout the
37 # application.
38 # Variables may be set via CLI argument, in environment, or left as default.
39
40 for cgilite_arg in "$@"; do case $cgilite_arg in
41   --exec=*) _EXEC="${cgilite_arg#*=}";;
42   --data=*) _DATA="${cgilite_arg#*=}";;
43   --base=*) _BASE="${cgilite_arg#*=}";;
44 esac; done
45 unset cgilite_arg
46
47 _EXEC="${_EXEC:-${0%/*}}"
48 _DATA="${_DATA:-.}"
49 _EXEC="${_EXEC%/}" _DATA="${_DATA%/}" _BASE="${_BASE%/}"
50
51 # Carriare Return and Line Break characters for convenience
52 CR="\r"
53 BR='
54 '
55
56 PATH(){ 
57   local str seg out
58   # normalize path
59   # read from stdin if no arguments are provided
60
61   [ $# -eq 0 ] && str="$(cat)" || str="$*"
62   while [ "$str" ]; do
63     seg=${str%%/*}; str="${str#*/}"
64     case $seg in
65       ..) out="${out%/}"; out="${out%/*}/";;
66     .|'') out="${out%/}/";;
67        *) out="${out%/}/${seg}";;
68     esac;
69     [ "$seg" = "$str" ] && break
70   done
71   [ "${str}" -a "${out}" ] && printf %s "$out" || printf %s/ "${out%/}"
72 }
73
74 HEX_DECODE(){
75   local pfx="$1" in="$2" out
76   # Print out Data encoded as Hex
77   #
78   # Arguments:
79   # pfx - required, prefix for a hex tupel, e.g. "\x", "%" "\", may be empty
80   # in - required, string to be decoded
81   #
82   # anything that does not constitute a tupel of valid Hex numerals
83   # will be copied to the output literally
84
85   while [ "$in" ]; do
86     case $in in
87       "$pfx"[0-9a-fA-F][0-9a-fA-F]*) in="${in#${pfx}}";;
88       \\*) in="${in#?}"; out="${out}\\\\"; continue;;
89        %*) in="${in#?}"; out="${out}%%";  continue;;
90         *) out="${out}${in%"${in#?}"}"; in="${in#?}"; continue;;
91     esac;
92
93     # Hex escaes for printf (e.g. \x41) are not portable 
94     # The portable way for Hex output is transforming Hex to Octal
95     # (e.g. \x41 = \101)
96     case $in in
97         [0123]?*) out="${out}\\0";;
98         [4567]?*) out="${out}\\1";;
99       [89aAbB]?*) out="${out}\\2";;
100       [c-fC-F]?*) out="${out}\\3";;
101     esac
102     case $in in
103             [048cC][0-7]*) out="${out}0";;
104        [048cC][89a-fA-F]*) out="${out}1";;
105             [159dD][0-7]*) out="${out}2";;
106        [159dD][89a-fA-F]*) out="${out}3";;
107            [26aAeE][0-7]*) out="${out}4";;
108       [26aAeE][89a-fA-F]*) out="${out}5";;
109            [37bBfF][0-7]*) out="${out}6";;
110       [37bBfF][89a-fA-F]*) out="${out}7";;
111     esac
112     case $in in
113        ?[08]*) out="${out}0";;
114        ?[19]*) out="${out}1";;
115       ?[2aA]*) out="${out}2";;
116       ?[3bB]*) out="${out}3";;
117       ?[4cC]*) out="${out}4";;
118       ?[5dD]*) out="${out}5";;
119       ?[6eE]*) out="${out}6";;
120       ?[7fF]*) out="${out}7";;
121     esac
122     in="${in#?}"
123     in="${in#?}"
124   done
125   printf -- "$out"
126 }
127
128 if [ -z "$REQUEST_METHOD" ]; then
129   # no webserver variables means we are running via inetd / ncat
130   # so use builtin web server
131
132   # Use env from inetd as webserver variables
133   REMOTE_ADDR="${TCPREMOTEIP}"
134   SERVER_NAME="${TCPLOCALIP}"
135   SERVER_PORT="${TCPLOCALPORT}"
136
137   # Wait 2 seconds for request or kill connection through watchdog.
138   # Once Request is received the watchdog will be suspended (killed).
139   # At the end of the loop the watchdog will be restarted to enable
140   # timeout for the subsequent request.
141
142   (sleep $cgilite_timeout && kill $$) & cgilite_watchdog=$!
143   while read REQUEST_METHOD REQUEST_URI SERVER_PROTOCOL; do
144     [ "${SERVER_PROTOCOL#HTTP/1.[01]${CR}}" ] && break
145     kill $cgilite_watchdog
146
147     SERVER_PROTOCOL="${SERVER_PROTOCOL%${CR}}"
148     PATH_INFO="$(HEX_DECODE % "${REQUEST_URI%\?*}" |PATH)"
149     [ "${REQUEST_URI}" = "${REQUEST_URI#*\?}" ] \
150     && QUERY_STRING='' \
151     || QUERY_STRING="${REQUEST_URI#*\?}"
152     cgilite_headers=''; while read -r hl; do
153       hl="${hl%${CR}}"; [ "$hl" ] || break
154       case $hl in
155         'Content-Length: '*) CONTENT_LENGTH="${hl#*: }";;
156           'Content-Type: '*)   CONTENT_TYPE="${hl#*: }";;
157       esac
158       cgilite_headers="${cgilite_headers}${hl}${BR}"
159     done
160
161     export REMOTE_ADDR SERVER_NAME SERVER_PORT REQUEST_METHOD REQUEST_URI SERVER_PROTOCOL \
162            PATH_INFO QUERY_STRING CONTENT_TYPE CONTENT_LENGTH
163
164     # Try to serve multiple requests, provided that script serves a
165     # Content-Length header.
166     # Without Content-Length header, connection will terminate after
167     # script.
168
169     cgilite_status='200 OK'; cgilite_response=''; cgilite_cl="Connection: close${CR}${BR}";
170     . "$0" | while read -r l; do case $l in
171       Status:*)
172         cgilite_status="${l#Status: }";;
173       Content-Length:*)
174         cgilite_cl=""
175         cgilite_response="${cgilite_response:+${cgilite_response}${BR}}${l}";;
176       Connection:*)
177         cgilite_cl="${l}${BR}";;
178       $CR) printf '%s %s\r\n%s%s\r\n' \
179              'HTTP/1.1' "${cgilite_status%${CR}}" \
180              "${cgilite_response}${cgilite_response:+${BR}}" "${cgilite_cl}"
181            cat || kill $$
182            [ "${cgilite_cl#Connection}" = "${cgilite_cl}" ]; exit;;
183       *) cgilite_response="${cgilite_response:+${cgilite_response}${BR}}${l}";;
184     esac; done || exit 0;
185     (sleep $cgilite_timeout && kill $$) & cgilite_watchdog=$!
186   done
187   kill $cgilite_watchdog
188   exit 0
189 fi
190
191 include_cgilite="$0"
192
193 if [ "${REQUEST_METHOD}" = POST -a "${CONTENT_LENGTH:-0}" -gt 0 -a \
194      "${CONTENT_TYPE}" = "application/x-www-form-urlencoded" ]; then
195   cgilite_post="$(head -c "$CONTENT_LENGTH")"
196 fi
197
198 debug(){ [ $# -gt 0 ] && printf '%s\n' "$@" >&2 || tee -a /dev/stderr; }
199 [ "${DEBUG+x}" ] && env >&2
200
201 # general helper functions, see GET, POST, and REF below
202
203 cgilite_count(){
204   printf %s "&$1" \
205   | grep -oE '&'"$2"'=[^&]*' \
206   | wc -l
207 }
208
209 cgilite_value(){
210   local str="&$1" name="$2" cnt="${3:-1}"
211   while [ $cnt -gt 0 ]; do
212     [ "${str}" = "${str#*&${name}=}" ] && return 1
213     str="${str#*&${name}=}"
214     cnt=$((cnt - 1))
215   done
216   HEX_DECODE % "$(printf %s "${str%%&*}" |tr + \  )"
217 }
218
219 cgilite_keys(){
220   local str="&$1"
221   while [ "${str#*&}" != "${str}" ]; do
222     str="${str#*&}"
223     printf '%s\n' "${str%%=*}"
224   done \
225   | sort -u
226 }
227
228 # Read arguments from GET, POST, or the query string of the referrer (REF).
229 # Example:
230 # GET varname n
231 #
232 # where n is number for the Nth occurence of a variable and defaults to 1
233 #
234 # *_COUNT varname
235 # -> returns number of ocurences
236 # *_KEYS
237 # -> returns list of available varnames
238
239 GET(){ cgilite_value "${QUERY_STRING}" "$@"; }
240 GET_COUNT(){ cgilite_count "${QUERY_STRING}" $1; }
241 GET_KEYS(){ cgilite_keys "${QUERY_STRING}"; }
242
243 POST(){ cgilite_value "${cgilite_post}" "$@"; }
244 POST_COUNT(){ cgilite_count "${cgilite_post}" $1; }
245 POST_KEYS(){ cgilite_keys "${cgilite_post}"; }
246
247 REF(){ cgilite_value "${HTTP_REFERER#*\?}" "$@"; }
248 REF_COUNT(){ cgilite_count "${HTTP_REFERER#*\?}" $1; }
249 REF_KEYS(){ cgilite_keys "${HTTP_REFERER#*\?}"; }
250
251 HEADER(){
252   # Read value of header line. Use this instead of
253   # referencing HTTP_* environment variables.
254   if [ -n "${cgilite_headers+x}" ]; then
255     local str="${BR}${cgilite_headers}"
256     [ "${str}" = "${str#*${BR}${1}: }" ] && return 1
257     str="${str#*${BR}${1}: }"
258     printf %s "${str%%${BR}*}"
259   else
260     local var="HTTP_$(printf %s "$1" |tr a-z- A-Z-)"
261     eval "[ \"\$$var\" ] && printf %s \"\$$var\" || return 1"
262     # eval "printf %s \"\$HTTP_$(printf %s "${1}" |tr a-z A-Z |tr -c A-Z _)\""
263   fi
264 }
265
266 COOKIE(){
267   # Read value of cookie
268   HEX_DECODE % "$(
269     HEADER Cookie \
270     | grep -oE '(^|; ?)'"$1"'=[^;]*' \
271     | sed -En "${2:-1}"'{s;^[^=]+=;;; s;\+; ;g; p;}'
272   )"
273 }
274
275 HTML(){
276   # Escape HTML cahracters
277   # Also escape [, ], and \n for use in html-sh
278   local str out
279   [ $# -eq 0 ] && str="$(cat)" || str="$*"
280   while [ "$str" ]; do
281     case $str in
282       \&*) out="${out}&amp;";;
283       \<*) out="${out}&lt;";;
284       \>*) out="${out}&gt;";;
285       \"*) out="${out}&quot;";;
286       \'*) out="${out}&#x27;";;
287       \[*) out="${out}&#x5B;";;
288       \]*) out="${out}&#x5D;";;
289       "${CR}"*) out="${out}&#x0D;";;
290       "${BR}"*) out="${out}&#x0A;";;
291       *) out="${out}${str%"${str#?}"}";;
292     esac
293     str="${str#?}"
294   done
295   printf %s "$out"
296 }
297
298 URL(){
299   # Escape pathes, so they can be used in link tags and HTTP Headers
300   local str out
301   [ $# -eq 0 ] && str="$(cat)" || str="$*"
302   while [ "$str" ]; do
303     case $str in
304       \&*) out="${out}%26";;
305       \"*) out="${out}%22";;
306       \'*) out="${out}%27";;
307       \?*) out="${out}%3F";;
308       \#*) out="${out}%23";;
309       \[*) out="${out}%5B";;
310       \]*) out="${out}%5D";;
311       \ *) out="${out}%20";;
312       " "*) out="${out}%09";;
313       "${CR}"*) out="${out}%0D";;
314       "${BR}"*) out="${out}%0A";;
315       %*) out="${out}%25";;
316       *) out="${out}${str%"${str#?}"}";;
317     esac
318     str="${str#?}"
319   done
320   printf %s "$out"
321 }
322
323 SET_COOKIE(){
324   # Param: session | +seconds | [date]
325   # Param: name=value
326   # Param: Path= | Domain= | Secure
327   local expire cookie
328   case "$1" in
329     ''|0|session) expire='';;
330     [+-][0-9]*)   expire="$(date -R -d @$(($(date +%s) + $1)))";;
331     *)            expire="$(date -R -d "$1")";;
332   esac
333   cookie="$2"
334
335   printf 'Set-Cookie: %s; HttpOnly; SameSite=Lax' "$cookie"
336   [ -n "$expire" ] && printf '; Expires=%s' "${expire%+????}${expire:+GMT}"
337   [ $# -ge 3 ] && shift 2 && printf '; %s' "$@"
338   printf '\r\n'
339 }
340
341 REDIRECT(){
342   # Trigger redirct and terminate script
343   printf '%s: %s\r\n' \
344     Status "303 See Other" \
345     Content-Length 0 \
346     Location "$*"
347   printf '\r\n'
348   exit 0
349 }