DumpCommand::getTableDefinitions() - Code Metrics - Inspection of "Merge branch 'release/1.97.9'" - netz98/n98-magerun - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( bd5921...d9293e )

by Christian

created 2016-01-05 12:43 UTC

DumpCommand::getTableDefinitions() A

↳ Parent: DumpCommand

Complexity

Conditions	2
Paths	2

Size

Total Lines	13
Code Lines	6

Duplication

Lines	0
Ratio	0 %

Importance

Changes	3
Bugs	1	Features	0

Metric	Value
c	3
b	1
f	0
dl	0
loc	13
rs	9.4286
cc	2
eloc	6
nc	2
nop	0

<?php

namespace N98\Magento\Command\Database;

use N98\Magento\Command\Database\Compressor\AbstractCompressor;
use N98\Util\Console\Helper\DatabaseHelper;
use N98\Util\OperatingSystem;
use RuntimeException;
use Symfony\Component\Console\Helper\DialogHelper;
use Symfony\Component\Console\Input\InputArgument;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Input\InputOption;
use Symfony\Component\Console\Output\OutputInterface;
use N98\Util\Exec;

class DumpCommand extends AbstractDatabaseCommand
{
    /**
     * @var array
     */
    protected $tableDefinitions = null;

    /**
     * @var array
     */
    protected $commandConfig = null;

    protected function configure()
    {
        $this
            ->setName('db:dump')
            ->addArgument('filename', InputArgument::OPTIONAL, 'Dump filename')
            ->addOption('add-time', 't', InputOption::VALUE_OPTIONAL, 'Adds time to filename (only if filename was not provided)')

            ->addOption('compression', 'c', InputOption::VALUE_REQUIRED, 'Compress the dump file using one of the supported algorithms')

            ->addOption('xml', null, InputOption::VALUE_NONE, 'Dump database in xml format')
            ->addOption('hex-blob', null, InputOption::VALUE_NONE, 'Dump binary columns using hexadecimal notation (for example, "abc" becomes 0x616263)')

            ->addOption('only-command', null, InputOption::VALUE_NONE, 'Print only mysqldump command. Do not execute')
            ->addOption('print-only-filename', null, InputOption::VALUE_NONE, 'Execute and prints no output except the dump filename')

            ->addOption('no-single-transaction', null, InputOption::VALUE_NONE, 'Do not use single-transaction (not recommended, this is blocking)')

            ->addOption('human-readable', null, InputOption::VALUE_NONE, 'Use a single insert with column names per row. Useful to track database differences. Use db:import --optimize for speeding up the import.')

            ->addOption('add-routines', null, InputOption::VALUE_NONE, 'Include stored routines in dump (procedures & functions)')

            ->addOption('stdout', null, InputOption::VALUE_NONE, 'Dump to stdout')
            ->addOption('strip', 's', InputOption::VALUE_OPTIONAL, 'Tables to strip (dump only structure of those tables)')

            ->addOption('exclude', 'e', InputOption::VALUE_OPTIONAL, 'Tables to exclude from the dump')
            ->addOption('force', 'f', InputOption::VALUE_NONE, 'Do not prompt if all options are defined')
            ->setDescription('Dumps database with mysqldump cli client according to informations from local.xml');

        $help = <<<HELP
Dumps configured magento database with `mysqldump`. You must have installed
the MySQL client tools.

On debian systems run `apt-get install mysql-client` to do that.

The command reads app/etc/local.xml to find the correct settings.

See it in action: http://youtu.be/ttjZHY6vThs

- If you like to prepend a timestamp to the dump name the --add-time option
  can be used.

- The command comes with a compression function. Add i.e. `--compression=gz`
  to dump directly in gzip compressed file.

HELP;
        $this->setHelp($help);

    }

    /**
     * @return bool
     */
    public function isEnabled()
    {
        return function_exists('exec') && !OperatingSystem::isWindows();
    }

