[ticket/14561] Reclean usernames command

PHPBB3-14561

phpBB/config/default/container/services_console.yml

@@ -258,3 +258,12 @@ services:
             - '%core.php_ext%'
         tags:
             - { name: console.command }
+
+    console.command.user.reclean:
+        class: phpbb\console\command\user\reclean
+        arguments:
+            - '@user'
+            - '@dbal.conn'
+            - '@language'
+        tags:
+            - { name: console.command }

phpBB/language/en/cli.php

@@ -95,6 +95,7 @@ $lang = array_merge($lang, array(
 	'CLI_DESCRIPTION_USER_DELETE'				=> 'Delete a user account.',
 	'CLI_DESCRIPTION_USER_DELETE_USERNAME'		=> 'Username of the user to delete',
 	'CLI_DESCRIPTION_USER_DELETE_OPTION_POSTS'	=> 'Delete all posts by the user. Without this option, the user’s posts will be retained.',
+	'CLI_DESCRIPTION_USER_RECLEAN'				=> 'Re-clean usernames.',
 
 	'CLI_EXTENSION_DISABLE_FAILURE'		=> 'Could not disable extension %s',
 	'CLI_EXTENSION_DISABLE_SUCCESS'		=> 'Successfully disabled extension %s',
@@ -135,6 +136,11 @@ $lang = array_merge($lang, array(
 
 	'CLI_USER_ADD_SUCCESS'		=> 'Successfully added user %s.',
 	'CLI_USER_DELETE_CONFIRM'	=> 'Are you sure you want to delete ‘%s’? [y/N]',
+	'CLI_USER_RECLEAN_SUCCESS'	=> [
+		0	=> 'Re-cleaning complete. No usernames needed to be cleaned.',
+		1	=> 'Re-cleaning complete. %d username was cleaned.',
+		2	=> 'Re-cleaning complete. %d usernames were cleaned.',
+	],
 ));
 
 // Additional help for commands.

phpBB/phpbb/console/command/user/reclean.php

@@ -0,0 +1,125 @@
+<?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\user;
+
+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 Symfony\Component\Console\Question\ConfirmationQuestion;
+use Symfony\Component\Console\Question\Question;
+use Symfony\Component\Console\Style\SymfonyStyle;
+
+class reclean extends \phpbb\console\command\command
+{
+	/** @var \phpbb\db\driver\driver_interface */
+	protected $db;
+
+	/** @var \phpbb\language\language */
+	protected $language;
+
+	/** @var int A count of the number of re-cleaned user names */
+	protected $processed;
+
+	/**
+	 * Construct method
+	 *
+	 * @param \phpbb\user                       $user
+	 * @param \phpbb\db\driver\driver_interface $db
+	 * @param \phpbb\language\language          $language
+	 */
+	public function __construct(\phpbb\user $user, \phpbb\db\driver\driver_interface $db, \phpbb\language\language $language)
+	{
+		$this->db = $db;
+		$this->language = $language;
+
+		parent::__construct($user);
+	}
+
+	/**
+	 * Sets the command name and description
+	 *
+	 * @return null
+	 */
+	protected function configure()
+	{
+		$this
+			->setName('user:reclean')
+			->setDescription($this->language->lang('CLI_DESCRIPTION_USER_RECLEAN'))
+		;
+	}
+
+	/**
+	 * Executes the command user:reclean
+	 *
+	 * Cleans user names that are unclean.
+	 *
+	 * @param InputInterface  $input  The input stream used to get the options
+	 * @param OutputInterface $output The output stream, used to print messages
+	 *
+	 * @return int 0 if all is well, 1 if any errors occurred
+	 */
+	protected function execute(InputInterface $input, OutputInterface $output)
+	{
+		$this->processed = 0;
+
+		$stage = 0;
+		while ($stage !== true)
+		{
+			$stage = $this->reclean_usernames($stage);
+		}
+
+		$io = new SymfonyStyle($input, $output);
+		$io->success($this->language->lang('CLI_USER_RECLEAN_SUCCESS', $this->processed));
+		return 0;
+	}
+
+	/**
+	 * Re-clean user names
+	 * Only user names that are unclean will be re-cleaned
+	 *
+	 * @param int $start An offset index
+	 * @return bool|int Return the next offset index or true if all records have been processed.
+	 */
+	protected function reclean_usernames($start = 0)
+	{
+		$limit = 500;
+		$i = 0;
+
+		$this->db->sql_transaction('begin');
+
+		$sql = 'SELECT user_id, username, username_clean FROM ' . USERS_TABLE;
+		$result = $this->db->sql_query_limit($sql, $limit, $start);
+		while ($row = $this->db->sql_fetchrow($result))
+		{
+			$i++;
+			$username_clean = $this->db->sql_escape(utf8_clean_string($row['username']));
+
+			if ($username_clean != $row['username_clean'])
+			{
+				$sql = 'UPDATE ' . USERS_TABLE . "
+					SET username_clean = '$username_clean'
+					WHERE user_id = {$row['user_id']}";
+				$this->db->sql_query($sql);
+
+				$this->processed++;
+			}
+		}
+		$this->db->sql_freeresult($result);
+
+		$this->db->sql_transaction('commit');
+
+		return ($i < $limit) ? true : $start + $i;
+	}
+}

tests/console/user/reclean_test.php

@@ -0,0 +1,78 @@
+<?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.
+*
+*/
+
+use Symfony\Component\Console\Application;
+use Symfony\Component\Console\Tester\CommandTester;
+use phpbb\console\command\user\reclean;
+
+class phpbb_console_command_user_reclean_test extends phpbb_database_test_case
+{
+	protected $db;
+	protected $user;
+	protected $language;
+	protected $command_name;
+
+	public function getDataSet()
+	{
+		return $this->createXMLDataSet(dirname(__FILE__) . '/fixtures/config.xml');
+	}
+
+	public function setUp()
+	{
+		$this->db = $this->new_dbal();
+
+		$this->language = $this->getMockBuilder('\phpbb\language\language')
+			->disableOriginalConstructor()
+			->getMock();
+		$this->language->expects($this->any())
+			->method('lang')
+			->will($this->returnArgument(0));
+		$this->user = $this->getMock('\phpbb\user', array(), array(
+			$this->language,
+			'\phpbb\datetime'
+		));
+
+		parent::setUp();
+	}
+
+	public function test_reclean()
+	{
+		$command_tester = $this->get_command_tester();
+
+		$command_tester->execute(array(
+			'command' => $this->command_name,
+		));
+
+		$this->assertContains('CLI_USER_RECLEAN_SUCCESS', $command_tester->getDisplay());
+
+		$result = $this->db->sql_query('SELECT user_id FROM ' . USERS_TABLE . " WHERE username_clean = 'test unclean'");
+		$row = $this->db->sql_fetchrow($result);
+		$this->db->sql_freeresult($result);
+		$this->assertNotNull($row['user_id']);
+	}
+
+	public function get_command_tester()
+	{
+		$application = new Application();
+		$application->add(new reclean(
+			$this->user,
+			$this->db,
+			$this->language
+		));
+
+		$command = $application->find('user:reclean');
+		$this->command_name = $command->getName();
+
+		return new CommandTester($command);
+	}
+}