refactor(SCRIPT): replace in-line printf styles

ab-nginx.sh

@@ -5,7 +5,7 @@
 #
 
 # text formatting presets
-if command -v tput > /dev/null; then
+if command -v tput >/dev/null; then
   cyan=$(tput bold)$(tput setaf 6)
   err=$(tput bold)$(tput setaf 1)
   magenta=$(tput sgr0)$(tput setaf 5)
@@ -21,7 +21,6 @@ else
   width=80
 fi
 
-
 ### parameter defaults
 shell=false
 container_name="ab-nginx"
@@ -34,25 +33,24 @@ unset SERVERS_DIR
 unset WEBROOT_DIR
 unset vmount
 
-
 ### functions
 
-checkExist () {
+checkExist() {
   if [ "$1" = 'file' ]; then
     if [ ! -f "$2" ]; then
-            printf "${err}\nCannot find file: '$2'. Exiting.\n${norm}"
+      printf "%s\nCannot find file: '$2'. Exiting.\n%s" "$err" "$norm"
       exit 3
     fi
   elif [ "$1" = 'dir' ]; then
     if [ ! -d "$2" ]; then
-            printf "${err}\nCannot find directory: '$2'. Exiting.\n${norm}"
+      printf "%s\nCannot find directory: '$2'. Exiting.\n$%s" "$err" "$norm"
       exit 3
     fi
   fi
   return 0
 }
 
-scriptHelp () {
+scriptHelp() {
   printf "\n%s%1000s\n" "$magenta" | tr " " "-" | cut -c -$width
   printf "%s" "$norm"
   textblock "This is a simple helper script so you can avoid lengthy typing when working with the nginx container. The script reads the contents of 'ab-nginx.params' and constructs various 'docker run' commands based on that file. The biggest time-saver is working with certificates. If they are specified in the params file, the script will automatically bind-mount them so nginx serves content via SSL by default."
@@ -77,11 +75,11 @@ scriptHelp () {
   exit 0
 }
 
-newline () {
+newline() {
   printf "\n"
 }
 
-textblock () {
+textblock() {
   printf "%s\n" "$1" | fold -w "$width" -s
 }
 
@@ -95,13 +93,12 @@ textblockParam() {
   fi
 }
 
-
 ### pre-requisite checks
 
 # is user root or in the docker group?
-if [ ! "$( id -u )" -eq 0 ]; then
+if [ ! "$(id -u)" -eq 0 ]; then
-    if ! id -Gn | grep docker > /dev/null; then
+  if ! id -Gn | grep docker >/dev/null; then
-        printf "${err}\nYou must either be root or in the 'docker' group to run this script since you must be able to actually start the container! Exiting.\n${norm}"
+    printf "%s\nYou must either be root or in the 'docker' group to run this script since you must be able to actually start the container! Exiting.\n$%s" "$err" "$norm"
     exit 2
   fi
 fi
@@ -110,11 +107,11 @@ fi
 checkExist 'file' './ab-nginx.params'
 
 # read .params file
-. ./ab-nginx.params
+. "./ab-nginx.params"
 
 # fix case of TLS13_ONLY var
 if [ "$TLS13_ONLY" ]; then
-    TLS13_ONLY=$( printf "%s" "$TLS13_ONLY" | tr "[:lower:]" "[:upper:]" )
+  TLS13_ONLY=$(printf "%s" "$TLS13_ONLY" | tr "[:lower:]" "[:upper:]")
 fi
 
 # check for certs if using SSL
@@ -125,7 +122,7 @@ if [ "$SSL_CHAIN" ]; then checkExist 'file' "$SSL_CHAIN"; fi
 # check for DHparam if using TLS1.2
 if [ "$TLS13_ONLY" = 'FALSE' ]; then
   if [ -z "$DH" ]; then
-        printf "${err}\nA DHparam file must be specified when using TLS 1.2. Exiting.${norm}\n"
+    printf "%s\nA DHparam file must be specified when using TLS 1.2. Exiting.%s\n" "$err" "$norm"
     exit 5
   else
     checkExist 'file' "$DH"
@@ -163,31 +160,30 @@ fi
 # trim leading whitespace
 vmount=${vmount##[[:space:]]}
 
-
 # process startup parameters
 while [ $# -gt 0 ]; do
   case "$1" in
-        -h|-\?|--help)
+  -h | -\? | --help)
     # display help
     scriptHelp
     exit 0
     ;;
-        -s|--shell)
+  -s | --shell)
     # start shell instead of default CMD
     shell=true
     ;;
-        -n|--name)
+  -n | --name)
     # container name
     if [ -z "$2" ]; then
-                printf "${err}\nNo container name specified. Exiting.\n${norm}"
+      printf "%s\nNo container name specified. Exiting.\n%s" "$err" "$norm"
       exit 1
     fi
     container_name="$2"
     shift
     ;;
   *)
-            printf "${err}\nUnknown option: %s\n" "$1"
+    printf "%s\nUnknown option: %s\n" "$err" "$1"
-            printf "Use '--help' for valid options.\n\n${norm}"
+    printf "Use '--help' for valid options.\n\n%s" "$norm"
     exit 1
     ;;
   esac
