New method for appdata path determination

Commifreak · Mar 30, 2023 · bdf7cc4 · bdf7cc4
1 parent c4cebb8
commit bdf7cc4
Show file tree

Hide file tree

Showing 4 changed files with 45 additions and 47 deletions.
diff --git a/src/include/ABHelper.php b/src/include/ABHelper.php
@@ -239,18 +239,17 @@ public static function backupContainer($container, $destination) {
 
         self::backupLog("Backup {$container['Name']} - Container Volumeinfo: " . print_r($container['Volumes'], true), self::LOGLEVEL_DEBUG);
 
-        $volumes           = self::examineContainerVolumes($container);
-        $dockerAppdataPath = self::getDockerAppdataPath();
-        if (empty($dockerAppdataPath)) {
+        $volumes            = self::getContainerVolumes($container);
+        $dockerAppdataPaths = self::getDockerAppdataPaths();
+        if (empty($dockerAppdataPaths)) {
             ABHelper::backupLog("Docker appdata path could not be examined!", self::LOGLEVEL_ERR);
             return false;
         }
 
-        if (true || $containerSettings['backupExtVolumes'] == 'no') {
+        if ($containerSettings['backupExtVolumes'] == 'no') {
             self::backupLog("Should NOT backup ext volumes, sanitizing...", self::LOGLEVEL_DEBUG);
             foreach ($volumes as $index => $volume) {
-                if (str_starts_with($volume, '/')) {
-                    self::backupLog("Removing volume " . $volume . " because ext volumes should be skipped", self::LOGLEVEL_DEBUG);
+                if (!self::isVolumeWithinAppdata($volume)) {
                     unset($volumes[$index]);
                 }
             }
@@ -266,9 +265,7 @@ public static function backupContainer($container, $destination) {
         $destination = $destination . "/" . $container['Name'] . '.tar';
 
         $tarVerifyOptions = ['--diff'];
-        $tarOptions       = ['-c'];
-
-        $tarOptions[] = $tarVerifyOptions[] = '-C ' . escapeshellarg($dockerAppdataPath);
+        $tarOptions       = ['-c', '-P'];
 
         switch ($abSettings->compression) {
             case 'yes':
@@ -292,10 +289,6 @@ public static function backupContainer($container, $destination) {
                 foreach ($excludes as $exclude) {
                     $exclude = rtrim($exclude, "/");
                     if (!empty($exclude)) {
-                        if (str_starts_with($exclude, $dockerAppdataPath)) {
-                            self::backupLog("exclude is within appdata apth: stripping appdata path", self::LOGLEVEL_DEBUG);
-                            $exclude = ltrim(str_replace($dockerAppdataPath, '', $exclude), '/');
-                        }
                         array_unshift($tarOptions, '--exclude ' . escapeshellarg($exclude)); // Add excludes to the beginning - https://unix.stackexchange.com/a/33334
                         array_unshift($tarVerifyOptions, '--exclude ' . escapeshellarg($exclude)); // Add excludes to the beginning - https://unix.stackexchange.com/a/33334
                     }
@@ -339,7 +332,7 @@ public static function backupContainer($container, $destination) {
                  */
                 foreach ($volumes as $volume) {
                     $output = null; // Reset exec lines
-                    exec("lsof -nl +D " . escapeshellarg($dockerAppdataPath) . "/" . escapeshellarg($volume), $output);
+                    exec("lsof -nl +D " . escapeshellarg($volume), $output);
                     self::backupLog("lsof($volume)" . PHP_EOL . print_r($output, true), self::LOGLEVEL_DEBUG);
                 }
 
@@ -372,12 +365,19 @@ public static function scriptRunning($externalCmd = false) {
         }
     }
 
+    /**
+     * @return bool
+     * @todo: register_shutdown_function? in beiden Scripts? Damit kill und goto :end?
+     */
     public static function abortRequested() {
         return file_exists(ABSettings::$tempFolder . '/' . ABSettings::$stateFileAbort);
     }
 
-    public static function getDockerAppdataPath() {
-        $dockerAppdataPath = '';
+    public static function getDockerAppdataPaths() {
+        $dockerAppdataPaths = [
+            '/mnt/user/appdata', // no trailing /!
+            '/mnt/cache/appdata'
+        ];
 
         // Get default docker storage path
         if (empty(self::$dockerCfg)) {
@@ -398,26 +398,33 @@ public static function getDockerAppdataPath() {
             $dockerCfg = self::$dockerCfg;
         }
 
-        if (isset($dockerCfg['DOCKER_APP_CONFIG_PATH'])) {
-            $dockerAppdataPath = $dockerCfg['DOCKER_APP_CONFIG_PATH'];
-        } else {
-            self::backupLog("dockerCfg is there but no Appdata path iset set??", self::LOGLEVEL_ERR);
+        if (isset($dockerCfg['DOCKER_APP_CONFIG_PATH']) && !in_array(rtrim($dockerCfg['DOCKER_APP_CONFIG_PATH'], '/'), $dockerAppdataPaths)) {
+            $dockerAppdataPaths[] = rtrim($dockerCfg['DOCKER_APP_CONFIG_PATH'], '/');
         }
-        return rtrim($dockerAppdataPath, '/');
-    }
 
-    public static function examineContainerVolumes($container) {
+        return $dockerAppdataPaths;
+    }
 
-        $dockerAppdataPath = self::getDockerAppdataPath();
+    public static function getContainerVolumes($container) {
 
         $volumes = [];
         foreach ($container['Volumes'] ?? [] as $volume) {
-            $hostPath = explode(":", $volume)[0];
-            if (!empty($dockerAppdataPath) && str_starts_with($volume, $dockerAppdataPath)) {
-                $hostPath = ltrim(str_replace($dockerAppdataPath, '', $hostPath), '/');
-            }
+            $hostPath  = explode(":", $volume)[0];
             $volumes[] = rtrim($hostPath, '/');
         }
         return $volumes;
     }
+
+    public static function isVolumeWithinAppdata($volume) {
+        $dockerAppdataPaths = self::getDockerAppdataPaths();
+
+        foreach ($dockerAppdataPaths as $appdataPath) {
+            ABHelper::backupLog("$appdataPath within $volume?", ABHelper::LOGLEVEL_DEBUG);
+            if (str_starts_with($volume, $appdataPath)) {
+                ABHelper::backupLog("YES!", ABHelper::LOGLEVEL_DEBUG);
+                return true;
+            }
+        }
+        return false;
+    }
 }
diff --git a/src/pages/content/settings.php b/src/pages/content/settings.php
@@ -389,13 +389,13 @@ class="fa fa-clock-o title"></i>Notifications, scheduling and retention</span>
 
             foreach ($allContainers as $container) {
                 $image   = empty($container['Icon']) ? '/plugins/dynamix.docker.manager/images/question.png' : $container['Icon'];
-                $volumes = ABHelper::examineContainerVolumes($container);
+                $volumes = ABHelper::getContainerVolumes($container);
 
                 if (empty($volumes)) {
                     $volumes = "<b>No volumes - container will NOT being backed up!</b>";
                 } else {
                     foreach ($volumes as $index => $volume) {
-                        $volumes[$index] = '<span class="fa ' . (str_starts_with($volume, '/') ? 'fa-external-link' : 'fa-folder') . '"> <code>' . $volume . '</code></span>';
+                        $volumes[$index] = '<span class="fa ' . (!ABHelper::isVolumeWithinAppdata($volume) ? 'fa-external-link' : 'fa-folder') . '"> <code>' . $volume . '</code></span>';
                     }
                     $volumes = implode('<br />', $volumes);
                 }
@@ -415,14 +415,15 @@ class="fa fa-clock-o title"></i>Notifications, scheduling and retention</span>
 
 <blockquote class='inline_help'>
 <dl>
-<dt>Configured volumes</dt>
+<dt>Configured volumes<br /><small><i class="fa fa-folder"></i> Appdata volume | <i class="fa fa-external-link"></i> Other/Extra volume</small></dt>
 <dd><div style="display: table">$volumes</div></dd>
+<br />
 
-<!--<dt>Save external volumes? <small>Those with an <i class="fa fa-external-link"></i></small></dt>
+<dt>Save external volumes?</dt>
 <dd><select id='{$container['Name']}_backupExtVolumes' name="containerSettings[{$container['Name']}][backupExtVolumes]" data-setting="{$containerSetting['backupExtVolumes']}" >
 		<option value='no'>No</option>
 		<option value='yes'>Yes</option>
-	</select></dd>-->
+	</select></dd>
 
 <dt>Verify Backup?</dt>
 <dd><select id='{$container['Name']}_verifyBackup' name="containerSettings[{$container['Name']}][verifyBackup]" data-setting="{$containerSetting['verifyBackup']}" >

diff --git a/src/scripts/backup.php b/src/scripts/backup.php
@@ -300,7 +300,7 @@
         ABHelper::backupLog("The tested extra files list is empty! Skipping extra files", ABHelper::LOGLEVEL_WARN);
     } else {
         ABHelper::backupLog("Extra files to backup: " . implode(', ', $extrasChecked), ABHelper::LOGLEVEL_DEBUG);
-        $tarOptions = ['-c'];
+        $tarOptions = ['-c', '-P'];
 
         $destination = $abDestination . '/extra_files.tar';
 

diff --git a/src/scripts/restore.php b/src/scripts/restore.php
@@ -18,13 +18,13 @@
     exec("rm " . ABSettings::$tempFolder . '/*.log');
 } // Creation of tempFolder is handled by backupLog
 
+file_put_contents(ABSettings::$tempFolder . '/' . ABSettings::$stateFileScriptRunning, getmypid());
+
 ABHelper::backupLog("👋 WELCOME TO APPDATA.BACKUP (in restore mode)!! :D");
 
 $unraidVersion = parse_ini_file('/etc/unraid-version');
 ABHelper::backupLog("unraid-version: " . print_r($unraidVersion, true), ABHelper::LOGLEVEL_DEBUG);
 
-file_put_contents(ABSettings::$tempFolder . '/' . ABSettings::$stateFileScriptRunning, getmypid());
-
 /**
  * Some basic checks
  */
@@ -84,18 +84,11 @@
 if (!isset($config['restoreItem']['containers'])) {
     ABHelper::backupLog("Not restoring containers: not wanted");
 } else {
-    $dockerCfg = parse_ini_file(ABSettings::$dockerIniFile);
-    if ($dockerCfg && isset($dockerCfg['DOCKER_APP_CONFIG_PATH'])) {
-        $appdataPath = $dockerCfg['DOCKER_APP_CONFIG_PATH'];
         foreach ($config['restoreItem']['containers'] as $container => $on) {
-            if (file_exists($appdataPath . '/' . explode('.', $container)[0])) {
-                ABHelper::backupLog("The destination already exists! Skipping.", ABHelper::LOGLEVEL_WARN);
-                continue;
-            }
             ABHelper::backupLog("Restoring $container");
 
             $tarOptions = [
-                '-C ' . escapeshellarg($appdataPath),
+                '-C /',
                 '-x',
                 '-f ' . escapeshellarg($restoreSource . '/' . $container)
             ];
@@ -121,9 +114,6 @@
                 goto abort;
             }
         }
-    } else {
-        ABHelper::backupLog("docker.cfg not found!", ABHelper::LOGLEVEL_ERR);
-    }
 }