Add auto transfer backup file to FTP server

backup.sh

@@ -1,18 +1,27 @@
 #!/usr/bin/env bash
-PATH=/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:~/bin
-#==============================================================#
-#   Description: backup script                                 #
-#   Author: Teddysun <[email protected]>                          #
-#   Visit:  https://teddysun.com                               #
-#==============================================================#
-
-[[ $EUID -ne 0 ]] && echo 'Error: This script must be run as root!' && exit 1
-
-### START OF CONFIG ###
-# Encrypt flag(true:encrypt, false:not encrypt)
+#
+# Auto backup script
+#
+# Copyright (C) 2016 Teddysun <[email protected]>
+#
+# URL: https://teddysun.com/469.html
+#
+# You must to modify the config before run it!!!
+# Backup MySQL/MariaDB/Percona datebases, files and directories
+# Backup file is encrypted with AES256-cbc with SHA1 message-digest (option)
+# Auto transfer backup file to Google Drive (need install gdrive command) (option)
+# Auto transfer backup file to FTP server (option)
+# Auto delete Google Drive's or FTP server's remote file (option)
+#
+
+[[ $EUID -ne 0 ]] && echo "Error: This script must be run as root!" && exit 1
+
+########## START OF CONFIG ##########
+
+# Encrypt flag (true: encrypt, false: not encrypt)
 ENCRYPTFLG=true
 
-# KEEP THE PASSWORD SAFE.
+# WARNING: KEEP THE PASSWORD SAFE!!!
 # The password used to encrypt the backup
 # To decrypt backups made by this script, run the following command:
 # openssl enc -aes256 -in [encrypted backup] -out decrypted_backup.tgz -pass pass:[backup password] -d -md sha1
@@ -27,150 +36,174 @@ TEMPDIR="/root/backups/temp/"
 # File to log the outcome of backups
 LOGFILE="/root/backups/backup.log"
 
-# OPTIONAL: If you want MySQL to be backed up, enter the root password below
+# OPTIONAL: If you want backup MySQL database, enter the MySQL root password below
 MYSQL_ROOT_PASSWORD=""
 
 # Below is a list of MySQL database name that will be backed up
-# if you want backup all databases, leave it blank.
+# If you want backup ALL databases, leave it blank.
 MYSQL_DATABASE_NAME[0]=""
 
 # Below is a list of files and directories that will be backed up in the tar backup
 # For example:
 # File: /data/www/default/test.tgz
-# Directory: /data/www/default/test/
-# if you want not to be backed up, leave it blank.
+# Directory: /data/www/default/test
 BACKUP[0]=""
 
-# Number of days to store daily local backups
+# Number of days to store daily local backups (default 7 days)
 LOCALAGEDAILIES="7"
 
-# Delete Googole Drive's remote file flag(true:delete, false:not delete)
-DELETE_REMOTE_FILE_FLG=true
+# Delete Googole Drive's & FTP server's remote file flag (true: delete, false: not delete)
+DELETE_REMOTE_FILE_FLG=false
+
+# Upload to FTP server flag (true: upload, false: not upload)
+FTP_FLG=false
+
+# FTP server
+# OPTIONAL: If you want upload to FTP server, enter the Hostname or IP address below
+FTP_HOST=""
+
+# FTP username
+# OPTIONAL: If you want upload to FTP server, enter the FTP username below
+FTP_USER=""
+
+# FTP password
+# OPTIONAL: If you want upload to FTP server, enter the username's password below
+FTP_PASS=""
+
+# FTP server remote folder
+# OPTIONAL: If you want upload to FTP server, enter the FTP remote folder below
+# For example: public_html
+FTP_DIR=""
+
+########## END OF CONFIG ##########
+
+
 
 # Date & Time
+DAY=$(date +%d)
+MONTH=$(date +%m)
+YEAR=$(date +%C%y)
 BACKUPDATE=$(date +%Y%m%d%H%M%S)
-
 # Backup file name
 TARFILE="${LOCALDIR}""$(hostname)"_"${BACKUPDATE}".tgz
