Merge branch 'main' into 6.0

Author: sebastianfeldmann

composer.json

@@ -49,8 +49,7 @@
     "ext-json": "*",
     "ext-spl": "*",
     "sebastian/environment": "^3.0|^4.0|^5.0",
-    "sebastianfeldmann/cli": "^3.1",
-    "phpmailer/phpmailer": "^6.0"
+    "sebastianfeldmann/cli": "^3.4"
   },
   "require-dev": {
     "sebastianfeldmann/git": "^3.2",
@@ -66,7 +65,8 @@
     "php-opencloud/openstack": "^3.0",
     "arhitector/yandex": "^2.0",
     "microsoft/azure-storage-blob": "^1.4",
-    "captainhook/captainhook": "^5.0"
+    "captainhook/captainhook": "^5.0",
+    "phpmailer/phpmailer": "^6.0"
   },
   "suggest": {
     "sebastianfeldmann/ftp": "Require ^0.9 to sync to an FTP server",
@@ -79,7 +79,8 @@
     "vlucas/phpdotenv": "Require ^3.0 or ^4.0 or ^5.0 to use the Dotenv adapter",
     "google/apiclient":"Require ^2.0 to sync to Google Drive",
     "arhitector/yandex":"Require ^2.0 to sync to Yandex Disk",
-    "microsoft/azure-storage-blob": "Require ^1.4 to sync to Azure Blob Storage"
+    "microsoft/azure-storage-blob": "Require ^1.4 to sync to Azure Blob Storage",
+    "phpmailer/phpmailer": "Require ^6.0 to receive logs via email"
   },
   "bin": [
     "phpbu"

phive.xml

@@ -1,7 +1,7 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <phive xmlns="https://phar.io/phive">
-  <phar name="phpunit" version="^9.4.3" location="./tools/phpunit" copy="true" installed="9.5.0"/>
-  <phar name="phpab" version="^1.20.0" location="./tools/phpab" copy="true" installed="1.26.0"/>
-  <phar name="phpcs" version="^3.5.2" location="./tools/phpcs" copy="true" installed="3.5.8"/>
-  <phar name="phpstan" version="^0.12.2" location="./tools/phpstan" copy="true" installed="0.12.67"/>
+  <phar name="phpunit" version="^9.4.3" location="./tools/phpunit" copy="true" installed="9.5.9"/>
+  <phar name="phpab" version="^1.20.0" location="./tools/phpab" copy="true" installed="1.26.3"/>
+  <phar name="phpcs" version="^3.5.2" location="./tools/phpcs" copy="true" installed="3.6.0"/>
+  <phar name="phpstan" version="^0.12.2" location="./tools/phpstan" copy="true" installed="0.12.99"/>
 </phive>

src/Backup/Crypter/OpenSSL.php

@@ -100,6 +100,9 @@ public function crypt(Target $target, Result $result)
 
             $result->warn($name . ': The ' . $this->algorithm . ' algorithm is considered weak');
         }
+        if ($target->getSize() > 1610612736) {
+            throw new Exception('Backup to big to encrypt: OpenSSL SMIME can only encrypt files smaller 1.5GB.');
+        }
         parent::crypt($target, $result);
     }
 
@@ -121,7 +124,7 @@ public function simulate(Target $target, Result $result)
      * Is the configured cipher secure enough
      *
      * @return bool
