mirror/php-phpbb
1
0
Fork 0
mirror of https://github.com/phpbb/phpbb.git synced 2025-07-31 22:10:45 +02:00
Code Issues Releases Wiki Activity

[ticket/13987] Add --dry-run option to reparser CLI

Browse Source 
PHPBB3-13987
This commit is contained in:
JoshyPHP
2015-07-06 01:43:43 +02:00
parent ca5d4fd310
commit 7ccb638912
7 changed files with 96 additions and 44 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
phpBB/language/en/cli.php
View File

@@ -64,6 +64,7 @@ $lang = array_merge($lang, array(
'CLI_DESCRIPTION_REPARSER_LIST' => 'Lists the types of text that can be reparsed.',
'CLI_DESCRIPTION_REPARSER_REPARSE' => 'Reparses stored text with the current text_formatter services.',
'CLI_DESCRIPTION_REPARSER_REPARSE_ARG_1' => 'Type of text to reparse. Leave blank to reparse everything.',
'CLI_DESCRIPTION_REPARSER_REPARSE_OPT_DRY_RUN' => 'Do not save any changes; just print what would happen',
'CLI_DESCRIPTION_REPARSER_REPARSE_OPT_RANGE_MIN' => 'Lowest record ID to process',
'CLI_DESCRIPTION_REPARSER_REPARSE_OPT_RANGE_MAX' => 'Highest record ID to process',
'CLI_DESCRIPTION_REPARSER_REPARSE_OPT_RANGE_SIZE' => 'Approximate number of records to process at a time',

15
phpBB/phpbb/console/command/reparser/reparse.php
View File

@@ -56,6 +56,12 @@ class reparse extends \phpbb\console\command\command
->setName('reparser:reparse')
->setDescription($this->user->lang('CLI_DESCRIPTION_REPARSER_REPARSE'))
->addArgument('reparser-name', InputArgument::OPTIONAL, $this->user->lang('CLI_DESCRIPTION_REPARSER_REPARSE_ARG_1'))
->addOption(
'dry-run',
null,
InputOption::VALUE_NONE,
$this->user->lang('CLI_DESCRIPTION_REPARSER_REPARSE_OPT_DRY_RUN')
)
->addOption(
'range-min',
null,
@@ -126,9 +132,10 @@ class reparse extends \phpbb\console\command\command
$reparser = $this->reparsers[$name];
// Start at range-max if specified or at the highest ID otherwise
$max = (is_null($input->getOption('range-max'))) ? $reparser->get_max_id() : $input->getOption('range-max');
$min = $input->getOption('range-min');
$size = $input->getOption('range-size');
$max = (is_null($input->getOption('range-max'))) ? $reparser->get_max_id() : $input->getOption('range-max');
$min = $input->getOption('range-min');
$size = $input->getOption('range-size');
$dry_run = $input->getOption('dry-run');
if ($max === 0)
{
@@ -176,7 +183,7 @@ class reparse extends \phpbb\console\command\command
$end = max($min, $current);
$progress->setMessage($this->user->lang('CLI_REPARSER_REPARSE_REPARSING', str_replace('text_reparser.', '', $name), $start, $end));
$reparser->reparse_range($start, $end);
$reparser->reparse_range($start, $end, $dry_run);
$current = $start - 1;
$progress->setProgress($max + 1 - $start);

13
phpBB/phpbb/textreparser/base.php
View File

@@ -170,20 +170,21 @@ abstract class base implements reparser_interface
/**
* {@inheritdoc}
*/
public function reparse_range($min_id, $max_id)
public function reparse_range($min_id, $max_id, $dry_run = false)
{
foreach ($this->get_records_by_range($min_id, $max_id) as $record)
{
$this->reparse_record($record);
$this->reparse_record($record, $dry_run);
}
}
/**
* Reparse given record
*
* @param array $record Associative array containing the record's data
* @param array $record Associative array containing the record's data
* @param integer $dry_run If TRUE, do not save the changes
*/
protected function reparse_record(array $record)
protected function reparse_record(array $record, $dry_run)
{
$record = $this->add_missing_fields($record);
$flags = ($record['enable_bbcode']) ? OPTION_FLAG_BBCODE : 0;
@@ -212,8 +213,8 @@ abstract class base implements reparser_interface
$unparsed['enable_url_bbcode']
);
// Save the new text if it has changed
if ($text !== $record['text'])
// Save the new text if it has changed and it's not a dry run
if ($text !== $record['text'] && !$dry_run)
{
$record['text'] = $text;
$this->save_record($record);

7
phpBB/phpbb/textreparser/reparser_interface.php
View File

@@ -25,8 +25,9 @@ interface reparser_interface
/**
* Reparse all records in given range
*
* @param integer $min_id Lower bound
* @param integer $max_id Upper bound
* @param integer $min_id Lower bound
* @param integer $max_id Upper bound
* @param integer $dry_run If TRUE, do not save the changes
*/
public function reparse_range($min_id, $max_id);
public function reparse_range($min_id, $max_id, $dry_run = false);
}