-
+# Encrypted backup file name
+ENC_TARFILE="${TARFILE}.enc"
 # Backup MySQL dump file name
 SQLFILE="${TEMPDIR}mysql_${BACKUPDATE}.sql"
 
-### END OF CONFIG ###
-
-
 log() {
     echo "$(date "+%Y-%m-%d %H:%M:%S")" "$1"
     echo -e "$(date "+%Y-%m-%d %H:%M:%S")" "$1" >> ${LOGFILE}
 }
 
+# Check for list of mandatory binaries
+check_commands() {
+    # This section checks for all of the binaries used in the backup
+    BINARIES=( cat cd du date dirname echo openssl mysql mysqldump pwd rm tar ftp )
+    
+    # Iterate over the list of binaries, and if one isn't found, abort
+    for BINARY in "${BINARIES[@]}"; do
+        if [ ! "$(command -v "$BINARY")" ]; then
+            log "$BINARY is not installed. Install it and try again"
+            exit 1
+        fi
+    done
 
-### START OF CHECKS ###
-# Check if the backup folders exist and are writeable
-if [ ! -d "${LOCALDIR}" ]; then
-    mkdir -p ${LOCALDIR}
-fi
-if [ ! -d "${TEMPDIR}" ]; then
-    mkdir -p ${TEMPDIR}
-fi
-
-# This section checks for all of the binaries used in the backup
-BINARIES=( cat cd du date dirname echo openssl mysql mysqldump pwd rm tar )
-
-# Iterate over the list of binaries, and if one isn't found, abort
-for BINARY in "${BINARIES[@]}"; do
-    if [ ! "$(command -v "$BINARY")" ]; then
-        log "$BINARY is not installed. Install it and try again"
-        exit 1
+    # check gdrive command
+    GDRIVE_COMMAND=false
+    if [ "$(command -v "gdrive")" ]; then
+        GDRIVE_COMMAND=true
     fi
-done
-### END OF CHECKS ###
-
-STARTTIME=$(date +%s)
-cd ${LOCALDIR} || exit
-log "Backup progress start"
+}
 
+calculate_size() {
+    local file_name=$1
+    local file_size=$(du -h $file_name 2>/dev/null | awk '{print $1}')
+    if [ "x${file_size}" = "x" ]; then
+        echo "unknown"
+    else
+        echo "${file_size}"
+    fi
+}
 
-### START OF MYSQL BACKUP ###
-if [ -z ${MYSQL_ROOT_PASSWORD} ]; then
-    log "MySQL root password not set, MySQL back up skip"
-else
-    log "MySQL dump start"
-    mysql -u root -p"${MYSQL_ROOT_PASSWORD}" 2>/dev/null <<EOF
+# Backup MySQL databases
+mysql_backup() {
+    if [ -z ${MYSQL_ROOT_PASSWORD} ]; then
+        log "MySQL root password not set, MySQL backup skipped"
+    else
+        log "MySQL dump start"
+        mysql -u root -p"${MYSQL_ROOT_PASSWORD}" 2>/dev/null <<EOF
 exit
 EOF
-    if [ $? -ne 0 ]; then
-        log "MySQL root password is incorrect. Please check it and try again"
-        exit 1
-    fi
-
-    if [ "${MYSQL_DATABASE_NAME[*]}" == "" ]; then
-        mysqldump -u root -p"${MYSQL_ROOT_PASSWORD}" --all-databases > "${SQLFILE}" 2>/dev/null
         if [ $? -ne 0 ]; then
-            log "MySQL all databases backup failed"
+            log "MySQL root password is incorrect. Please check it and try again"
             exit 1
         fi
-        log "MySQL all databases dump file name: ${SQLFILE}"
-        #Add MySQL backup dump file to BACKUP list
-        BACKUP=(${BACKUP[*]} ${SQLFILE})
-    else
-        for db in ${MYSQL_DATABASE_NAME[*]}
-        do
-            unset DBFILE
-            DBFILE="${TEMPDIR}${db}_${BACKUPDATE}.sql"
-            mysqldump -u root -p"${MYSQL_ROOT_PASSWORD}" ${db} > "${DBFILE}" 2>/dev/null
+    
+        if [ "${MYSQL_DATABASE_NAME[*]}" == "" ]; then
+            mysqldump -u root -p"${MYSQL_ROOT_PASSWORD}" --all-databases > "${SQLFILE}" 2>/dev/null
             if [ $? -ne 0 ]; then
-                log "MySQL database name [${db}] backup failed, please check database name is correct and try again"
+                log "MySQL all databases backup failed"
                 exit 1
             fi
-            log "MySQL database name [${db}] dump file name: ${DBFILE}"
+            log "MySQL all databases dump file name: ${SQLFILE}"
             #Add MySQL backup dump file to BACKUP list
-            BACKUP=(${BACKUP[*]} ${DBFILE})
-        done
+            BACKUP=(${BACKUP[*]} ${SQLFILE})
+        else
+            for db in ${MYSQL_DATABASE_NAME[*]}
+            do
+                unset DBFILE
+                DBFILE="${TEMPDIR}${db}_${BACKUPDATE}.sql"
+                mysqldump -u root -p"${MYSQL_ROOT_PASSWORD}" ${db} > "${DBFILE}" 2>/dev/null
+                if [ $? -ne 0 ]; then
+                    log "MySQL database name [${db}] backup failed, please check database name is correct and try again"
+                    exit 1
+                fi
+                log "MySQL database name [${db}] dump file name: ${DBFILE}"
+                #Add MySQL backup dump file to BACKUP list
+                BACKUP=(${BACKUP[*]} ${DBFILE})
+            done
+        fi
+        log "MySQL dump completed"
     fi
+}
 