    /**
     * @return array
     *
     * @deprecated Use database helper
     * @throws RuntimeException
     */
    public function getTableDefinitions()
    {
        $this->commandConfig = $this->getCommandConfig();

        if (is_null($this->tableDefinitions)) {
            /* @var $dbHelper DatabaseHelper */
            $dbHelper = $this->getHelper('database');

            $this->tableDefinitions = $dbHelper->getTableDefinitions($this->commandConfig);
        }

        return $this->tableDefinitions;
    }

    /**
     * Generate help for table definitions
     *
     * @return string
     */
    public function getTableDefinitionHelp()
    {
        $messages = PHP_EOL;
        $this->commandConfig = $this->getCommandConfig();
        $messages .= <<<HELP
<comment>Strip option</comment>
 If you like to skip data of some tables you can use the --strip option.
 The strip option creates only the structure of the defined tables and
 forces `mysqldump` to skip the data.

 Separate each table to strip by a space.
 You can use wildcards like * and ? in the table names to strip multiple
 tables. In addition you can specify pre-defined table groups, that start
 with an

 Example: "dataflow_batch_export unimportant_module_* @log

    $ n98-magerun.phar db:dump --strip="@stripped"

<comment>Available Table Groups</comment>

HELP;

        $definitions = $this->getTableDefinitions();

        $list = array();
        $maxNameLen = 0;
        foreach ($definitions as $id => $definition) {
            $name    = '@' . $id;
            $description = isset($definition['description']) ? $definition['description'] . '.' : '';
            $nameLen = strlen($name);
            if ($nameLen > $maxNameLen) {
                $maxNameLen = $nameLen;
            }
            $list[] = array($name, $description);
        }

        $decrSize = 78 - $maxNameLen - 3;

        foreach ($list as $entry) {
            list($name, $description) = $entry;
            $delta  = max(0, $maxNameLen - strlen($name));
            $spacer = $delta ? str_repeat(' ', $delta) : '';
            $buffer = wordwrap($description, $decrSize);
            $buffer = strtr($buffer, array("\n" => "\n" . str_repeat(' ', 3 + $maxNameLen)));
            $messages .= sprintf(" <info>%s</info>%s  %s\n", $name, $spacer, $buffer);
        }

        return $messages;
    }

    public function getHelp()
    {
        return parent::getHelp() . PHP_EOL
            . $this->getCompressionHelp() . PHP_EOL
            . $this->getTableDefinitionHelp();
    }

    /**
     * @param InputInterface  $input
     * @param OutputInterface $output
     *
     * @return int|void
     */
    protected function execute(InputInterface $input, OutputInterface $output)
    {
        $this->detectDbSettings($output);

        if (!$input->getOption('stdout') && !$input->getOption('only-command')
            && !$input->getOption('print-only-filename')
        ) {
            $this->writeSection($output, 'Dump MySQL Database');
        }

        $compressor = $this->getCompressor($input->getOption('compression'));
        $fileName   = $this->getFileName($input, $output, $compressor);

        $stripTables = array();
        if ($input->getOption('strip')) {

            /* @var $database DatabaseHelper */
            $database = $this->getHelper('database');
            $stripTables = $database->resolveTables(explode(' ', $input->getOption('strip')), $this->getTableDefinitions());

            if (!$input->getOption('stdout') && !$input->getOption('only-command')
                && !$input->getOption('print-only-filename')
            ) {
                $output->writeln('<comment>No-data export for: <info>' . implode(' ', $stripTables)
                    . '</info></comment>'
                );
            }
        }

        $excludeTables = array();
        if ($input->getOption('exclude')) {

            $excludeTables = $this->getHelper('database')->resolveTables(explode(' ', $input->getOption('exclude')), $this->getTableDefinitions());

            if (!$input->getOption('stdout') && !$input->getOption('only-command')
                && !$input->getOption('print-only-filename')
            ) {
                $output->writeln('<comment>Excluded: <info>' . implode(' ', $excludeTables)
                    . '</info></comment>'
                );
            }
        }

        $dumpOptions = '';
        if (!$input->getOption('no-single-transaction')) {
            $dumpOptions = '--single-transaction --quick ';
        }

        if ($input->getOption('human-readable')) {
            $dumpOptions .= '--complete-insert --skip-extended-insert ';
        }

        if ($input->getOption('add-routines')) {
            $dumpOptions .= '--routines ';
        }

        if ($input->getOption('xml')) {
            $dumpOptions .= '--xml ';
        }

        if ($input->getOption('hex-blob')) {
            $dumpOptions .= '--hex-blob ';
        }

        $execs = array();

        $ignore = '';
        foreach (array_merge($excludeTables, $stripTables) as $tableName) {
            $ignore .= '--ignore-table=' . $this->dbSettings['dbname'] . '.' . $tableName . ' ';
        }

        if (count($stripTables) > 0) {
            // dump structure for strip-tables
            $exec = 'mysqldump ' . $dumpOptions . '--no-data ' . $this->getHelper('database')->getMysqlClientToolConnectionString();

            $exec .= ' ' . implode(' ', $stripTables);
            $exec .= $this->postDumpPipeCommands();
            $exec = $compressor->getCompressingCommand($exec);
            if (!$input->getOption('stdout')) {
                $exec .= ' > ' . escapeshellarg($fileName);
            }
            $execs[] = $exec;
        }

        // dump data for all other tables
        $exec = 'mysqldump ' . $dumpOptions . $ignore . $this->getHelper('database')->getMysqlClientToolConnectionString();

        $exec .= $this->postDumpPipeCommands();
        $exec = $compressor->getCompressingCommand($exec);
        if (!$input->getOption('stdout')) {
            $exec .= (count($stripTables) > 0 ? ' >> ' : ' > ') . escapeshellarg($fileName);
        }
        $execs[] = $exec;

        $this->runExecs($execs, $fileName, $input, $output);
    }