-     * @throws \phpbu\App\Backup\Crypter\Exception
+     * @throws Exception
      */
     public function isUsingWeakAlgorithm(): bool
     {
@@ -170,8 +173,8 @@ public function getSuffix() : string
     /**
      * Decrypt the backup
      *
-     * @param  \phpbu\App\Backup\Target       $target
-     * @param  \phpbu\App\Backup\Restore\Plan $plan
+     * @param Target $target
+     * @param Plan $plan
      * @throws \phpbu\App\Exception
      */
     public function restore(Target $target, Plan $plan)
@@ -183,8 +186,8 @@ public function restore(Target $target, Plan $plan)
     /**
      * Create the Executable to run the 'mcrypt' command
      *
-     * @param  \phpbu\App\Backup\Target $target
-     * @return \phpbu\App\Cli\Executable
+     * @param Target $target
+     * @return Executable
      * @throws \phpbu\App\Exception
      */
     protected function createExecutable(Target $target) : Executable
@@ -195,8 +198,8 @@ protected function createExecutable(Target $target) : Executable
     /**
      * Create encryption OpenSSL
      *
-     * @param  \phpbu\App\Backup\Target $target
-     * @return \phpbu\App\Cli\Executable\OpenSSL
+     * @param Target $target
+     * @return Executable\OpenSSL
      * @throws \phpbu\App\Exception
      */
     private function createEncryptionOpenSSL(Target $target): Executable\OpenSSL
@@ -211,8 +214,8 @@ private function createEncryptionOpenSSL(Target $target): Executable\OpenSSL
     /**
      * Create decryption OpenSSL
      *
-     * @param  \phpbu\App\Backup\Target $target
-     * @return \phpbu\App\Cli\Executable\OpenSSL
+     * @param Target $target
+     * @return Executable\OpenSSL
      * @throws \phpbu\App\Exception
      */
     private function createDecryptionOpenSSL(Target $target): Executable\OpenSSL
@@ -227,8 +230,8 @@ private function createDecryptionOpenSSL(Target $target): Executable\OpenSSL
     /**
      * Setup an OpenSSL executable only thing missing is the decision of en or decryption
      *
-     * @param  \phpbu\App\Backup\Target $target
-     * @return \phpbu\App\Cli\Executable\OpenSSL
+     * @param Target $target
+     * @return Executable\OpenSSL
      * @throws \phpbu\App\Exception
      */
     private function createOpenSSL(Target $target): Executable\OpenSSL

src/Backup/Source/Mongodump.php

@@ -35,6 +35,14 @@ class Mongodump extends SimulatorExecutable implements Simulator
      */
     private $useIPv6;
 
+    /**
+     * Uri to connect to
+     * --uri <uri>
+     *
+     * @var string
+     */
+    private $uri;
+
     /**
      * Host to connect to
      * --host <hostname:port>
@@ -113,6 +121,8 @@ public function setup(array $conf = [])
 
         $this->pathToMongodump = Util\Arr::getValue($conf, 'pathToMongodump', '');
         $this->useIPv6         = Util\Str::toBoolean(Util\Arr::getValue($conf, 'ipv6', ''), false);
+
+        $this->setupValidation();
     }
 
     /**
@@ -137,12 +147,32 @@ protected function setupSourceData(array $conf)
      */
     protected function setupCredentials(array $conf)
     {
+        $this->uri                    = Util\Arr::getValue($conf, 'uri', '');
         $this->host                   = Util\Arr::getValue($conf, 'host', '');
         $this->user                   = Util\Arr::getValue($conf, 'user', '');
         $this->password               = Util\Arr::getValue($conf, 'password', '');
         $this->authenticationDatabase = Util\Arr::getValue($conf, 'authenticationDatabase', '');
     }
 
+    /**
+     * Validate source setup
+     *
+     * @throws \phpbu\App\Exception
+     */
+    protected function setupValidation()
+    {
+        if (empty($this->uri)) {
+            return;
+        }
+
+        // If uri is set, cannot set other configurations
+        foreach (['user', 'host', 'password', 'authenticationDatabase', 'databases'] as $attr) {
+            if (!empty($this->{$attr})) {
+                throw new Exception("cannot specify $attr and uri");
+            }
+        }
+    }
+
     /**
      * Execute the backup.
      *
@@ -177,6 +207,7 @@ protected function createExecutable(Target $target) : Executable
         $executable = new Executable\Mongodump($this->pathToMongodump);
         $executable->dumpToDirectory($this->getDumpDir($target))
                    ->useIpv6($this->useIPv6)
+                   ->useUri($this->uri)
                    ->useHost($this->host)
                    ->credentials($this->user, $this->password, $this->authenticationDatabase)
                    ->dumpDatabases($this->databases)

src/Cli/Executable/Mongodump.php

@@ -36,6 +36,14 @@ class Mongodump extends Abstraction implements Executable
      */
     private $useIPv6;
 
+    /**
+     * Uri to connect to
+     * --uri <uri>
+     *
+     * @var string
+     */
+    private $uri;
+
     /**
      * Host to connect to
      * --host <hostname:port>
@@ -135,6 +143,18 @@ public function useIpv6(bool $bool) : Mongodump
         return $this;
     }
 
+    /**
+     * Set uri to dump from
+     *
+     * @param string $uri
+     * @return \phpbu\App\Cli\Executable\Mongodump
+     */
+    public function useUri(string $uri) : Mongodump
+    {
+        $this->uri = $uri;
+        return $this;
+    }
+
     /**
      * Set host to dump from.
      *
@@ -228,6 +248,7 @@ protected function createCommandLine() : CommandLine
 
         $cmd->addOption('--out', $this->dumpDir, ' ');
         $cmd->addOptionIfNotEmpty('--ipv6', $this->useIPv6, false);
+        $cmd->addOptionIfNotEmpty('--uri', $this->uri, true, ' ');
         $cmd->addOptionIfNotEmpty('--host', $this->host, true, ' ');
         $cmd->addOptionIfNotEmpty('--username', $this->user, true, ' ');
         $cmd->addOptionIfNotEmpty('--password', $this->password, true, ' ');