MysqlDumper::useSingleTransaction() - Code Metrics - Inspection of "Update MysqlDumper dump prepared command" - Codexshaper/database-backup-restore - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( d9a4d3...d15b5c )

by CodexShaper

created 2019-12-29 14:17 UTC

MysqlDumper::useSingleTransaction() A

↳ Parent: MysqlDumper

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	1
eloc	2
c	1
b	0
f	0
nc	1
nop	0
dl	0
loc	4
rs	10

<?php

namespace CodexShaper\Dumper\Drivers;

use CodexShaper\Dumper\Dumper;
use Symfony\Component\Process\Exception\ProcessFailedException;

class MysqlDumper extends Dumper
{
    /*@var bool*/
    protected $singleTransaction = false;
    /*@var bool*/
    protected $skipLockTables = false;
    /*@var bool*/
    protected $quick = false;
    /*@var bool*/
    protected $skipComments = true;
    /*@var string*/
    protected $defaultCharacterSet = '';
    /*@var bool*/
    protected $createTables = true;

    public function useSingleTransaction()
    {
        $this->singleTransaction = true;
        return $this;
    }
    public function useSkipLockTables()
    {
        $this->skipLockTables = true;
        return $this;
    }
    public function useQuick()
    {
        $this->quick = true;
        return $this;
    }
    public function doNotUseSkipComments()
    {
        $this->skipComments = false;
        return $this;
    }
    public function doNotUseCreateTables()
    {
        $this->createTables = false;
        return $this;
    }
    public function setDefaultCharacterSet(string $charecterSet)
    {
        $this->defaultCharacterSet = $charecterSet;
        return $this;
    }

    public function dump(string $destinationPath = "")
    {
        $destinationPath = !empty($destinationPath) ? $destinationPath : $this->destinationPath;
        $this->runCommand($destinationPath, "dump");
        return $this;
    }

    public function restore(string $restorePath = "")
    {
        $restorePath = !empty($restorePath) ? $restorePath : $this->restorePath;
        $this->runCommand($restorePath, 'restore');
        return $this;
    }

    public function getDumpOptions(string $credentialFile)
    {
        $options = [
            "{$this->dumpCommandPath}mysqldump",
            "--defaults-extra-file={$credentialFile}",
        ];

        if ($this->dbName) {
            $options['database'] = $this->dbName;
        }
        if ($this->socket) {
            $options['socket'] = "--socket={$this->socket}";
        }
        if ($this->skipComments) {
            $options['skipComments'] = '--skip-comments';
        }
        if (!$this->createTables) {
            $options['createTables'] = '--no-create-info';
        }
        if ($this->singleTransaction) {
            $options['singleTransaction'] = '--single-transaction';
        }

        if ($this->skipLockTables) {
            $options['skipLockTables'] = '--skip-lock-tables';
        }

        if ($this->quick) {
            $options['quick'] = '--quick';
        }
        if ($this->defaultCharacterSet) {
            $options['defaultCharacterSet'] = '--default-character-set=' . $this->defaultCharacterSet;
        }
        if (count($this->tables) > 0) {
            $options['tables'] = '--tables ' . implode(' ', $this->tables);
        }
        // Ignore Tables
        $ignoreTables = [];
        foreach ($this->ignoreTables as $tableName) {
            $ignoreTables[]          = "--ignore-table=" . $databaseArg . "." . $tableName;

            $options['ignoreTables'] = implode(' ', $ignoreTables);
        }
        return $options;
    }

    protected function prepareDumpCommand(string $credentialFile, string $destinationPath): string
    {
        // Dump command
        $dumpCommand = implode(' ', $this->getDumpOptions($credentialFile));
        // Add compressor if compress is enable
        if ($this->isCompress) {
            return "{$dumpCommand} | {$this->compressBinaryPath}{$this->compressCommand} > {$destinationPath}{$this->compressExtension}";
        }

        return "{$dumpCommand} > {$destinationPath}";
    }

    protected function prepareRestoreCommand(string $credentialFile, string $filePath): string
    {
        // Database
        $database = $this->dbName;
        // Authentication File
        $authenticate = "--defaults-extra-file=" . $credentialFile;
        // Restore command
        $restoreCommand = sprintf("%smysql %s %s",
            $this->dumpCommandPath,
            $authenticate,
            $database
        );
        // Add compressor if compress is enable
        if ($this->isCompress) {
            return "{$this->compressBinaryPath}{$this->compressCommand} < {$filePath} | {$restoreCommand}";
        }

        return "{$restoreCommand} < {$filePath}";
    }

    protected function runCommand($filePath, $action)
    {
        try {
            // Get Credentials
            $credentials = $this->getCredentials();
            // Create a temporary file
            $this->tempFile = tempnam(sys_get_temp_dir(), 'mysqlpass');
            // Create file handler
            $handler = fopen($this->tempFile, 'r+');
            // Write credentials into temporary file
            fwrite($handler, $credentials);
            fwrite(/** @scrutinizer ignore-type */ $handler, $credentials);

            if ($action == 'dump') {
                $this->command = preg_replace('/\s+/', ' ', $this->prepareDumpCommand($this->tempFile, $filePath));
            } else if ($action == 'restore') {
                $this->command = preg_replace('/\s+/', ' ', $this->prepareRestoreCommand($this->tempFile, $filePath));
            }
            // Get Symfony process with prepared command
            $process = $this->prepareProcessCommand();

            if ($this->debug) {
                $process->mustRun();
            } else {
                $process->run();
            }
            // close handler
            fclose($handler);
            fclose(/** @scrutinizer ignore-type */ $handler);
            // Remove temporary
            unlink($this->tempFile);

        } catch (ProcessFailedException $e) {
            throw new \Exception($e->getMessage());

        }
    }

    protected function getCredentials()
    {
        $contents = [
            '[client]',
            "user = '{$this->username}'",
            "password = '{$this->password}'",
            "host = '{$this->host}'",
            "port = '{$this->port}'",
        ];
        return implode(PHP_EOL, $contents);
    }
}


Codexshaper / database-backup-restore

Push — master ( d9a4d3...d15b5c )

MysqlDumper::useSingleTransaction() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like