@@ -195,33 +191,32 @@ while [ $# -gt 0 ]; do
 done
 
 # create network if it doesn't already exist
-docker network inspect ${NETWORK} > /dev/null 2>&1 || \
+docker network inspect ${NETWORK} >/dev/null 2>&1 ||
   docker network create \
     --attachable \
     --driver=bridge \
     --subnet=${SUBNET} \
     ${NETWORK}
 
-
 # run without TLS
 if [ -z "$SSL_CERT" ]; then
   if [ $shell = 'true' ]; then
     # exec shell
-        printf "${cyan}\nRunning SHELL on %s...${norm}\n" "$container_name"
+    printf "%s\nRunning SHELL on %s...%s\n" "$cyan" "$container_name" "$norm"
-        docker run --rm -it --name ${container_name} \
+    docker run --rm -it --name "${container_name}" \
       --env-file ab-nginx.params \
       -e SERVER_NAMES="$HOSTNAMES" \
-            $vmount \
+      "${vmount}" \
       --network=${NETWORK} \
       -p ${HTTP_PORT}:80 \
       docker.asifbacchus.app/nginx/ab-nginx:latest /bin/sh
   else
     # exec normally
-        printf "${cyan}\nRunning NGINX on %s...${norm}\n" "$container_name"
+    printf "%s\nRunning NGINX on %s...%s\n" "$cyan" "$container_name" "$norm"
-        docker run -d --name ${container_name} \
+    docker run -d --name "${container_name}" \
       --env-file ab-nginx.params \
       -e SERVER_NAMES="$HOSTNAMES" \
-        $vmount \
+      "${vmount}" \
       --network=${NETWORK} \
       -p ${HTTP_PORT}:80 \
       --restart unless-stopped \
@@ -231,11 +226,11 @@ if [ -z "$SSL_CERT" ]; then
 elif [ "$SSL_CERT" ] && [ "$TLS13_ONLY" = 'FALSE' ]; then
   if [ $shell = 'true' ]; then
     # exec shell
-        printf "${cyan}\nRunning SHELL on %s (TLS 1.2)...${norm}\n" "$container_name"
+    printf "%s\nRunning SHELL on %s (TLS 1.2)...%s\n" "$cyan" "$container_name" "$norm"
-        docker run --rm -it --name ${container_name} \
+    docker run --rm -it --name "${container_name}" \
       --env-file ab-nginx.params \
       -e SERVER_NAMES="$HOSTNAMES" \
-            $vmount \
+      "${vmount}" \
       --network=${NETWORK} \
       -v "$SSL_CERT":/certs/fullchain.pem:ro \
       -v "$SSL_KEY":/certs/privkey.pem:ro \
@@ -245,11 +240,11 @@ elif [ "$SSL_CERT" ] && [ "$TLS13_ONLY" = 'FALSE' ]; then
       docker.asifbacchus.app/nginx/ab-nginx:latest /bin/sh
   else
     # exec normally
-        printf "${cyan}\nRunning NGINX on %s (TLS 1.2)...${norm}\n" "$container_name"
+    printf "%s\nRunning NGINX on %s (TLS 1.2)...%s\n" "$cyan" "$container_name" "$norm"
-        docker run -d --name ${container_name} \
+    docker run -d --name "${container_name}" \
       --env-file ab-nginx.params \
       -e SERVER_NAMES="$HOSTNAMES" \
-            $vmount \
+      "${vmount}" \
       --network=${NETWORK} \
       -v "$SSL_CERT":/certs/fullchain.pem:ro \
       -v "$SSL_KEY":/certs/privkey.pem:ro \
@@ -263,11 +258,11 @@ elif [ "$SSL_CERT" ] && [ "$TLS13_ONLY" = 'FALSE' ]; then
 elif [ "$SSL_CERT" ] && [ "$TLS13_ONLY" = 'TRUE' ]; then
   if [ $shell = 'true' ]; then
     # exec shell
-        printf "${cyan}\nRunning SHELL on %s (TLS 1.3)...${norm}\n" "$container_name"
+    printf "%s\nRunning SHELL on %s (TLS 1.3)...%s\n" "$cyan" "$container_name" "$norm"
-        docker run --rm -it --name ${container_name} \
+    docker run --rm -it --name "${container_name}" \
       --env-file ab-nginx.params \
       -e SERVER_NAMES="$HOSTNAMES" \
-            $vmount \
+      "${vmount}" \
       --network=${NETWORK} \
       -v "$SSL_CERT":/certs/fullchain.pem:ro \
       -v "$SSL_KEY":/certs/privkey.pem:ro \
@@ -276,11 +271,11 @@ elif [ "$SSL_CERT" ] && [ "$TLS13_ONLY" = 'TRUE' ]; then
       docker.asifbacchus.app/nginx/ab-nginx:latest /bin/sh
   else
     # exec normally
-        printf "${cyan}\nRunning NGINX on %s (TLS 1.3)...${norm}\n" "$container_name"
+    printf "%s\nRunning NGINX on %s (TLS 1.3)...%s\n" "$cyan" "$container_name" "$norm"
-        docker run -d --name ${container_name} \
+    docker run -d --name "${container_name}" \
       --env-file ab-nginx.params \
       -e SERVER_NAMES="$HOSTNAMES" \
-            $vmount \
+      "${vmount}" \
       --network=${NETWORK} \
       -v "$SSL_CERT":/certs/fullchain.pem:ro \
       -v "$SSL_KEY":/certs/privkey.pem:ro \
@@ -291,6 +286,5 @@ elif [ "$SSL_CERT" ] && [ "$TLS13_ONLY" = 'TRUE' ]; then
   fi
 fi
 
-
 ### exit gracefully
 exit 0