backup_server_osx_linux.sh

#!/bin/bash

################################################################################

log_file="/private/var/log/fw_backup.log"

####################DO NOT MODIFY BELOW THIS LINE###############################

version="4.5.4"

function log()
{
 echo $1
 echo `date` ' | ' "$1" >> "$log_file"
}

function syntaxError
{
#SCRIPTLOCATION="$(cd "$(dirname "$0")"; pwd)/$(basename "$0")"
SCRIPT=$0
 /bin/echo "+-------------------------------------------------------------------------------------------------------------------"
 /bin/echo "|  Summary:                                                                                                         "
 /bin/echo "|  Version $version                                                                                                "
 /bin/echo "|  This script is used to schedule and run FileWave Server backups. It works on both Linux and OS X                 "
 /bin/echo "|  Scheduling is setup using cron jobs (crontab) on both OS X and Linux.                                            " 
 /bin/echo "|  Automated backups run at 12:01 AM either weekly or daily, depending on how you configure it. see examples       "
 /bin/echo "|  Weekly backup will run every Friday night at 12:01 AM                                                            "
 /bin/echo "|  This script, if ran automatically at night, will restart the FileWave server if postgres is not running         "
 /bin/echo "|  You can also use this script to restore a backup using the restore command                                      "
 /bin/echo "+-------------------------------------------------------------------------------------------------------------------"
 /bin/echo "|  Examples:                                                                                                        "
 /bin/echo "|                                                      "
 /bin/echo "|           Automated Backups:                                                                                      " 
 /bin/echo "|                   $SCRIPT setup daily  /Volumes/backupFolder_path                                        "
 /bin/echo "|                   $SCRIPT setup weekly  /Volumes/backupFolder_path                                       "
 /bin/echo "|           Manual Backups:                                                                                        "
 /bin/echo "|                   $SCRIPT run /Volumes/backupFolder_path   manual                                        "
 /bin/echo "|           Restore Backup:                                                                                        "
 /bin/echo "|                   $SCRIPT restore /path/to/backup.tar.gz                                                 "
 /bin/echo "|                                                  "
 /bin/echo "+-------------------------------------------------------------------------------------------------------------------"
}


#check if running as root
if [ ! $(whoami) == "root" ] ; then
        log "Script must be run as root"
        exit 1
fi

#parameter checks
if [ "$1" == "setup" ] ; then
  log "setup of backup script $0"
  if [ ! "$#" == "3" ] ; then
    syntaxError
    exit
  fi
  log "Base destination is $3"
  BASEDESTINATION="$3"
  CRONDESTINATION=$( echo "$3" | sed 's/\ /\\\ /g') 
#SCRIPTPATH=$( echo "$0" | sed 's/\ /\\\ /g')
  SCRIPTPATH=$(realpath "$0")
  SCRIPTPATH=$( echo "$SCRIPTPATH" | sed 's/\\ /\\\\\\ /g')

 
  if [ "$2" == "weekly" ] ; then
    	log "weekly..."
     	cd /usr/local/etc
	/bin/echo "0 1 * * 5  " "$SCRIPTPATH" " run " "$CRONDESTINATION" automated > fwbackup_tab
	/usr/bin/crontab fwbackup_tab
	rm fwbackup_tab
    	exit
  elif  [ "$2" == "daily" ] ; then
     	log "daily...."
	cd /usr/local/etc
        /bin/echo "0 1 * * *  " "$SCRIPTPATH" " run " "$CRONDESTINATION" automated > fwbackup_tab
        /usr/bin/crontab fwbackup_tab
        rm fwbackup_tab
	exit
  else  
    log "parameter not recognised : " "$2"
    syntaxError
    exit
  fi

elif [ "$1" == "run" ] ; then
  if [ ! "$#" == "3" ] ; then
    syntaxError
    exit
  fi
  log "base destination: $2"
  BASEDESTINATION="$2"

  # either now (means we running this script manually now) or 'automated' (this script is running from a scheduled task like cronjob)
  # the reason is that: while in automated mode, we don't care if the script restarts the server services if we have to, to be able to run postgres and dump the pg_data.
  MODE=$3

elif [ "$1" == "restore" ] ; then
  if [ ! "$#" == "2" ] ; then
    syntaxError
    exit
  fi
  ARCHIVE_PATH=$2
  if [ ! -f $ARCHIVE_PATH ]; then
    log "Archive file not found: $ARCHIVE_PATH"
    exit
  fi
  log "Starting restore from $ARCHIVE_PATH"
  if [ -d "restore" ]; then
    log "Existing restore directory found."
  fi
  mkdir restore
  tar -xzf $ARCHIVE_PATH -C restore
  log "Restore completed: Note that in this version of the script the next copies and database restore are manual"
  exit


else syntaxError
     exit    
fi

if [[ "$BASEDESTINATION" =~ ^"." ]]
then
    echo "Please provide full path to destination"
    exit 0
