diff --git a/phpBB/config/default/container/services_console.yml b/phpBB/config/default/container/services_console.yml index 038aa360e4..6c85e22f9a 100644 --- a/phpBB/config/default/container/services_console.yml +++ b/phpBB/config/default/container/services_console.yml @@ -359,6 +359,22 @@ services: tags: - { name: console.command } + 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: + - { 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 7eb71d9e6d..b2e512fd72 100644 --- a/phpBB/language/en/cli.php +++ b/phpBB/language/en/cli.php @@ -112,6 +112,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.', @@ -171,10 +173,14 @@ $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_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' => [ 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_id.php b/phpBB/phpbb/console/command/user/delete_id.php new file mode 100644 index 0000000000..ac00138a17 --- /dev/null +++ b/phpBB/phpbb/console/command/user/delete_id.php @@ -0,0 +1,227 @@ + + * @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_id extends command +{ + /** @var driver_interface */ + protected $db; + + /** @var language */ + protected $language; + + /** @var log_interface */ + protected $log; + + /** @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; + + /** @var string PHP extension */ + protected $php_ext; + + /** + * 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(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; + + $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_id') + ->setDescription($this->language->lang('CLI_DESCRIPTION_USER_DELETE_ID')) + ->addArgument( + 'user_ids', + InputArgument::REQUIRED | InputArgument::IS_ARRAY, + $this->language->lang('CLI_DESCRIPTION_USER_DELETE_ID_OPTION_ID') + ) + ->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) + { + $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); + + // 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); + } + else + { + 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'])); + } + + $progress->advance(); + $deleted_users++; + } + + $progress->finish(); + + if ($deleted_users > 0) + { + $io->success($this->language->lang('CLI_USER_DELETE_ID_SUCCESS')); + } + } + + if (!$deleted_users) + { + $io->note($this->language->lang('CLI_USER_DELETE_NONE')); + } + + 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_ID_CONFIRM', implode(',', $user_ids)), + false + ); + + if (!$helper->ask($input, $output, $question)) + { + $input->setArgument('user_ids', []); + } + } + } + + /** + * Deletes a bot user + * + * @param array $user_row + * @return void + */ + protected function delete_bot_user(array $user_row): void + { + $delete_tables = [$this->bots_table, $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_id_test.php b/tests/console/user/delete_id_test.php new file mode 100644 index 0000000000..fb5b60ba0e --- /dev/null +++ b/tests/console/user/delete_id_test.php @@ -0,0 +1,129 @@ + +* @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_id; + +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_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 + )); + + $command = $application->find('user:delete_id'); + $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_ID_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_ID_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' => [6], + '--delete-posts' => false, + )); + + $this->assertNull($this->get_user_id('Test Bot')); + $this->assertStringContainsString('CLI_USER_DELETE_ID_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')); + } +} 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 +