makary/phpbb
1
0
Fork 0
mirror of https://github.com/phpbb/phpbb.git synced 2025-06-28 14:18:52 +00:00
Code Issues Projects Releases Packages Wiki Activity

Merge pull request #3744 from s9e/ticket/13987

Browse source 
[ticket/13987] Add --dry-run option to reparser CLI
This commit is contained in:
Tristan Darricau 2015-07-07 17:25:28 +02:00
commit 2fbfb0e004
6 changed files with 117 additions and 34 deletions
Show stats 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',

14
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,
@ -124,6 +130,14 @@ class reparse extends \phpbb\console\command\command
protected function reparse(InputInterface $input, OutputInterface $output, $name)
{
$reparser = $this->reparsers[$name];
if ($input->getOption('dry-run'))
{
$reparser->disable_save();
}
else
{
$reparser->enable_save();
}
// 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');

27
phpBB/phpbb/textreparser/base.php
View file

@ -15,6 +15,11 @@ namespace phpbb\textreparser;
abstract class base implements reparser_interface
{
/**
* @var bool Whether to save changes to the database
*/
protected $save_changes = true;
/**
* {@inheritdoc}
*/
@ -84,6 +89,22 @@ abstract class base implements reparser_interface
return $record;
}
/**
* Disable saving changes to the database
*/
public function disable_save()
{
$this->save_changes = false;
}
/**
* Enable saving changes to the database
*/
public function enable_save()
{
$this->save_changes = true;
}
/**
* Guess whether given BBCode is in use in given record
*
@ -181,7 +202,7 @@ abstract class base implements reparser_interface
/**
* Reparse given record
*
* @param array $record Associative array containing the record's data
* @param array $record Associative array containing the record's data
*/
protected function reparse_record(array $record)
{
@ -212,8 +233,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'] && $this->save_changes)
{
$record['text'] = $text;
$this->save_record($record);

35
tests/text_reparser/plugins/contact_admin_info_test.php
View file

@ -28,6 +28,18 @@ class phpbb_textreparser_contact_admin_info_test extends phpbb_database_test_cas
return new \phpbb\textreparser\plugins\contact_admin_info(new \phpbb\config\db_text($this->db, CONFIG_TEXT_TABLE));
}
protected function get_rows()
{
$sql = 'SELECT config_name, config_value
FROM ' . CONFIG_TEXT_TABLE . '
ORDER BY config_name';
$result = $this->db->sql_query($sql);
$rows = $this->db->sql_fetchrowset($result);
$this->db->sql_freeresult($result);
return $rows;
}
public function setUp()
{
global $config;
@ -46,18 +58,21 @@ class phpbb_textreparser_contact_admin_info_test extends phpbb_database_test_cas
$this->assertEquals(1, $reparser->get_max_id());
}
public function testReparse()
public function test_dry_run()
{
$old_rows = $this->get_rows();
$reparser = $this->get_reparser();
$reparser->disable_save();
$reparser->reparse_range(1, 1);
$new_rows = $this->get_rows();
$this->assertEquals($old_rows, $new_rows);
}
public function test_reparse()
{
$reparser = $this->get_reparser();
$reparser->enable_save();
$reparser->reparse_range(1, 1);
$sql = 'SELECT config_name, config_value
FROM ' . CONFIG_TEXT_TABLE . '
ORDER BY config_name';
$result = $this->db->sql_query($sql);
$rows = $this->db->sql_fetchrowset($result);
$this->db->sql_freeresult($result);
$expected = array(
array(
'config_name' => 'contact_admin_info',
@ -76,6 +91,6 @@ class phpbb_textreparser_contact_admin_info_test extends phpbb_database_test_cas
'config_value' => '1a2hbwf5',
),
);
$this->assertEquals($expected, $rows);
$this->assertEquals($expected, $this->get_rows());
}
}

33
tests/text_reparser/plugins/poll_option_test.php
View file

@ -28,6 +28,18 @@ class phpbb_textreparser_poll_option_test extends phpbb_database_test_case
return new \phpbb\textreparser\plugins\poll_option($this->db);
}
protected function get_rows()
{
$sql = 'SELECT topic_id, poll_option_id, poll_option_text
FROM ' . POLL_OPTIONS_TABLE . '
ORDER BY topic_id, poll_option_id';
$result = $this->db->sql_query($sql);
$rows = $this->db->sql_fetchrowset($result);
$this->db->sql_freeresult($result);
return $rows;
}
public function setUp()
{
global $config;
@ -46,18 +58,21 @@ class phpbb_textreparser_poll_option_test extends phpbb_database_test_case
$this->assertEquals(123, $reparser->get_max_id());
}
public function test_dry_run()
{
$old_rows = $this->get_rows();
$reparser = $this->get_reparser();
$reparser->disable_save();
$reparser->reparse_range(1, 1);
$new_rows = $this->get_rows();
$this->assertEquals($old_rows, $new_rows);
}
public function testReparse()
{
$reparser = $this->get_reparser();
$reparser->enable_save();
$reparser->reparse_range(2, 13);
$sql = 'SELECT topic_id, poll_option_id, poll_option_text
FROM ' . POLL_OPTIONS_TABLE . '
ORDER BY topic_id, poll_option_id';
$result = $this->db->sql_query($sql);
$rows = $this->db->sql_fetchrowset($result);
$this->db->sql_freeresult($result);
$expected = array(
array(
'topic_id' => 1,
@ -110,6 +125,6 @@ class phpbb_textreparser_poll_option_test extends phpbb_database_test_case
'poll_option_text' => 'This row should be [b:abcd1234]ignored[/b:abcd1234]',
),
);
$this->assertEquals($expected, $rows);
$this->assertEquals($expected, $this->get_rows());
}
}

