Merge pull request #4199 from VSEphpbb/ticket/12684

[ticket/12684] Add console command user:add

* VSEphpbb/ticket/12684: (26 commits)
  [ticket/12684] Use a switch statement for readability
  [ticket/12684] Refactor a test
  [ticket/12684] Use interactive method correctly
  [ticket/12684] Extract interactivity to a method
  [ticket/12684] Update option help
  [ticket/12684] Add extended help for the user:add command
  [ticket/12684] Add shorthand alternates to the options
  [ticket/12684] Remove whitespace
  [ticket/12684] Add an error on user creation failure
  [ticket/12684] Remove unnecessary null arguments
  [ticket/12684] Additional clean up
  [ticket/12684] Allowed to use $this in enclosure
  [ticket/12684] Move all lang keys to cli
  [ticket/12684] Fix a few mistakes and clean it up
  [ticket/12684] Some code clean up
  [ticket/12684] Another little fix
  [ticket/12684] Fix tests
  [ticket/12684] Update to use non-deprecated methods
  [ticket/12684] Add send email option
  [ticket/12684] Add input validation
  ...

phpBB/config/default/container/services_console.yml

@@ -219,3 +219,16 @@ services:
             - '@user'
         tags:
             - { name: console.command }
+
+    console.command.user.add:
+        class: phpbb\console\command\user\add
+        arguments:
+            - '@user'
+            - '@dbal.conn'
+            - '@config'
+            - '@language'
+            - '@passwords.manager'
+            - '%core.root_path%'
+            - '%core.php_ext%'
+        tags:
+            - { name: console.command }

phpBB/language/en/cli.php

@@ -82,6 +82,12 @@ $lang = array_merge($lang, array(
 	'CLI_DESCRIPTION_THUMBNAIL_GENERATE'	=> 'Generate all missing thumbnails.',
 	'CLI_DESCRIPTION_THUMBNAIL_RECREATE'	=> 'Recreate all thumbnails.',
 
+	'CLI_DESCRIPTION_USER_ADD'					=> 'Add a new user.',
+	'CLI_DESCRIPTION_USER_ADD_OPTION_USERNAME'	=> 'Username of the new user',
+	'CLI_DESCRIPTION_USER_ADD_OPTION_PASSWORD'	=> 'Password of the new user',
+	'CLI_DESCRIPTION_USER_ADD_OPTION_EMAIL'		=> 'E-mail address of the new user',
+	'CLI_DESCRIPTION_USER_ADD_OPTION_NOTIFY'	=> 'Send account activation email to the new user (not sent by default)',
+
 	'CLI_EXTENSION_DISABLE_FAILURE'		=> 'Could not disable extension %s',
 	'CLI_EXTENSION_DISABLE_SUCCESS'		=> 'Successfully disabled extension %s',
 	'CLI_EXTENSION_ENABLE_FAILURE'		=> 'Could not enable extension %s',
@@ -118,9 +124,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.',
 ));
 
 // Additional help for commands.
 $lang = array_merge($lang, array(
 	'CLI_HELP_CRON_RUN'			=> $lang['CLI_DESCRIPTION_CRON_RUN'] . ' Optionally you can specify a cron task name to run only the specified cron task.',
+	'CLI_HELP_USER_ADD'			=> 'The <info>%command.name%</info> command adds a new user:
+If this command is run without options, you will be prompted to enter them.
+To optionally send an email to the new user, use the <info>--send-email</info> option.',
 ));

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

