Snapshot::getFileHandler() - Code Metrics - Inspection of "Make load snapshot streamable" - spatie/laravel-db-snapshots - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#93)

by Peter

created 2020-05-25 11:04 UTC

Snapshot::getFileHandler() A

↳ Parent: Snapshot

Complexity

Conditions	4
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	16
rs	9.7333
c	0
b	0
f	0
cc	4
nc	1
nop	1

<?php

namespace Spatie\DbSnapshots;

use Carbon\Carbon;
use Exception;
use Illuminate\Filesystem\FilesystemAdapter as Disk;
use Illuminate\Support\Facades\DB;
use Illuminate\Support\Facades\Storage;
use Illuminate\Support\LazyCollection;
use Spatie\DbSnapshots\Events\DeletedSnapshot;
use Spatie\DbSnapshots\Events\DeletingSnapshot;
use Spatie\DbSnapshots\Events\LoadedSnapshot;
use Spatie\DbSnapshots\Events\LoadingSnapshot;
use Spatie\DbSnapshots\Events\SnapshotStatus;
use Spatie\TemporaryDirectory\TemporaryDirectory;

class Snapshot
{
    /** @var \Illuminate\Filesystem\FilesystemAdapter */
    public $disk;

    /** @var string */
    public $fileName;

    /** @var string */
    public $name;

    /** @var string */
    public $compressionExtension = null;

    /** @var bool */
    private $useStream = false;

    /** @var bool */
    private $showProgress = false;

    /** @var array */
    private $errors = [];

    /** @var int */
    const STREAM_BUFFER_SIZE = 16384;

    public function __construct(Disk $disk, string $fileName)
    {
        $this->disk = $disk;

        $this->fileName = $fileName;

        $pathinfo = pathinfo($fileName);

        if ($pathinfo['extension'] === 'gz') {
            $this->compressionExtension = $pathinfo['extension'];
            $fileName = $pathinfo['filename'];
        }

        $this->name = pathinfo($fileName, PATHINFO_FILENAME);
    }

    public function useStream()
    {
        $this->useStream = true;

        return $this;
    }

    public function showProgress()
    {
        $this->showProgress = true;

        return $this;
    }

    public function load(string $connectionName = null)
    {
        event(new LoadingSnapshot($this));

        if ($connectionName !== null) {
            DB::setDefaultConnection($connectionName);
        }

        $this->dropAllCurrentTables();

        $this->useStream ? $this->loadStream($connectionName) : $this->loadAsync($connectionName);

        event(new LoadedSnapshot($this));
    }

    public function getErrors()
    {
        return $this->errors;
    }

    protected function loadAsync(string $connectionName = null)
    {
        $dbDumpContents = $this->disk->get($this->fileName);

        if ($this->compressionExtension === 'gz') {
            event(new SnapshotStatus($this, 'Decompressing snapshot...'));
            $dbDumpContents = gzdecode($dbDumpContents);
        }

        event(new SnapshotStatus($this, 'Importing SQL...'));

        DB::connection($connectionName)->unprepared($dbDumpContents);
<?php

function getDate($date)
{
    if ($date !== null) {
        return new DateTime($date);
    }

    return false;
}
    }

    protected function loadStream(string $connectionName = null)
    {
        $dumpFilePath = $this->compressionExtension === 'gz' ?
            $this->downloadExternalSnapshort() :
            $this->disk->path($this->fileName);

        return $this->streamFileIntoDB($dumpFilePath, $connectionName);
    }

    protected function getFileHandler($path): LazyCollection
    {
        return LazyCollection::make(function () use ($path) {
            if ($this->compressionExtension === 'gz') {
                $handle = gzopen($path, 'r');
                while (! gzeof($handle)) {
                    yield gzgets($handle, self::STREAM_BUFFER_SIZE);
                }
            } else {
                $handle = $this->disk->readStream($path);
                while (($line = fgets($handle)) !== false) {
                    yield $line;
                }
            }
        });
    }

    protected function streamFileIntoDB($path, string $connectionName = null)
    {
        if ($connectionName !== null) {
            DB::setDefaultConnection($connectionName);
        }

        $tmpLine = '';
        $counter = $this->showProgress ? 0 : false;

        event(new SnapshotStatus($this, 'Importing SQL...'));

        $this->getFileHandler($path)->each(function ($line) use (&$tmpLine, &$counter, $connectionName) {
            if ($counter !== false && $counter % 500 === 0) {
                echo '.';
            }

            // Skip it if line is a comment
            if (substr($line, 0, 2) === '--' || trim($line) == '') {
                return;
            }

            $tmpLine .= $line;

            // If the line ends with a semicolon, it is the end of the query - run it
            if (substr(trim($line), -1, 1) === ';') {
                try {
                    DB::connection($connectionName)->unprepared($tmpLine);
                } catch (Exception $e) {
                    if ($counter !== false) {
                        echo 'E';
                    }

                    preg_match_all('/INSERT INTO `(.*)`/mU', $e->getMessage(), $matches);

                    if (is_array($matches)) {
                        unset($matches[0]);

                        foreach ($matches as $match) {
                            if (empty($match[0])) {
                                continue;
                            }
                            $tableName = $match[0];
                            if (! isset($this->errors[$tableName])) {
                                $this->errors[$tableName] = 0;
                            }
                            $this->errors[$tableName]++;
                        }
                    }
                }

                $tmpLine = '';
            }
            $counter++;
        });

        if ($counter !== false) {
            echo PHP_EOL;
        }

        if (! empty($this->errors)) {
            return $this->errors;
        }

        return true;
    }

