Merge pull request #180 from ChuckPa/chuckpa/cleanup-purge

Minor cleanup from 1.10 release
This commit is contained in:
Chuck 2025-01-02 18:33:37 -05:00 committed by GitHub
commit 804c9014d1
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 186 additions and 150 deletions

View File

@ -2,12 +2,12 @@
######################################################################### #########################################################################
# Plex Media Server database check and repair utility script. # # Plex Media Server database check and repair utility script. #
# Maintainer: ChuckPa # # Maintainer: ChuckPa #
# Version: v1.09.00 # # Version: v1.10.01 #
# Date: 06-Nov-2024 # # Date: 02-Jan-2025 #
######################################################################### #########################################################################
# Version for display purposes # Version for display purposes
Version="v1.09.00" Version="v1.10.01"
# Have the databases passed integrity checks # Have the databases passed integrity checks
CheckedDB=0 CheckedDB=0
@ -1146,149 +1146,187 @@ DoRepair() {
fi fi
} }
##### DoReplace ##### Replace current DB with a valid backup DB (if available)
DoReplace() { DoReplace() {
# If Databases already checked, confirm the user really wants to do this # If Databases already checked, confirm the user really wants to do this
Confirmed=0 Confirmed=0
Fail=0 Fail=0
if CheckDatabases "Replace"; then if CheckDatabases "Replace"; then
if ConfirmYesNo "Are you sure you want to restore a previous database backup"; then if ConfirmYesNo "Are you sure you want to restore a previous database backup "; then
Confirmed=1 Confirmed=1
fi fi
fi
if [ $Damaged -eq 1 ] || [ $Confirmed -eq 1 ]; then
# Get list of dates to use
Dates="$(GetDates)"
# If no backups, error and exit
if [ "$Dates" = "" ] && [ $Damaged -eq 1 ]; then
Output "Database is damaged and no backups avaiable."
Output "Only available option is Repair."
WriteLog "Replace - Scan for usable candidates - FAIL"
return 1
fi fi
if [ $Damaged -eq 1 ] || [ $Confirmed -eq 1 ]; then Output "Checking for a usable backup."
# Get list of dates to use Candidate=""
Dates="$(GetDates)"
# If no backups, error and exit # Make certain there is ample free space
if [ "$Dates" = "" ] && [ $Damaged -eq 1 ]; then if ! FreeSpaceAvailable ; then
Output "Database is damaged and no backups avaiable." Output "ERROR: Insufficient free space available on $AppSuppDir. Cannot continue"
Output "Only available option is Repair." WriteLog "REPLACE - Insufficient free space available on $AppSuppDir. Aborted."
WriteLog "Replace - Scan for usable candidates - FAIL" return 1
return 1 fi
Output "Database backups available are: $Dates"
Output " "
Count=0
Selection=0
Candidate=""
Valid=0
# Print the list of dates
for i in $Dates
do
Count=$((Count + 1))
echo " ${Count}) - $i"
done
# Get the selection
Selection=""
Output " "
echo -n "Select backup date by number or date name (blank = return to menu) "
read Selection
# If no selection - return
[ "$Selection" = "" ] && return
# Search for match
Candidate=""
Count=0
for i in $Dates; do
Count=$((Count + 1))
if [ "$Selection" = "$Count" ] || [ "$Selection" = "$i" ]; then
Candidate="$i"
fi fi
done
Output "Checking for a usable backup." # If no match, return
Candidate="" if [ "$Candidate" = "" ]; then
Output "Error. No valid matching main and blobs database pairs. Cannot replace."
WriteLog "Replace - Select candidate - FAIL"
return
fi
# Make certain there is ample free space # Check candidate
if ! FreeSpaceAvailable ; then if [ -e $CPPL.db-$Candidate ] && \
Output "ERROR: Insufficient free space available on $AppSuppDir. Cannot continue" [ -e $CPPL.blobs.db-$Candidate ] ; then
WriteLog "REPLACE - Insufficient free space available on $AppSuppDir. Aborted."
return 1 Fail=0
Output "Checking backup candidate $Candidate"
! CheckDB $CPPL.db-$Candidate && Fail=1
! CheckDB $CPPL.blobs.db-$Candidate && Fail=1
[ $Fail -eq 1 ] && Output "Backup from $Candidate is not usable. Try again" && return
Output "Database backup $Candidate is valid."
UseThis=0
Output " "
if ConfirmYesNo "Use backup dated: '$Candidate' ?"; then
UseThis=1
fi fi
else
# Did not pass checks
Output "One of the backup files is missing. Please make another selection"
Fail=1
return
fi
Output "Database backups available are: $Dates" # OK, use this one
for i in $Dates if [ $UseThis -eq 1 ]; then
# Move database, wal, and shm (keep safe) with timestamp
Output "Saving current databases with timestamp: '-BACKUP-$TimeStamp'"
for j in "db" "db-wal" "db-shm" "blobs.db" "blobs.db-wal" "blobs.db-shm"
do do
[ -e $CPPL.$j ] && mv -f $CPPL.$j "$TMPDIR/$CPPL.$j-BACKUP-$TimeStamp"
# Check candidate
if [ -e $CPPL.db-$i ] && \
[ -e $CPPL.blobs.db-$i ] && \
Output "Checking database $i" && \
CheckDB $CPPL.db-$i && \
CheckDB $CPPL.blobs.db-$i ; then
Output "Found valid database backup date: $i"
Candidate=$i
UseThis=0
if ConfirmYesNo "Use backup '$Candidate' ?"; then
UseThis=1
fi
# OK, use this one
if [ $UseThis -eq 1 ]; then
# Move database, wal, and shm (keep safe) with timestamp
Output "Saving current databases with timestamp: '-BACKUP-$TimeStamp'"
for j in "db" "db-wal" "db-shm" "blobs.db" "blobs.db-wal" "blobs.db-shm"
do
[ -e $CPPL.$j ] && mv -f $CPPL.$j "$TMPDIR/$CPPL.$j-BACKUP-$TimeStamp"
done
WriteLog "Replace - Move Files - PASS"
# Copy this backup into position as primary
Output "Copying backup database $Candidate to use as new database."
cp -p $CPPL.db-$Candidate $CPPL.db-REPLACE-$TimeStamp
Result=$?
if [ $Result -ne 0 ]; then
Output "Error $Result while copying $CPPL.db"
Output "Database file is incomplete. Please resolve manually."
WriteLog "Replace - Copy $CPPL.db-$Candidate - FAIL"
Fail=1
else
WriteLog "Replace - Copy $CPPL.db-$i - PASS"
fi
cp -p $CPPL.blobs.db-$Candidate $CPPL.blobs.db-REPLACE-$TimeStamp
Result=$?
if [ $Result -ne 0 ]; then
Output "Error $Result while copying $CPPL.blobs.db"
Output "Database file is incomplete. Please resolve manually."
WriteLog "Replace - Copy $CPPL.blobs.db-$Candidate - FAIL"
Fail=1
else
WriteLog "Replace - Copy $CPPL.blobs.db-$Candidate - PASS"
fi
# If no failure copying, check and make active
if [ $Fail -eq 0 ]; then
# Final checks
Output "Copy complete. Performing final check"
if CheckDB $CPPL.db-REPLACE-$TimeStamp && \
CheckDB $CPPL.blobs.db-REPLACE-$TimeStamp ; then
# Move into position as active
mv $CPPL.db-REPLACE-$TimeStamp $CPPL.db
mv $CPPL.blobs.db-REPLACE-$TimeStamp $CPPL.blobs.db
# done
Output "Database recovery and verification complete."
WriteLog "Replace - Verify databases - PASS"
else
# DB did not verify after copy -- Something wrong
rm -f $CPPL.db-$TimeStamp $CPPL.blobs.db-$TimeStamp
Output "Final check failed. Keeping existing databases"
WriteLog "Replace - Verify databases - FAIL"
WriteLog "Replace - Failed Databses - REMOVED"
fi
else
Output "Could not copy backup databases. Out of disk space?"
Output "Restoring original databases"
for k in "db" "db-wal" "db-shm" "blobs.db" "blobs.db-wal" "blobs.db-shm"
do
[ -e "$TMPDIR/$CPPL.$k-BACKUP-$TimeStamp" ] && mv -f "$TMPDIR/$CPPL.$k-BACKUP-$TimeStamp" $CPPL.$k
done
WriteLog "Replace - Verify databases - FAIL"
Fail=1
fi
# If successful, save
[ $Fail -eq 0 ] && SetLast "Replace" "$TimeStamp"
break
fi
fi
done done
WriteLog "Replace - Move Files - PASS"
# Error check if no Candidate found # Copy this backup into position as primary
if [ "$Candidate" = "" ]; then Output "Copying backup database from $Candidate to use as new database."
Output "Error. No valid matching main and blobs database pairs. Cannot replace."
WriteLog "Replace - Select candidate - FAIL" cp -p $CPPL.db-$Candidate $CPPL.db-REPLACE-$TimeStamp
Result=$?
if [ $Result -ne 0 ]; then
Output "Error $Result while copying $CPPL.db"
Output "Database file is incomplete. Please resolve manually."
WriteLog "Replace - Copy $CPPL.db-$Candidate - FAIL"
Fail=1
else
WriteLog "Replace - Copy $CPPL.db-$i - PASS"
fi fi
cp -p $CPPL.blobs.db-$Candidate $CPPL.blobs.db-REPLACE-$TimeStamp
Result=$?
if [ $Result -ne 0 ]; then
Output "Error $Result while copying $CPPL.blobs.db"
Output "Database file is incomplete. Please resolve manually."
WriteLog "Replace - Copy $CPPL.blobs.db-$Candidate - FAIL"
Fail=1
else
WriteLog "Replace - Copy $CPPL.blobs.db-$Candidate - PASS"
fi
# If no failure copying, check and make active
if [ $Fail -eq 0 ]; then
# Final checks
Output "Copy complete. Performing final check"
if CheckDB $CPPL.db-REPLACE-$TimeStamp && \
CheckDB $CPPL.blobs.db-REPLACE-$TimeStamp ; then
# Move into position as active
mv $CPPL.db-REPLACE-$TimeStamp $CPPL.db
mv $CPPL.blobs.db-REPLACE-$TimeStamp $CPPL.blobs.db
# done
Output " "
Output "Database recovery and verification complete."
WriteLog "Replace - Verify databases - PASS"
else
# DB did not verify after copy -- Something wrong
rm -f $CPPL.db-$TimeStamp $CPPL.blobs.db-$TimeStamp
Output "Final check failed. Keeping existing databases"
WriteLog "Replace - Verify databases - FAIL"
WriteLog "Replace - Failed Databses - REMOVED"
fi
else
Output "Could not copy backup databases. Out of disk space?"
Output "Restoring original databases"
for k in "db" "db-wal" "db-shm" "blobs.db" "blobs.db-wal" "blobs.db-shm"
do
[ -e "$TMPDIR/$CPPL.$k-BACKUP-$TimeStamp" ] && mv -f "$TMPDIR/$CPPL.$k-BACKUP-$TimeStamp" $CPPL.$k
done
WriteLog "Replace - Verify databases - FAIL"
Fail=1
fi
# If successful, save
[ $Fail -eq 0 ] && SetLast "Replace" "$TimeStamp"
fi fi
fi
} }
@ -1906,8 +1944,7 @@ do
echo " 12 - 'undo' - Undo last successful command." echo " 12 - 'undo' - Undo last successful command."
echo "" echo ""
echo " 21 - 'prune' - Prune (remove) old image files (jpeg,jpg,png) from PhotoTranscoder cache." echo " 21 - 'prune' - Remove old image files (jpeg,jpg,png) from PhotoTranscoder cache & all temp files left by PMS."
echo " 22 - 'purge' - Purge (remove) all temporary files left by PMS & Transcoder in Temp Dir."
[ $IgnoreErrors -eq 0 ] && echo " 42 - 'ignore' - Ignore duplicate/constraint errors." [ $IgnoreErrors -eq 0 ] && echo " 42 - 'ignore' - Ignore duplicate/constraint errors."
[ $IgnoreErrors -eq 1 ] && echo " 42 - 'honor' - Honor all database errors." [ $IgnoreErrors -eq 1 ] && echo " 42 - 'honor' - Honor all database errors."
@ -2213,7 +2250,8 @@ do
# Remove (prune) unused image files from PhotoTranscoder Cache > 30 days old. # Remove (prune) unused image files from PhotoTranscoder Cache > 30 days old.
21|prun*|remo*) # Also remove all PMS temp files left behind in TMP. (combine both into one action)
21|22|prun*|remo*|purg*)
# Check if PMS running # Check if PMS running
if IsRunning; then if IsRunning; then
@ -2227,20 +2265,6 @@ do
WriteLog "Prune - PASS" WriteLog "Prune - PASS"
;; ;;
22|purg*)
# Check if PMS running
if IsRunning; then
WriteLog "Purge - FAIL - PMS runnning"
Output "Unable to purge temp files. PMS is running."
continue
fi
WriteLog "Purge - START"
DoPurgeTmp
WriteLog "Purge - PASS"
;;
# Ignore/Honor errors # Ignore/Honor errors
42|igno*|hono*) 42|igno*|hono*)
@ -2336,4 +2360,4 @@ do
esac esac
done done
done done
exit 0 exit 0

View File

@ -8,6 +8,18 @@
![Maintenance](https://img.shields.io/badge/Maintained-Yes-green.svg) ![Maintenance](https://img.shields.io/badge/Maintained-Yes-green.svg)
# Release Info: # Release Info:
v1.10.01
1. Minor cleanup - Cleanup purge/prune handling after merging commands into one.
v1.10.00
1. Refactor REPLACE - Processing of DB Replace was awkward.
List of available databases will now be printed in a menu
After selecting the desired DB, the candidate will be checked.
(Selection may be by list item # or date printed)
If valid (DB and Blobs) replacement will proceed normally.
v1.09.00 v1.09.00
1. Purge command - Add 'purge' command to clean up all temporary transcoder and image files. 1. Purge command - Add 'purge' command to clean up all temporary transcoder and image files.
@ -812,4 +824,4 @@ root@lizum:/sata/plex/Plex Media Server/Plug-in Support/Databases#
Instructs SQLite to remove the empty/deleted records and gaps from the databases. Instructs SQLite to remove the empty/deleted records and gaps from the databases.
This is most beneficial after deleting whole library sections. This is most beneficial after deleting whole library sections.
### ###