Merge pull request #3662 from s9e/ticket/13891

[ticket/13891] Added reparser:list and reparser:reparse to CLI

phpBB/config/default/container/services_console.yml

@@ -140,3 +140,19 @@ services:
             - @dbal.conn
         tags:
             - { name: console.command }
+
+    console.command.reparser.list:
+        class: phpbb\console\command\reparser\list_all
+        arguments:
+            - @user
+            - @text_reparser_collection
+        tags:
+            - { name: console.command }
+
+    console.command.reparser.reparse:
+        class: phpbb\console\command\reparser\reparse
+        arguments:
+            - @user
+            - @text_reparser_collection
+        tags:
+            - { name: console.command }

phpBB/language/en/cli.php

@@ -61,6 +61,12 @@ $lang = array_merge($lang, array(
 	'CLI_DESCRIPTION_OPTION_SAFE_MODE'			=> 'Run in Safe Mode (without extensions).',
 	'CLI_DESCRIPTION_OPTION_SHELL'				=> 'Launch the shell.',
 	'CLI_DESCRIPTION_PURGE_EXTENSION'			=> 'Purges the specified extension.',
+	'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_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',
 	'CLI_DESCRIPTION_RECALCULATE_EMAIL_HASH'	=> 'Recalculates the user_email_hash column of the users table.',
 	'CLI_DESCRIPTION_SET_ATOMIC_CONFIG'			=> 'Sets a configuration option’s value only if the old matches the current value',
 	'CLI_DESCRIPTION_SET_CONFIG'				=> 'Sets a configuration option’s value',
@@ -78,4 +84,8 @@ $lang = array_merge($lang, array(
 	'CLI_EXTENSIONS_ENABLED'			=> 'Enabled',
 
 	'CLI_FIXUP_RECALCULATE_EMAIL_HASH_SUCCESS'	=> 'Successfully recalculated all email hashes.',
+
+	'CLI_REPARSER_REPARSE_REPARSING'		=> 'Reparsing %1$s (range %2$d..%3$d)',
+	'CLI_REPARSER_REPARSE_REPARSING_START'	=> 'Reparsing %s...',
+	'CLI_REPARSER_REPARSE_SUCCESS'			=> 'Reparsing ended with success',
 ));

phpBB/phpbb/console/command/reparser/list_all.php

@@ -0,0 +1,69 @@
+<?php
+/**
+*
+* This file is part of the phpBB Forum Software package.
+*
+* @copyright (c) phpBB Limited <https://www.phpbb.com>
+* @license GNU General Public License, version 2 (GPL-2.0)
+*
+* For full copyright and license information, please see
+* the docs/CREDITS.txt file.
+*
+*/
+
+namespace phpbb\console\command\reparser;
+
+use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Output\OutputInterface;
+
+class list_all extends \phpbb\console\command\command
+{
+	/**
+	* @var string[] Names of the reparser services
+	*/
+	protected $reparser_names;
+
+	/**
+	* Constructor
+	*
+	* @param \phpbb\user $user
+	* @param \phpbb\di\service_collection $reparsers
+	*/
+	public function __construct(\phpbb\user $user, \phpbb\di\service_collection $reparsers)
+	{
+		parent::__construct($user);
+		$this->reparser_names = array();
+		foreach ($reparsers as $name => $reparser)
+		{
+			// Store the names without the "text_reparser." prefix
+			$this->reparser_names[] = str_replace('text_reparser.', '', $name);
+		}
+	}
+
+	/**
+	* Sets the command name and description
+	*
+	* @return null
+	*/
+	protected function configure()
+	{
+		$this
+			->setName('reparser:list')
+			->setDescription($this->user->lang('CLI_DESCRIPTION_REPARSER_LIST'))
+		;
+	}
+
+	/**
+	* Executes the command reparser:reparse
+	*
+	* @param InputInterface $input
+	* @param OutputInterface $output
+	* @return integer
+	*/
+	protected function execute(InputInterface $input, OutputInterface $output)
+	{
+		$output->writeln('<info>' . implode(', ', $this->reparser_names) . '</info>');
+
+		return 0;
+	}
+}

phpBB/phpbb/console/command/reparser/reparse.php

@@ -0,0 +1,188 @@
+<?php
+/**
+*
+* This file is part of the phpBB Forum Software package.
+*
+* @copyright (c) phpBB Limited <https://www.phpbb.com>
+* @license GNU General Public License, version 2 (GPL-2.0)
+*
+* For full copyright and license information, please see
+* the docs/CREDITS.txt file.
+*
+*/
+
+namespace phpbb\console\command\reparser;
+
+use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Input\InputArgument;
+use Symfony\Component\Console\Input\InputOption;
+use Symfony\Component\Console\Output\OutputInterface;
+use Symfony\Component\Console\Style\SymfonyStyle;
+
+class reparse extends \phpbb\console\command\command
+{
+	/**
+	* @var \phpbb\di\service_collection
+	*/
+	protected $reparsers;
+
+	/**
+	* @var SymfonyStyle
+	*/
+	protected $io;
+
+	/**
+	* Constructor
+	*
+	* @param \phpbb\user $user
+	* @param \phpbb\di\service_collection $reparser_collection
+	*/
+	public function __construct(\phpbb\user $user, \phpbb\di\service_collection $reparsers)
+	{
+		require_once __DIR__ . '/../../../../includes/functions_content.php';
+
+		$this->reparsers = $reparsers;
+		parent::__construct($user);
+	}
+
+	/**
+	* Sets the command name and description
+	*
+	* @return null
+	*/
+	protected function configure()
+	{
+		$this
+			->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(
+				'range-min',
+				null,
+				InputOption::VALUE_REQUIRED,
+				$this->user->lang('CLI_DESCRIPTION_REPARSER_REPARSE_OPT_RANGE_MIN'),
+				1
+			)
+			->addOption(
+				'range-max',
+				null,
+				InputOption::VALUE_REQUIRED,
+				$this->user->lang('CLI_DESCRIPTION_REPARSER_REPARSE_OPT_RANGE_MAX')
+			)
+			->addOption(
+				'range-size',
+				null,
+				InputOption::VALUE_REQUIRED,
+				$this->user->lang('CLI_DESCRIPTION_REPARSER_REPARSE_OPT_RANGE_SIZE'),
+				100
+			);
+		;
+	}
+
+	/**
+	* Executes the command reparser:reparse
+	*
+	* @param InputInterface $input
+	* @param OutputInterface $output
+	* @return integer
+	*/
+	protected function execute(InputInterface $input, OutputInterface $output)
+	{
+		$this->io = new SymfonyStyle($input, $output);
+
+		$name = $input->getArgument('reparser-name');
+		if (isset($name))
+		{
+			// Allow "post_text" to be an alias for "text_reparser.post_text"
+			if (!isset($this->reparsers[$name]))
+			{
+				$name = 'text_reparser.' . $name;
+			}
+			$this->reparse($input, $output, $name);
+		}
+		else
+		{
+			foreach ($this->reparsers as $name => $service)
+			{
+				$this->reparse($input, $output, $name);
+			}
+		}
+
+		$this->io->success($this->user->lang('CLI_REPARSER_REPARSE_SUCCESS'));
+
+		return 0;
+	}
+
+	/**
+	* Reparse all text handled by given reparser within given range
+	*
+	* @param InputInterface $input
+	* @param OutputInterface $output
+	* @param string $name Reparser name
+	* @return null
+	*/
+	protected function reparse(InputInterface $input, OutputInterface $output, $name)
+	{
+		$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');
+
+		if ($max === 0)
+		{
+			return;
+		}
+
+		$this->io->section($this->user->lang('CLI_REPARSER_REPARSE_REPARSING', str_replace('text_reparser.', '', $name), $min, $max));
+
+		$progress = $this->io->createProgressBar($max);
+		if ($output->getVerbosity() === OutputInterface::VERBOSITY_VERBOSE)
+		{
+			$progress->setFormat('<info>[%percent:3s%%]</info> %message%');
+			$progress->setOverwrite(false);
+		}
+		elseif ($output->getVerbosity() >= OutputInterface::VERBOSITY_VERY_VERBOSE)
+		{
+			$progress->setFormat('<info>[%current:s%/%max:s%]</info><comment>[%elapsed%/%estimated%][%memory%]</comment> %message%');
+			$progress->setOverwrite(false);
+		}
+		else
+		{
+			$this->io->newLine(2);
+			$progress->setFormat(
+				"    %current:s%/%max:s% %bar%  %percent:3s%%\n" .
+				"        %message% %elapsed:6s%/%estimated:-6s% %memory:6s%\n");
+			$progress->setBarWidth(60);
+		}
+
+		$progress->setMessage($this->user->lang('CLI_REPARSER_REPARSE_REPARSING_START', str_replace('text_reparser.', '', $name)));
+
+		if (!defined('PHP_WINDOWS_VERSION_BUILD'))
+		{
+			$progress->setEmptyBarCharacter('░'); // light shade character \u2591
+			$progress->setProgressCharacter('');
+			$progress->setBarCharacter('▓'); // dark shade character \u2593
+		}
+
+		$progress->start();
+
+		// Start from $max and decrement $current by $size until we reach $min
+		$current = $max;
+		while ($current >= $min)
+		{
+			$start = max($min, $current + 1 - $size);
+			$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);
+
+			$current = $start - 1;
+			$progress->setProgress($max + 1 - $start);
+		}
+		$progress->finish();
+
+		$this->io->newLine(2);
+	}
+}