Improving backup_and_restore.sh script before new-coming features

helper-scripts/backup_and_restore.sh

@@ -1,156 +1,203 @@
 #!/usr/bin/env bash
 
+# ---------------------------------------------------
+# Here's only the functions that are optimized,
+# checked and refactored.
+# 
+# This comment will be deleted once I finished 
+# working with this file.
+# ---------------------------------------------------
+
+# ----------------- Start Functions -----------------
+
+function print_usage() {
+  echo "Usage: ${0} [option] [argument]"
+  echo
+  echo "Options:"
+  echo -e "  backup\t[crypt|vmail|redis|rspamd|postfix|mysql|all|--delete-days]"
+  echo -e "  restore"
+  echo
+  echo "Environment Variables:"
+  echo -e "  THREADS\t<num>\tYou can set the thread count with the THREADS environment variable before you run this script."
+}
+
+function check_required_tools() {
+  # Add the required tools to the array
+  local required_tools=("docker")
+
+  for bin in "${required_tools[@]}"; do
+    if [[ -z $(which ${bin}) ]]; then
+      echo -e "\e[31mCannot find ${bin} in local PATH, exiting...\e[0m"
+      exit 1
+    fi
+  done
+
+  if grep --help 2>&1 | head -n 1 | grep -q -i "busybox"; then
+    echo -e "\e[31mBusyBox grep detected on local system, please install GNU grep\e[0m"
+    exit 1
+  fi
+}
+
+# ----------------- End Functions -----------------
+
+check_required_tools
+
 DEBIAN_DOCKER_IMAGE="mailcow/backup:latest"
 
-if [[ ! -z ${MAILCOW_BACKUP_LOCATION} ]]; then
+if [[ ! -z "${MAILCOW_BACKUP_LOCATION}" ]]; then
   BACKUP_LOCATION="${MAILCOW_BACKUP_LOCATION}"
 fi
 
 if [[ ! ${1} =~ (backup|restore) ]]; then
-  echo "First parameter needs to be 'backup' or 'restore'"
+  print_usage
   exit 1
 fi
 
 if [[ ${1} == "backup" && ! ${2} =~ (crypt|vmail|redis|rspamd|postfix|mysql|all|--delete-days) ]]; then
-  echo "Second parameter needs to be 'vmail', 'crypt', 'redis', 'rspamd', 'postfix', 'mysql', 'all' or '--delete-days'"
+  if [[ -z "${2}" ]]; then
+    echo -e "\e[31mRequired argument for backup option\e[0m\n"
+  else
+    echo -e "\e[31mUnknown argument: ${2}\e[0m\n"
+  fi
+
+  print_usage
   exit 1
 fi
 
-if [[ -z ${BACKUP_LOCATION} ]]; then
-  while [[ -z ${BACKUP_LOCATION} ]]; do
+if [[ -z "${BACKUP_LOCATION}" ]]; then
+  while [[ -z "${BACKUP_LOCATION}" ]]; do
     read -ep "Backup location (absolute path, starting with /): " BACKUP_LOCATION
   done
 fi
 
-if [[ ! ${BACKUP_LOCATION} =~ ^/ ]]; then
-  echo "Backup directory needs to be given as absolute path (starting with /)."
+if [[ ! "${BACKUP_LOCATION}" =~ ^/ ]]; then
+  echo -e "\e[31mBackup directory needs to be given as absolute path (starting with /).\e[0m"
   exit 1
 fi
 
-if [[ -f ${BACKUP_LOCATION} ]]; then
-  echo "${BACKUP_LOCATION} is a file!"
-  exit 1
-fi
-
-if [[ ! -d ${BACKUP_LOCATION} ]]; then
-  echo "${BACKUP_LOCATION} is not a directory"
+# if "${BACKUP_LOCATION}" not exists, create it.
+if [[ ! -e "${BACKUP_LOCATION}" ]]; then
+  echo -e "\e[33m${BACKUP_LOCATION} is not exist\e[0m"
   read -p "Create it now? [y|N] " CREATE_BACKUP_LOCATION
   if [[ ! ${CREATE_BACKUP_LOCATION,,} =~ ^(yes|y)$ ]]; then
-    exit 1
+    echo -e "\e[33mExiting without creating the backup location.\e[0m"
+    exit 0
   else
-    mkdir -p ${BACKUP_LOCATION}
-    chmod 755 ${BACKUP_LOCATION}
+    mkdir -p "${BACKUP_LOCATION}"
+    chmod 755 "${BACKUP_LOCATION}"
+
+    if [[ ! "${?}" -eq 0 ]]; then
+      echo -e "\e[31mFailed, check the error above!\e[0m"
+      exit 1
+    fi
   fi