    /**
     * @param array $execs
     * @param string $fileName
     * @param InputInterface $input
     * @param OutputInterface $output
     */
    private function runExecs(array $execs, $fileName, InputInterface $input, OutputInterface $output)
    {
        if ($input->getOption('only-command') && !$input->getOption('print-only-filename')) {
            foreach ($execs as $exec) {
                $output->writeln($exec);
            }
        } else {
            if (!$input->getOption('stdout') && !$input->getOption('only-command')
                && !$input->getOption('print-only-filename')
            ) {
                $output->writeln('<comment>Start dumping database <info>' . $this->dbSettings['dbname']
                    . '</info> to file <info>' . $fileName . '</info>'
                );
            }

            foreach ($execs as $exec) {
                $commandOutput = '';
                if ($input->getOption('stdout')) {
                    passthru($exec, $returnValue);
                } else {
                    Exec::run($exec, $commandOutput, $returnValue);
                }
                if ($returnValue > 0) {
                    $output->writeln('<error>' . $commandOutput . '</error>');
                    $output->writeln('<error>Return Code: ' . $returnValue . '. ABORTED.</error>');

                    return;
                }
            }

            if (!$input->getOption('stdout') && !$input->getOption('print-only-filename')) {
                $output->writeln('<info>Finished</info>');
            }
        }

        if ($input->getOption('print-only-filename')) {
            $output->writeln($fileName);
        }
    }

    /**
     * Commands which filter mysql data. Piped to mysqldump command
     *
     * @return string
     */
    protected function postDumpPipeCommands()
    {
        return ' | sed -e ' . escapeshellarg('s/DEFINER[ ]*=[ ]*[^*]*\*/\*/');
    }

