DumpCommand::getTableDefinitionHelp() - Code Metrics - Inspection of "[TASK] Streamline author and file-comment" - ktomk/n98-magerun - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — develop ( 3676ae...babe21 )

by Tom

created 2016-03-20 00:19 UTC

DumpCommand::getTableDefinitionHelp() B

↳ Parent: DumpCommand

Complexity

Conditions	6
Paths	15

Size

Total Lines	49
Code Lines	25

Duplication

Lines	0
Ratio	0 %

Importance

Changes	2
Bugs	0	Features	0

Metric	Value
c	2
b	0
f	0
dl	0
loc	49
rs	8.5906
cc	6
eloc	25
nc	15
nop	0

<?php

namespace N98\Magento\Command\Database;

use N98\Magento\Command\Database\Compressor\Compressor;
use N98\Util\Console\Enabler;
use N98\Util\Console\Helper\DatabaseHelper;
use N98\Util\Exec;
use N98\Util\VerifyOrDie;
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;

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 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)
    {
        // communicate early what is required for this command to run (is enabled)
        $enabler = new Enabler($this);
        $enabler->functionExists('exec');
        $enabler->functionExists('passthru');
        $enabler->operatingSystemIsNotWindows();

        $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 . ' ';
        }

        $mysqlClientToolConnectionString = $this->getHelper('database')->getMysqlClientToolConnectionString();

        if (count($stripTables) > 0) {
            // dump structure for strip-tables
            $exec = 'mysqldump ' . $dumpOptions . '--no-data ' . $mysqlClientToolConnectionString;
            $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 . $mysqlClientToolConnectionString . ' ' . $ignore;
        $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 ' | LANG=C LC_CTYPE=C LC_ALL=C sed -e ' . escapeshellarg('s/DEFINER[ ]*=[ ]*[^*]*\*/\*/');
    }

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

ktomk / n98-magerun

Push — develop ( 3676ae...babe21 )

DumpCommand::getTableDefinitionHelp() B

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like