41
tests/text_reparser/plugins/test_row_based_plugin.php
View file

@ -20,6 +20,21 @@ abstract class phpbb_textreparser_test_row_based_plugin extends phpbb_database_t
abstract protected function get_reparser();
protected function get_rows(array $ids)
{
$reparser = $this->get_reparser();
$columns = $reparser->get_columns();
$sql = 'SELECT ' . $columns['id'] . ' AS id, ' . $columns['text'] . ' AS text
FROM ' . $reparser->get_table_name() . '
WHERE ' . $this->db->sql_in_set($columns['id'], $ids) . '
ORDER BY id';
$result = $this->db->sql_query($sql);
$rows = $this->db->sql_fetchrowset($result);
$this->db->sql_freeresult($result);
return $rows;
}
public function setUp()
{
global $config;
@ -38,10 +53,20 @@ abstract class phpbb_textreparser_test_row_based_plugin extends phpbb_database_t
$this->assertEquals(1000, $reparser->get_max_id());
}
public function test_dry_run()
{
$old_rows = $this->get_rows(array(1));
$reparser = $this->get_reparser();
$reparser->disable_save();
$reparser->reparse_range(1, 1);
$new_rows = $this->get_rows(array(1));
$this->assertEquals($old_rows, $new_rows);
}
/**
* @dataProvider getReparseTests
* @dataProvider get_reparse_tests
*/
public function testReparse($min_id, $max_id, $expected)
public function test_reparse($min_id, $max_id, $expected)
{
$reparser = $this->get_reparser();
$reparser->reparse_range($min_id, $max_id);
@ -52,18 +77,10 @@ abstract class phpbb_textreparser_test_row_based_plugin extends phpbb_database_t
$ids[] = $row['id'];
}
$columns = $reparser->get_columns();
$sql = 'SELECT ' . $columns['id'] . ' AS id, ' . $columns['text'] . ' AS text
FROM ' . $reparser->get_table_name() . '
WHERE ' . $this->db->sql_in_set($columns['id'], $ids) . '
ORDER BY id';
$result = $this->db->sql_query($sql);
$rows = $this->db->sql_fetchrowset($result);
$this->db->sql_freeresult($result);
$this->assertEquals($expected, $rows);
$this->assertEquals($expected, $this->get_rows($ids));
}
public function getReparseTests()
public function get_reparse_tests()
{
return array(
array(