    /**
     * @param InputInterface     $input
     * @param OutputInterface    $output
     * @param AbstractCompressor $compressor
     *
     * @return string
     */
    protected function getFileName(InputInterface $input, OutputInterface $output, AbstractCompressor $compressor)
    {
        $namePrefix    = '';
        $nameSuffix    = '';
        if ($input->getOption('xml')) {
            $nameExtension = '.xml';
        } else {
            $nameExtension = '.sql';
        }


        if ($input->getOption('add-time') !== false) {
            $timeStamp = date('Y-m-d_His');

            if ($input->getOption('add-time') == 'suffix') {
                $nameSuffix = '_' . $timeStamp;
            } else {
                $namePrefix = $timeStamp . '_';
            }
        }

        if ((($fileName = $input->getArgument('filename')) === null || ($isDir = is_dir($fileName))) && !$input->getOption('stdout')) {

            /** @var DialogHelper $dialog */
            $dialog      = $this->getHelperSet()->get('dialog');
            $defaultName = $namePrefix . $this->dbSettings['dbname'] . $nameSuffix . $nameExtension;
            if (isset($isDir) && $isDir) {
                $defaultName = rtrim($fileName, DIRECTORY_SEPARATOR) . DIRECTORY_SEPARATOR . $defaultName;
            }
            if (!$input->getOption('force')) {
                $fileName = $dialog->ask($output, '<question>Filename for SQL dump:</question> [<comment>'
                    . $defaultName . '</comment>]', $defaultName
                );
            } else {
                $fileName = $defaultName;
            }
        } else {
            if ($input->getOption('add-time')) {
                $pathParts = pathinfo($fileName);
                $fileName = ($pathParts['dirname'] == '.' ? '' : $pathParts['dirname'] . DIRECTORY_SEPARATOR) .
                    $namePrefix . $pathParts['filename'] . $nameSuffix . '.' . $pathParts['extension'];
            }
        }

        $fileName = $compressor->getFileName($fileName);

        return $fileName;
    }
}