    public function downloadExternalSnapshort()
    {
        $stream = $this->disk->readStream($this->fileName);
        $gzFilePath = (new TemporaryDirectory(config('db-snapshots.temporary_directory_path')))
                           ->create()
                           ->path('temp-load.tmp').'.gz';
        $fileDest = fopen($gzFilePath, 'w');

        event(new SnapshotStatus($this, 'Downloading snapshot...'));

        if (! file_exists($this->disk->path($this->fileName))) {
            while (feof($stream) !== true) {
                fwrite($fileDest, gzread($stream, self::STREAM_BUFFER_SIZE));
            }
        }

        $this->disk = Storage::disk('local');

        return $gzFilePath;
    }

    public function delete()
    {
        event(new DeletingSnapshot($this));

        $this->disk->delete($this->fileName);

        event(new DeletedSnapshot($this->fileName, $this->disk));
    }

    public function size(): int
    {
        return $this->disk->size($this->fileName);
    }

    public function createdAt(): Carbon
    {
        return Carbon::createFromTimestamp($this->disk->lastModified($this->fileName));
    }

    protected function dropAllCurrentTables()
    {
        event(new SnapshotStatus($this, 'Dropping all current database tables...'));

        DB::connection(DB::getDefaultConnection())
            ->getSchemaBuilder()
            ->dropAllTables();

        DB::reconnect();
    }
}


