Restore_Linux_Plex_Backup.sh

#!/usr/bin/env bash
# shellcheck disable=SC2317,SC2181
#--------------------------------------------------------------------------
# Companion script for Linux Plex Backup script.
# v1.1.7  3-Sep-2025  007revad
#
#   MUST be run by a user in sudo, sudoers or wheel group, or as root
#
# To run the script:
# sudo i /share/scripts/Restore_Linux_Plex_Backup.sh
#   Change /share/scripts/ to the path where this script is located
#
# Github: https://github.com/007revad/Linux_Plex_Backup
# Script verified at https://www.shellcheck.net/
#--------------------------------------------------------------------------

scriptver="v1.1.7"
script=Restore_Linux_Plex_Backup


# Read variables from backup_linux_plex.config
Backup_Directory=""
Name=""
snap=""
LogAll=""
if [[ -f $(dirname -- "$0";)/backup_linux_plex.config ]];then
    # shellcheck disable=SC1090,SC1091
    while read -r var; do
        if [[ $var =~ ^[a-zA-Z0-9_]+=.* ]]; then export "$var"; fi
    done < "$(dirname -- "$0";)"/backup_linux_plex.config
else
    echo "backup_linux_plex.config file missing!"
    exit 1
fi


# Check if backup directory exists
# shellcheck disable=SC2154
if [[ ! -d $Backup_Directory ]]; then
    echo "Backup directory not found:"
    echo "$Backup_Directory"
    echo "Check your setting in backup_linux_plex.config"
    exit 1
fi


#--------------------------------------------------------------------------
# Set date and time variables

# Timer variable to log time taken to backup PMS
start="${SECONDS}"

# Get Start Time and Date
Started=$( date )


#--------------------------------------------------------------------------
# Set NAS name (used in backup and log filenames)

# shellcheck disable=SC2154
case "${Name,,}" in
    distro)
        # Get Linux Distro
        Nas="$(uname -a | awk '{print $2}')"
        ;;
    hostname|"")
        # Get Hostname
        Nas=$( hostname )
        ;;
    *)
        # Set Nas to nickname
        Nas="$Name"
        ;;
esac


#--------------------------------------------------------------------------
# Get list of backups from backup path

# filelist=()
# readarray -d '' filelist < <(find "${Backup_Directory}/" -size +100\
#    \( -iname "${Nas}*.tgz" -o -iname "${Nas}*.tar.gz" \) -print0)

# set +m only needed for interactive command line. In a script job control is off by default.
#set +m
shopt -s lastpipe
u_filelist=()
BD="${Backup_Directory}"
if [[ ${1,,} == "test" ]]; then
    echo "Listing only small test backups to restore"
    find "${BD}/" -maxdepth 1 -size -1000k \( -iname "${Nas}*.tgz" -o -iname "${Nas}*.tar.gz" \) -print0 |\
        while IFS=  read -r -d $'\0'; do u_filelist+=("$REPLY"); done; declare -p u_filelist >/dev/null
else
    find "${BD}/" -maxdepth 1 -size +999k \( -iname "${Nas}*.tgz" -o -iname "${Nas}*.tar.gz" \) -print0 |\
        while IFS=  read -r -d $'\0'; do u_filelist+=("$REPLY"); done; declare -p u_filelist >/dev/null
fi

# Sort array into new array
IFS=$'\n'
filelist=($(sort <<<"${u_filelist[*]}"))
unset IFS

# Menu to select file to restore
echo "Please select a file to restore:"
num="0"
while [[ $num -lt "${#filelist[@]}" ]]; do
    echo "$((num +1))) $(basename "${filelist[$num]}")"
    num=$((num +1))
done
echo "$((num +1))) Quit"
read -r choice

# Validate choice
if [[ ! $choice -eq "0" ]] &&  [[ $choice =~ ^[0-9]+$ ]] && [[ ! $choice -gt "${#filelist[@]}" ]];
then
    index=$((choice -1))
    echo "You selected: $(basename "${filelist[$index]}")"
    tgz_file="${filelist[$index]}"
else
    exit
fi


#--------------------------------------------------------------------------
# Set log names

Backup_Name="Restore_Plex_Backup"

# Set log filename
Log_File="${Backup_Directory}"/"${Backup_Name}".log

# Set error log filename
Err_Log_File="${Backup_Directory}"/"${Backup_Name}"_ERROR.log


#--------------------------------------------------------------------------
# Create temp error log

# Create temp directory for temp error log
Tmp_Dir=$(mktemp -d -t plex_to_tar-XXXXXX)

# Create temp error log
Tmp_Err_Log_File=$(mktemp "${Tmp_Dir}"/errorlog-XXXXXX)


#--------------------------------------------------------------------------
# Create trap and clean up function