fi


log "=======running backup now ==========="
log "FileWave Server backup started at $(date +%H-%M) on $(date +%b-%d-%Y)"
SIZEFACTOR=2    # 2 means twice as much space as the /fwxserver folder uses must be free to start

#if base destination does not exist , create it
if [ ! -d "$BASEDESTINATION" ] ; then
	 mkdir -p "$BASEDESTINATION"
fi

if [ ! -d "$BASEDESTINATION" ] ; then
	log "Could not create dir $BASEDESTINATION"
 	exit 1
fi

#define the temporary location and archive name here
#TEMPDIR="$BASEDESTINATION"/tmp/fwxserver-Config-DB-$(date +%b-%d-%y--%H-%M)
TEMPDIR=/tmp/fwxserver-Config-DB-$(date +%b-%d-%y--%H-%M)
#make sure tempdir is created:
log "Making temp path: $TEMPDIR"
mkdir -p "$TEMPDIR"
if [ ! -d "$TEMPDIR" ]; then
 log "Could not create dir $TEMPDIR"
 exit 1
fi

DESTINATION="$BASEDESTINATION"/fw-backups
log "Making destination path: $DESTINATION"
mkdir -p  "$DESTINATION"
if [ ! -d "$DESTINATION" ]; then
 echo "Could not create dir "$DESTINATION
 exit 1
fi

#determine filewave fwxserver folder location by checking 13.1.4+ location of Data Folder
if [ -d '/usr/local/filewave/fwxserver/Data Folder' ] ; then 
SOURCEPATH="/usr/local/filewave/fwxserver"
else
SOURCEPATH="/fwxserver"
fi

#transform into absolute path just in case parameter was relative
cd "$DESTINATION"
DESTINATION="$(pwd)"

#patch for version 11 ; skip sqlite backups in case they're not there
if [ -f '/fwxserver/DB/admin.sqlite' ] ; then
    #check if sqlite3 binary is available
    if [ $(which sqlite3 2>&1 | grep "no sqlite3 in" | wc -l) -gt 0 ] ; then
            log "No sqlite3 binary found in Path. Please install sqlite3 and try again"
            exit 1
    fi
    log "sqlite3 binary available: Ok"
fi

#check if rsync binary is available
which rsync &>/dev/null
if [ $? -ne 0 ] ; then
	log "No rsync binary found in Path. Please install rsync and try again:"
	log "yum -y install rsync"
	exit 1
fi
log "rsync binary available: Ok"

#check if there's enough space left for the database backup
DESTFREE=$(df -Pk "$DESTINATION" | tail -n 1 | awk {'print $4'})
TEMPFREE=$(df -Pk "$(dirname "$TEMPDIR")" | tail -n 1 | awk {'print $4'})
BACKUPSIZE=$(du -sk "$SOURCEPATH"/DB | awk {'print $1'})
#calculate minimum free size on /tmp and destination
((BACKUPSIZE=$BACKUPSIZE*$SIZEFACTOR))
#check destination FS space availability
if [ $DESTFREE -lt $BACKUPSIZE ] ; then
	log "Not Enough Space for DB Backup at Destination"
	exit 1
fi
#check temp FS space availability
if [ $TEMPFREE -lt $BACKUPSIZE ] ; then
	log "Not enough Space on /tmp for DB Backup"
	exit 1
fi

log "Free disk space to run backup: Ok"

#start working
log  "Creating temporary backup directory at $TEMPDIR"
/bin/mkdir -p "$TEMPDIR"/DB
/bin/mkdir -p "$TEMPDIR"/certs
/bin/chmod -R 777 "$TEMPDIR"


if [ ! -f "/tmp/.s.PGSQL.9432.lock" ]; then
   log "connection to postgres database is not possible. Is postgres server running and accepting connections on Unix domain socket '/tmp/.s.PGSQL.9432'"
   # check the MODE to decide what to do:
   if [ $MODE == "manual" ]; then
     log "Please make sure your server is running properly. restarting the server with 'sudo fwcontrol server restart' might fix the issue."
     exit
   fi
   # we are then in the automated mode which most likely will run overnight like we have in the crontab setup above.
   log "restarting the server now and trying again..."
   if [ -f '/sbin/fwcontrol' ] ; then FWCONTROL='/sbin/fwcontrol' ; else FWCONTROL='/usr/local/bin/fwcontrol' ; fi
   "$FWCONTROL" postgres start
   sleep 3
   if [ ! -f "/tmp/.s.PGSQL.9432.lock" ]; then 
     log "there is still a problem with postgres not running. Please contact technical support."
     log "exiting."
     exit
   fi
fi