-    log "MySQL dump completed"
-
-fi
-### END OF MYSQL BACKUP ###
-
-
-### START OF TAR BACKUP ###
-log "Tar backup file start"
-tar -zcPf ${TARFILE} ${BACKUP[*]}
-if [ $? -ne 0 ]; then
-    log "Tar backup file failed"
-    exit 1
-fi
-log "Tar backup file completed"
+start_backup() {
+    [ "${BACKUP[*]}" == "" ] && echo "Error: You must to modify the [$(basename $0)] config before run it!" && exit 1
 
-# Encrypt tar file
-if ${ENCRYPTFLG}; then
-    log "Encrypt backup file start"
-    openssl enc -aes256 -in "${TARFILE}" -out "${TARFILE}.enc" -pass pass:"${BACKUPPASS}" -md sha1
-    log "Encrypt backup file completed"
+    log "Tar backup file start"
+    tar -zcPf ${TARFILE} ${BACKUP[*]}
+    if [ $? -gt 1 ]; then
+        log "Tar backup file failed"
+        exit 1
+    fi
+    log "Tar backup file completed"
 
-    # Delete unencrypted tar
-    log "Delete unencrypted tar file: ${TARFILE}"
-    rm -f ${TARFILE}
-fi
+    # Encrypt tar file
+    if ${ENCRYPTFLG}; then
+        log "Encrypt backup file start"
+        openssl enc -aes256 -in "${TARFILE}" -out "${ENC_TARFILE}" -pass pass:"${BACKUPPASS}" -md sha1
+        log "Encrypt backup file completed"
 
-# Delete MySQL temporary dump file
-for sql in `ls ${TEMPDIR}*.sql`
-do
-    log "Delete MySQL temporary dump file: ${sql}"
-    rm -f ${sql}
-done
+        # Delete unencrypted tar
+        log "Delete unencrypted tar file: ${TARFILE}"
+        rm -f ${TARFILE}
+    fi
 
-log "Backup progress complete"
+    # Delete MySQL temporary dump file
+    for sql in `ls ${TEMPDIR}*.sql`
+    do
+        log "Delete MySQL temporary dump file: ${sql}"
+        rm -f ${sql}
+    done
 
-if ${ENCRYPTFLG}; then
-    BACKUPSIZE=$(du -h ${TARFILE}.enc | cut -f1)
-    log "File name: ${TARFILE}.enc, File size: ${BACKUPSIZE}"
-else
-    BACKUPSIZE=$(du -h ${TARFILE} | cut -f1)
-    log "File name: ${TARFILE}, File size: ${BACKUPSIZE}"
-fi
+    if ${ENCRYPTFLG}; then
+        OUT_FILE="${ENC_TARFILE}"
+    else
+        OUT_FILE="${TARFILE}"
+    fi
+    log "File name: ${OUT_FILE}, File size: `calculate_size ${OUT_FILE}`"
+}
 
 # Transfer backup file to Google Drive
 # If you want to install gdrive command, please visit website:
@@ -178,33 +211,51 @@ fi
 # of cause, you can use below command to install it
 # For x86_64: wget -O /usr/bin/gdrive http://dl.lamp.sh/files/gdrive-linux-x64; chmod +x /usr/bin/gdrive
 # For i386: wget -O /usr/bin/gdrive http://dl.lamp.sh/files/gdrive-linux-386; chmod +x /usr/bin/gdrive
+gdrive_upload() {
+    if ${GDRIVE_COMMAND}; then
+        log "Tranferring backup file to Google Drive"
+        gdrive upload --no-progress ${OUT_FILE} >> ${LOGFILE}
+        if [ $? -ne 0 ]; then
+            log "Error: Tranferring backup file to Google Drive failed"
+            exit 1
+        fi
+        log "Tranferring backup file to Google Drive completed"
+    fi
+}
 
-if [ ! "$(command -v "gdrive")" ]; then
-    GDRIVE_COMMAND=false
-    log "gdrive is not installed"
-    log "File transfer skipped. please install it and try again"
-else
-    GDRIVE_COMMAND=true
-    log "Tranferring backup file to Google Drive"
-    if ${ENCRYPTFLG}; then
-        gdrive upload --no-progress ${TARFILE}.enc >> ${LOGFILE}
-    else
-        gdrive upload --no-progress ${TARFILE} >> ${LOGFILE}
+# Tranferring backup file to FTP server
+ftp_upload() {
+    if ${FTP_FLG}; then
+        [ -z ${FTP_HOST} ] && echo "Error: FTP_HOST can not be empty!" && exit 1
+        [ -z ${FTP_USER} ] && echo "Error: FTP_USER can not be empty!" && exit 1
+        [ -z ${FTP_PASS} ] && echo "Error: FTP_PASS can not be empty!" && exit 1
+        [ -z ${FTP_DIR} ] && echo "Error: FTP_DIR can not be empty!" && exit 1
+
+        local FTP_OUT_FILE=$(basename ${OUT_FILE})
+        log "Tranferring backup file to FTP server"
+        ftp -in ${FTP_HOST} 2>&1 >> ${LOGFILE} <<EOF
+user $FTP_USER $FTP_PASS
+binary
+lcd $LOCALDIR
+cd $FTP_DIR
+put $FTP_OUT_FILE
+quit
+EOF
+        log "Tranferring backup file to FTP server completed"
     fi
-    log "Tranfer completed"
-fi
-### END OF TAR BACKUP ###
+}
 
