diff options
Diffstat (limited to 'phpBB/phpbb/console/command')
| -rw-r--r-- | phpBB/phpbb/console/command/user/activate.php | 218 | ||||
| -rw-r--r-- | phpBB/phpbb/console/command/user/add.php | 32 | ||||
| -rw-r--r-- | phpBB/phpbb/console/command/user/delete.php | 170 | ||||
| -rw-r--r-- | phpBB/phpbb/console/command/user/reclean.php | 198 | 
4 files changed, 605 insertions, 13 deletions
| diff --git a/phpBB/phpbb/console/command/user/activate.php b/phpBB/phpbb/console/command/user/activate.php new file mode 100644 index 0000000000..9c85718b4c --- /dev/null +++ b/phpBB/phpbb/console/command/user/activate.php @@ -0,0 +1,218 @@ +<?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 phpbb\config\config; +use phpbb\console\command\command; +use phpbb\db\driver\driver_interface; +use phpbb\language\language; +use phpbb\log\log_interface; +use phpbb\notification\manager; +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\Style\SymfonyStyle; + +class activate extends command +{ +	/** @var driver_interface */ +	protected $db; + +	/** @var config */ +	protected $config; + +	/** @var language */ +	protected $language; + +	/** @var log_interface */ +	protected $log; + +	/** @var manager */ +	protected $notifications; + +	/** @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 user             $user +	 * @param driver_interface $db +	 * @param config           $config +	 * @param language         $language +	 * @param log_interface    $log +	 * @param manager          $notifications +	 * @param user_loader      $user_loader +	 * @param string           $phpbb_root_path +	 * @param string           $php_ext +	 */ +	public function __construct(user $user, driver_interface $db, config $config, language $language, log_interface $log, manager $notifications, user_loader $user_loader, $phpbb_root_path, $php_ext) +	{ +		$this->db = $db; +		$this->config = $config; +		$this->language = $language; +		$this->log = $log; +		$this->notifications = $notifications; +		$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 null +	 */ +	protected function configure() +	{ +		$this +			->setName('user:activate') +			->setDescription($this->language->lang('CLI_DESCRIPTION_USER_ACTIVATE')) +			->setHelp($this->language->lang('CLI_HELP_USER_ACTIVATE')) +			->addArgument( +				'username', +				InputArgument::REQUIRED, +				$this->language->lang('CLI_DESCRIPTION_USER_ACTIVATE_USERNAME') +			) +			->addOption( +				'deactivate', +				'd', +				InputOption::VALUE_NONE, +				$this->language->lang('CLI_DESCRIPTION_USER_ACTIVATE_DEACTIVATE') +			) +			->addOption( +				'send-email', +				null, +				InputOption::VALUE_NONE, +				$this->language->lang('CLI_DESCRIPTION_USER_ADD_OPTION_NOTIFY') +			) +		; +	} + +	/** +	 * Executes the command user:activate +	 * +	 * Activate (or deactivate) a user account +	 * +	 * @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) +	{ +		$io = new SymfonyStyle($input, $output); + +		$name = $input->getArgument('username'); +		$mode = ($input->getOption('deactivate')) ? 'deactivate' : 'activate'; + +		$user_id  = $this->user_loader->load_user_by_username($name); +		$user_row = $this->user_loader->get_user($user_id); + +		if ($user_row['user_id'] == ANONYMOUS) +		{ +			$io->error($this->language->lang('NO_USER')); +			return 1; +		} + +		// Check if the user is already active (or inactive) +		if ($mode == 'activate' && $user_row['user_type'] != USER_INACTIVE) +		{ +			$io->error($this->language->lang('CLI_DESCRIPTION_USER_ACTIVATE_ACTIVE')); +			return 1; +		} +		else if ($mode == 'deactivate' && $user_row['user_type'] == USER_INACTIVE) +		{ +			$io->error($this->language->lang('CLI_DESCRIPTION_USER_ACTIVATE_INACTIVE')); +			return 1; +		} + +		// Activate the user account +		if (!function_exists('user_active_flip')) +		{ +			require($this->phpbb_root_path . 'includes/functions_user.' . $this->php_ext); +		} + +		user_active_flip($mode, $user_row['user_id']); + +		// Notify the user upon activation +		if ($mode == 'activate' && $this->config['require_activation'] == USER_ACTIVATION_ADMIN) +		{ +			$this->send_notification($user_row, $input); +		} + +		// Log and display the result +		$msg = ($mode == 'activate') ? 'USER_ADMIN_ACTIVATED' : 'USER_ADMIN_DEACTIVED'; +		$log = ($mode == 'activate') ? 'LOG_USER_ACTIVE' : 'LOG_USER_INACTIVE'; + +		$this->log->add('admin', ANONYMOUS, '', $log, false, array($user_row['username'])); +		$this->log->add('user', ANONYMOUS, '', $log . '_USER', false, array( +			'reportee_id' => $user_row['user_id'] +		)); + +		$io->success($this->language->lang($msg)); + +		return 0; +	} + +	/** +	 * Send account activation notification to user +	 * +	 * @param array           $user_row The user data array +	 * @param InputInterface  $input    The input stream used to get the options +	 * @return null +	 */ +	protected function send_notification($user_row, InputInterface $input) +	{ +		$this->notifications->delete_notifications('notification.type.admin_activate_user', $user_row['user_id']); + +		if ($input->getOption('send-email')) +		{ +			if (!class_exists('messenger')) +			{ +				require($this->phpbb_root_path . 'includes/functions_messenger.' . $this->php_ext); +			} + +			$messenger = new \messenger(false); +			$messenger->template('admin_welcome_activated', $user_row['user_lang']); +			$messenger->set_addresses($user_row); +			$messenger->anti_abuse_headers($this->config, $this->user); +			$messenger->assign_vars(array( +					'USERNAME'	=> htmlspecialchars_decode($user_row['username'])) +			); + +			$messenger->send(NOTIFY_EMAIL); +		} +	} +} diff --git a/phpBB/phpbb/console/command/user/add.php b/phpBB/phpbb/console/command/user/add.php index df1f4aa54a..c60a059251 100644 --- a/phpBB/phpbb/console/command/user/add.php +++ b/phpBB/phpbb/console/command/user/add.php @@ -13,28 +13,34 @@  namespace phpbb\console\command\user; +use phpbb\config\config; +use phpbb\console\command\command; +use phpbb\db\driver\driver_interface;  use phpbb\exception\runtime_exception; +use phpbb\language\language; +use phpbb\passwords\manager; +use phpbb\user;  use Symfony\Component\Console\Input\InputInterface;  use Symfony\Component\Console\Input\InputOption;  use Symfony\Component\Console\Output\OutputInterface;  use Symfony\Component\Console\Question\Question;  use Symfony\Component\Console\Style\SymfonyStyle; -class add extends \phpbb\console\command\command +class add extends command  {  	/** @var array Array of interactively acquired options */  	protected $data; -	/** @var \phpbb\db\driver\driver_interface */ +	/** @var driver_interface */  	protected $db; -	/** @var \phpbb\config\config */ +	/** @var config */  	protected $config; -	/** @var \phpbb\language\language */ +	/** @var language */  	protected $language; -	/** @var \phpbb\passwords\manager */ +	/** @var manager */  	protected $password_manager;  	/** @@ -54,15 +60,15 @@ class add extends \phpbb\console\command\command  	/**  	 * Construct method  	 * -	 * @param \phpbb\user                       $user -	 * @param \phpbb\db\driver\driver_interface $db -	 * @param \phpbb\config\config              $config -	 * @param \phpbb\language\language          $language -	 * @param \phpbb\passwords\manager          $password_manager -	 * @param string                            $phpbb_root_path -	 * @param string                            $php_ext +	 * @param user             $user +	 * @param driver_interface $db +	 * @param config           $config +	 * @param language         $language +	 * @param manager          $password_manager +	 * @param string           $phpbb_root_path +	 * @param string           $php_ext  	 */ -	public function __construct(\phpbb\user $user, \phpbb\db\driver\driver_interface $db, \phpbb\config\config $config, \phpbb\language\language $language, \phpbb\passwords\manager $password_manager, $phpbb_root_path, $php_ext) +	public function __construct(user $user, driver_interface $db, config $config, language $language, manager $password_manager, $phpbb_root_path, $php_ext)  	{  		$this->db = $db;  		$this->config = $config; diff --git a/phpBB/phpbb/console/command/user/delete.php b/phpBB/phpbb/console/command/user/delete.php new file mode 100644 index 0000000000..8593541c1a --- /dev/null +++ b/phpBB/phpbb/console/command/user/delete.php @@ -0,0 +1,170 @@ +<?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 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 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 user             $user +	 * @param driver_interface $db +	 * @param language         $language +	 * @param log_interface    $log +	 * @param user_loader      $user_loader +	 * @param string           $phpbb_root_path +	 * @param string           $php_ext +	 */ +	public function __construct(user $user, driver_interface $db, language $language, log_interface $log, user_loader $user_loader, $phpbb_root_path, $php_ext) +	{ +		$this->db = $db; +		$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 null +	 */ +	protected function configure() +	{ +		$this +			->setName('user:delete') +			->setDescription($this->language->lang('CLI_DESCRIPTION_USER_DELETE')) +			->addArgument( +				'username', +				InputArgument::REQUIRED, +				$this->language->lang('CLI_DESCRIPTION_USER_DELETE_USERNAME') +			) +			->addOption( +				'delete-posts', +				null, +				InputOption::VALUE_NONE, +				$this->language->lang('CLI_DESCRIPTION_USER_DELETE_OPTION_POSTS') +			) +		; +	} + +	/** +	 * Executes the command user:delete +	 * +	 * Deletes a user from the database. An option to delete the user's 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) +	{ +		$name = $input->getArgument('username'); +		$mode = ($input->getOption('delete-posts')) ? 'remove' : 'retain'; + +		if ($name) +		{ +			$io = new SymfonyStyle($input, $output); + +			$user_id  = $this->user_loader->load_user_by_username($name); +			$user_row = $this->user_loader->get_user($user_id); + +			if ($user_row['user_id'] == ANONYMOUS) +			{ +				$io->error($this->language->lang('NO_USER')); +				return 1; +			} + +			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'])); + +			$io->success($this->language->lang('USER_DELETED')); +		} + +		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) +	{ +		$helper = $this->getHelper('question'); + +		$question = new ConfirmationQuestion( +			$this->language->lang('CLI_USER_DELETE_CONFIRM', $input->getArgument('username')), +			false +		); + +		if (!$helper->ask($input, $output, $question)) +		{ +			$input->setArgument('username', false); +		} +	} +} diff --git a/phpBB/phpbb/console/command/user/reclean.php b/phpBB/phpbb/console/command/user/reclean.php new file mode 100644 index 0000000000..e298c285be --- /dev/null +++ b/phpBB/phpbb/console/command/user/reclean.php @@ -0,0 +1,198 @@ +<?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 phpbb\console\command\command; +use phpbb\db\driver\driver_interface; +use phpbb\language\language; +use phpbb\user; +use Symfony\Component\Console\Helper\ProgressBar; +use Symfony\Component\Console\Input\InputInterface; +use Symfony\Component\Console\Output\OutputInterface; +use Symfony\Component\Console\Style\SymfonyStyle; + +class reclean extends command +{ +	/** @var driver_interface */ +	protected $db; + +	/** @var language */ +	protected $language; + +	/** @var int A count of the number of re-cleaned user names */ +	protected $processed; + +	/** @var ProgressBar */ +	protected $progress; + +	/** +	 * Construct method +	 * +	 * @param user             $user +	 * @param driver_interface $db +	 * @param language         $language +	 */ +	public function __construct(user $user, driver_interface $db, 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')) +			->setHelp($this->language->lang('CLI_HELP_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) +	{ +		$io = new SymfonyStyle($input, $output); + +		$io->section($this->language->lang('CLI_USER_RECLEAN_START')); + +		$this->processed = 0; + +		$this->progress = $this->create_progress_bar($this->get_count(), $io, $output); +		$this->progress->setMessage($this->language->lang('CLI_USER_RECLEAN_START')); +		$this->progress->start(); + +		$stage = 0; +		while ($stage !== true) +		{ +			$stage = $this->reclean_usernames($stage); +		} + +		$this->progress->finish(); + +		$io->newLine(2); +		$io->success($this->language->lang('CLI_USER_RECLEAN_DONE', $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->progress->advance(); +		} +		$this->db->sql_freeresult($result); + +		$this->db->sql_transaction('commit'); + +		return ($i < $limit) ? true : $start + $i; +	} + +	/** +	 * Create a styled progress bar +	 * +	 * @param integer         $max    Max value for the progress bar +	 * @param SymfonyStyle    $io +	 * @param OutputInterface $output The output stream, used to print messages +	 * @return ProgressBar +	 */ +	protected function create_progress_bar($max, SymfonyStyle $io, OutputInterface $output) +	{ +		$progress = $io->createProgressBar($max); +		if ($output->getVerbosity() === OutputInterface::VERBOSITY_VERBOSE) +		{ +			$progress->setFormat('<info>[%percent:3s%%]</info> %message%'); +			$progress->setOverwrite(false); +		} +		else if ($output->getVerbosity() >= OutputInterface::VERBOSITY_VERY_VERBOSE) +		{ +			$progress->setFormat('<info>[%current:s%/%max:s%]</info><comment>[%elapsed%/%estimated%][%memory%]</comment> %message%'); +			$progress->setOverwrite(false); +		} +		else +		{ +			$io->newLine(2); +			$progress->setFormat( +				"    %current:s%/%max:s% %bar%  %percent:3s%%\n" . +				"                         %elapsed:6s%/%estimated:-6s% %memory:6s%\n"); +			$progress->setBarWidth(60); +		} + +		if (!defined('PHP_WINDOWS_VERSION_BUILD')) +		{ +			$progress->setEmptyBarCharacter('░'); // light shade character \u2591 +			$progress->setProgressCharacter(''); +			$progress->setBarCharacter('▓'); // dark shade character \u2593 +		} + +		return $progress; +	} + +	/** +	 * Get the count of users in the database +	 * +	 * @return int +	 */ +	protected function get_count() +	{ +		$sql = 'SELECT COUNT(user_id) AS count FROM ' . USERS_TABLE; +		$result = $this->db->sql_query($sql); +		$count = (int) $this->db->sql_fetchfield('count'); +		$this->db->sql_freeresult($result); + +		return $count; +	} +} | 