log "dumping MDM postgres database to :${TEMPDIR}/DB/mdm-dump.sql"
#cd /
mkdir -p "$TEMPDIR"/DB
# -c was in a prior version but was removed from below because it could result in the dump having issues.
/usr/local/filewave/postgresql/bin/pg_dump -U django --encoding=UTF8 -f "$TEMPDIR"/DB/mdm-dump.sql -N committed_* -d mdm

#patch for version 11 ; skip sqlite backups in case they're not there
if [ -f '/fwxserver/DB/admin.sqlite' ] ; then
    #copy all committed databases to temporary backup destination
    log "Backing up committed&ldap databases.."
    rsync -aL /fwxserver/DB/committed* "$TEMPDIR"/DB
    log "Backing up admin, ldap and server database.."
    echo '.dump' | sqlite3 /fwxserver/DB/admin.sqlite | sqlite3 "$TEMPDIR"/DB/admin.sqlite
    echo '.dump' | sqlite3 /fwxserver/DB/server.sqlite | sqlite3 "$TEMPDIR"/DB/server.sqlite
    echo '.dump' | sqlite3 /fwxserver/DB/ldap.sqlite | sqlite3 "$TEMPDIR"/DB/ldap.sqlite
fi

log "Backing up Server Certs.."
mkdir -p "$TEMPDIR"/certs
rsync -aL /usr/local/filewave/certs/* "$TEMPDIR"/certs

# Backup apache conf files
declare -a conf_files=("httpd.conf" "httpd_custom.conf" "httpd_webadmin.conf" "mdm_auth.conf")
log "backing up: ${conf_files[@]}"
for conf_file in ${conf_files[@]}
do
	if [ -e "/usr/local/filewave/apache/conf/$conf_file" ]
	then
		rsync -aL /usr/local/filewave/apache/conf/$conf_file "$TEMPDIR"/
	fi
done

#backup settings_custom.py
rsync -aL /usr/local/filewave/django/filewave/settings_custom.py "$TEMPDIR"/

#backup apache password files for local enrolment users
log "backing up apache htpasswd files"
rsync -aL /usr/local/filewave/apache/passwd/* "$TEMPDIR"/

#backup fwxcodes
log "backing up fwxcodes"
rsync -aL /usr/local/etc/fwxcodes "$TEMPDIR"/

#backup fwxserver.conf
log "backing up fwxserver.conf"
rsync -aL /etc/xdg/filewave/fwxserver.conf "$TEMPDIR"/

# Backup /usr/local/etc/filewave/prometheus/conf.d/jobs/http/*
log "Backing up Prometheus HTTP jobs"
mkdir -p "$TEMPDIR"/prometheus_http_jobs
rsync -aL /usr/local/etc/filewave/prometheus/conf.d/jobs/http/* "$TEMPDIR"/prometheus_http_jobs/

# Backup /usr/local/etc/filewave/prometheus/conf.d/jobs/https/*
log "Backing up Prometheus HTTPS jobs"
mkdir -p "$TEMPDIR"/prometheus_https_jobs
rsync -aL /usr/local/etc/filewave/prometheus/conf.d/jobs/https/* "$TEMPDIR"/prometheus_https_jobs/

# Backup /usr/local/filewave/instrumentation_data/grafana/grafana.db
log "Backing up Grafana database"
rsync -aL /usr/local/filewave/instrumentation_data/grafana/grafana.db "$TEMPDIR"/

# Backup /usr/local/filewave/conf/user_postgresql.conf
log "Backing up user PostgreSQL config"
rsync -aL /usr/local/filewave/conf/user_postgresql.conf "$TEMPDIR"/

###############################################
#bundle up the database and config files backup
log "zipping...."
cd "$(dirname "$TEMPDIR")"
tar cvpfz $(basename "$TEMPDIR").tar.gz $(basename "$TEMPDIR")
mv $(basename "$TEMPDIR").tar.gz "$DESTINATION"

#rsync the data folder
log "Starting rsync of Data Folder to $DESTINATION/Data Folder...."
rsync -aL "$SOURCEPATH"/Data\ Folder/ "$DESTINATION"/Data\ Folder
log "rsync data folder done"

#rsync the ipa folder
log "Starting rsync of .ipa Folder to $DESTINATION/ipa.."
rsync -aL /usr/local/filewave/ipa/ "$DESTINATION"/ipa
echo "rsync ipa done"

#rsync the media folder
log "Starting rsync of media Folder to $DESTINATION/media.."
rsync -aL /usr/local/filewave/media/ "$DESTINATION"/media
echo "rsync media done"

#rsync the custom msi and pkg folder
log "Starting rsync of the custom client folder to $DESTINATION/fwcld.."
rsync -aL /usr/local/filewave/fwcld/ "$DESTINATION"/fwcld
echo "rsync fwcld done"

###############################################
#done 
log "Removing temporary Backup Directory at $TEMPDIR"
rm -rf "$TEMPDIR"
log "FileWave Server backup completed at $(date +%H-%M) on $(date +%b-%d-%Y)"