-else
-  if [[ ${1} == "backup" ]] && [[ -z $(echo $(stat -Lc %a ${BACKUP_LOCATION}) | grep -oE '[0-9][0-9][5-7]') ]]; then
-    echo "${BACKUP_LOCATION} is not write-able for others, that's required for a backup."
+# if "${BACKUP_LOCATION}" is an exists directory,
+# then just check the permissions
+elif [[ -d "${BACKUP_LOCATION}" ]]; then
+  echo -e "\e[32mFound directory ${BACKUP_LOCATION}\e[0m"
+  if [[ ${1} == "backup" ]] && [[ -z $(echo $(stat -Lc %a "${BACKUP_LOCATION}") | grep -oE '[0-9][0-9][5-7]') ]]; then
+    echo -e "\e[31m${BACKUP_LOCATION} is not write-able for others, that's required for a backup.\e[0m"
+    echo "Execute \`chmod 755 ${BACKUP_LOCATION}\` and try again."
     exit 1
   fi
+# else, the "${BACKUP_LOCATION}" is something else! an alien? yes!
+else
+  echo -e "\e[31m${BACKUP_LOCATION} is not a valid path! Maybe a file or a symbolic?\e["
+  exit 1
 fi
 
-BACKUP_LOCATION=$(echo ${BACKUP_LOCATION} | sed 's#/$##')
+BACKUP_LOCATION=$(echo "${BACKUP_LOCATION}" | sed 's#/$##')
 SCRIPT_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
 COMPOSE_FILE=${SCRIPT_DIR}/../docker-compose.yml
 ENV_FILE=${SCRIPT_DIR}/../.env
 THREADS=$(echo ${THREADS:-1})
 ARCH=$(uname -m)
 
-if ! [[ "${THREADS}" =~ ^[1-9][0-9]?$ ]] ; then
-  echo "Thread input is not a number!"
+if [[ "${THREADS}" =~ ^[1-9][0-9]?$ ]]; then
+  echo -e "\e[32mUsing ${THREADS} thread(s) for this run.\e[0m"
+else
+  echo -e "\e[31mThread input is not a number!\e[0m"
   exit 1
-elif [[ "${THREADS}" =~ ^[1-9][0-9]?$ ]] ; then
-  echo "Using ${THREADS} Thread(s) for this run."
-  echo "Notice: You can set the Thread count with the THREADS Variable before you run this script."
 fi
 
 if [ ! -f ${COMPOSE_FILE} ]; then
-  echo "Compose file not found"
+  echo -e "\e[31mCompose file not found\e[0m"
   exit 1
 fi
 
 if [ ! -f ${ENV_FILE} ]; then
-  echo "Environment file not found"
+  echo -e "\e[31mEnvironment file not found\e[0m"
   exit 1
 fi
 
-echo "Using ${BACKUP_LOCATION} as backup/restore location."
+echo -e "\e[33mUsing ${BACKUP_LOCATION} as backup/restore location.\e[0m"
 echo
 
 source ${SCRIPT_DIR}/../mailcow.conf
 
 if [[ -z ${COMPOSE_PROJECT_NAME} ]]; then
-  echo "Could not determine compose project name"
+  echo -e "\e[31mCould not determine compose project name\e[0m"
   exit 1
 else
-  echo "Found project name ${COMPOSE_PROJECT_NAME}"
+  echo -e "\e[32mFound project name ${COMPOSE_PROJECT_NAME}\e[0m"
   CMPS_PRJ=$(echo ${COMPOSE_PROJECT_NAME} | tr -cd "[0-9A-Za-z-_]")
 fi
 
-if grep --help 2>&1 | head -n 1 | grep -q -i "busybox"; then
-  >&2 echo -e "\e[31mBusyBox grep detected on local system, please install GNU grep\e[0m"
-  exit 1
-fi
-
 
 function backup() {
   DATE=$(date +"%Y-%m-%d-%H-%M-%S")
   mkdir -p "${BACKUP_LOCATION}/mailcow-${DATE}"
   chmod 755 "${BACKUP_LOCATION}/mailcow-${DATE}"
   cp "${SCRIPT_DIR}/../mailcow.conf" "${BACKUP_LOCATION}/mailcow-${DATE}"
   touch "${BACKUP_LOCATION}/mailcow-${DATE}/.$ARCH"
-  for bin in docker; do
-  if [[ -z $(which ${bin}) ]]; then
-    >&2 echo -e "\e[31mCannot find ${bin} in local PATH, exiting...\e[0m"
-    exit 1
-  fi
-  done
+
   while (( "$#" )); do
     case "$1" in
     vmail|all)
       docker run --name mailcow-backup --rm \
