From 77d1010081012f8b9e4b43129ee017abbf869d17 Mon Sep 17 00:00:00 2001 From: Marc Alexander Date: Thu, 20 Jun 2024 21:17:48 +0200 Subject: [PATCH 1/8] [ticket/17347] Add console command to delete users by user IDs PHPBB-17347 --- .../default/container/services_console.yml | 12 ++ phpBB/language/en/cli.php | 11 +- .../phpbb/console/command/user/delete_ids.php | 182 ++++++++++++++++++ 3 files changed, 201 insertions(+), 4 deletions(-) create mode 100644 phpBB/phpbb/console/command/user/delete_ids.php diff --git a/phpBB/config/default/container/services_console.yml b/phpBB/config/default/container/services_console.yml index 2a62543c2f..b7288e2ec7 100644 --- a/phpBB/config/default/container/services_console.yml +++ b/phpBB/config/default/container/services_console.yml @@ -281,6 +281,18 @@ services: tags: - { name: console.command } + console.command.user.delete_ids: + class: phpbb\console\command\user\delete_ids + arguments: + - '@language' + - '@log' + - '@user' + - '@user_loader' + - '%core.root_path%' + - '%core.php_ext%' + tags: + - { name: console.command } + console.command.user.reclean: class: phpbb\console\command\user\reclean arguments: diff --git a/phpBB/language/en/cli.php b/phpBB/language/en/cli.php index ce81039809..a0c2f3693a 100644 --- a/phpBB/language/en/cli.php +++ b/phpBB/language/en/cli.php @@ -155,10 +155,13 @@ $lang = array_merge($lang, array( 'CLI_THUMBNAIL_NOTHING_TO_GENERATE' => 'No thumbnails to generate.', 'CLI_THUMBNAIL_NOTHING_TO_DELETE' => 'No thumbnails to delete.', - '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_START' => 'Re-cleaning usernames', - 'CLI_USER_RECLEAN_DONE' => [ + 'CLI_USER_ADD_SUCCESS' => 'Successfully added user %s.', + 'CLI_USER_DELETE_CONFIRM' => 'Are you sure you want to delete ‘%s’? [y/N]', + 'CLI_USER_DELETE_IDS_CONFIRM' => 'Are you sure you want to delete the user IDs ‘%s’? [y/N]', + 'CLI_USER_DELETE_IDS_SUCCESS' => 'Successfully deleted user IDs.', + 'CLI_USER_DELETE_IDS_NOT_FOUND' => 'No users were deleted by user ID.', + 'CLI_USER_RECLEAN_START' => 'Re-cleaning usernames', + 'CLI_USER_RECLEAN_DONE' => [ 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.', diff --git a/phpBB/phpbb/console/command/user/delete_ids.php b/phpBB/phpbb/console/command/user/delete_ids.php new file mode 100644 index 0000000000..cdd7ef544e --- /dev/null +++ b/phpBB/phpbb/console/command/user/delete_ids.php @@ -0,0 +1,182 @@ + + * @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 phpbb\console\command\command; +use phpbb\db\driver\driver_interface; +use phpbb\language\language; +use phpbb\log\log_interface; +use phpbb\user; +use phpbb\user_loader; +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\Style\SymfonyStyle; + +class delete_ids extends command +{ + /** @var driver_interface */ + protected $db; + + /** @var language */ + protected $language; + + /** @var log_interface */ + protected $log; + + /** @var user_loader */ + protected $user_loader; + + /** + * phpBB root path + * + * @var string + */ + protected $phpbb_root_path; + + /** + * PHP extension. + * + * @var string + */ + protected $php_ext; + + /** + * Construct method + * + * @param language $language + * @param log_interface $log + * @param user $user + * @param user_loader $user_loader + * @param string $phpbb_root_path + * @param string $php_ext + */ + public function __construct(language $language, log_interface $log, user $user, user_loader $user_loader, string $phpbb_root_path, string $php_ext) + { + $this->language = $language; + $this->log = $log; + $this->user_loader = $user_loader; + $this->phpbb_root_path = $phpbb_root_path; + $this->php_ext = $php_ext; + + $this->language->add_lang('acp/users'); + parent::__construct($user); + } + + /** + * Sets the command name and description + * + * @return void + */ + protected function configure(): void + { + $this + ->setName('user:delete_ids') + ->setDescription($this->language->lang('CLI_DESCRIPTION_USER_DELETE_IDS')) + ->addArgument( + 'user_ids', + InputArgument::REQUIRED | InputArgument::IS_ARRAY, + $this->language->lang('CLI_DESCRIPTION_USER_DELETE_IDS_LIST') + ) + ->addOption( + 'delete-posts', + null, + InputOption::VALUE_NONE, + $this->language->lang('CLI_DESCRIPTION_USER_DELETE_OPTION_POSTS') + ) + ; + } + + /** + * Executes the command user:delete_ids + * + * Deletes a list of user ids from the database. An option to delete the users' posts + * is available, by default posts will be retained. + * + * @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): int + { + $user_ids = $input->getArgument('user_ids'); + $mode = ($input->getOption('delete-posts')) ? 'remove' : 'retain'; + $deleted_users = 0; + $io = new SymfonyStyle($input, $output); + + if (count($user_ids) > 0) + { + foreach ($user_ids as $user_id) + { + $user_row = $this->user_loader->get_user((int) $user_id); + + // Skip anonymous user + if ($user_row['user_id'] == ANONYMOUS) + { + continue; + } + + if (!function_exists('user_delete')) + { + require($this->phpbb_root_path . 'includes/functions_user.' . $this->php_ext); + } + + user_delete($mode, $user_row['user_id'], $user_row['username']); + + $this->log->add('admin', ANONYMOUS, '', 'LOG_USER_DELETED', false, array($user_row['username'])); + } + + if ($deleted_users > 0) + { + $io->success($this->language->lang('CLI_USER_DELETE_IDS_SUCCESS')); + } + } + + if (!$deleted_users) + { + $io->caution($this->language->lang('CLI_USER_DELETE_IDS_NOT_FOUND')); + } + + return 0; + } + + /** + * Interacts with the user. + * Confirm they really want to delete the account...last chance! + * + * @param InputInterface $input An InputInterface instance + * @param OutputInterface $output An OutputInterface instance + */ + protected function interact(InputInterface $input, OutputInterface $output): void + { + $helper = $this->getHelper('question'); + + $user_ids = $input->getArgument('user_ids'); + if (count($user_ids) > 0) + { + $question = new ConfirmationQuestion( + $this->language->lang('CLI_USER_DELETE_IDS_CONFIRM', implode(',', $user_ids)), + false + ); + + if (!$helper->ask($input, $output, $question)) + { + $input->setArgument('user_ids', []); + } + } + } +} From 8432e506c4b5b604785c682b057a27fa2132e1ea Mon Sep 17 00:00:00 2001 From: Marc Alexander Date: Thu, 20 Jun 2024 22:23:38 +0200 Subject: [PATCH 2/8] [ticket/17347] Add tests for delete ids PHPBB-17347 --- phpBB/language/en/cli.php | 2 +- .../phpbb/console/command/user/delete_ids.php | 20 +---- tests/console/user/delete_ids_test.php | 90 +++++++++++++++++++ 3 files changed, 95 insertions(+), 17 deletions(-) create mode 100644 tests/console/user/delete_ids_test.php diff --git a/phpBB/language/en/cli.php b/phpBB/language/en/cli.php index a0c2f3693a..e271380a2f 100644 --- a/phpBB/language/en/cli.php +++ b/phpBB/language/en/cli.php @@ -159,7 +159,7 @@ $lang = array_merge($lang, array( 'CLI_USER_DELETE_CONFIRM' => 'Are you sure you want to delete ‘%s’? [y/N]', 'CLI_USER_DELETE_IDS_CONFIRM' => 'Are you sure you want to delete the user IDs ‘%s’? [y/N]', 'CLI_USER_DELETE_IDS_SUCCESS' => 'Successfully deleted user IDs.', - 'CLI_USER_DELETE_IDS_NOT_FOUND' => 'No users were deleted by user ID.', + 'CLI_USER_DELETE_NONE' => 'No users were deleted by user ID.', 'CLI_USER_RECLEAN_START' => 'Re-cleaning usernames', 'CLI_USER_RECLEAN_DONE' => [ 0 => 'Re-cleaning complete. No usernames needed to be cleaned.', diff --git a/phpBB/phpbb/console/command/user/delete_ids.php b/phpBB/phpbb/console/command/user/delete_ids.php index cdd7ef544e..3ecd43b314 100644 --- a/phpBB/phpbb/console/command/user/delete_ids.php +++ b/phpBB/phpbb/console/command/user/delete_ids.php @@ -14,7 +14,6 @@ namespace phpbb\console\command\user; use phpbb\console\command\command; -use phpbb\db\driver\driver_interface; use phpbb\language\language; use phpbb\log\log_interface; use phpbb\user; @@ -28,9 +27,6 @@ use Symfony\Component\Console\Style\SymfonyStyle; class delete_ids extends command { - /** @var driver_interface */ - protected $db; - /** @var language */ protected $language; @@ -40,18 +36,10 @@ class delete_ids extends command /** @var user_loader */ protected $user_loader; - /** - * phpBB root path - * - * @var string - */ + /** @var string phpBB root path */ protected $phpbb_root_path; - /** - * PHP extension. - * - * @var string - */ + /** @var string PHP extension */ protected $php_ext; /** @@ -122,7 +110,7 @@ class delete_ids extends command { foreach ($user_ids as $user_id) { - $user_row = $this->user_loader->get_user((int) $user_id); + $user_row = $this->user_loader->get_user($user_id); // Skip anonymous user if ($user_row['user_id'] == ANONYMOUS) @@ -148,7 +136,7 @@ class delete_ids extends command if (!$deleted_users) { - $io->caution($this->language->lang('CLI_USER_DELETE_IDS_NOT_FOUND')); + $io->note($this->language->lang('CLI_USER_DELETE_NONE')); } return 0; diff --git a/tests/console/user/delete_ids_test.php b/tests/console/user/delete_ids_test.php new file mode 100644 index 0000000000..0595271b6b --- /dev/null +++ b/tests/console/user/delete_ids_test.php @@ -0,0 +1,90 @@ + +* @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\delete_ids; + +require_once __DIR__ . '/base.php'; + +class phpbb_console_user_delete_ids_test extends phpbb_console_user_base +{ + public function get_command_tester() + { + $application = new Application(); + $application->add(new delete_ids( + $this->language, + $this->log, + $this->user, + $this->user_loader, + $this->phpbb_root_path, + $this->php_ext + )); + + $command = $application->find('user:delete_ids'); + $this->command_name = $command->getName(); + $this->question = $command->getHelper('question'); + + return new CommandTester($command); + } + + public function test_delete() + { + $command_tester = $this->get_command_tester(); + + $command_tester->setInputs(['yes', '']); + + $command_tester->execute(array( + 'command' => $this->command_name, + 'user_ids' => [3, 4], + '--delete-posts' => false, + )); + + $this->assertNull($this->get_user_id('Test')); + $this->assertNull($this->get_user_id('Test 2')); + $this->assertStringContainsString('CLI_USER_DELETE_IDS_SUCCESS', $command_tester->getDisplay()); + } + + public function test_delete_non_user() + { + $command_tester = $this->get_command_tester(); + + $command_tester->setInputs(['yes', '']); + + $command_tester->execute(array( + 'command' => $this->command_name, + 'user_ids' => [999], + '--delete-posts' => false, + )); + + $this->assertStringContainsString('CLI_USER_DELETE_NONE', $command_tester->getDisplay()); + } + + public function test_delete_cancel() + { + $command_tester = $this->get_command_tester(); + + $this->assertEquals(3, $this->get_user_id('Test')); + + $command_tester->setInputs(['no', '']); + + $command_tester->execute(array( + 'command' => $this->command_name, + 'user_ids' => [3, 4], + '--delete-posts' => false, + )); + + $this->assertNotNull($this->get_user_id('Test')); + $this->assertNotNull($this->get_user_id('Test 2')); + } +} From 09f0b417be6dd7ee67ed2481b7f1d0c3d016e67d Mon Sep 17 00:00:00 2001 From: Marc Alexander Date: Thu, 20 Jun 2024 22:38:24 +0200 Subject: [PATCH 3/8] [ticket/17347] Fix issues noticed in tests PHPBB-17347 --- phpBB/phpbb/console/command/user/delete_ids.php | 3 +++ 1 file changed, 3 insertions(+) diff --git a/phpBB/phpbb/console/command/user/delete_ids.php b/phpBB/phpbb/console/command/user/delete_ids.php index 3ecd43b314..ee5bfe8c6f 100644 --- a/phpBB/phpbb/console/command/user/delete_ids.php +++ b/phpBB/phpbb/console/command/user/delete_ids.php @@ -108,6 +108,8 @@ class delete_ids extends command if (count($user_ids) > 0) { + $this->user_loader->load_users($user_ids); + foreach ($user_ids as $user_id) { $user_row = $this->user_loader->get_user($user_id); @@ -126,6 +128,7 @@ class delete_ids extends command user_delete($mode, $user_row['user_id'], $user_row['username']); $this->log->add('admin', ANONYMOUS, '', 'LOG_USER_DELETED', false, array($user_row['username'])); + $deleted_users++; } if ($deleted_users > 0) From 8c77da9c308f2f9702a6a61998eec36be9928491 Mon Sep 17 00:00:00 2001 From: Marc Alexander Date: Fri, 21 Jun 2024 20:48:41 +0200 Subject: [PATCH 4/8] [ticket/17347] Add special handling for deletion of bots PHPBB-17347 --- .../default/container/services_console.yml | 8 ++- phpBB/language/en/cli.php | 2 + .../user/{delete_ids.php => delete_id.php} | 56 +++++++++++++++++-- ...delete_ids_test.php => delete_id_test.php} | 44 ++++++++++++++- tests/console/user/fixtures/config.xml | 26 +++++++++ 5 files changed, 128 insertions(+), 8 deletions(-) rename phpBB/phpbb/console/command/user/{delete_ids.php => delete_id.php} (73%) rename tests/console/user/{delete_ids_test.php => delete_id_test.php} (65%) diff --git a/phpBB/config/default/container/services_console.yml b/phpBB/config/default/container/services_console.yml index b7288e2ec7..8b9dcbc5f0 100644 --- a/phpBB/config/default/container/services_console.yml +++ b/phpBB/config/default/container/services_console.yml @@ -281,13 +281,17 @@ services: tags: - { name: console.command } - console.command.user.delete_ids: - class: phpbb\console\command\user\delete_ids + console.command.user.delete_id: + class: phpbb\console\command\user\delete_id arguments: + - '@dbal.conn' - '@language' - '@log' - '@user' - '@user_loader' + - '%tables.bots%' + - '%tables.user_group%' + - '%tables.users%' - '%core.root_path%' - '%core.php_ext%' tags: diff --git a/phpBB/language/en/cli.php b/phpBB/language/en/cli.php index e271380a2f..b2fdbebd3a 100644 --- a/phpBB/language/en/cli.php +++ b/phpBB/language/en/cli.php @@ -108,6 +108,8 @@ $lang = array_merge($lang, array( 'CLI_DESCRIPTION_USER_ADD_OPTION_NOTIFY' => 'Send account activation email to the new user (not sent by default)', 'CLI_DESCRIPTION_USER_DELETE' => 'Delete a user account.', 'CLI_DESCRIPTION_USER_DELETE_USERNAME' => 'Username of the user to delete', + 'CLI_DESCRIPTION_USER_DELETE_ID' => 'Delete user accounts by ID.', + 'CLI_DESCRIPTION_USER_DELETE_ID_OPTION_ID' => 'User IDs of the users 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.', diff --git a/phpBB/phpbb/console/command/user/delete_ids.php b/phpBB/phpbb/console/command/user/delete_id.php similarity index 73% rename from phpBB/phpbb/console/command/user/delete_ids.php rename to phpBB/phpbb/console/command/user/delete_id.php index ee5bfe8c6f..2dda64e7d7 100644 --- a/phpBB/phpbb/console/command/user/delete_ids.php +++ b/phpBB/phpbb/console/command/user/delete_id.php @@ -14,6 +14,7 @@ namespace phpbb\console\command\user; use phpbb\console\command\command; +use phpbb\db\driver\driver_interface; use phpbb\language\language; use phpbb\log\log_interface; use phpbb\user; @@ -25,8 +26,11 @@ use Symfony\Component\Console\Output\OutputInterface; use Symfony\Component\Console\Question\ConfirmationQuestion; use Symfony\Component\Console\Style\SymfonyStyle; -class delete_ids extends command +class delete_id extends command { + /** @var driver_interface */ + protected $db; + /** @var language */ protected $language; @@ -36,6 +40,15 @@ class delete_ids extends command /** @var user_loader */ protected $user_loader; + /** @var string Bots table */ + protected $bots_table; + + /** @var string User group table */ + protected $user_group_table; + + /** @var string Users table */ + protected $users_table; + /** @var string phpBB root path */ protected $phpbb_root_path; @@ -45,18 +58,27 @@ class delete_ids extends command /** * Construct method * + * @param driver_interface $db * @param language $language * @param log_interface $log * @param user $user * @param user_loader $user_loader + * @param string $bots_table + * @param string $user_group_table + * @param string $users_table * @param string $phpbb_root_path * @param string $php_ext */ - public function __construct(language $language, log_interface $log, user $user, user_loader $user_loader, string $phpbb_root_path, string $php_ext) + public function __construct(driver_interface $db, language $language, log_interface $log, user $user, user_loader $user_loader, + string $bots_table, string $user_group_table, string $users_table, string $phpbb_root_path, string $php_ext) { + $this->db = $db; $this->language = $language; $this->log = $log; $this->user_loader = $user_loader; + $this->bots_table = $bots_table; + $this->user_group_table = $user_group_table; + $this->users_table = $users_table; $this->phpbb_root_path = $phpbb_root_path; $this->php_ext = $php_ext; @@ -73,11 +95,11 @@ class delete_ids extends command { $this ->setName('user:delete_ids') - ->setDescription($this->language->lang('CLI_DESCRIPTION_USER_DELETE_IDS')) + ->setDescription($this->language->lang('CLI_DESCRIPTION_USER_DELETE_ID')) ->addArgument( 'user_ids', InputArgument::REQUIRED | InputArgument::IS_ARRAY, - $this->language->lang('CLI_DESCRIPTION_USER_DELETE_IDS_LIST') + $this->language->lang('CLI_DESCRIPTION_USER_DELETE_ID_OPTION_ID') ) ->addOption( 'delete-posts', @@ -119,6 +141,11 @@ class delete_ids extends command { continue; } + else if ($user_row['user_type'] == USER_IGNORE) + { + $this->delete_bot_user($user_row); + continue; + } if (!function_exists('user_delete')) { @@ -170,4 +197,25 @@ class delete_ids extends command } } } + + /** + * Deletes a bot user + * + * @param array $user_row + * @return void + */ + protected function delete_bot_user(array $user_row): void + { + $sql = 'DELETE FROM ' . $this->bots_table . ' + WHERE user_id = ' . (int) $user_row['user_id']; + $this->db->sql_query($sql); + + $delete_tables = [$this->user_group_table, $this->users_table]; + foreach ($delete_tables as $table) + { + $sql = "DELETE FROM $table + WHERE user_id = " . (int) $user_row['user_id']; + $this->db->sql_query($sql); + } + } } diff --git a/tests/console/user/delete_ids_test.php b/tests/console/user/delete_id_test.php similarity index 65% rename from tests/console/user/delete_ids_test.php rename to tests/console/user/delete_id_test.php index 0595271b6b..a579312552 100644 --- a/tests/console/user/delete_ids_test.php +++ b/tests/console/user/delete_id_test.php @@ -13,7 +13,7 @@ use Symfony\Component\Console\Application; use Symfony\Component\Console\Tester\CommandTester; -use phpbb\console\command\user\delete_ids; +use phpbb\console\command\user\delete_id; require_once __DIR__ . '/base.php'; @@ -22,11 +22,15 @@ class phpbb_console_user_delete_ids_test extends phpbb_console_user_base public function get_command_tester() { $application = new Application(); - $application->add(new delete_ids( + $application->add(new delete_id( + $this->db, $this->language, $this->log, $this->user, $this->user_loader, + BOTS_TABLE, + USER_GROUP_TABLE, + USERS_TABLE, $this->phpbb_root_path, $this->php_ext )); @@ -55,6 +59,42 @@ class phpbb_console_user_delete_ids_test extends phpbb_console_user_base $this->assertStringContainsString('CLI_USER_DELETE_IDS_SUCCESS', $command_tester->getDisplay()); } + public function test_delete_one() + { + $command_tester = $this->get_command_tester(); + + $command_tester->setInputs(['yes', '']); + + $command_tester->execute(array( + 'command' => $this->command_name, + 'user_ids' => [3], + '--delete-posts' => false, + )); + + $this->assertNull($this->get_user_id('Test')); + $this->assertNotNull($this->get_user_id('Test 2')); + $this->assertStringContainsString('CLI_USER_DELETE_IDS_SUCCESS', $command_tester->getDisplay()); + } + + public function test_delete_bot() + { + $command_tester = $this->get_command_tester(); + + $this->assertNotNull($this->get_user_id('Test Bot')); + + $command_tester->setInputs(['yes', '']); + + $command_tester->execute(array( + 'command' => $this->command_name, + 'user_ids' => [3, 6], + '--delete-posts' => false, + )); + + $this->assertNull($this->get_user_id('Test')); + $this->assertNull($this->get_user_id('Test Bot')); + $this->assertStringContainsString('CLI_USER_DELETE_IDS_SUCCESS', $command_tester->getDisplay()); + } + public function test_delete_non_user() { $command_tester = $this->get_command_tester(); diff --git a/tests/console/user/fixtures/config.xml b/tests/console/user/fixtures/config.xml index a988ba463f..eba2eba637 100644 --- a/tests/console/user/fixtures/config.xml +++ b/tests/console/user/fixtures/config.xml @@ -47,6 +47,14 @@ 0 + + 6 + + Test Bot + Test Bot + + 2 + group_id @@ -59,5 +67,23 @@ 3foobar + + 6 + BOTS + 3 + + +
+ + group_id + user_id + group_leader + user_pending + + 6 + 6 + 0 + 0 +
From db40145fd56e43238d1de58b7fada829b533d6c6 Mon Sep 17 00:00:00 2001 From: Marc Alexander Date: Fri, 21 Jun 2024 20:59:04 +0200 Subject: [PATCH 5/8] [ticket/17347] Use progress bar and test bot deletion only PHPBB-17347 --- phpBB/language/en/cli.php | 5 ++-- .../phpbb/console/command/user/delete_id.php | 28 +++++++++++++------ tests/console/user/delete_id_test.php | 2 +- 3 files changed, 23 insertions(+), 12 deletions(-) diff --git a/phpBB/language/en/cli.php b/phpBB/language/en/cli.php index b2fdbebd3a..b1cbe80f4d 100644 --- a/phpBB/language/en/cli.php +++ b/phpBB/language/en/cli.php @@ -159,8 +159,9 @@ $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_DELETE_IDS_CONFIRM' => 'Are you sure you want to delete the user IDs ‘%s’? [y/N]', - 'CLI_USER_DELETE_IDS_SUCCESS' => 'Successfully deleted user IDs.', + 'CLI_USER_DELETE_ID_CONFIRM' => 'Are you sure you want to delete the user IDs ‘%s’? [y/N]', + 'CLI_USER_DELETE_ID_SUCCESS' => 'Successfully deleted user IDs.', + 'CLI_USER_DELETE_ID_START' => 'Deleting users by ID', 'CLI_USER_DELETE_NONE' => 'No users were deleted by user ID.', 'CLI_USER_RECLEAN_START' => 'Re-cleaning usernames', 'CLI_USER_RECLEAN_DONE' => [ diff --git a/phpBB/phpbb/console/command/user/delete_id.php b/phpBB/phpbb/console/command/user/delete_id.php index 2dda64e7d7..dfb389aca1 100644 --- a/phpBB/phpbb/console/command/user/delete_id.php +++ b/phpBB/phpbb/console/command/user/delete_id.php @@ -132,6 +132,10 @@ class delete_id extends command { $this->user_loader->load_users($user_ids); + $progress = $this->create_progress_bar(count($user_ids), $io, $output); + $progress->setMessage($this->language->lang('CLI_USER_DELETE_ID_START')); + $progress->start(); + foreach ($user_ids as $user_id) { $user_row = $this->user_loader->get_user($user_id); @@ -139,28 +143,34 @@ class delete_id extends command // Skip anonymous user if ($user_row['user_id'] == ANONYMOUS) { + $progress->advance(); continue; } else if ($user_row['user_type'] == USER_IGNORE) { $this->delete_bot_user($user_row); - continue; } - - if (!function_exists('user_delete')) + else { - require($this->phpbb_root_path . 'includes/functions_user.' . $this->php_ext); + if (!function_exists('user_delete')) + { + require($this->phpbb_root_path . 'includes/functions_user.' . $this->php_ext); + } + + user_delete($mode, $user_row['user_id'], $user_row['username']); + + $this->log->add('admin', ANONYMOUS, '', 'LOG_USER_DELETED', false, array($user_row['username'])); } - user_delete($mode, $user_row['user_id'], $user_row['username']); - - $this->log->add('admin', ANONYMOUS, '', 'LOG_USER_DELETED', false, array($user_row['username'])); + $progress->advance(); $deleted_users++; } + $progress->finish(); + if ($deleted_users > 0) { - $io->success($this->language->lang('CLI_USER_DELETE_IDS_SUCCESS')); + $io->success($this->language->lang('CLI_USER_DELETE_ID_SUCCESS')); } } @@ -187,7 +197,7 @@ class delete_id extends command if (count($user_ids) > 0) { $question = new ConfirmationQuestion( - $this->language->lang('CLI_USER_DELETE_IDS_CONFIRM', implode(',', $user_ids)), + $this->language->lang('CLI_USER_DELETE_ID_CONFIRM', implode(',', $user_ids)), false ); diff --git a/tests/console/user/delete_id_test.php b/tests/console/user/delete_id_test.php index a579312552..293bb56b9d 100644 --- a/tests/console/user/delete_id_test.php +++ b/tests/console/user/delete_id_test.php @@ -86,7 +86,7 @@ class phpbb_console_user_delete_ids_test extends phpbb_console_user_base $command_tester->execute(array( 'command' => $this->command_name, - 'user_ids' => [3, 6], + 'user_ids' => [6], '--delete-posts' => false, )); From d875eaa40596d334318e92cfd1524565657c1613 Mon Sep 17 00:00:00 2001 From: Marc Alexander Date: Fri, 21 Jun 2024 21:12:09 +0200 Subject: [PATCH 6/8] [ticket/17347] Update tests for delete_id command PHPBB-17347 --- tests/console/user/delete_id_test.php | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/tests/console/user/delete_id_test.php b/tests/console/user/delete_id_test.php index 293bb56b9d..46db028eaf 100644 --- a/tests/console/user/delete_id_test.php +++ b/tests/console/user/delete_id_test.php @@ -56,7 +56,7 @@ class phpbb_console_user_delete_ids_test extends phpbb_console_user_base $this->assertNull($this->get_user_id('Test')); $this->assertNull($this->get_user_id('Test 2')); - $this->assertStringContainsString('CLI_USER_DELETE_IDS_SUCCESS', $command_tester->getDisplay()); + $this->assertStringContainsString('CLI_USER_DELETE_ID_SUCCESS', $command_tester->getDisplay()); } public function test_delete_one() @@ -73,7 +73,7 @@ class phpbb_console_user_delete_ids_test extends phpbb_console_user_base $this->assertNull($this->get_user_id('Test')); $this->assertNotNull($this->get_user_id('Test 2')); - $this->assertStringContainsString('CLI_USER_DELETE_IDS_SUCCESS', $command_tester->getDisplay()); + $this->assertStringContainsString('CLI_USER_DELETE_ID_SUCCESS', $command_tester->getDisplay()); } public function test_delete_bot() @@ -90,9 +90,8 @@ class phpbb_console_user_delete_ids_test extends phpbb_console_user_base '--delete-posts' => false, )); - $this->assertNull($this->get_user_id('Test')); $this->assertNull($this->get_user_id('Test Bot')); - $this->assertStringContainsString('CLI_USER_DELETE_IDS_SUCCESS', $command_tester->getDisplay()); + $this->assertStringContainsString('CLI_USER_DELETE_ID_SUCCESS', $command_tester->getDisplay()); } public function test_delete_non_user() From 7f9bcc2743e77aa02480b69a4f89fa4a3e31bfde Mon Sep 17 00:00:00 2001 From: Marc Alexander Date: Fri, 21 Jun 2024 21:12:38 +0200 Subject: [PATCH 7/8] [ticket/17347] Change command to be called user:delete_id PHPBB-17347 --- phpBB/phpbb/console/command/user/delete_id.php | 2 +- tests/console/user/delete_id_test.php | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/phpBB/phpbb/console/command/user/delete_id.php b/phpBB/phpbb/console/command/user/delete_id.php index dfb389aca1..f189fe72cc 100644 --- a/phpBB/phpbb/console/command/user/delete_id.php +++ b/phpBB/phpbb/console/command/user/delete_id.php @@ -94,7 +94,7 @@ class delete_id extends command protected function configure(): void { $this - ->setName('user:delete_ids') + ->setName('user:delete_id') ->setDescription($this->language->lang('CLI_DESCRIPTION_USER_DELETE_ID')) ->addArgument( 'user_ids', diff --git a/tests/console/user/delete_id_test.php b/tests/console/user/delete_id_test.php index 46db028eaf..fb5b60ba0e 100644 --- a/tests/console/user/delete_id_test.php +++ b/tests/console/user/delete_id_test.php @@ -35,7 +35,7 @@ class phpbb_console_user_delete_ids_test extends phpbb_console_user_base $this->php_ext )); - $command = $application->find('user:delete_ids'); + $command = $application->find('user:delete_id'); $this->command_name = $command->getName(); $this->question = $command->getHelper('question'); From fa893f092b1381ab85f3c70f7ed589a28b6d6b22 Mon Sep 17 00:00:00 2001 From: Marc Alexander Date: Sat, 22 Jun 2024 07:33:06 +0200 Subject: [PATCH 8/8] [ticket/17347] Get rid of not needed code duplication PHPBB-17347 --- phpBB/phpbb/console/command/user/delete_id.php | 6 +----- 1 file changed, 1 insertion(+), 5 deletions(-) diff --git a/phpBB/phpbb/console/command/user/delete_id.php b/phpBB/phpbb/console/command/user/delete_id.php index f189fe72cc..ac00138a17 100644 --- a/phpBB/phpbb/console/command/user/delete_id.php +++ b/phpBB/phpbb/console/command/user/delete_id.php @@ -216,11 +216,7 @@ class delete_id extends command */ protected function delete_bot_user(array $user_row): void { - $sql = 'DELETE FROM ' . $this->bots_table . ' - WHERE user_id = ' . (int) $user_row['user_id']; - $this->db->sql_query($sql); - - $delete_tables = [$this->user_group_table, $this->users_table]; + $delete_tables = [$this->bots_table, $this->user_group_table, $this->users_table]; foreach ($delete_tables as $table) { $sql = "DELETE FROM $table