Feature/b2 backup support (hestiacp#1534)

* Add download and validation routine for b2 backup support.

* Add config part, example and credential validation

* Add upload function, thanks to @rez0n.

* Fix a small issue with var definition.

* Small fixes

* Increase version number to 1.4.0

* Add WebUI support 
Add check at v-add-backup-host
Added information v-list-backup-host

* Replaced remote backup with input box
Fixed minor issue with saving

* Update code formating.

* Drop commented error reporting.

Co-authored-by: Jaap Marcus <9754650+jaapmarcus@users.noreply.github.com>

Author: ScIT-Raphael

bin/v-add-backup-host

@@ -4,6 +4,7 @@
 # labels: 
 #
 # example: v-add-backup-host sftp backup.acme.com admin p4$$w@Rd
+#          v-add-backup-host b2 bucketName keyID applicationKey
 #
 # This function adds a backup host
 
@@ -25,6 +26,10 @@ port=$6
 source $HESTIA/func/main.sh
 source $HESTIA/conf/hestia.conf
 
+# Paths
+b2cli="/usr/local/bin/b2"
+b2lnk="https://f000.backblazeb2.com/file/backblazefiles/b2/cli/linux/b2"
+
 # Defining ftp command function
 ftpc() {
     ftp -p -n $host $port <<EOF
@@ -103,9 +108,11 @@ if [ "$type" != 'local' ];then
         which expect >/dev/null 2>&1
         check_result $? "expect command not found"  $E_NOTEXIST
     fi
-    if ! (is_ip_format_valid "$host" >/dev/null); then
-        host "$host" >/dev/null 2>&1
-        check_result $? "host connection failed" "$E_CONNECT"
+    if [ "$type" != 'b2' ]; then
+        if ! (is_ip_format_valid "$host" >/dev/null); then
+            host "$host" >/dev/null 2>&1
+            check_result $? "host connection failed" "$E_CONNECT"
+        fi
     fi
 fi
 
@@ -146,6 +153,7 @@ if [ "$type" = 'ftp' ]; then
         exit $E_FTP
     fi
 fi
+
 if [ "$type" = 'sftp' ]; then
     if [ -z $port ]; then
         port=22
@@ -173,14 +181,46 @@ if [ "$type" = 'sftp' ]; then
     fi
 fi
 
+if [ "$type" = 'b2' ]; then
+    # Download b2 binary
+    if [ ! -f "$b2cli" ]; then
+        wget -O $b2cli $b2lnk > /dev/null 2>&1
+        chmod +x $b2cli > /dev/null 2>&1
+        if [ ! -f "$b2cli" ]; then
+            echo "Error: Binary download failed, b2 doesnt work as expected."
+            exit 3
+        fi
+    fi
+
+    # Validate b2 binary
+    b2version="$(b2 version)"
+    if [[ ! "$b2version" =~ "b2 command line tool" ]]; then
+        echo "Error: Binary download failed, b2 doesnt work as expected."
+        exit 3
+    fi
+    
+    b2 clear-account > /dev/null 2>&1
+    b2 authorize-account "$user" "$raw_password"> /dev/null 2>&1
+    b2 ls --long $host $user > /dev/null 2>&1
+    
+    if [ $? -ne 0 ]; then
+        check_result "$E_CONNECT" "b2 failed to verify connection"
+    fi
+fi
 
 # Adding backup host
-if [ $type != 'local' ]; then
+if [ $type != 'local' ] && [ $type != 'b2' ]; then
     new_timestamp
     str="HOST='$host'\nUSERNAME='$user'\nPASSWORD='$password'"
     str="$str\nBPATH='$path'\nPORT='$port'\nTIME='$time'\nDATE='$date'"
     echo -e "$str" > $HESTIA/conf/$type.backup.conf
     chmod 660 $HESTIA/conf/$type.backup.conf
+elif [ $type == 'b2' ]; then
+    new_timestamp
+    str="BUCKET='$host'\nB2_KEYID='$user'\nB2_KEY='$password'"
+    str="$str\nTIME='$time'\nDATE='$date'"
+    echo -e "$str" > $HESTIA/conf/$type.backup.conf
+    chmod 660 $HESTIA/conf/$type.backup.conf
 fi
 
 

bin/v-backup-user

@@ -594,6 +594,7 @@ for backup_type in $(echo -e "${BACKUP_SYSTEM//,/\\n}"); do
         ftp)   ftp_backup ;;
         sftp)  sftp_backup ;;
         google) google_backup ;;
+        b2) b2_backup ;;
     esac
 done
 

bin/v-list-backup-host

@@ -21,6 +21,8 @@ source $HESTIA/func/main.sh
 
 # JSON list function
 json_list() {
+    case $type in 
+    'sftp' | 'ftp')
     echo '{'
     echo '    "'$type'": {
         "HOST": "'$HOST'",
@@ -32,28 +34,67 @@ json_list() {
         "DATE": "'$DATE'"
     }'
     echo '}'
