Completed
Pull Request — master (#525)
by Harish
01:40
created

BackupJob::createBackupManifest()   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 14
Code Lines 8

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
cc 1
eloc 8
nc 1
nop 0
dl 0
loc 14
rs 9.4285
c 0
b 0
f 0
1
<?php
2
3
namespace Spatie\Backup\Tasks\Backup;
4
5
use Exception;
6
use Carbon\Carbon;
7
use Spatie\DbDumper\DbDumper;
8
use Illuminate\Support\Collection;
9
use Spatie\DbDumper\Databases\Sqlite;
10
use Spatie\Backup\Events\BackupHasFailed;
11
use Spatie\Backup\Events\BackupWasSuccessful;
12
use Spatie\Backup\Events\BackupZipWasCreated;
13
use Spatie\Backup\Exceptions\InvalidBackupJob;
14
use Spatie\TemporaryDirectory\TemporaryDirectory;
15
use Spatie\Backup\Events\BackupManifestWasCreated;
16
use Spatie\Backup\BackupDestination\BackupDestination;
17
18
class BackupJob
19
{
20
    /** @var \Spatie\Backup\Tasks\Backup\FileSelection */
21
    protected $fileSelection;
22
23
    /** @var \Illuminate\Support\Collection */
24
    protected $dbDumpers;
25
26
    /** @var \Illuminate\Support\Collection */
27
    protected $backupDestinations;
28
29
    /** @var string */
30
    protected $filename;
31
32
    /** @var \Spatie\TemporaryDirectory\TemporaryDirectory */
33
    protected $temporaryDirectory;
34
35
    /** @var bool */
36
    protected $sendNotifications = true;
37
38
    public function __construct()
39
    {
40
        $this->dontBackupFilesystem();
41
        $this->dontBackupDatabases();
42
        $this->setDefaultFilename();
43
44
        $this->backupDestinations = new Collection();
45
    }
46
47
    public function dontBackupFilesystem(): BackupJob
48
    {
49
        $this->fileSelection = FileSelection::create();
50
51
        return $this;
52
    }
53
54
    public function dontBackupDatabases(): BackupJob
55
    {
56
        $this->dbDumpers = new Collection();
57
58
        return $this;
59
    }
60
61
    public function disableNotifications(): BackupJob
62
    {
63
        $this->sendNotifications = false;
64
65
        return $this;
66
    }
67
68
    public function setDefaultFilename(): BackupJob
69
    {
70
        $this->filename = Carbon::now()->format('Y-m-d-H-i-s').'.zip';
71
72
        return $this;
73
    }
74
75
    public function setFileSelection(FileSelection $fileSelection): BackupJob
76
    {
77
        $this->fileSelection = $fileSelection;
78
79
        return $this;
80
    }
81
82
    public function setDbDumpers(Collection $dbDumpers): BackupJob
83
    {
84
        $this->dbDumpers = $dbDumpers;
85
86
        return $this;
87
    }
88
89
    public function setFilename(string $filename): BackupJob
90
    {
91
        $this->filename = $filename;
92
93
        return $this;
94
    }
95
96
    public function onlyBackupTo(string $diskName): BackupJob
97
    {
98
        $this->backupDestinations = $this->backupDestinations->filter(function (BackupDestination $backupDestination) use ($diskName) {
99
            return $backupDestination->diskName() === $diskName;
100
        });
101
102
        if (! count($this->backupDestinations)) {
103
            throw InvalidBackupJob::destinationDoesNotExist($diskName);
104
        }
105
106
        return $this;
107
    }
108
109
    public function setBackupDestinations(Collection $backupDestinations): BackupJob
110
    {
111
        $this->backupDestinations = $backupDestinations;
112
113
        return $this;
114
    }
115
116
    public function temporaryDirectoryLocation(): string
117
    {
118
        return config('filesystems.disks.backups.root');
119
    }
120
121
    public function run()
122
    {
123
        $this->temporaryDirectory = (new TemporaryDirectory($this->temporaryDirectoryLocation()))
124
            ->name('temp')
125
            ->force()
126
            ->create()
127
            ->empty();
128
129
        try {
130
            if (! count($this->backupDestinations)) {
131
                throw InvalidBackupJob::noDestinationsSpecified();
132
            }
133
134
            $manifest = $this->createBackupManifest();
135
136
            if (! $manifest->count()) {
137
                throw InvalidBackupJob::noFilesToBeBackedUp();
138
            }
139
140
            $zipFile = $this->createZipContainingEveryFileInManifest($manifest);
141
142
            $this->copyToBackupDestinations($zipFile);
143
        } catch (Exception $exception) {
144
            consoleOutput()->error("Backup failed because {$exception->getMessage()}.".PHP_EOL.$exception->getTraceAsString());
0 ignored issues
show
Documentation Bug introduced by
The method error does not exist on object<Spatie\Backup\Helpers\ConsoleOutput>? Since you implemented __call, maybe consider adding a @method annotation.

If you implement __call and you know which methods are available, you can improve IDE auto-completion and static analysis by adding a @method annotation to the class.

This is often the case, when __call is implemented by a parent class and only the child class knows which methods exist:

class ParentClass {
    private $data = array();

    public function __call($method, array $args) {
        if (0 === strpos($method, 'get')) {
            return $this->data[strtolower(substr($method, 3))];
        }

        throw new \LogicException(sprintf('Unsupported method: %s', $method));
    }
}

/**
 * If this class knows which fields exist, you can specify the methods here:
 *
 * @method string getName()
 */
class SomeClass extends ParentClass { }
Loading history...
145
146
            $this->sendNotification(new BackupHasFailed($exception));
147
        }
148
149
        $this->temporaryDirectory->delete();
150
    }
151
152
    protected function createBackupManifest(): Manifest
153
    {
154
        $databaseDumps = $this->dumpDatabases();
155
156
        consoleOutput()->info('Determining files to backup...');
0 ignored issues
show
Documentation Bug introduced by
The method info does not exist on object<Spatie\Backup\Helpers\ConsoleOutput>? Since you implemented __call, maybe consider adding a @method annotation.

If you implement __call and you know which methods are available, you can improve IDE auto-completion and static analysis by adding a @method annotation to the class.

This is often the case, when __call is implemented by a parent class and only the child class knows which methods exist:

class ParentClass {
    private $data = array();

    public function __call($method, array $args) {
        if (0 === strpos($method, 'get')) {
            return $this->data[strtolower(substr($method, 3))];
        }

        throw new \LogicException(sprintf('Unsupported method: %s', $method));
    }
}

/**
 * If this class knows which fields exist, you can specify the methods here:
 *
 * @method string getName()
 */
class SomeClass extends ParentClass { }
Loading history...
157
158
        $manifest = Manifest::create($this->temporaryDirectory->path('manifest.txt'))
159
            ->addFiles($databaseDumps)
160
            ->addFiles($this->filesToBeBackedUp());
0 ignored issues
show
Documentation introduced by
$this->filesToBeBackedUp() is of type object<Generator>, but the function expects a array.

It seems like the type of the argument is not accepted by the function/method which you are calling.

In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug.

We suggest to add an explicit type cast like in the following example:

function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
Loading history...
161
162
        $this->sendNotification(new BackupManifestWasCreated($manifest));
163
164
        return $manifest;
165
    }
166
167
    public function filesToBeBackedUp()
168
    {
169
        $this->fileSelection->excludeFilesFrom($this->directoriesUsedByBackupJob());
170
171
        return $this->fileSelection->selectedFiles();
172
    }
173
174
    protected function directoriesUsedByBackupJob(): array
175
    {
176
        return $this->backupDestinations
177
            ->filter(function (BackupDestination $backupDestination) {
178
                return $backupDestination->filesystemType() === 'local';
179
            })
180
            ->map(function (BackupDestination $backupDestination) {
181
                return $backupDestination->disk()->getDriver()->getAdapter()->applyPathPrefix('').$backupDestination->backupName();
182
            })
183
            ->each(function (string $backupDestinationDirectory) {
184
                $this->fileSelection->excludeFilesFrom($backupDestinationDirectory);
185
            })
186
            ->push($this->temporaryDirectory->path())
187
            ->toArray();
188
    }
189
190
    protected function createZipContainingEveryFileInManifest(Manifest $manifest)
191
    {
192
        consoleOutput()->info("Zipping {$manifest->count()} files...");
0 ignored issues
show
Documentation Bug introduced by
The method info does not exist on object<Spatie\Backup\Helpers\ConsoleOutput>? Since you implemented __call, maybe consider adding a @method annotation.

If you implement __call and you know which methods are available, you can improve IDE auto-completion and static analysis by adding a @method annotation to the class.

This is often the case, when __call is implemented by a parent class and only the child class knows which methods exist:

class ParentClass {
    private $data = array();

    public function __call($method, array $args) {
        if (0 === strpos($method, 'get')) {
            return $this->data[strtolower(substr($method, 3))];
        }

        throw new \LogicException(sprintf('Unsupported method: %s', $method));
    }
}

/**
 * If this class knows which fields exist, you can specify the methods here:
 *
 * @method string getName()
 */
class SomeClass extends ParentClass { }
Loading history...
193
194
        $pathToZip = $this->temporaryDirectory->path(config('backup.backup.name').'-'.$this->filename);
195
196
        $zip = Zip::createForManifest($manifest, $pathToZip);
197
198
        consoleOutput()->info("Created zip containing {$zip->count()} files. Size is {$zip->humanReadableSize()}");
0 ignored issues
show
Documentation Bug introduced by
The method info does not exist on object<Spatie\Backup\Helpers\ConsoleOutput>? Since you implemented __call, maybe consider adding a @method annotation.

If you implement __call and you know which methods are available, you can improve IDE auto-completion and static analysis by adding a @method annotation to the class.

This is often the case, when __call is implemented by a parent class and only the child class knows which methods exist:

class ParentClass {
    private $data = array();

    public function __call($method, array $args) {
        if (0 === strpos($method, 'get')) {
            return $this->data[strtolower(substr($method, 3))];
        }

        throw new \LogicException(sprintf('Unsupported method: %s', $method));
    }
}

/**
 * If this class knows which fields exist, you can specify the methods here:
 *
 * @method string getName()
 */
class SomeClass extends ParentClass { }
Loading history...
199
200
        $this->sendNotification(new BackupZipWasCreated($pathToZip));
201
202
        return $pathToZip;
203
    }
204
205
    /**
206
     * Dumps the databases to the given directory.
207
     * Returns an array with paths to the dump files.
208
     *
209
     * @return array
210
     */
211
    protected function dumpDatabases(): array
212
    {
213
        return $this->dbDumpers->map(function (DbDumper $dbDumper) {
214
            consoleOutput()->info("Dumping database {$dbDumper->getDbName()}...");
0 ignored issues
show
Documentation Bug introduced by
The method info does not exist on object<Spatie\Backup\Helpers\ConsoleOutput>? Since you implemented __call, maybe consider adding a @method annotation.

If you implement __call and you know which methods are available, you can improve IDE auto-completion and static analysis by adding a @method annotation to the class.

This is often the case, when __call is implemented by a parent class and only the child class knows which methods exist:

class ParentClass {
    private $data = array();

    public function __call($method, array $args) {
        if (0 === strpos($method, 'get')) {
            return $this->data[strtolower(substr($method, 3))];
        }

        throw new \LogicException(sprintf('Unsupported method: %s', $method));
    }
}

/**
 * If this class knows which fields exist, you can specify the methods here:
 *
 * @method string getName()
 */
class SomeClass extends ParentClass { }
Loading history...
215
216
            $dbType = mb_strtolower(basename(str_replace('\\', '/', get_class($dbDumper))));
217
218
            $dbName = $dbDumper instanceof Sqlite ? 'database' : $dbDumper->getDbName();
219
220
            $fileName = "{$dbType}-{$dbName}.sql";
221
222
            $temporaryFilePath = $this->temporaryDirectory->path('db-dumps'.DIRECTORY_SEPARATOR.$fileName);
223
224
            $dbDumper->dumpToFile($temporaryFilePath);
225
226
            if (config('backup.backup.gzip_database_dump')) {
227
                consoleOutput()->info("Gzipping {$dbDumper->getDbName()}...");
0 ignored issues
show
Documentation Bug introduced by
The method info does not exist on object<Spatie\Backup\Helpers\ConsoleOutput>? Since you implemented __call, maybe consider adding a @method annotation.

If you implement __call and you know which methods are available, you can improve IDE auto-completion and static analysis by adding a @method annotation to the class.

This is often the case, when __call is implemented by a parent class and only the child class knows which methods exist:

class ParentClass {
    private $data = array();

    public function __call($method, array $args) {
        if (0 === strpos($method, 'get')) {
            return $this->data[strtolower(substr($method, 3))];
        }

        throw new \LogicException(sprintf('Unsupported method: %s', $method));
    }
}

/**
 * If this class knows which fields exist, you can specify the methods here:
 *
 * @method string getName()
 */
class SomeClass extends ParentClass { }
Loading history...
228
229
                $compressedDumpPath = Gzip::compress($temporaryFilePath);
230
231
                return $compressedDumpPath;
232
            }
233
234
            return $temporaryFilePath;
235
        })->toArray();
236
    }
237
238
    protected function copyToBackupDestinations(string $path)
239
    {
240
        $this->backupDestinations->each(function (BackupDestination $backupDestination) use ($path) {
241
            try {
242
                consoleOutput()->info("Copying zip to disk named {$backupDestination->diskName()}...");
0 ignored issues
show
Documentation Bug introduced by
The method info does not exist on object<Spatie\Backup\Helpers\ConsoleOutput>? Since you implemented __call, maybe consider adding a @method annotation.

If you implement __call and you know which methods are available, you can improve IDE auto-completion and static analysis by adding a @method annotation to the class.

This is often the case, when __call is implemented by a parent class and only the child class knows which methods exist:

class ParentClass {
    private $data = array();

    public function __call($method, array $args) {
        if (0 === strpos($method, 'get')) {
            return $this->data[strtolower(substr($method, 3))];
        }

        throw new \LogicException(sprintf('Unsupported method: %s', $method));
    }
}

/**
 * If this class knows which fields exist, you can specify the methods here:
 *
 * @method string getName()
 */
class SomeClass extends ParentClass { }
Loading history...
243
244
                $backupDestination->write($path);
245
246
                consoleOutput()->info("Successfully copied zip to disk named {$backupDestination->diskName()}.");
0 ignored issues
show
Documentation Bug introduced by
The method info does not exist on object<Spatie\Backup\Helpers\ConsoleOutput>? Since you implemented __call, maybe consider adding a @method annotation.

If you implement __call and you know which methods are available, you can improve IDE auto-completion and static analysis by adding a @method annotation to the class.

This is often the case, when __call is implemented by a parent class and only the child class knows which methods exist:

class ParentClass {
    private $data = array();

    public function __call($method, array $args) {
        if (0 === strpos($method, 'get')) {
            return $this->data[strtolower(substr($method, 3))];
        }

        throw new \LogicException(sprintf('Unsupported method: %s', $method));
    }
}

/**
 * If this class knows which fields exist, you can specify the methods here:
 *
 * @method string getName()
 */
class SomeClass extends ParentClass { }
Loading history...
247
248
                $this->sendNotification(new BackupWasSuccessful($backupDestination));
249
            } catch (Exception $exception) {
250
                consoleOutput()->error("Copying zip failed because: {$exception->getMessage()}.");
0 ignored issues
show
Documentation Bug introduced by
The method error does not exist on object<Spatie\Backup\Helpers\ConsoleOutput>? Since you implemented __call, maybe consider adding a @method annotation.

If you implement __call and you know which methods are available, you can improve IDE auto-completion and static analysis by adding a @method annotation to the class.

This is often the case, when __call is implemented by a parent class and only the child class knows which methods exist:

class ParentClass {
    private $data = array();

    public function __call($method, array $args) {
        if (0 === strpos($method, 'get')) {
            return $this->data[strtolower(substr($method, 3))];
        }

        throw new \LogicException(sprintf('Unsupported method: %s', $method));
    }
}

/**
 * If this class knows which fields exist, you can specify the methods here:
 *
 * @method string getName()
 */
class SomeClass extends ParentClass { }
Loading history...
251
252
                $this->sendNotification(new BackupHasFailed($exception, $backupDestination ?? null));
253
            }
254
        });
255
    }
256
257
    protected function sendNotification($notification)
258
    {
259
        if ($this->sendNotifications) {
260
            event($notification);
261
        }
262
    }
263
}
264