feat: opt-in session store + example

Author: cgsdev0

core.sh

@@ -8,6 +8,7 @@ declare -A QUERY_PARAMS
 declare -A FORM_DATA
 declare -A PATH_VARS
 declare -A COOKIES
+declare -A SESSION
 
 [[ -f 'config.sh' ]] && source config.sh
 
@@ -28,6 +29,9 @@ respond() {
     shift
     printf "HTTP/1.1 %s %s\r\n" "$CODE" "$*"
     header Server "bash-stack ${VERSION:-devbuild}"
+    [[ ! -z "$SESSION_HEADER_TO_BE_WRITTEN" ]] && \
+      printf "%s" "$SESSION_HEADER_TO_BE_WRITTEN"
+
 }
 
 end_headers() {
@@ -64,6 +68,39 @@ urldecode() {
     printf '%b\n' "${_//%/\\x}"
 }
 
+function create_or_resume_session() {
+  local KEY
+  local VAL
+  if [[ -z "${COOKIES[_session]}" ]]; then
+    SESSION_ID="$(tr -dc A-Za-z0-9 </dev/urandom | head -c 32 ; echo '')"
+    SESSION_HEADER_TO_BE_WRITTEN=$(header Set-Cookie "_session=$SESSION_ID; Path=/; Secure; HttpOnly")
+  else
+    SESSION_ID=$(echo "${COOKIES[_session]}" | tr -dc A-Za-z0-9)
+  fi
+  if [[ -f "sessions/$SESSION_ID" ]]; then
+    while IFS= read -r line; do
+      KEY="$(echo "$line" | cut -f1)"
+      VAL="$(echo "$line" | cut -f2-)"
+      SESSION["$KEY"]="$VAL"
+    done < "sessions/$SESSION_ID"
+  fi
+}
+
+function save_session() {
+  if [[ "${ENABLE_SESSIONS:-false}" != true ]]; then
+    debug "Error: You must set ENABLE_SESSIONS=true before calling save_session!"
+    return
+  fi
+  local KEY
+  if [[ -z "$SESSION_ID" ]]; then
+    return
+  fi
+  touch "sessions/$SESSION_ID"
+  for KEY in ${!SESSION[@]}; do
+    printf "%s\t%s\n" "$KEY" "${SESSION[$KEY]}"
+  done > "sessions/$SESSION_ID"
+}
+
 function _inject_hmr() {
   if [[ -z "$USE_HMR" ]]; then
     return
@@ -348,6 +385,9 @@ writeHttpResponse() {
     return
   fi
   matchRoute "$REQUEST_PATH"
+
+  [[ "${ENABLE_SESSIONS:-false}" == "true" ]] && create_or_resume_session
+
   if [[ ! -z "$USE_HMR" ]] && [[ "$REQUEST_PATH" == "/hmr" ]]; then
     if [[ "$REQUEST_METHOD" == "POST" ]]; then
       respond 204 OK
@@ -391,6 +431,7 @@ writeHttpResponse() {
     return
   fi
 
+
   if directive_test=$(head -1 "pages/${ROUTE_SCRIPT}"); then
     if [[ "$directive_test" == "# sse" ]]; then
       respond 200 OK
@@ -550,6 +591,7 @@ export -f findPredefinedRoutes
 export -f findDynamicRoutes
 export -f findCatchAllRoutes
 export -f matchRoute
+export -f save_session
 
 parseHttpRequest
 writeHttpResponse

examples/sessions/.gitignore

@@ -0,0 +1,4 @@
+data/
+pubsub/
+uploads/
+sessions/

examples/sessions/Dockerfile

@@ -0,0 +1,11 @@
+FROM ubuntu
+
+ENV DEV false
+
+RUN apt-get update && apt-get install ucspi-tcp
+
+EXPOSE 3000
+
+COPY . /app
+
+CMD [ "/app/start.sh" ]

examples/sessions/config.sh

@@ -0,0 +1,2 @@
+PROJECT_NAME="Session Store Demo"
+ENABLE_SESSIONS=true # note: consult your lawyer before enabling this in your project!

examples/sessions/core.sh

@@ -0,0 +1 @@
+../../core.sh

examples/sessions/pages/false.sh

@@ -0,0 +1,6 @@
+# headers
+header HX-Refresh true
+end_headers
+
+SESSION[test]=false
+save_session

examples/sessions/pages/index.sh

@@ -0,0 +1,10 @@
+
+source config.sh
+
+htmx_page << EOF
+  <h1>${PROJECT_NAME}</h1>
+  <p>Your session ID: ${SESSION_ID:-not yet set}</p>
+  <p>Your session value: ${SESSION[test]:-not yet set}</p>
+  <button hx-post="/true" hx-swap="none">True</button>
+  <button hx-post="/false" hx-swap="none">False</button>
+EOF

examples/sessions/pages/true.sh

@@ -0,0 +1,6 @@
+# headers
+header HX-Refresh true
+end_headers
+
+SESSION[test]=true
+save_session

examples/sessions/start.sh

@@ -0,0 +1 @@
+../../start.sh

examples/sessions/static/style.css

@@ -0,0 +1,37 @@
+body {
+  padding: 0 40px;
+}
+#signature {
+  position: absolute;
+  z-index: 100;
+  right: 20px;
+  top: 20px;
+  display: flex;
+  align-items: center;
+  justify-content: center;
+}
+
+#signature a {
+  text-decoration: none;
+}
+
+#signature a:hover {
+  text-decoration: underline;
+}
+
+#signature svg {
+  width: 36px;
+  height: 36px;
+  margin-top: -4px;
+  vertical-align: middle;
+}
+
+#form {
+  display: flex;
+  max-width: 400px;
+  flex-direction: column;
+}
+
+#count {
+  font-size: 24px;
+}

start.sh

@@ -13,6 +13,7 @@ fi
 # remove any old subscriptions; they are no longer valid
 rm -rf pubsub
 
+mkdir -p sessions
 mkdir -p pubsub
 mkdir -p data
 mkdir -p uploads