├── cgi-bin
    ├── test
    └── httputils
└── README.md


/cgi-bin/test:
--------------------------------------------------------------------------------
 1 | #!/bin/bash
 2 | #
 3 | # Example Bash CGI script.
 4 | #
 5 | # Caveat: Remember the empty line after echoing headers
 6 | #
 7 | 
 8 | # httputils creates the associative arrays POST_PARAMS and GET_PARAMS
 9 | if [[ "$SCRIPT_FILENAME" ]]; then
10 |   . "$(dirname $SCRIPT_FILENAME)/httputils"
11 | else
12 |   . "$(dirname $(pwd)$SCRIPT_NAME)/httputils"
13 | fi
14 | 
15 | POST_vars_to_str() {
16 |   local __resultvar=$1
17 |   local q
18 |   for param in "${!POST_PARAMS[@]}"; do
19 |     q="${q} \"${param}\": \"${POST_PARAMS[$param]}\"," 
20 |   done
21 |   eval $__resultvar="'$q'"
22 | }
23 | 
24 | do_POST() {
25 |   POST_vars_to_str result
26 |   echo "Status: 200 OK"
27 |   echo ""
28 |   cat <<JSON
29 | {
30 |     $result
31 | }
32 | JSON
33 | }
34 | do_GET() {
35 |   echo "Status: 405 Method Not Allowed"
36 |   echo ""
37 |   cat <<JSON
38 | {
39 |     "query_string": "$QUERY_STRING"
40 | }
41 | JSON
42 | }
43 | 
44 | # Print out available ENV vars
45 | #/usr/bin/env
46 | 
47 | # Common headers goes here
48 | echo "Content-Type: application/json"
49 | 
50 | case $REQUEST_METHOD in
51 |   POST)
52 |     do_POST
53 |     ;;
54 |   GET)
55 |     do_GET
56 |     ;;
57 |   *)
58 |     echo "No handle for $REQUEST_METHOD"
59 |     exit 0
60 |     ;;
61 | esac
62 | 


--------------------------------------------------------------------------------
/cgi-bin/httputils:
--------------------------------------------------------------------------------
 1 | #!/bin/bash
 2 | # HTTP POST and GET params in an associative array
 3 | declare -A GET_PARAMS
 4 | declare -A POST_PARAMS
 5 | 
 6 | read_POST_vars() {
 7 |   if [[ "$REQUEST_METHOD" = "POST" ]] && [[ ! -z "$CONTENT_LENGTH" ]]; then
 8 |     QUERY_STRING_POST=$(dd bs="${CONTENT_LENGTH}" count=1 status=none)
 9 |   fi
10 | }
11 | 
12 | parse_POST_params() {
13 |   local q p k v
14 | 
15 |   if [[ ! "${QUERY_STRING_POST}" ]]; then
16 |     return
17 |   fi
18 | 
19 |   q="${QUERY_STRING_POST}&"
20 | 
21 |   while [[ ! -z "$q" ]]; do
22 |     p="${q%%&*}"  # get first part of query string
23 |     k="${p%%=*}"  # get the key (variable name) from it
24 |     v="${p#*=}"   # get the value from it
25 |     q="${q#$p&*}" # strip first part from query string
26 | 
27 |     POST_PARAMS["${k}"]="${v}"
28 |   done
29 | }
30 | 
31 | parse_GET_params() {
32 |   local q p k v
33 | 
34 |   if [[ ! "${QUERY_STRING}" ]]; then
35 |     return
36 |   fi
37 | 
38 |   q="${QUERY_STRING}&"
39 | 
40 |   while [[ ! -z "$q" ]]; do
41 |     p="${q%%&*}"  # get first part of query string
42 |     k="${p%%=*}"  # get the key (variable name) from it
43 |     v="${p#*=}"   # get the value from it
44 |     q="${q#$p&*}" # strip first part from query string
45 | 
46 |     GET_PARAMS["${k}"]="${v}"
47 |   done
48 | }
49 | 
50 | read_POST_vars
51 | parse_POST_params
52 | parse_GET_params
53 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
 1 | Bash CGI Example
 2 | ================
 3 | 
 4 | Development server
 5 | ------------------
 6 | Quickly get up an running using
 7 | [Python's CGIHTTPServer](http://docs.python.org/2/library/cgihttpserver.html):
 8 | 
 9 |     python -m CGIHTTPServer
10 | 
11 | Caveats:
12 |   - scripts need to be placed in a sub-folder named `cgi-bin/` or `htbin/`
13 |   - every response gets the status **200 Script output follows**
14 | 
15 | Nginx
16 | -----
17 | As [Nginx](http://nginx.org/) only supports FastCGI out of the box,
18 | we also need to install [fcgiwrap](https://github.com/gnosek/fcgiwrap).
19 | 
20 | On Ubuntu: `apt-get install nginx fcgiwrap`  
21 | On Arch: `pacman -S nginx fcgiwrap`
22 | 
23 | Example Nginx config (Ubuntu: `/etc/nginx/sites-enabled/default`):
24 | ```
25 | server {
26 |     listen   80;
27 |     server_name  localhost;
28 |     access_log  /var/log/nginx/access.log;
29 | 
30 |     location / {
31 |         root /srv/static;
32 |         autoindex on;
33 |         index index.html index.htm;
34 |     }
35 | 
36 |     location ~ ^/cgi {
37 |         root /srv/my_cgi_app;
38 |         rewrite ^/cgi/(.*) /$1 break;
39 | 
40 |         include fastcgi_params;
41 |         fastcgi_pass unix:/var/run/fcgiwrap.socket;
42 |         fastcgi_param SCRIPT_FILENAME /srv/my_cgi_app$fastcgi_script_name;
43 |     }
44 | }
45 | ```
46 | 
47 | Change the **root** and **fastcgi_param** lines to a directory containing CGI
48 | scripts, e.g. the `cgi-bin/` dir in this repository.
49 | 
50 | If you are a control freak and run `fcgiwrap` manually,
51 | be sure to change **fastcgi_pass** accordingly. The path listed in the example
52 | is the default in Ubuntu when using the out-of-the-box fcgiwrap setup.
53 | 


--------------------------------------------------------------------------------