1			<?php
2
3			namespace Spatie\DbSnapshots;
4
5			use Carbon\Carbon;
6			use Exception;
7			use Illuminate\Filesystem\FilesystemAdapter as Disk;
8			use Illuminate\Support\Facades\DB;
9			use Illuminate\Support\Facades\Storage;
10			use Illuminate\Support\LazyCollection;
11			use Spatie\DbSnapshots\Events\DeletedSnapshot;
12			use Spatie\DbSnapshots\Events\DeletingSnapshot;
13			use Spatie\DbSnapshots\Events\LoadedSnapshot;
14			use Spatie\DbSnapshots\Events\LoadingSnapshot;
15			use Spatie\DbSnapshots\Events\SnapshotStatus;
16			use Spatie\TemporaryDirectory\TemporaryDirectory;
17
18			class Snapshot
19			{
20			/** @var \Illuminate\Filesystem\FilesystemAdapter */
21			public $disk;
22
23			/** @var string */
24			public $fileName;
25
26			/** @var string */
27			public $name;
28
29			/** @var string */
30			public $compressionExtension = null;
31
32			/** @var bool */
33			private $useStream = false;
34
35			/** @var bool */
36			private $showProgress = false;
37
38			/** @var array */
39			private $errors = [];
40
41			/** @var int */
42			const STREAM_BUFFER_SIZE = 16384;
43
44			public function __construct(Disk $disk, string $fileName)
45			{
46			$this->disk = $disk;
47
48			$this->fileName = $fileName;
49
50			$pathinfo = pathinfo($fileName);
51
52			if ($pathinfo['extension'] === 'gz') {
53			$this->compressionExtension = $pathinfo['extension'];
54			$fileName = $pathinfo['filename'];
55			}
56
57			$this->name = pathinfo($fileName, PATHINFO_FILENAME);
58			}
59
60			public function useStream()
61			{
62			$this->useStream = true;
63
64			return $this;
65			}
66
67			public function showProgress()
68			{
69			$this->showProgress = true;
70
71			return $this;
72			}
73
74			public function load(string $connectionName = null)
75			{
76			event(new LoadingSnapshot($this));
77
78			if ($connectionName !== null) {
79			DB::setDefaultConnection($connectionName);
80			}
81
82			$this->dropAllCurrentTables();
83
84			$this->useStream ? $this->loadStream($connectionName) : $this->loadAsync($connectionName);
85
86			event(new LoadedSnapshot($this));
87			}
88
89			public function getErrors()
90			{
91			return $this->errors;
92			}
93
94			protected function loadAsync(string $connectionName = null)
95			{
96			$dbDumpContents = $this->disk->get($this->fileName);
97
98			if ($this->compressionExtension === 'gz') {
99			event(new SnapshotStatus($this, 'Decompressing snapshot...'));
100			$dbDumpContents = gzdecode($dbDumpContents);
101			}
102
103			event(new SnapshotStatus($this, 'Importing SQL...'));
104
105			DB::connection($connectionName)->unprepared($dbDumpContents);
			0 ignored issues – show Security Bug introduced 2018-09-15 05:33 UTC by Report Bug Copy Issue Report It seems like `$dbDumpContents` defined by `$this->disk->get($this->fileName)` on line `96` can also be of type `false`; however, `Illuminate\Database\Conn...Interface::unprepared()` does only seem to accept `string`, did you maybe forget to handle an error condition? This check looks for type mismatches where the missing type is `false`. This is usually indicative of an error condtion. Consider the follow example <?php function getDate($date) { if ($date !== null) { return new DateTime($date); } return false; } This function either returns a new `DateTime` object or false, if there was an error. This is a typical pattern in PHP programming to show that an error has occurred without raising an exception. The calling code should check for this returned `false` before passing on the value to another function or method that may not be able to handle a `false`. Loading history...
106			}
107
108			protected function loadStream(string $connectionName = null)
109			{
110			$dumpFilePath = $this->compressionExtension === 'gz' ?
111			$this->downloadExternalSnapshort() :
112			$this->disk->path($this->fileName);
113
114			return $this->streamFileIntoDB($dumpFilePath, $connectionName);
115			}
116
117			protected function getFileHandler($path): LazyCollection
118			{
119			return LazyCollection::make(function () use ($path) {
120			if ($this->compressionExtension === 'gz') {
121			$handle = gzopen($path, 'r');
122			while (! gzeof($handle)) {
123			yield gzgets($handle, self::STREAM_BUFFER_SIZE);
124			}
125			} else {
126			$handle = $this->disk->readStream($path);
127			while (($line = fgets($handle)) !== false) {
128			yield $line;
129			}
130			}
131			});
132			}
133
134			protected function streamFileIntoDB($path, string $connectionName = null)
135			{
136			if ($connectionName !== null) {
137			DB::setDefaultConnection($connectionName);
138			}
139
140			$tmpLine = '';
141			$counter = $this->showProgress ? 0 : false;
142
143			event(new SnapshotStatus($this, 'Importing SQL...'));
144
145			$this->getFileHandler($path)->each(function ($line) use (&$tmpLine, &$counter, $connectionName) {
146			if ($counter !== false && $counter % 500 === 0) {
147			echo '.';
148			}
149
150			// Skip it if line is a comment
151			if (substr($line, 0, 2) === '--' \|\| trim($line) == '') {
152			return;
153			}
154
155			$tmpLine .= $line;
156
157			// If the line ends with a semicolon, it is the end of the query - run it
158			if (substr(trim($line), -1, 1) === ';') {
159			try {
160			DB::connection($connectionName)->unprepared($tmpLine);
161			} catch (Exception $e) {
162			if ($counter !== false) {
163			echo 'E';
164			}
165
166			preg_match_all('/INSERT INTO `(.*)`/mU', $e->getMessage(), $matches);
167
168			if (is_array($matches)) {
169			unset($matches[0]);
170
171			foreach ($matches as $match) {
172			if (empty($match[0])) {
173			continue;
174			}
175			$tableName = $match[0];
176			if (! isset($this->errors[$tableName])) {
177			$this->errors[$tableName] = 0;
178			}
179			$this->errors[$tableName]++;
180			}
181			}
182			}
183
184			$tmpLine = '';
185			}
186			$counter++;
187			});
188
189			if ($counter !== false) {
190			echo PHP_EOL;
191			}
192
193			if (! empty($this->errors)) {
194			return $this->errors;
195			}
196
197			return true;
198			}
199
200			public function downloadExternalSnapshort()
201			{
202			$stream = $this->disk->readStream($this->fileName);
203			$gzFilePath = (new TemporaryDirectory(config('db-snapshots.temporary_directory_path')))
204			->create()
205			->path('temp-load.tmp').'.gz';
206			$fileDest = fopen($gzFilePath, 'w');
207
208			event(new SnapshotStatus($this, 'Downloading snapshot...'));
209
210			if (! file_exists($this->disk->path($this->fileName))) {
211			while (feof($stream) !== true) {
212			fwrite($fileDest, gzread($stream, self::STREAM_BUFFER_SIZE));
213			}
214			}
215
216			$this->disk = Storage::disk('local');
217
218			return $gzFilePath;
219			}
220
221			public function delete()
222			{
223			event(new DeletingSnapshot($this));
224
225			$this->disk->delete($this->fileName);
226
227			event(new DeletedSnapshot($this->fileName, $this->disk));
228			}
229
230			public function size(): int
231			{
232			return $this->disk->size($this->fileName);
233			}
234
235			public function createdAt(): Carbon
236			{
237			return Carbon::createFromTimestamp($this->disk->lastModified($this->fileName));
238			}
239
240			protected function dropAllCurrentTables()
241			{
242			event(new SnapshotStatus($this, 'Dropping all current database tables...'));
243
244			DB::connection(DB::getDefaultConnection())
245			->getSchemaBuilder()
246			->dropAllTables();
247
248			DB::reconnect();
249			}
250			}
251

spatie / laravel-db-snapshots

Pull Request — master (#93)

Snapshot::getFileHandler() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like