+# Get file date
+get_file_date() {
+    #Approximate a 30-day month and 365-day year
+    DAYS=$(( $((10#${YEAR}*365)) + $((10#${MONTH}*30)) + $((10#${DAY})) ))
 
-### START OF DELETE OLD BACKUP FILE###
-getFileDate() {
-    unset FILEYEAR FILEMONTH FILEDAY FILETIME FILEDAYS FILEAGE
+    unset FILEYEAR FILEMONTH FILEDAY FILEDAYS FILEAGE
     FILEYEAR=$(echo "$1" | cut -d_ -f2 | cut -c 1-4)
     FILEMONTH=$(echo "$1" | cut -d_ -f2 | cut -c 5-6)
     FILEDAY=$(echo "$1" | cut -d_ -f2 | cut -c 7-8)
-    FILETIME=$(echo "$1" | cut -d_ -f2 | cut -c 9-14)
 
-    if [[ "${FILEYEAR}" && "${FILEMONTH}" && "${FILEDAY}" && "${FILETIME}" ]]; then
+    if [[ "${FILEYEAR}" && "${FILEMONTH}" && "${FILEDAY}" ]]; then
         #Approximate a 30-day month and 365-day year
         FILEDAYS=$(( $((10#${FILEYEAR}*365)) + $((10#${FILEMONTH}*30)) + $((10#${FILEDAY})) ))
         FILEAGE=$(( 10#${DAYS} - 10#${FILEDAYS} ))
@@ -214,45 +265,79 @@ getFileDate() {
     return 1
 }
 
-deleteRemoteFile() {
+# Delete Google Drive's old backup file
+delete_gdrive_file() {
     local FILENAME=$1
     if ${DELETE_REMOTE_FILE_FLG} && ${GDRIVE_COMMAND}; then
         local FILEID=$(gdrive list -q "name = '${FILENAME}'" --no-header | awk '{print $1}')
         if [ -n ${FILEID} ]; then
             gdrive delete ${FILEID} >> ${LOGFILE}
-            log "Google Drive's old backup file name:${FILENAME} has been deleted"
+            log "Google Drive's old backup file name: ${FILENAME} has been deleted"
         fi
     fi
 }
 
-AGEDAILIES=${LOCALAGEDAILIES}
-DAY=$(date +%d)
-MONTH=$(date +%m)
-YEAR=$(date +%C%y)
-#Approximate a 30-day month and 365-day year
-DAYS=$(( $((10#${YEAR}*365)) + $((10#${MONTH}*30)) + $((10#${DAY})) ))
+# Delete FTP server's old backup file
+delete_ftp_file() {
+    local FILENAME=$1
+    if ${DELETE_REMOTE_FILE_FLG} && ${FTP_FLG}; then
+        ftp -in ${FTP_HOST} 2>&1 >> ${LOGFILE} <<EOF
+user $FTP_USER $FTP_PASS
+cd $FTP_DIR
+del $FILENAME
+quit
+EOF
+        log "FTP server's old backup file name: ${FILENAME} has been deleted"
+    fi
+}
 
-cd ${LOCALDIR} || exit
+# Clean up old file
+clean_up_files() {
+    cd ${LOCALDIR} || exit
 
-if ${ENCRYPTFLG}; then
-    LS=($(ls *.enc))
-else
-    LS=($(ls *.tgz))
-fi
+    if ${ENCRYPTFLG}; then
+        LS=($(ls *.enc))
+    else
+        LS=($(ls *.tgz))
+    fi
 
-for f in ${LS[*]}
-do
-    getFileDate ${f}
-    if [ $? == 0 ]; then
-        if [[ ${FILEAGE} -gt ${AGEDAILIES} ]]; then
-            rm -f ${f}
-            log "Old backup file name:${f} has been deleted"
-            deleteRemoteFile ${f}
+    for f in ${LS[@]}
+    do
+        get_file_date ${f}
+        if [ $? == 0 ]; then
+            if [[ ${FILEAGE} -gt ${LOCALAGEDAILIES} ]]; then
+                rm -f ${f}
+                log "Old backup file name: ${f} has been deleted"
+                delete_gdrive_file ${f}
+                delete_ftp_file ${f}
+            fi
         fi
-    fi
-done
-### END OF DELETE OLD BACKUP FILE###
+    done
+}
+
+# Main progress
+STARTTIME=$(date +%s)
+
+# Check if the backup folders exist and are writeable
+if [ ! -d "${LOCALDIR}" ]; then
+    mkdir -p ${LOCALDIR}
+fi
+if [ ! -d "${TEMPDIR}" ]; then
+    mkdir -p ${TEMPDIR}
+fi
+
+log "Backup progress start"
+check_commands
+mysql_backup
+start_backup
+log "Backup progress complete"
+
+log "Upload progress start"
+gdrive_upload
+ftp_upload
+log "Upload progress complete"
 
+clean_up_files
 
 ENDTIME=$(date +%s)
 DURATION=$((ENDTIME - STARTTIME))