# Tmp logs clean up function
# shellcheck disable=SC2329
cleanup(){ 
    arg1=$?
    # Move tmp_error_log to error log if tmp_error_log is not empty
    if [[ -s $Tmp_Err_Log_File ]] && [[ -d $Backup_Directory ]]; then
        mv "${Tmp_Err_Log_File}" "${Err_Log_File}"
        if [[ $? -gt "0" ]]; then
            echo "WARNING Failed moving ${Tmp_Err_Log_File} to ${Err_Log_File}"\
                |& tee -a "${Err_Log_File}"
        fi
    fi
    # Delete our tmp directory
    if [[ -d $Tmp_Dir ]]; then
        rm -rf "${Tmp_Dir}"
        if [[ $? -gt "0" ]]; then
            echo "WARNING Failed deleting ${Tmp_Dir}" |& tee -a "${Err_Log_File}"
        fi
    fi

    if [[ $Version ]]; then Version="${Version} "; fi

    # Log and notify of success or errors
    if [[ -f $Err_Log_File ]]; then
        # Log and notify backup had errors
        if [[ ! -f $Log_File ]]; then
            # Add script name to top of log file
            basename -- "$0" |& tee -a "${Log_File}"
        fi
        echo -e "\n\e[41mWARNING\e[0m Plex restoration had errors! See error log:"
        echo -e "\nWARNING Plex restoration had errors! See error log:" >> "${Log_File}"
        echo -e "$(basename -- "${Err_Log_File}")\n" |& tee -a "${Log_File}"
    else
        # Log and notify of backup success
        echo -e "\nPlex restoration completed successfully" |& tee -a "${Log_File}"
    fi
    exit "${arg1}"
}

trap cleanup EXIT


#--------------------------------------------------------------------------
# Check that script is running as root

if [[ $( whoami ) != "root" ]]; then
    if [[ -d $Backup_Directory ]]; then
        echo "ERROR: This script must be run as root!" |& tee -a "${Tmp_Err_Log_File}"
        echo "ERROR: $( whoami ) is not root. Aborting." |& tee -a "${Tmp_Err_Log_File}"
    else
        # Can't log error to log file because $Backup_Directory does not exist
        echo -e "\nERROR: This script must be run as root!"
        echo -e "ERROR: $( whoami ) is not root. Aborting.\n"
    fi
    # Abort script because it isn't being run by root
    exit 255
fi


#--------------------------------------------------------------------------
# Find Plex Media Server location

# Set the Plex Media Server data location
if [[ ${snap,,} == "yes" ]]; then
    Plex_Data_Path="/var/snap/plexmediaserver/common/Library/Application Support"
else
    Plex_Data_Path="/var/lib/plexmediaserver/Library/Application Support"
fi


#--------------------------------------------------------------------------
# Check Plex Media Server data path exists

if [[ ! -d $Plex_Data_Path ]]; then
    echo "Plex Media Server data path invalid! Aborting." |& tee -a "${Tmp_Err_Log_File}"
    echo "${Plex_Data_Path}" |& tee -a "${Tmp_Err_Log_File}"
    # Abort script because Plex data path invalid
    exit 255
fi


#--------------------------------------------------------------------------
# Get Plex Media Server version

if [[ ${snap,,} == "yes" ]]; then
    #Version="$(/usr/snap/plexmediaserver/Plex\ Media\ Server --version)"
    Version="$(snap list plexmediaserver | head -n 2 | tail -n 1 | awk '{print $2}')"
    # Returns 1.29.2.6364-6d72b0cf6
    # Plex version without hex string
    Version=$(printf %s "$Version"| cut -d "-" -f1)
    # Returns 1.29.2.6364
else
    Version="$(/usr/lib/plexmediaserver/Plex\ Media\ Server --version)"
    # Returns v1.29.2.6364-6d72b0cf6
    # Plex version without v or hex string
    Version=$(printf %s "${Version:1}"| cut -d "-" -f1)
    # Returns 1.29.2.6364
fi


#--------------------------------------------------------------------------
# Start logging

echo -e "$script $scriptver\n" |& tee -a "${Log_File}"

# Log Linux distro, version and hostname
Distro="$(uname -a | awk '{print $2}')"
DistroVersion="$(uname -a | awk '{print $3}' | cut -d"-" -f1)"
echo "${Distro}" "${DistroVersion}" |& tee -a "${Log_File}"
echo "Hostname: $( hostname )" |& tee -a "${Log_File}"

# Log Plex version
echo Plex version: "${Version}" |& tee -a "${Log_File}"


#--------------------------------------------------------------------------
# Stop Plex Media Server

echo "Stopping Plex..." |& tee -a "${Log_File}"

if [[ ${snap,,} == "yes" ]]; then
    Result=$(snap stop plexmediaserver)
else
    Result=$(systemctl stop plexmediaserver)
fi
code="$?"
# Give sockets a moment to close
sleep 5

if [[ $code == "0" ]]; then
    echo "Plex Media Server has stopped." |& tee -a "$Log_File"
