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', []); + } + } + } +}