-        -v ${BACKUP_LOCATION}/mailcow-${DATE}:/backup:z \
+        -v "${BACKUP_LOCATION}"/mailcow-${DATE}:/backup:z \
         -v $(docker volume ls -qf name=^${CMPS_PRJ}_vmail-vol-1$):/vmail:ro,z \
         ${DEBIAN_DOCKER_IMAGE} /bin/tar --warning='no-file-ignored' --use-compress-program="pigz --rsyncable -p ${THREADS}" -Pcvpf /backup/backup_vmail.tar.gz /vmail
       ;;&
     crypt|all)
       docker run --name mailcow-backup --rm \
-        -v ${BACKUP_LOCATION}/mailcow-${DATE}:/backup:z \
+        -v "${BACKUP_LOCATION}"/mailcow-${DATE}:/backup:z \
         -v $(docker volume ls -qf name=^${CMPS_PRJ}_crypt-vol-1$):/crypt:ro,z \
         ${DEBIAN_DOCKER_IMAGE} /bin/tar --warning='no-file-ignored' --use-compress-program="pigz --rsyncable -p ${THREADS}" -Pcvpf /backup/backup_crypt.tar.gz /crypt
       ;;&
     redis|all)
       docker exec $(docker ps -qf name=redis-mailcow) redis-cli save
       docker run --name mailcow-backup --rm \
-        -v ${BACKUP_LOCATION}/mailcow-${DATE}:/backup:z \
+        -v "${BACKUP_LOCATION}"/mailcow-${DATE}:/backup:z \
         -v $(docker volume ls -qf name=^${CMPS_PRJ}_redis-vol-1$):/redis:ro,z \
         ${DEBIAN_DOCKER_IMAGE} /bin/tar --warning='no-file-ignored' --use-compress-program="pigz --rsyncable -p ${THREADS}" -Pcvpf /backup/backup_redis.tar.gz /redis
       ;;&
     rspamd|all)
       docker run --name mailcow-backup --rm \
-        -v ${BACKUP_LOCATION}/mailcow-${DATE}:/backup:z \
+        -v "${BACKUP_LOCATION}"/mailcow-${DATE}:/backup:z \
         -v $(docker volume ls -qf name=^${CMPS_PRJ}_rspamd-vol-1$):/rspamd:ro,z \
         ${DEBIAN_DOCKER_IMAGE} /bin/tar --warning='no-file-ignored' --use-compress-program="pigz --rsyncable -p ${THREADS}" -Pcvpf /backup/backup_rspamd.tar.gz /rspamd
       ;;&
     postfix|all)
       docker run --name mailcow-backup --rm \
-        -v ${BACKUP_LOCATION}/mailcow-${DATE}:/backup:z \
+        -v "${BACKUP_LOCATION}"/mailcow-${DATE}:/backup:z \
         -v $(docker volume ls -qf name=^${CMPS_PRJ}_postfix-vol-1$):/postfix:ro,z \
         ${DEBIAN_DOCKER_IMAGE} /bin/tar --warning='no-file-ignored' --use-compress-program="pigz --rsyncable -p ${THREADS}" -Pcvpf /backup/backup_postfix.tar.gz /postfix
       ;;&
     mysql|all)
       SQLIMAGE=$(grep -iEo '(mysql|mariadb)\:.+' ${COMPOSE_FILE})
       if [[ -z "${SQLIMAGE}" ]]; then
-        echo "Could not determine SQL image version, skipping backup..."
+        echo -e "\e[31mCould not determine SQL image version, skipping backup...\e[0m"
         shift
         continue
       else
-        echo "Using SQL image ${SQLIMAGE}, starting..."
+        echo -e "\e[32mUsing SQL image ${SQLIMAGE}, starting...\e[0m"
         docker run --name mailcow-backup --rm \
           --network $(docker network ls -qf name=^${CMPS_PRJ}_mailcow-network$) \
           -v $(docker volume ls -qf name=^${CMPS_PRJ}_mysql-vol-1$):/var/lib/mysql/:ro,z \
           -t --entrypoint= \
           --sysctl net.ipv6.conf.all.disable_ipv6=1 \