else
    echo "$Result" |& tee -a "$Log_File"
    exit $code
fi


# Nicely terminate any residual Plex processes (plug-ins, tuner service and EAE etc)
###pgrep [Pp]lex | xargs kill -15 &>/dev/null
# Give sockets a moment to close
###sleep 5

# Kill any residual processes which DSM did not clean up (plug-ins and EAE)
Pids="$(ps -ef | grep -i 'plex plug-in' | grep -v grep | awk '{print $2}')"
[ "$Pids" != "" ] && kill -9 "$Pids"

Pids="$(ps -ef | grep -i 'plex eae service' | grep -v grep | awk '{print $2}')"
[ "$Pids" != "" ] && kill -9 "$Pids"

Pids="$(ps -ef | grep -i 'plex tuner service' | grep -v grep | awk '{print $2}')"
[ "$Pids" != "" ] && kill -9 "$Pids"

# Give sockets a moment to close
sleep 2


#--------------------------------------------------------------------------
# Check if all Plex processes have stopped

echo Checking status of Plex processes... |& tee -a "${Log_File}"
Response=$(pgrep -l plex)
# Check if plexmediaserver was found in $Response
if [[ -n $Response ]]; then
    # Forcefully kill any residual Plex processes (plug-ins, tuner service and EAE etc)
    pgrep [Pp]lex | xargs kill -9 &>/dev/null
    sleep 5

    # Check if plexmediaserver still found in $Response
    Response=$(pgrep -l plex)
    if [[ -n $Response ]]; then
        echo "ERROR: Some Plex processes still running! Aborting restore."\
            |& tee -a "${Log_File}" "${Tmp_Err_Log_File}"
        echo "${Response}" |& tee -a "${Log_File}" "${Tmp_Err_Log_File}"
        # Start Plex to make sure it's not left partially running
        if [[ ${snap,,} == "yes" ]]; then
            snap start plexmediaserver
        else
            #/usr/lib/plexmediaserver/Resources/start.sh
            systemctl start plexmediaserver
        fi
        # Abort script because Plex didn't shut down fully
        exit 255
    else
        echo "All Plex processes have stopped." |& tee -a "${Log_File}"
    fi
else
    echo "All Plex processes have stopped." |& tee -a "${Log_File}"
fi


#--------------------------------------------------------------------------
# Restore Plex Media Server from backup

echo "=================================================" |& tee -a "${Log_File}"
echo "Restoring Plex Media Server data files from:" |& tee -a "${Log_File}"
basename "$tgz_file" |& tee -a "${Log_File}"

# Use short variable names so tar command is not too long
BD="${Backup_Directory}"
#BN="${Backup_Name}"
PDP="${Plex_Data_Path}"
LF="${Log_File}"
TELF="${Tmp_Err_Log_File}"
#PMS="Plex Media Server"

# Restore tgz backup to PMS, send all output to shell and log, plus errors to error.log
# Using -C to change directory to "/share/Plex/Library/Application Support"
# shellcheck disable=SC2154
if [[ ${LogAll,,} == "yes" ]]; then
    echo "Logging all restored files" |& tee -a "${Log_File}"
    tar -zxvpf "$tgz_file" -C "${PDP}" > >(tee -a "${LF}") 2> >(tee -a "${LF}" "${TELF}" >&2)
else
    # Don't log all backed up files.
    echo "Only logging errors" |& tee -a "${Log_File}"
    tar -zxvpf "$tgz_file" -C "${PDP}" 2> >(tee -a "${LF}" "${TELF}" >&2)
fi

echo "Finished restoring Plex Media Server data files." |& tee -a "${Log_File}"
echo "=================================================" |& tee -a "${Log_File}"


#--------------------------------------------------------------------------
# Start Plex Media Server

echo "Starting Plex..." |& tee -a "${Log_File}"
if [[ ${snap,,} == "yes" ]]; then
    snap start plexmediaserver
else
    #/usr/lib/plexmediaserver/Resources/start.sh
    systemctl start plexmediaserver
fi


#--------------------------------------------------------------------------
# Append the time taken to stdout and log file

# End Time and Date
Finished=$( date )

# bash timer variable to log time taken to backup Plex
end="${SECONDS}"

# Elapsed time in seconds
Runtime=$(( end - start ))

# Append start and end date/time and runtime
echo -e "\nRestore Started: " "${Started}" |& tee -a "${Log_File}"
echo "Restore Finished:" "${Finished}" |& tee -a "${Log_File}"
# Append days, hours, minutes and seconds from $Runtime
printf "Restore Duration: " |& tee -a "${Log_File}"
printf '%dd:%02dh:%02dm:%02ds\n' \
$((Runtime/86400)) $((Runtime%86400/3600)) $((Runtime%3600/60))\
    $((Runtime%60)) |& tee -a "${Log_File}"


#--------------------------------------------------------------------------
# Trigger cleanup function

exit 0