1		<?php
2
3		namespace N98\Magento\Command\Database;
4
5		use N98\Magento\Command\Database\Compressor\AbstractCompressor;
6		use N98\Util\Console\Helper\DatabaseHelper;
7		use N98\Util\OperatingSystem;
8		use RuntimeException;
9		use Symfony\Component\Console\Helper\DialogHelper;
10		use Symfony\Component\Console\Input\InputArgument;
11		use Symfony\Component\Console\Input\InputInterface;
12		use Symfony\Component\Console\Input\InputOption;
13		use Symfony\Component\Console\Output\OutputInterface;
14		use N98\Util\Exec;
15
16		class DumpCommand extends AbstractDatabaseCommand
17		{
18		/**
19		* @var array
20		*/
21		protected $tableDefinitions = null;
22
23		/**
24		* @var array
25		*/
26		protected $commandConfig = null;
27
28		protected function configure()
29		{
30		$this
31		->setName('db:dump')
32		->addArgument('filename', InputArgument::OPTIONAL, 'Dump filename')
33		->addOption('add-time', 't', InputOption::VALUE_OPTIONAL, 'Adds time to filename (only if filename was not provided)')
		0 ignored issues – show Coding Style introduced 2015-11-25 15:21 UTC by Report Bug Copy Issue Report This line exceeds maximum limit of 120 characters; contains 130 characters Overly long lines are hard to read on any screen. Most code styles therefor impose a maximum limit on the number of characters in a line. Loading history...
34		->addOption('compression', 'c', InputOption::VALUE_REQUIRED, 'Compress the dump file using one of the supported algorithms')
		0 ignored issues – show Coding Style introduced 2015-11-25 15:21 UTC by Report Bug Copy Issue Report This line exceeds maximum limit of 120 characters; contains 136 characters Overly long lines are hard to read on any screen. Most code styles therefor impose a maximum limit on the number of characters in a line. Loading history...
35		->addOption('xml', null, InputOption::VALUE_NONE, 'Dump database in xml format')
36		->addOption('hex-blob', null, InputOption::VALUE_NONE, 'Dump binary columns using hexadecimal notation (for example, "abc" becomes 0x616263)')
		0 ignored issues – show Coding Style introduced 2015-11-25 15:21 UTC by Report Bug Copy Issue Report This line exceeds maximum limit of 120 characters; contains 154 characters Overly long lines are hard to read on any screen. Most code styles therefor impose a maximum limit on the number of characters in a line. Loading history...
37		->addOption('only-command', null, InputOption::VALUE_NONE, 'Print only mysqldump command. Do not execute')
38		->addOption('print-only-filename', null, InputOption::VALUE_NONE, 'Execute and prints no output except the dump filename')
		0 ignored issues – show Coding Style introduced 2015-11-25 15:21 UTC by Report Bug Copy Issue Report This line exceeds maximum limit of 120 characters; contains 134 characters Overly long lines are hard to read on any screen. Most code styles therefor impose a maximum limit on the number of characters in a line. Loading history...
39		->addOption('no-single-transaction', null, InputOption::VALUE_NONE, 'Do not use single-transaction (not recommended, this is blocking)')
		0 ignored issues – show Coding Style introduced 2015-11-25 15:21 UTC by Report Bug Copy Issue Report This line exceeds maximum limit of 120 characters; contains 148 characters Overly long lines are hard to read on any screen. Most code styles therefor impose a maximum limit on the number of characters in a line. Loading history...
40		->addOption('human-readable', null, InputOption::VALUE_NONE, 'Use a single insert with column names per row. Useful to track database differences. Use db:import --optimize for speeding up the import.')
		0 ignored issues – show Coding Style introduced 2015-11-25 15:21 UTC by Report Bug Copy Issue Report This line exceeds maximum limit of 120 characters; contains 213 characters Overly long lines are hard to read on any screen. Most code styles therefor impose a maximum limit on the number of characters in a line. Loading history...
41		->addOption('add-routines', null, InputOption::VALUE_NONE, 'Include stored routines in dump (procedures & functions)')
		0 ignored issues – show Coding Style introduced 2015-11-25 15:21 UTC by Report Bug Copy Issue Report This line exceeds maximum limit of 120 characters; contains 130 characters Overly long lines are hard to read on any screen. Most code styles therefor impose a maximum limit on the number of characters in a line. Loading history...
42		->addOption('stdout', null, InputOption::VALUE_NONE, 'Dump to stdout')
43		->addOption('strip', 's', InputOption::VALUE_OPTIONAL, 'Tables to strip (dump only structure of those tables)')
		0 ignored issues – show Coding Style introduced 2015-11-25 15:21 UTC by Report Bug Copy Issue Report This line exceeds maximum limit of 120 characters; contains 123 characters Overly long lines are hard to read on any screen. Most code styles therefor impose a maximum limit on the number of characters in a line. Loading history...
44		->addOption('exclude', 'e', InputOption::VALUE_OPTIONAL, 'Tables to exclude from the dump')
45		->addOption('force', 'f', InputOption::VALUE_NONE, 'Do not prompt if all options are defined')
46		->setDescription('Dumps database with mysqldump cli client according to informations from local.xml');
47
48		$help = <<<HELP
49		Dumps configured magento database with `mysqldump`. You must have installed
50		the MySQL client tools.
51
52		On debian systems run `apt-get install mysql-client` to do that.
53
54		The command reads app/etc/local.xml to find the correct settings.
55
56		See it in action: http://youtu.be/ttjZHY6vThs
57
58		- If you like to prepend a timestamp to the dump name the --add-time option
59		can be used.
60
61		- The command comes with a compression function. Add i.e. `--compression=gz`
62		to dump directly in gzip compressed file.
63
64		HELP;
65		$this->setHelp($help);
66
67		}
68
69		/**
70		* @return bool
71		*/
72		public function isEnabled()
73		{
74		return function_exists('exec') && !OperatingSystem::isWindows();
75		}
76
77		/**
78		* @return array
79		*
80		* @deprecated Use database helper
81		* @throws RuntimeException
82		*/
83		public function getTableDefinitions()
84		{
85		$this->commandConfig = $this->getCommandConfig();
86
87		if (is_null($this->tableDefinitions)) {
88		/* @var $dbHelper DatabaseHelper */
89		$dbHelper = $this->getHelper('database');
90
91		$this->tableDefinitions = $dbHelper->getTableDefinitions($this->commandConfig);
92		}
93
94		return $this->tableDefinitions;
95		}
96
97		/**
98		* Generate help for table definitions
99		*
100		* @return string
101		*/
102		public function getTableDefinitionHelp()
103		{
104		$messages = PHP_EOL;
105		$this->commandConfig = $this->getCommandConfig();
106		$messages .= <<<HELP
107		<comment>Strip option</comment>
108		If you like to skip data of some tables you can use the --strip option.
109		The strip option creates only the structure of the defined tables and
110		forces `mysqldump` to skip the data.
111
112		Separate each table to strip by a space.
113		You can use wildcards like * and ? in the table names to strip multiple
114		tables. In addition you can specify pre-defined table groups, that start
115		with an
116
117		Example: "dataflow_batch_export unimportant_module_* @log
118
119		$ n98-magerun.phar db:dump --strip="@stripped"
120
121		<comment>Available Table Groups</comment>
122
123		HELP;
124
125		$definitions = $this->getTableDefinitions();
		0 ignored issues – show Deprecated Code introduced 2015-11-25 15:20 UTC by Report Bug Copy Issue Report The method `N98\Magento\Command\Data...::getTableDefinitions()` has been deprecated with message: Use database helper This method has been deprecated. The supplier of the class has supplied an explanatory message. The explanatory message should give you some clue as to whether and when the method will be removed from the class and what other method or class to use instead. Loading history...
126		$list = array();
127		$maxNameLen = 0;
128		foreach ($definitions as $id => $definition) {
129		$name = '@' . $id;
130		$description = isset($definition['description']) ? $definition['description'] . '.' : '';
131		$nameLen = strlen($name);
132		if ($nameLen > $maxNameLen) {
133		$maxNameLen = $nameLen;
134		}
135		$list[] = array($name, $description);
136		}
137
138		$decrSize = 78 - $maxNameLen - 3;
139
140		foreach ($list as $entry) {
141		list($name, $description) = $entry;
142		$delta = max(0, $maxNameLen - strlen($name));
143		$spacer = $delta ? str_repeat(' ', $delta) : '';
144		$buffer = wordwrap($description, $decrSize);
145		$buffer = strtr($buffer, array("\n" => "\n" . str_repeat(' ', 3 + $maxNameLen)));
146		$messages .= sprintf(" <info>%s</info>%s %s\n", $name, $spacer, $buffer);
147		}
148
149		return $messages;
150		}
151
152		public function getHelp()
153		{
154		return parent::getHelp() . PHP_EOL
155		. $this->getCompressionHelp() . PHP_EOL
156		. $this->getTableDefinitionHelp();
157		}
158
159		/**
160		* @param InputInterface $input
161		* @param OutputInterface $output
162		*
163		* @return int\|void
164		*/
165		protected function execute(InputInterface $input, OutputInterface $output)
166		{
167		$this->detectDbSettings($output);
168
169		if (!$input->getOption('stdout') && !$input->getOption('only-command')
170		&& !$input->getOption('print-only-filename')
171		) {
172		$this->writeSection($output, 'Dump MySQL Database');
173		}
174
175		$compressor = $this->getCompressor($input->getOption('compression'));
176		$fileName = $this->getFileName($input, $output, $compressor);
177
178		$stripTables = array();
179	View Code Duplication	if ($input->getOption('strip')) {
		0 ignored issues – show Duplication introduced 2015-11-25 15:21 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
180		/* @var $database DatabaseHelper */
181		$database = $this->getHelper('database');
182		$stripTables = $database->resolveTables(explode(' ', $input->getOption('strip')), $this->getTableDefinitions());
		0 ignored issues – show Deprecated Code introduced 2015-11-25 15:20 UTC by Report Bug Copy Issue Report The method `N98\Magento\Command\Data...::getTableDefinitions()` has been deprecated with message: Use database helper This method has been deprecated. The supplier of the class has supplied an explanatory message. The explanatory message should give you some clue as to whether and when the method will be removed from the class and what other method or class to use instead. Loading history... Coding Style introduced 2016-01-01 09:21 UTC by Report Bug Copy Issue Report This line exceeds maximum limit of 120 characters; contains 124 characters Overly long lines are hard to read on any screen. Most code styles therefor impose a maximum limit on the number of characters in a line. Loading history...
183		if (!$input->getOption('stdout') && !$input->getOption('only-command')
184		&& !$input->getOption('print-only-filename')
185		) {
186		$output->writeln('<comment>No-data export for: <info>' . implode(' ', $stripTables)
187		. '</info></comment>'
188		);
189		}
190		}
191
192		$excludeTables = array();
193	View Code Duplication	if ($input->getOption('exclude')) {
		0 ignored issues – show Duplication introduced 2015-11-25 15:21 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
194		$excludeTables = $this->getHelper('database')->resolveTables(explode(' ', $input->getOption('exclude')), $this->getTableDefinitions());
		0 ignored issues – show Deprecated Code introduced 2015-11-25 15:20 UTC by Report Bug Copy Issue Report The method `N98\Magento\Command\Data...::getTableDefinitions()` has been deprecated with message: Use database helper This method has been deprecated. The supplier of the class has supplied an explanatory message. The explanatory message should give you some clue as to whether and when the method will be removed from the class and what other method or class to use instead. Loading history... Coding Style introduced 2015-11-25 15:21 UTC by Report Bug Copy Issue Report This line exceeds maximum limit of 120 characters; contains 147 characters Overly long lines are hard to read on any screen. Most code styles therefor impose a maximum limit on the number of characters in a line. Loading history...
195		if (!$input->getOption('stdout') && !$input->getOption('only-command')
196		&& !$input->getOption('print-only-filename')
197		) {
198		$output->writeln('<comment>Excluded: <info>' . implode(' ', $excludeTables)
199		. '</info></comment>'
200		);
201		}
202		}
203
204		$dumpOptions = '';
205		if (!$input->getOption('no-single-transaction')) {
206		$dumpOptions = '--single-transaction --quick ';
207		}
208
209		if ($input->getOption('human-readable')) {
210		$dumpOptions .= '--complete-insert --skip-extended-insert ';
211		}
212
213		if ($input->getOption('add-routines')) {
214		$dumpOptions .= '--routines ';
215		}
216
217		if ($input->getOption('xml')) {
218		$dumpOptions .= '--xml ';
219		}
220
221		if ($input->getOption('hex-blob')) {
222		$dumpOptions .= '--hex-blob ';
223		}
224
225		$execs = array();
226
227		$ignore = '';
228		foreach (array_merge($excludeTables, $stripTables) as $tableName) {
229		$ignore .= '--ignore-table=' . $this->dbSettings['dbname'] . '.' . $tableName . ' ';
230		}
231
232		if (count($stripTables) > 0) {
233		// dump structure for strip-tables
234		$exec = 'mysqldump ' . $dumpOptions . '--no-data ' . $this->getHelper('database')->getMysqlClientToolConnectionString();
		0 ignored issues – show Coding Style introduced 2015-11-25 15:21 UTC by Report Bug Copy Issue Report This line exceeds maximum limit of 120 characters; contains 132 characters Overly long lines are hard to read on any screen. Most code styles therefor impose a maximum limit on the number of characters in a line. Loading history...
235		$exec .= ' ' . implode(' ', $stripTables);
236		$exec .= $this->postDumpPipeCommands();
237		$exec = $compressor->getCompressingCommand($exec);
238		if (!$input->getOption('stdout')) {
239		$exec .= ' > ' . escapeshellarg($fileName);
240		}
241		$execs[] = $exec;
242		}
243
244		// dump data for all other tables
245		$exec = 'mysqldump ' . $dumpOptions . $ignore . $this->getHelper('database')->getMysqlClientToolConnectionString();
		0 ignored issues – show Coding Style introduced 2015-11-25 15:21 UTC by Report Bug Copy Issue Report This line exceeds maximum limit of 120 characters; contains 123 characters Overly long lines are hard to read on any screen. Most code styles therefor impose a maximum limit on the number of characters in a line. Loading history...
246		$exec .= $this->postDumpPipeCommands();
247		$exec = $compressor->getCompressingCommand($exec);
248		if (!$input->getOption('stdout')) {
249		$exec .= (count($stripTables) > 0 ? ' >> ' : ' > ') . escapeshellarg($fileName);
250		}
251		$execs[] = $exec;
252
253		$this->runExecs($execs, $fileName, $input, $output);
254		}
255
256		/**
257		* @param array $execs
258		* @param string $fileName
259		* @param InputInterface $input
260		* @param OutputInterface $output
261		*/
262		private function runExecs(array $execs, $fileName, InputInterface $input, OutputInterface $output)
263		{
264		if ($input->getOption('only-command') && !$input->getOption('print-only-filename')) {
265		foreach ($execs as $exec) {
266		$output->writeln($exec);
267		}
268		} else {
269		if (!$input->getOption('stdout') && !$input->getOption('only-command')
270		&& !$input->getOption('print-only-filename')
271		) {
272		$output->writeln('<comment>Start dumping database <info>' . $this->dbSettings['dbname']
273		. '</info> to file <info>' . $fileName . '</info>'
274		);
275		}
276
277		foreach ($execs as $exec) {
278		$commandOutput = '';
279		if ($input->getOption('stdout')) {
280		passthru($exec, $returnValue);
281		} else {
282		Exec::run($exec, $commandOutput, $returnValue);
283		}
284		if ($returnValue > 0) {
285		$output->writeln('<error>' . $commandOutput . '</error>');
286		$output->writeln('<error>Return Code: ' . $returnValue . '. ABORTED.</error>');
287
288		return;
289		}
290		}
291
292		if (!$input->getOption('stdout') && !$input->getOption('print-only-filename')) {
293		$output->writeln('<info>Finished</info>');
294		}
295		}
296
297		if ($input->getOption('print-only-filename')) {
298		$output->writeln($fileName);
299		}
300		}
301
302		/**
303		* Commands which filter mysql data. Piped to mysqldump command
304		*
305		* @return string
306		*/
307		protected function postDumpPipeCommands()
308		{
309		return ' \| sed -e ' . escapeshellarg('s/DEFINER[ ]=[ ][^]\/\/');
310		}
311
312		/**
313		* @param InputInterface $input
314		* @param OutputInterface $output
315		* @param AbstractCompressor $compressor
316		*
317		* @return string
318		*/
319		protected function getFileName(InputInterface $input, OutputInterface $output, AbstractCompressor $compressor)
320		{
321		$namePrefix = '';
322		$nameSuffix = '';
323		if ($input->getOption('xml')) {
324		$nameExtension = '.xml';
325		} else {
326		$nameExtension = '.sql';
327		}
328
329
330		if ($input->getOption('add-time') !== false) {
331		$timeStamp = date('Y-m-d_His');
332
333		if ($input->getOption('add-time') == 'suffix') {
334		$nameSuffix = '_' . $timeStamp;
335		} else {
336		$namePrefix = $timeStamp . '_';
337		}
338		}
339
340		if ((($fileName = $input->getArgument('filename')) === null \|\| ($isDir = is_dir($fileName))) && !$input->getOption('stdout')) {
		0 ignored issues – show Coding Style introduced 2015-11-25 15:21 UTC by Report Bug Copy Issue Report This line exceeds maximum limit of 120 characters; contains 135 characters Overly long lines are hard to read on any screen. Most code styles therefor impose a maximum limit on the number of characters in a line. Loading history...
341		/** @var DialogHelper $dialog */
342		$dialog = $this->getHelperSet()->get('dialog');
343		$defaultName = $namePrefix . $this->dbSettings['dbname'] . $nameSuffix . $nameExtension;
344		if (isset($isDir) && $isDir) {
345		$defaultName = rtrim($fileName, DIRECTORY_SEPARATOR) . DIRECTORY_SEPARATOR . $defaultName;
346		}
347		if (!$input->getOption('force')) {
348		$fileName = $dialog->ask($output, '<question>Filename for SQL dump:</question> [<comment>'
349		. $defaultName . '</comment>]', $defaultName
350		);
351		} else {
352		$fileName = $defaultName;
353		}
354		} else {
355		if ($input->getOption('add-time')) {
356		$pathParts = pathinfo($fileName);
357		$fileName = ($pathParts['dirname'] == '.' ? '' : $pathParts['dirname'] . DIRECTORY_SEPARATOR) .
358		$namePrefix . $pathParts['filename'] . $nameSuffix . '.' . $pathParts['extension'];
359		}
360		}
361
362		$fileName = $compressor->getFileName($fileName);
363
364		return $fileName;
365		}
366		}
367

netz98 / n98-magerun

Push — master ( bd5921...d9293e )

DumpCommand::getTableDefinitions() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like