@@ -0,0 +1,328 @@
+<?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\exception\runtime_exception;
+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
+{
+	/** @var array Array of interactively acquired options */
+	protected $data;
+
+	/** @var \phpbb\db\driver\driver_interface */
+	protected $db;
+
+	/** @var \phpbb\config\config */
+	protected $config;
+
+	/** @var \phpbb\language\language */
+	protected $language;
+
+	/** @var \phpbb\passwords\manager */
+	protected $password_manager;
+
+	/**
+	 * phpBB root path
+	 *
+	 * @var string
+	 */
+	protected $phpbb_root_path;
+
+	/**
+	 * PHP extension.
+	 *
+	 * @var string
+	 */
+	protected $php_ext;
+
+	/**
+	 * 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
+	 */
+	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)
+	{
+		$this->db = $db;
+		$this->config = $config;
+		$this->language = $language;
+		$this->password_manager = $password_manager;
+		$this->phpbb_root_path = $phpbb_root_path;
+		$this->php_ext = $php_ext;
+
+		$this->language->add_lang('ucp');
+		parent::__construct($user);
+	}
+
+	/**
+	 * Sets the command name and description
+	 *
+	 * @return null
+	 */
+	protected function configure()
+	{
+		$this
+			->setName('user:add')
+			->setDescription($this->language->lang('CLI_DESCRIPTION_USER_ADD'))
+			->setHelp($this->language->lang('CLI_HELP_USER_ADD'))
+			->addOption(
+				'username',
+				'U',
+				InputOption::VALUE_REQUIRED,
+				$this->language->lang('CLI_DESCRIPTION_USER_ADD_OPTION_USERNAME')
+			)
+			->addOption(
+				'password',
+				'P',
+				InputOption::VALUE_REQUIRED,
+				$this->language->lang('CLI_DESCRIPTION_USER_ADD_OPTION_PASSWORD')
+			)
+			->addOption(
+				'email',
+				'E',
+				InputOption::VALUE_REQUIRED,
+				$this->language->lang('CLI_DESCRIPTION_USER_ADD_OPTION_EMAIL')
+			)
+			->addOption(
+				'send-email',
+				null,
+				InputOption::VALUE_NONE,
+				$this->language->lang('CLI_DESCRIPTION_USER_ADD_OPTION_NOTIFY')
+			)
+		;
+	}
+
+	/**
+	 * Executes the command user:add
+	 *
+	 * Adds a new user to the database. If options are not provided, it will ask for the username, password and email.
+	 * User is added to the registered user group. Language and timezone default to $config settings.
+	 *
+	 * @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);
+
+		try
+		{
+			$this->validate_user_data();
+			$group_id = $this->get_group_id();
+		}
+		catch (runtime_exception $e)
+		{
+			$io->error($e->getMessage());
+			return 1;
+		}
+
+		$user_row = array(
+			'username'      => $this->data['username'],
+			'user_password' => $this->password_manager->hash($this->data['new_password']),
+			'user_email'    => $this->data['email'],
+			'group_id'      => $group_id,
+			'user_timezone' => $this->config['board_timezone'],
+			'user_lang'     => $this->config['default_lang'],
+			'user_type'     => USER_NORMAL,
+			'user_regdate'  => time(),
+		);
+
+		$user_id = (int) user_add($user_row);
+
+		if (!$user_id)
+		{
+			$io->error($this->language->lang('AUTH_NO_PROFILE_CREATED'));
+			return 1;
+		}
+
+		if ($input->getOption('send-email') && $this->config['email_enable'])
+		{
+			$this->send_activation_email($user_id);
+		}
+
+		$io->success($this->language->lang('CLI_USER_ADD_SUCCESS', $this->data['username']));
+
+		return 0;
+	}
+
+	/**
+	 * Interacts with the user.
+	 *
+	 * @param InputInterface  $input  An InputInterface instance
+	 * @param OutputInterface $output An OutputInterface instance
+	 */
+	protected function interact(InputInterface $input, OutputInterface $output)
+	{
+		$helper = $this->getHelper('question');
+
+		$this->data = array(
+			'username'     => $input->getOption('username'),
+			'new_password' => $input->getOption('password'),
+			'email'        => $input->getOption('email'),
+		);
+
+		if (!$this->data['username'])
+		{
+			$question = new Question($this->ask_user('USERNAME'));
+			$this->data['username'] = $helper->ask($input, $output, $question);
+		}
+
+		if (!$this->data['new_password'])
+		{
+			$question = new Question($this->ask_user('PASSWORD'));
+			$question->setValidator(function ($value) use ($helper, $input, $output) {
+				$question = new Question($this->ask_user('CONFIRM_PASSWORD'));
+				$question->setHidden(true);
+				if ($helper->ask($input, $output, $question) != $value)
+				{
+					throw new runtime_exception($this->language->lang('NEW_PASSWORD_ERROR'));
+				}
+				return $value;
+			});
+			$question->setHidden(true);
+			$question->setMaxAttempts(5);
+
+			$this->data['new_password'] = $helper->ask($input, $output, $question);
+		}
+
+		if (!$this->data['email'])
+		{
+			$question = new Question($this->ask_user('EMAIL_ADDRESS'));
+			$this->data['email'] = $helper->ask($input, $output, $question);
+		}
+	}
+
+	/**
+	 * Validate the submitted user data
+	 *
+	 * @throws runtime_exception if any data fails validation
+	 * @return null
+	 */
+	protected function validate_user_data()
+	{
+		if (!function_exists('validate_data'))
+		{
+			require($this->phpbb_root_path . 'includes/functions_user.' . $this->php_ext);
+		}
+
+		$error = validate_data($this->data, array(
+			'username'     => array(
+				array('string', false, $this->config['min_name_chars'], $this->config['max_name_chars']),
+				array('username', '')),
+			'new_password' => array(
+				array('string', false, $this->config['min_pass_chars'], $this->config['max_pass_chars']),
+				array('password')),
+			'email'        => array(
+				array('string', false, 6, 60),
+				array('user_email')),
+		));
+
+		if ($error)
+		{
+			throw new runtime_exception(implode("\n", array_map(array($this->language, 'lang'), $error)));
+		}
+	}
+
+	/**
+	 * Get the group id
+	 *
+	 * Go and find in the database the group_id corresponding to 'REGISTERED'
+	 *
+	 * @throws runtime_exception if the group id does not exist in database.
+	 * @return null
+	 */
+	protected function get_group_id()
+	{
+		$sql = 'SELECT group_id
+			FROM ' . GROUPS_TABLE . "
+			WHERE group_name = '" . $this->db->sql_escape('REGISTERED') . "'
+				AND group_type = " . GROUP_SPECIAL;
+		$result = $this->db->sql_query($sql);
+		$row = $this->db->sql_fetchrow($result);
+		$this->db->sql_freeresult($result);
+
+		if (!$row || !$row['group_id'])
+		{
+			throw new runtime_exception($this->language->lang('NO_GROUP'));
+		}
+
+		return $row['group_id'];
+	}
+
+	/**
+	 * Send account activation email
+	 *
+	 * @param int   $user_id The new user's id
+	 * @return null
+	 */
+	protected function send_activation_email($user_id)
+	{
+		switch ($this->config['require_activation'])
+		{
+			case USER_ACTIVATION_SELF:
+				$email_template = 'user_welcome_inactive';
+				$user_actkey = gen_rand_string(mt_rand(6, 10));
+			break;
+			case USER_ACTIVATION_ADMIN:
+				$email_template = 'admin_welcome_inactive';
+				$user_actkey = gen_rand_string(mt_rand(6, 10));
+			break;
+			default:
+				$email_template = 'user_welcome';
+				$user_actkey = '';
+			break;
+		}
+
+		if (!class_exists('messenger'))
+		{
+			require($this->phpbb_root_path . 'includes/functions_messenger.' . $this->php_ext);
+		}
+
+		$messenger = new \messenger(false);
+		$messenger->template($email_template, $this->user->lang_name);
+		$messenger->to($this->data['email'], $this->data['username']);
+		$messenger->anti_abuse_headers($this->config, $this->user);
+		$messenger->assign_vars(array(
+			'WELCOME_MSG' => htmlspecialchars_decode($this->language->lang('WELCOME_SUBJECT', $this->config['sitename'])),
+			'USERNAME'    => htmlspecialchars_decode($this->data['username']),
+			'PASSWORD'    => htmlspecialchars_decode($this->data['new_password']),
+			'U_ACTIVATE'  => generate_board_url() . "/ucp.{$this->php_ext}?mode=activate&u=$user_id&k=$user_actkey")
+		);
+
+		$messenger->send(NOTIFY_EMAIL);
+	}
+
+	/**
+	 * Helper to translate questions to the user
+	 *
+	 * @param string $key The language key
+	 * @return string The language key translated with a colon and space appended
+	 */
+	protected function ask_user($key)
+	{
+		return $this->language->lang($key) . $this->language->lang('COLON') . ' ';
+	}
+}

