Merge pull request #1 from MatthiasDeWinter/master

DB dumper for Laravel 5, only for mySQL db's

Author: freekmurze

composer.json

@@ -22,7 +22,8 @@
     "require": {
         "php" : ">=5.4.0",
         "illuminate/support": "5.0.x",
-        "illuminate/console": "5.0.x"
+        "illuminate/console": "5.0.x",
+        "fabpot/php-cs-fixer": "~1.4"
     },
     "require-dev": {
         "phpunit/phpunit" : "4.*",

src/Assets/config/laravel-backup.php

@@ -2,7 +2,7 @@
 <?php
 
 return [
-    'path' => storage_path() . '/db-dumps/',
+    'path' => storage_path().'/db-dumps/',
 
     'mysql' => array(
         'dump_command_path' => '',

src/Commands/BackupCommand.php

@@ -1,38 +1,69 @@
 <?php namespace Spatie\DatabaseBackup\Commands;
 
-use Illuminate\Console\Command;
-
-class BackupCommand extends Command
+class BackupCommand extends BaseCommand
 {
     /**
      * The console command name.
      *
      * @var string
      */
-    protected $name = 'db.backup';
+    protected $name = 'db:backup';
+
     /**
      * The console command description.
      *
      * @var string
      */
     protected $description = 'Backup the database to a file';
-    /**
-     * Create a new command instance.
-     *
-     */
-    public function __construct()
-    {
-        parent::__construct();
-    }
+
+    protected $filePath;
+    protected $fileName;
+
     /**
      * Execute the console command.
      * @return mixed
      * @throws Exception
      */
     public function fire()
     {
+        $this->info('Starting database dump...');
+
+        $database = $this->getDatabase([]);
+
+        $this->checkDumpFolder();
+
+        $this->fileName = date('YmdHis').'.'.$database->getFileExtension();
+        $this->filePath = rtrim($this->getDumpsPath(), '/').'/'.$this->fileName;
 
+        $status = $database->dump($this->filePath);
+
+        if ($status === true) {
+            $this->info('Database dumped successful in:');
+            $this->comment($this->filePath);
+        }
+    }
+
+    protected function getArguments()
+    {
+        return [
+        ];
     }
 
+    protected function getOptions()
+    {
+        return [
+        ];
+    }
 
-}
+    /**
+     * Checks if dump-folder already exists
+     */
+    protected function checkDumpFolder()
+    {
+        $dumpsPath = $this->getDumpsPath();
+
+        if (!is_dir($dumpsPath)) {
+            mkdir($dumpsPath);
+        }
+    }
+}

src/Commands/BaseCommand.php

@@ -0,0 +1,46 @@
+<?php namespace Spatie\DatabaseBackup\Commands;
+
+use Illuminate\Console\Command;
+use Spatie\DatabaseBackup\DatabaseBuilder;
+use Spatie\DatabaseBackup\Console;
+use Config;
+
+class BaseCommand extends Command
+{
+
+    protected $databaseBuilder;
+    protected $console;
+
+    public function __construct(DatabaseBuilder $databaseBuilder)
+    {
+        parent::__construct();
+
+        $this->databaseBuilder = $databaseBuilder;
+        $this->console = new Console();
+    }
+
+    /**
+     * Get database configuration
+     *
+     * @param $database
+     * @return mixed
+     * @throws \Exception
+     */
+    public function getDatabase($database)
+    {
+        $database = $database ?: Config::get('database.default');
+        $realConfig = Config::get('database.connections.'.$database);
+
+        return $this->databaseBuilder->getDatabase($realConfig);
+    }
+
+    /**
+     * Gets the path to dump folder from the config
+     *
+     * @return mixed
+     */
+    protected function getDumpsPath()
+    {
+        return Config::get('laravel-backup.path');
+    }
+}

src/Console.php

@@ -12,13 +12,10 @@ public function run($command)
 
         $process->run();
 
-        if ($process->isSuccessful())
-        {
+        if ($process->isSuccessful()) {
             return true;
-        }
-        else
-        {
+        } else {
             return $process->getErrorOutput();
         }
     }
-}
+}

src/DatabaseBackupServiceProvider.php

@@ -1,6 +1,4 @@
-<?php
-
-namespace Spatie\DatabaseBackup;
+<?php namespace Spatie\DatabaseBackup;
 
 use Illuminate\Support\ServiceProvider;
 
@@ -21,6 +19,9 @@ class DatabaseBackupServiceProvider extends ServiceProvider
      */
     public function boot()
     {
+        $this->publishes([
+            __DIR__.'/Assets/config/laravel-backup.php' => config_path('laravel-backup.php'),
+        ]);
     }
 
     /**
@@ -30,13 +31,15 @@ public function boot()
      */
     public function register()
     {
-        $this->app['command.db.backup'] = $this->app->share(
-            function ($app) {
-                return new Commands\BackupCommand();
+        $databaseBuilder = new DatabaseBuilder();
+
+        $this->app['command.db:backup'] = $this->app->share(
+            function ($app) use ($databaseBuilder) {
+                return new Commands\BackupCommand($databaseBuilder);
             }
         );
 
-        $this->commands('command.db.backup');
+        $this->commands('command.db:backup');
     }
 
     /**
@@ -46,6 +49,6 @@ function ($app) {
      */
     public function provides()
     {
-        return ['command.db.backup'];
+        return ['command.db:backup'];
     }
-}
+}

src/DatabaseBuilder.php

@@ -0,0 +1,40 @@
+<?php namespace Spatie\DatabaseBackup;
+
+use Exception;
+
+class DatabaseBuilder
+{
+
+    protected $database;
+    protected $console;
+
+    public function __construct()
+    {
+        $this->console = new Console();
+    }
+
+    public function getDatabase(array $realConfig)
+    {
+        try {
+            $this->buildMySQL($realConfig);
+        } catch (Exception $e) {
+            throw new \Exception('Whoops, '.$e->getMessage());
+        }
+
+        return $this->database;
+    }
+
+    protected function buildMySQL(array $config)
+    {
+        $port = isset($config['port']) ? $config['port'] : 3306;
+
+        $this->database = new Databases\MySQLDatabase(
+            $this->console,
+            $config['database'],
+            $config['username'],
+            $config['password'],
+            $config['host'],
+            $port
+        );
+    }
+}

src/Databases/DatabaseInterface.php

@@ -25,4 +25,3 @@ public function restore($sourceFile);
      */
     public function getFileExtension();
 }
-

src/Databases/MySQLDatabase.php

@@ -1,7 +1,6 @@
 <?php namespace Spatie\DatabaseBackup\Databases;
 
 use Spatie\DatabaseBackup\Console;
-
 use Config;
 
 class MySQLDatabase implements DatabaseInterface
@@ -34,6 +33,7 @@ public function dump($destinationFile)
             escapeshellarg($this->database),
             escapeshellarg($destinationFile)
         );
+
         return $this->console->run($command);
     }
     public function restore($sourceFile)
@@ -47,6 +47,7 @@ public function restore($sourceFile)
             escapeshellarg($this->database),
             escapeshellarg($sourceFile)
         );
+
         return $this->console->run($command);
     }
 
@@ -57,7 +58,6 @@ public function getFileExtension()
 
     protected function getDumpCommandPath()
     {
-        return Config::get('backup::mysql.dump_command_path');;
+        return Config::get('backup::mysql.dump_command_path');
     }
-
-}
+}