+    ;;
+    'b2')
+     echo '{'
+     echo '    "'$type'": {
+         "BUCKET": "'$BUCKET'",
+         "TYPE": "'$type'",
+         "B2_KEY_ID": "'$B2_KEYID'",
+         "TIME": "'$TIME'",
+         "DATE": "'$DATE'"
+     }'
+     echo '}' 
+    ;;
+    esac
 }
 
 # SHELL list function
 shell_list() {
+    case $type in
+    'sftp' | 'ftp')
     echo "HOST:           $HOST"
     echo "USERNAME:       $USERNAME"
     echo "PORT:           $PORT"
     echo "TYPE:           $type"
     echo "PATH:           $BPATH"
     echo "TIME:           $TIME"
     echo "DATE:           $DATE"
+    ;;
+    'b2')
+    echo "BUCKET          $BUCKET"
+    echo "TYPE            $type"
+    echo "B2_KEY_ID       $B2_KEYID"
+    echo "TIME:           $TIME"
+    echo "DATE:           $DATE"
+    ;;
+    esac
 }
 
 # PLAIN list function
 plain_list() {
+    case $type in
+    'sftp' | 'ftp')
     echo -e "$HOST\t$USERNAME\t$PORT\t$type\t$BPATH\t$TIME\t$DATE"
+    ;;
+    'b2')
+    echo -e "$BUCKET\t$type\t$B2_KEYID\t$TIME\t$DATE"
+    ;;
+    esac 
 }
 
 # CSV list function
 csv_list() {
+    case $type in
+    'sftp' | 'ftp')
     echo "HOST,USERNAME,PORT,TYPE,PATH,TIME,DATE"
     echo "$HOST,$USERNAME,$PORT,$type,$BPATH,$TIME,$DATE"
+    ;;
+    'b2')
+    echo "BUCKET,TYPE,B2_KEYID,TIME,DATE"
+    echo "$BUCKET,$type,$B2_KEYID,$TIME,$DATE"
+    ;;
+    esac 
 }
 
 # Type format validator

func/backup.sh

@@ -418,4 +418,43 @@ google_download() {
     if [ "$?" -ne 0 ]; then
         check_result "$E_CONNECT" "gsutil failed to download $1"
     fi
-} 
+}
+
+# BackBlaze B2 backup function
+b2_backup() {
+    # Defining backblaze b2 settings
+    source $HESTIA/conf/b2.backup.conf
+
+    # Recreate backblaze auth file ~/.b2_account_info (for situation when key was changed in b2.backup.conf)
+    b2 clear-account > /dev/null 2>&1
+    b2 authorize-account $B2_KEYID $B2_KEY > /dev/null 2>&1
+
+    # Uploading backup archive
+    echo -e "$(date "+%F %T") Upload to B2: $user/$user.$backup_new_date.tar"
+    if [ "$localbackup" = 'yes' ]; then
+        cd $BACKUP
+        b2 upload-file $BUCKET $user.$backup_new_date.tar $user/$user.$backup_new_date.tar > /dev/null 2>&1
+    else
+        cd $tmpdir
+        tar -cf $BACKUP/$user.$backup_new_date.tar .
+        cd $BACKUP/
+        b2 upload-file $BUCKET $user.$backup_new_date.tar $user/$user.$backup_new_date.tar > /dev/null 2>&1
+        rc=$?
+        rm -f $user.$backup_new_date.tar
+        if [ "$rc" -ne 0 ]; then
+            check_result "$E_CONNECT" "b2 failed to upload $user.$backup_new_date.tar"
+        fi
+    fi
+
+    # Checking retention
+    backup_list=$(b2 ls --long $BUCKET $user | cut -f 1 -d ' ' 2>/dev/null)
+    backups_count=$(echo "$backup_list" |wc -l)
+    if [ "$backups_count" -ge "$BACKUPS" ]; then
+        backups_rm_number=$((backups_count - BACKUPS))
+        for backup in $(echo "$backup_list" |head -n $backups_rm_number); do
+            backup_file_name=$(b2 get-file-info $backup | grep fileName | cut -f 4 -d '"' 2>/dev/null)
+            echo -e "$(date "+%F %T") Rotated b2 backup: $backup_file_name"
+            b2 delete-file-version $backup > /dev/null 2>&1
+        done
+    fi
+}

install/hst-install-debian.sh

@@ -23,7 +23,7 @@ HESTIA_INSTALL_DIR="$HESTIA/install/deb"
 VERBOSE='no'
 
 # Define software versions
-HESTIA_INSTALL_VER='1.3.3~alpha'
+HESTIA_INSTALL_VER='1.4.0~alpha'
 pma_v='5.0.4'
 rc_v="1.4.10"
 multiphp_v=("5.6" "7.0" "7.1" "7.2" "7.3" "7.4" "8.0")

install/hst-install-ubuntu.sh

@@ -23,7 +23,7 @@ HESTIA_INSTALL_DIR="$HESTIA/install/deb"
 VERBOSE='no'
 
 # Define software versions
-HESTIA_INSTALL_VER='1.3.3~alpha'
+HESTIA_INSTALL_VER='1.4.0~alpha'
 pma_v='5.0.4'
 rc_v="1.4.10"
 multiphp_v=("5.6" "7.0" "7.1" "7.2" "7.3" "7.4" "8.0")

src/deb/hestia/control

@@ -1,7 +1,7 @@
 Source: hestia
 Package: hestia
 Priority: optional
-Version: 1.3.3~alpha
+Version: 1.4.0~alpha
 Section: admin
 Maintainer: HestiaCP <info@hestiacp.com>
 Homepage: https://www.hestiacp.com