tests/console/user/add_test.php

@@ -0,0 +1,185 @@
+<?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\add;
+
+require_once dirname(__FILE__) . '/../../../phpBB/includes/functions_user.php';
+require_once dirname(__FILE__) . '/../../../phpBB/includes/functions.php';
+require_once dirname(__FILE__) . '/../../../phpBB/includes/utf/utf_tools.php';
+
+class phpbb_console_command_user_add_test extends phpbb_database_test_case
+{
+	protected $db;
+	protected $config;
+	protected $user;
+	protected $language;
+	protected $passwords_manager;
+	protected $command_name;
+	protected $question;
+	protected $phpbb_root_path;
+	protected $php_ext;
+
+	public function getDataSet()
+	{
+		return $this->createXMLDataSet(dirname(__FILE__) . '/fixtures/config.xml');
+	}
+
+	public function setUp()
+	{
+		global $db, $cache, $config, $user, $phpbb_dispatcher, $phpbb_container, $phpbb_root_path, $phpEx;
+
+		$phpbb_dispatcher = new phpbb_mock_event_dispatcher();
+		$phpbb_container = new phpbb_mock_container_builder();
+		$phpbb_container->set('cache.driver', new phpbb_mock_cache());
+		$phpbb_container->set('notification_manager', new phpbb_mock_notification_manager());
+
+		$cache = $phpbb_container->get('cache.driver');
+
+		$config = $this->config = new \phpbb\config\config(array(
+			'board_timezone'	=> 'UTC',
+			'default_lang'		=> 'en',
+			'email_enable'		=> false,
+			'min_name_chars'	=> 3,
+			'max_name_chars'	=> 10,
+			'min_pass_chars'	=> 3,
+			'max_pass_chars'	=> 10,
+			'pass_complex'		=> 'PASS_TYPE_ANY',
+		));
+
+		$db = $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));
+		$user = $this->user = $this->getMock('\phpbb\user', array(), array(
+			$this->language,
+			'\phpbb\datetime'
+		));
+
+		$driver_helper = new \phpbb\passwords\driver\helper($this->config);
+		$passwords_drivers = array(
+			'passwords.driver.bcrypt_2y'	=> new \phpbb\passwords\driver\bcrypt_2y($this->config, $driver_helper),
+			'passwords.driver.bcrypt'		=> new \phpbb\passwords\driver\bcrypt($this->config, $driver_helper),
+			'passwords.driver.salted_md5'	=> new \phpbb\passwords\driver\salted_md5($this->config, $driver_helper),
+			'passwords.driver.phpass'		=> new \phpbb\passwords\driver\phpass($this->config, $driver_helper),
+		);
+
+		$passwords_helper = new \phpbb\passwords\helper;
+		$this->passwords_manager = new \phpbb\passwords\manager($this->config, $passwords_drivers, $passwords_helper, array_keys($passwords_drivers));
+
+		$this->phpbb_root_path = $phpbb_root_path;
+		$this->php_ext = $phpEx;
+
+		parent::setUp();
+	}
+
+	public function test_add_no_dialog()
+	{
+		$command_tester = $this->get_command_tester();
+
+		$this->assertEquals(2, $this->get_user_id('Admin'));
+
+		$command_tester->execute(array(
+			'command'		=> $this->command_name,
+			'--username'	=> 'foo',
+			'--password'	=> 'bar',
+			'--email'		=> 'foo@test.com'
+		));
+
+		$this->assertNotEquals(null, $this->get_user_id('foo'));
+		$this->assertContains('CLI_USER_ADD_SUCCESS', $command_tester->getDisplay());
+	}
+
+	public function test_add_dialog()
+	{
+		$command_tester = $this->get_command_tester();
+
+		$this->assertEquals(2, $this->get_user_id('Admin'));
+
+		$this->question->setInputStream($this->getInputStream("bar\npassword\npassword\nbar@test.com\n"));
+
+		$command_tester->execute(array(
+			'command'		=> $this->command_name,
+		));
+
+		$this->assertNotEquals(null, $this->get_user_id('bar'));
+		$this->assertContains('CLI_USER_ADD_SUCCESS', $command_tester->getDisplay());
+
+	}
+
+	public function test_add_no_dialog_invalid()
+	{
+		$command_tester = $this->get_command_tester();
+
+		$this->assertEquals(3, $this->get_user_id('Test'));
+
+		$command_tester->execute(array(
+			'command'		=> $this->command_name,
+			'--username'	=> 'Test',
+			'--password'	=> '1',
+			'--email'		=> 'foo'
+		));
+
+		$this->assertContains('USERNAME_TAKEN', $command_tester->getDisplay());
+		$this->assertContains('TOO_SHORT', $command_tester->getDisplay());
+		$this->assertContains('EMAIL_INVALID', $command_tester->getDisplay());
+	}
+
+	public function get_command_tester()
+	{
+		$application = new Application();
+		$application->add(new add(
+			$this->user,
+			$this->db,
+			$this->config,
+			$this->language,
+			$this->passwords_manager,
+			$this->phpbb_root_path,
+			$this->php_ext
+		));
+
+		$command = $application->find('user:add');
+		$this->command_name = $command->getName();
+		$this->question = $command->getHelper('question');
+		return new CommandTester($command);
+	}
+
+	public function get_user_id($username)
+	{
+		$sql = 'SELECT user_id
+			FROM ' . USERS_TABLE . '
+			WHERE ' . 'username = ' . "'" . $username . "'";
+
+		$result = $this->db->sql_query($sql);
+
+		$row = $this->db->sql_fetchrow($result);
+
+		$this->db->sql_freeresult($result);
+
+		return $row['user_id'];
+	}
+
+	public function getInputStream($input)
+	{
+		$stream = fopen('php://memory', 'r+', false);
+		fputs($stream, $input);
+		rewind($stream);
+
+		return $stream;
+	}
+}

tests/console/user/fixtures/config.xml

@@ -0,0 +1,43 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<dataset>
+	<table name="phpbb_users">
+		<column>user_id</column>
+		<column>user_permissions</column>
+		<column>username</column>
+		<column>username_clean</column>
+		<column>user_sig</column>
+		<row>
+			<value>1</value>
+			<value></value>
+			<value>Guest</value>
+			<value>guest</value>
+			<value></value>
+		</row>
+		<row>
+			<value>2</value>
+			<value></value>
+			<value>Admin</value>
+			<value>admin</value>
+			<value></value>
+		</row>
+		<row>
+			<value>3</value>
+			<value></value>
+			<value>Test</value>
+			<value>test</value>
+			<value></value>
+		</row>
+	</table>
+	<table name="phpbb_groups">
+		<column>group_id</column>
+		<column>group_name</column>
+		<column>group_type</column>
+		<column>group_desc</column>
+		<row>
+			<value>1</value>
+			<value>REGISTERED</value>
+			<value>3</value>
+			<value>foobar</value>
+		</row>
+	</table>
+</dataset>