Merge pull request #152 from ChuckPa/chuckpa/plexsqlite-dir-path

v1.06.02

DBRepair.sh

@@ -2,12 +2,12 @@
 #########################################################################
 # Plex Media Server database check and repair utility script.           #
 # Maintainer: ChuckPa                                                   #
-# Version:    v1.06.00                                                  #
+# Version:    v1.06.02                                                  #
-# Date:       01-May-2024                                               #
+# Date:       11-May-2024                                               #
 #########################################################################
 
 # Version for display purposes
-Version="v1.06.00"
+Version="v1.06.02"
 
 # Have the databases passed integrity checks
 CheckedDB=0
@@ -46,6 +46,8 @@ HostType=""
 LOG_TOOL="echo"
 ShowMenu=1
 Exit=0
+Scripted=0
+HaveStartStop=0
 
 # On all hosts except Mac
 PIDOF="pidof"
@@ -373,8 +375,8 @@ HostConfig() {
   # Manual Config
   if [ $ManualConfig -eq 1 ]; then
 
-    CacheDir="$DBDIR/../../Cache"
+    CACHEDIR="$DBDIR/../../Cache/PhotoTranscoder"
-    Logfile="$DBDIR/DBRepair.log"
+    LOGFILE="$DBDIR/DBRepair.log"
     HostType="MANUAL"
     return 0
   fi
@@ -391,7 +393,7 @@ HostConfig() {
     # Where is the data
     AppSuppDir="/var/packages/PlexMediaServer/shares/PlexMediaServer/AppData"
     DBDIR="$AppSuppDir/Plex Media Server/Plug-in Support/Databases"
-    CacheDir="$AppSuppDir/Plex Media Server/Cache/PhotoTranscoder"
+    CACHEDIR="$AppSuppDir/Plex Media Server/Cache/PhotoTranscoder"
     PID_FILE="$AppSuppDir/Plex Media Server/plexmediaserver.pid"
     LOGFILE="$DBDIR/DBRepair.log"
 
@@ -421,7 +423,7 @@ HostConfig() {
     if [ -d "$AppSuppDir/Plex Media Server" ]; then
 
       DBDIR="$AppSuppDir/Plex Media Server/Plug-in Support/Databases"
-      CacheDir="$AppSuppDir/Plex Media Server/Cache/PhotoTranscoder"
+      CACHEDIR="$AppSuppDir/Plex Media Server/Cache/PhotoTranscoder"
       PID_FILE="$AppSuppDir/Plex Media Server/plexmediaserver.pid"
       LOGFILE="$DBDIR/DBRepair.log"
 
@@ -446,7 +448,7 @@ HostConfig() {
     # Where is the data
     AppSuppDir="$PKGDIR/Library"
     DBDIR="$AppSuppDir/Plex Media Server/Plug-in Support/Databases"
-    CacheDir="$AppSuppDir/Plex Media Server/Cache/PhotoTranscoder"
+    CACHEDIR="$AppSuppDir/Plex Media Server/Cache/PhotoTranscoder"
     PID_FILE="$AppSuppDir/Plex Media Server/plexmediaserver.pid"
     LOGFILE="$DBDIR/DBRepair.log"
 
@@ -469,7 +471,7 @@ HostConfig() {
     # Where things are
     PLEX_SQLITE="/snap/plexmediaserver/current/Plex SQLite"
     AppSuppDir="/var/snap/plexmediaserver/common/Library/Application Support"
-    CacheDir="$AppSuppDir/Plex Media Server/Cache/PhotoTranscoder"
+    CACHEDIR="$AppSuppDir/Plex Media Server/Cache/PhotoTranscoder"
     PID_FILE="$AppSuppDir/plexmediaserver.pid"
     DBDIR="$AppSuppDir/Plex Media Server/Plug-in Support/Databases"
     LOGFILE="$DBDIR/DBRepair.log"
@@ -511,7 +513,7 @@ HostConfig() {
     fi
 
     DBDIR="$AppSuppDir/Plex Media Server/Plug-in Support/Databases"
-    CacheDir="$AppSuppDir/Plex Media Server/Cache/PhotoTranscoder"
+    CACHEDIR="$AppSuppDir/Plex Media Server/Cache/PhotoTranscoder"
     PID_FILE="$AppSuppDir/Plex Media Server/plexmediaserver.pid"
     LOGFILE="$DBDIR/DBRepair.log"
 
@@ -535,7 +537,7 @@ HostConfig() {
       AppSuppDir="$PKGDIR/MediaLibrary"
       PID_FILE="$AppSuppDir/Plex Media Server/plexmediaserver.pid"
       DBDIR="$AppSuppDir/Plex Media Server/Plug-in Support/Databases"
-      CacheDir="$AppSuppDir/Plex Media Server/Cache/PhotoTranscoder"
+      CACHEDIR="$AppSuppDir/Plex Media Server/Cache/PhotoTranscoder"
       LOGFILE="$DBDIR/DBRepair.log"
       LOG_TOOL="logger"
 
@@ -556,7 +558,7 @@ HostConfig() {
     AppSuppDir="/volume1/Plex/Library"
     PID_FILE="$AppSuppDir/Plex Media Server/plexmediaserver.pid"
     DBDIR="$AppSuppDir/Plex Media Server/Plug-in Support/Databases"
-    CacheDir="$AppSuppDir/Plex Media Server/Cache/PhotoTranscoder"
+    CACHEDIR="$AppSuppDir/Plex Media Server/Cache/PhotoTranscoder"
     LOGFILE="$DBDIR/DBRepair.log"
     LOG_TOOL="logger"
 
@@ -572,7 +574,7 @@ HostConfig() {
     PLEX_SQLITE="/Applications/Plex Media Server.app/Contents/MacOS/Plex SQLite"
     AppSuppDir="$HOME/Library/Application Support"
     DBDIR="$AppSuppDir/Plex Media Server/Plug-in Support/Databases"
-    CacheDir="$HOME/Library/Caches/PlexMediaServer/PhotoTranscoder"
+    CACHEDIR="$HOME/Library/Caches/PlexMediaServer/PhotoTranscoder"
     PID_FILE="$DBDIR/dbtmp/plexmediaserver.pid"
     LOGFILE="$DBDIR/DBRepair.log"
     LOG_TOOL="logger"
@@ -608,7 +610,7 @@ HostConfig() {
     AppSuppDir="$(echo /mnt/HD/HD*/Nas_Prog/plex_conf)"
     PID_FILE="$AppSuppDir/Plex Media Server/plexmediaserver.pid"
     DBDIR="$AppSuppDir/Plex Media Server/Plug-in Support/Databases"
-    CacheDir="$AppSuppDir/Plex Media Server/Cache/PhotoTranscoder"
+    CACHEDIR="$AppSuppDir/Plex Media Server/Cache/PhotoTranscoder"
     LOGFILE="$DBDIR/DBRepair.log"
     LOG_TOOL="logger"
 
@@ -628,7 +630,7 @@ HostConfig() {
       AppSuppDir="/config"
       PID_FILE="$AppSuppDir/plexmediaserver.pid"
       DBDIR="$AppSuppDir/Plug-in Support/Databases"
-      CacheDir="$AppSuppDir/Plex Media Server/Cache/PhotoTranscoder"
+      CACHEDIR="$AppSuppDir/Plex Media Server/Cache/PhotoTranscoder"
       LOGFILE="$DBDIR/DBRepair.log"
       LOG_TOOL="logger"
       if [ -d "/run/service/plex" ] || [ -d "/run/service/service-plex" ]; then
@@ -648,7 +650,7 @@ HostConfig() {
       AppSuppDir="/config/Library/Application Support"
       PID_FILE="$AppSuppDir/Plex Media Server/plexmediaserver.pid"
       DBDIR="$AppSuppDir/Plex Media Server/Plug-in Support/Databases"
-      CacheDir="$AppSuppDir/Plex Media Server/Cache/PhotoTranscoder"
+      CACHEDIR="$AppSuppDir/Plex Media Server/Cache/PhotoTranscoder"
 
       LOGFILE="$DBDIR/DBRepair.log"
       LOG_TOOL="logger"
@@ -677,7 +679,7 @@ HostConfig() {
       AppSuppDir="/config"
       PID_FILE="$AppSuppDir/Plex Media Server/plexmediaserver.pid"
       DBDIR="$AppSuppDir/Plex Media Server/Plug-in Support/Databases"
-      CacheDir="$AppSuppDir/Plex Media Server/Cache/PhotoTranscoder"
+      CACHEDIR="$AppSuppDir/Plex Media Server/Cache/PhotoTranscoder"
       LOGFILE="$DBDIR/DBRepair.log"
       LOG_TOOL="logger"
 
@@ -718,7 +720,7 @@ HostConfig() {
       fi
 
       DBDIR="$AppSuppDir/Plex Media Server/Plug-in Support/Databases"
-      CacheDir="$AppSuppDir/Plex Media Server/Cache/PhotoTranscoder"
+      CACHEDIR="$AppSuppDir/Plex Media Server/Cache/PhotoTranscoder"
       LOGFILE="$DBDIR/DBRepair.log"
       LOG_TOOL="logger"
       HostType="$(grep PRETTY_NAME /etc/os-release | sed -e 's/^.*="//' | tr -d \" )"
@@ -1619,7 +1621,7 @@ DoPrunePhotoTranscoder() {
     PruneIt=1
   else
     Output "Counting how many files are more than $CacheAge days old."
-    FileCount=$(find "$CacheDir" \( -name \*.jpg -o -name \*.jpeg -o -name \*.png -o -name \*.ppm \) -mtime +${CacheAge} -print | wc -l)
+    FileCount=$(find "$CACHEDIR" \( -name \*.jpg -o -name \*.jpeg -o -name \*.png -o -name \*.ppm \) -mtime +${CacheAge} -print | wc -l)
 
     # If nothing found, continue back to the menu
     [ $FileCount -eq 0 ] && Output "No files found to prune." && return
@@ -1634,7 +1636,7 @@ DoPrunePhotoTranscoder() {
   if [ $PruneIt -eq 1 ]; then
     Output "Pruning started."
     WriteLog "Prune   - Removing $FileCount files over $CacheAge days old."
-    find "$CacheDir" \( -name \*.jpg -o -name \*.jpeg -o -name \*.png \) -mtime +${CacheAge} -delete
+    find "$CACHEDIR" \( -name \*.jpg -o -name \*.jpeg -o -name \*.png \) -mtime +${CacheAge} -delete
     Output "Pruning completed."
     WriteLog "Prune   - PASS."
   fi
@@ -1661,15 +1663,21 @@ do
   [ "$Opt" = "-f" ] && shift
   [ "$Opt" = "-p" ] && shift
 
-  # Manual configuration options (running outside of container)
+  # Manual configuration options (running outside of container or unusual hosts)
   if [ "$Opt" = "--sqlite" ]; then
 
-    # Manually specify path to where Plex SQLite is installed.
+    # Is this the directory where Plex SQLite exists?
-    if [ -d "$2" ] && [ -f "$2/Plex SQLite" ]; then
+    if   [ -d "$2" ] && [ -f "$2/Plex SQLite" ]; then
       PLEX_SQLITE="$2/Plex SQLite"
       ManualConfig=1
+
+    # Or is it the direct path to Plex SQLite
+    elif echo "$2" | grep "Plex SQLite" > /dev/null  && [ -f "$2" ] ; then
+      PLEX_SQLITE="$2"
+
     else
-      Output "Given directory path ('$1') for Plex SQLite is invalid. Ignoring."
+      Output "Given 'Plex SQLite' directory/path ('$2') is invalid. Aborting."
+      exit 2
     fi
     shift 2
   fi
@@ -1679,15 +1687,18 @@ do
   # Manual path to databases
   if [ "$Opt" = "--databases" ]; then
 
-    # Manually specify path to where the databases reside
+    # Manually specify path to where the databases reside and set all dependent dirs
     if [ -d "$2" ] && [ -f "$2"/com.plexapp.plugins.library.db ]; then
       DBDIR="$2"
-      ManualConfig=1
+      AppSuppDir="$(dirname "$(dirname "$(dirname "$DBDIR")")")"
+      CACHEDIR="$AppSuppDir/Plex Media Server/Cache/PhotoTranscoder"
       LOGFILE="$DBDIR/DBRepair.log"
-      AppSuppDir="$( dirname "$(dirname "$(dirname "$db")))")")"
+      ManualConfig=1
+
 
     else
-      Output "Given directory path ('$1') for Plex databases is invalid. Ignoring."
+      Output "Given Plex databases directory ('$2') is invalid. Aborting."
+      exit 2
     fi
     shift 2
   fi
@@ -1721,6 +1732,7 @@ Scripted=0
 if [ $ManualConfig -eq 0 ] && ! HostConfig; then
   Output 'Error: Unknown host. Current supported hosts are: QNAP, Syno, Netgear, Mac, ASUSTOR, WD (OS5), Linux wkstn/svr, SNAP'
   Output '                     Current supported container images:  Plexinc, LinuxServer, HotIO, & BINHEX'
+  Output '                     Manual host configuration is available in most use cases.'
   Output ' '
   Output 'Are you trying to run the tool from outside the container environment?  Manual mode is available. Please see documentation.'
   exit 1
@@ -1807,8 +1819,8 @@ do
 
   # Print info if Manual
   if [ $ManualConfig -eq 1 ]; then
-    WriteLog "Manual SQLite path:  '$PLEX_SQLITE'
+    WriteLog "SQLite path:   '$PLEX_SQLITE'"
-    WriteLog "Manual Database path: '$DBDIR'
+    WriteLog "Database path: '$DBDIR'"
     Output "      PlexSQLite = '$PLEX_SQLITE'"
     Output "      Databases  = '$DBDIR'"
   fi

README.md

@@ -7,10 +7,6 @@
 [![master](https://img.shields.io/badge/master-stable-green.svg?maxAge=2592000)]('')
 ![Maintenance](https://img.shields.io/badge/Maintained-Yes-green.svg)
 
-# Introduction
-
-DBRepair provides database repair and maintenance for the most common  Plex Media Server database problems.
-It is a simple menu-driven utility with a command line backend.
 
 DBRepair is run from a command line (terminal or ssh/putty session) which has sufficient privilege to read/write the databases (minimum).
 If sufficient privleges exist (root), and supported by the environment, the options to start and stop PMS are presented as well.
@@ -857,14 +853,78 @@ root@lizum:/sata/plex/Plex Media Server/Plug-in Support/Databases#
   Manual configuration is enabled by supplying two command line arguments.
   These must precede all other options or commands on the command line.
 
+  --sqlite "Directory containing Plex SQLite"   (OR)   --sqlite  "/path/to/Plex SQLite"
+
   Scripted Example:
 
-  DBRepair.sh --sqlite /usr/lib/plexmediaserver --databases /real/host/directory/...../Databases auto prune
+  DBRepair.sh --sqlite /usr/lib/plexmediaserver --databases "/real/host/directory/...../Databases" auto prune
+  -or-
+  DBRepair.sh --sqlite "/tmp/plex/Plex SQLite" --databases "/real/host/directory/...../Databases" auto prune
 
   Interactive Example:
 
   DBRepair.sh --sqlite /usr/lib/plexmediaserver --databases /real/host/directory/...../Databases
 
+## Manual Configuration --  Example of using with docker.
+
+1.  I find the SQLite executable
+```
+root@Jasper:/mnt/disk1/appdata# find /var/lib/docker -name \*SQLite\*
+/var/lib/docker/btrfs/subvolumes/4bb78fb70589d4d2ba56754f4d6bc0edd4cdaa8eab7986943767e09a66cefd19/usr/lib/plexmediaserver/Plex SQLite
+/var/lib/docker/btrfs/subvolumes/eae4fef243ca71fbf190957256705fdc493863ee1f08222a7df0b5004cc8afb6-init/usr/lib/plexmediaserver/Plex SQLite
+/var/lib/docker/btrfs/subvolumes/eae4fef243ca71fbf190957256705fdc493863ee1f08222a7df0b5004cc8afb6/usr/lib/plexmediaserver/Plex SQLite
+root@Jasper:/mnt/disk1/appdata#
+```
+
+2.  I get to where my container is
+```
+root@Jasper:~# cd /mnt/user
+root@Jasper:/mnt/user# ls
+Media/  appdata/  domains/  isos/  plex/  system/
+root@Jasper:/mnt/user# cd appdata
+root@Jasper:/mnt/user/appdata# ls
+PlexMediaServer/
+root@Jasper:/mnt/user/appdata# cd PlexMediaServer/
+```
+
+3.  Invoke DBRepair.sh with both --sqlite and --databases command line options specified (both are required when either is used)
+```
+root@Jasper:/mnt/user/appdata/PlexMediaServer# /tmp/DBRepair.sh --databases /mnt/user/appdata/PlexMediaServer/Library/Application\ Support/Plex\ Media\ Server/Plug-in\ Support/Databases/ --sqlite /var/lib/docker/btrfs/subvolumes/4bb78fb70589d4d2ba56754f4d6bc0edd4cdaa8eab7986943767e09a66cefd19/usr/lib/plexmediaserver/
+
+
+
+      Plex Media Server Database Repair Utility (User Defined)
+                       Version v1.06.00
+
+      PlexSQLite = '/var/lib/docker/btrfs/subvolumes/4bb78fb70589d4d2ba56754f4d6bc0edd4cdaa8eab7986943767e09a66cefd19/usr/lib/plexmediaserver//Plex SQLite'
+      Databases  = '/mnt/user/appdata/PlexMediaServer/Library/Application Support/Plex Media Server/Plug-in Support/Databases/'
+
+Select
+
+  1 - 'stop'      - (Not available. Stop manually.)
+  2 - 'automatic' - Check, Repair/Optimize, and Reindex Database in one step.
+  3 - 'check'     - Perform integrity check of database.
+  4 - 'vacuum'    - Remove empty space from database without optimizing.
+  5 - 'repair'    - Repair/Optimize databases.
+  6 - 'reindex'   - Rebuild database database indexes.
+  7 - 'start'     - (Not available. Start manually)
+
+  8 - 'import'    - Import watch history from another database independent of Plex. (risky).
+  9 - 'replace'   - Replace current databases with newest usable backup copy (interactive).
+ 10 - 'show'      - Show logfile.
+ 11 - 'status'    - Report status of PMS (run-state and databases).
+ 12 - 'undo'      - Undo last successful command.
+
+ 21 - 'prune'     - Prune (remove) old image files (jpeg,jpg,png) from PhotoTranscoder cache.
+ 42 - 'ignore'    - Ignore duplicate/constraint errors.
+
+ 88 - 'update'    - Check for updates.
+ 99 - 'quit'      - Quit immediately.  Keep all temporary files.
+      'exit'      - Exit with cleanup options.
+
+Enter command # -or- command name (4 char min) :
+```
+
 
 
 # Special considerations - Synology DSM 7

ReleaseNotes

@@ -8,6 +8,18 @@
 ![Maintenance](https://img.shields.io/badge/Maintained-Yes-green.svg)
 
 # Release Info:
+v1.06.02
+  1. Bug fix              - Fixed incorrect error handling when command line arguments not valid in manual configuration mode.
+                            Fixed incorrect reporting of what was wrong in manual configuration mode.
+
+v1.06.01
+
+  1. Manual SQLite path   - You many now also specify the full path to "Plex SQLite".  ( example: "/tmp/downloads/Plex SQLite")
+                            DBRepair.sh will automatically figure out which form to use (path or directory)
+
+                            --sqlite "/real/host/path/to/plexmediaserver/Directory"
+                            --sqlite "/real/host/path/to/plexmediaserver/directory/Plex SQLite"
+
 v1.06.00
 
   1. Manual configuration - You may now run DBRepair from outside container environments.