-          -v ${BACKUP_LOCATION}/mailcow-${DATE}:/backup:z \
+          -v "${BACKUP_LOCATION}"/mailcow-${DATE}:/backup:z \
           ${SQLIMAGE} /bin/sh -c "mariabackup --host mysql --user root --password ${DBROOT} --backup --rsync --target-dir=/backup_mariadb ; \
           mariabackup --prepare --target-dir=/backup_mariadb ; \
           chown -R 999:999 /backup_mariadb ; \
@@ -160,9 +207,9 @@ function backup() {
     --delete-days)
       shift
       if [[ "${1}" =~ ^[0-9]+$ ]]; then
-        find ${BACKUP_LOCATION}/mailcow-* -maxdepth 0 -mmin +$((${1}*60*24)) -exec rm -rvf {} \;
+        find "${BACKUP_LOCATION}"/mailcow-* -maxdepth 0 -mmin +$((${1}*60*24)) -exec rm -rvf {} \;
       else
-        echo "Parameter of --delete-days is not a number."
+        echo -e "\e[31mParameter of --delete-days is not a number.\e[0m"
       fi
       ;;
     esac
@@ -171,13 +218,6 @@ function backup() {
 }
 
 function restore() {
-  for bin in docker; do
-  if [[ -z $(which ${bin}) ]]; then
-    >&2 echo -e "\e[31mCannot find ${bin} in local PATH, exiting...\e[0m"
-    exit 1
-  fi
-  done
-
   if [ "${DOCKER_COMPOSE_VERSION}" == "native" ]; then
   COMPOSE_COMMAND="docker compose"
 
@@ -190,7 +230,7 @@ function restore() {
   fi
 
   echo
-  echo "Stopping watchdog-mailcow..."
+  echo -e "\e[33mStopping watchdog-mailcow...\e[0m"
   docker stop $(docker ps -qf name=watchdog-mailcow)
   echo
   RESTORE_LOCATION="${1}"
@@ -268,11 +308,11 @@ function restore() {
     mysql|mariadb)
       SQLIMAGE=$(grep -iEo '(mysql|mariadb)\:.+' ${COMPOSE_FILE})
       if [[ -z "${SQLIMAGE}" ]]; then
-        echo "Could not determine SQL image version, skipping restore..."
+        echo -e "\e[31mCould not determine SQL image version, skipping restore...\e[0m"
         shift
         continue
       elif [ ! -f "${RESTORE_LOCATION}/mailcow.conf" ]; then
-        echo "Could not find the corresponding mailcow.conf in ${RESTORE_LOCATION}, skipping restore."
+        echo -e "\e[31mCould not find the corresponding mailcow.conf in ${RESTORE_LOCATION}, skipping restore.\e[0m"
         echo "If you lost that file, copy the last working mailcow.conf file to ${RESTORE_LOCATION} and restart the restore process."
         shift
         continue
@@ -339,11 +379,11 @@ if [[ ${1} == "backup" ]]; then
 elif [[ ${1} == "restore" ]]; then
   i=1
   declare -A FOLDER_SELECTION
-  if [[ $(find ${BACKUP_LOCATION}/mailcow-* -maxdepth 1 -type d 2> /dev/null| wc -l) -lt 1 ]]; then
-    echo "Selected backup location has no subfolders"
+  if [[ $(find "${BACKUP_LOCATION}"/mailcow-* -maxdepth 1 -type d 2> /dev/null| wc -l) -lt 1 ]]; then
+    echo -e "\e[31mSelected backup location has no subfolders\e[0m"
     exit 1
   fi
-  for folder in $(ls -d ${BACKUP_LOCATION}/mailcow-*/); do
+  for folder in $(ls -d "${BACKUP_LOCATION}"/mailcow-*/); do
     echo "[ ${i} ] - ${folder}"
     FOLDER_SELECTION[${i}]="${folder}"
     ((i++))
@@ -358,7 +398,7 @@ elif [[ ${1} == "restore" ]]; then
   declare -A FILE_SELECTION
   RESTORE_POINT="${FOLDER_SELECTION[${input_sel}]}"
   if [[ -z $(find "${FOLDER_SELECTION[${input_sel}]}" -maxdepth 1 \( -type d -o -type f \) -regex ".*\(redis\|rspamd\|mariadb\|mysql\|crypt\|vmail\|postfix\).*") ]]; then
-    echo "No datasets found"
+    echo -e "\e[31mNo datasets found\e[0m"
     exit 1
   fi