Sync with 'rsync' is now working

Author: sebastianfeldmann

src/Backup/Cli/Cmd.php

@@ -35,6 +35,13 @@ class Cmd
      */
     private $options = array();
 
+    /**
+     * Command arguments
+     *
+     * @var array<string>
+     */
+    private $args = array();
+
     /**
      * Constructor
      *
@@ -84,12 +91,33 @@ public function addOption($option, $argument = null, $glue = '=')
         $this->options[] = $option . (null !== $argument ? $glue . $escapedArgument : '');
     }
 
+    /**
+     * Add argument to list
+     *
+     * @param miyed<string|array> $argument
+     * @param string              $glue
+     */
+    public function addArgument($argument)
+    {
+        if (is_array($argument)) {
+            $argument        = array_map('escapeshellarg', $argument);
+            $glue            = ' ';
+            $escapedArgument = implode(' ', $argument);
+        } else {
+            $escapedArgument = escapeshellarg($argument);
+        }
+        $this->args[] = $escapedArgument;
+    }
+
     /**
      *
      * @return string
      */
     public function __toString()
     {
-        return $this->name . ' ' . implode(' ', $this->options) . ( $this->isSilent ? ' 2> /dev/null' : '');
+        return $this->name
+            . ( count($this->options) ? ' ' . implode(' ', $this->options) : '' )
+            . ( count($this->args)    ? ' ' . implode(' ', $this->args)    : '' )
+            . ( $this->isSilent       ? ' 2> /dev/null'                    : '' );
     }
 }

src/Backup/Sync/Cli.php

@@ -1,7 +1,7 @@
 <?php
 namespace phpbu\Backup\Sync;
 
-use phpbu\Backup\Cli\Command;
+use phpbu\Backup\Cli\Cmd;
 use phpbu\Backup\Cli\Exec;
 use phpbu\Backup\Target;
 
@@ -23,17 +23,18 @@ abstract class Cli
     /**
      * Executes a cli command
      *
-     * @return \phpbu\Cli\Result
+     * @param  \phpbu\Backup\Cli\Cmd
      * @throws \phpbu\Backup\Sync\Exception
      */
-    protected function execute(Command $command)
+    protected function execute(Cmd $command)
     {
         $exec = new Exec();
-        $exec->addCommand($cmd);
+        $exec->addCommand($command);
 
+        /* @var $res \phpbu\Backup\Cli\Result */
         $res = $exec->execute();
         if ($res->getCode()) {
-            throw new Exception('sync failed: ' . PHP_EOL . $res->getOutput());
+            throw new Exception('sync failed: ' . PHP_EOL . $res->getOutputAsString());
         }
     }
 
@@ -46,7 +47,7 @@ protected function execute(Command $command)
      */
     protected function replaceTargetPlaceholder($string, Target $target)
     {
-        $targetFile = $target->getFilenameCompressed();
+        $targetFile = $target->getPathnameCompressed();
         $targetDir  = dirname($targetFile);
         $search     = array('%TARGET_DIR%', '%TARGET_FILE%');
         $replace    = array($targetDir, $targetFile);

src/Backup/Sync/Rsync.php

@@ -95,10 +95,10 @@ public function setup(array $config)
                              ? array_map('trim', explode(':', $config['exclude']))
                              : array();
             $this->delete    = isset($config['delete'])
-                             ? Util\String::toBoolean($this->config['delete'], false)
+                             ? Util\String::toBoolean($config['delete'], false)
                              : false;
             $this->isDirSync = isset($config['dirsync'])
-                             ? Util\String::toBoolean($this->config['dirsync'], false)
+                             ? Util\String::toBoolean($config['dirsync'], false)
                              : false;
         }
     }
@@ -109,20 +109,22 @@ public function setup(array $config)
      */
     public function sync(Target $target, Result $result)
     {
-        $rsync      = new Cmd(Util\Cli::detectCmdLocation('rsync'));
-        $targetFile = $target->getFilenameCompressed();
-        $targetDir  = dirname($targetFile);
-        // std err > dev null
-        $rsync->silence();
+        $rsync = new Cmd(Util\Cli::detectCmdLocation('rsync'));
 
         if ($this->args) {
             // pro mode define all arguments yourself
             // WARNING! no escaping is done by phpbu
             $result->debug('WARNING: phpbu uses your rsync args without escaping');
-            $rsync->addOption($this->replaceTargetPlaceholder($this->args), $target);
+            $rsync->addOption($this->replaceTargetPlaceholder($this->args, $target));
         } else {
+            // std err > dev null
+            $rsync->silence();
+
+            $targetFile = $target->getPathnameCompressed();
+            $targetDir  = dirname($targetFile);
+
             // use archive mode, verbose and compress if not allready done
-            $options = '-av' . $target->shouldBeCompressed() ? '' : 'z';
+            $options = '-av' . ( $target->shouldBeCompressed() ? '' : 'z' );
             $rsync->addOption($options);
 
             if (count($this->excludes)) {
@@ -138,10 +140,10 @@ public function sync(Target $target, Result $result)
                 if ($this->delete) {
                     $rsync->addOption('--delete');
                 }
-                $rsync->addOption($targetDir);
+                $rsync->addArgument($targetDir);
             } else {
                 // sync just the created backup
-                $rsync->addOption($targetFile);
+                $rsync->addArgument($targetFile);
             }
 
             // target handling
@@ -157,9 +159,11 @@ public function sync(Target $target, Result $result)
             // remote path
             $syncTarget .= $this->path;
 
-            $rsync->addOption($syncTarget);
-
-            $this->execute($rsync);
+            $rsync->addArgument($syncTarget);
         }
+        // add some debug output
+        $result->debug((string) $rsync);
+
+        $this->execute($rsync);
     }
 }