namespace Friendica\Console;
+use Console_Table;
use Friendica\App;
+use Friendica\Content\Pager;
use Friendica\Core\L10n;
use Friendica\Database\Database;
+use Friendica\Model\Register;
use Friendica\Model\User as UserModel;
+use Friendica\Util\Temporal;
use RuntimeException;
+use Seld\CliPrompt\CliPrompt;
/**
- * tool to set a new password for a user
- *
- * With this tool, you can set a new password for a user
+ * tool to manage users of the current node
*/
class User extends \Asika\SimpleConsole\Console
{
$help = <<<HELP
console user - Modify user settings per console commands.
Usage
- bin/console user <nickname> password [<password>] [-h|--help|-?] [-v]
+ bin/console user password <nickname> [<password>] [-h|--help|-?] [-v]
+ bin/console user add [<name> [<nickname> [<email> [<language>]]]] [-h|--help|-?] [-v]
+ bin/console user delete [<nickname>] [-q] [-h|--help|-?] [-v]
+ bin/console user allow [<nickname>] [-h|--help|-?] [-v]
+ bin/console user deny [<nickname>] [-h|--help|-?] [-v]
+ bin/console user block [<nickname>] [-h|--help|-?] [-v]
+ bin/console user unblock [<nickname>] [-h|--help|-?] [-v]
+ bin/console user list pending [-s|--start=0] [-c|--count=50] [-h|--help|-?] [-v]
+ bin/console user list removed [-s|--start=0] [-c|--count=50] [-h|--help|-?] [-v]
+ bin/console user list active [-s|--start=0] [-c|--count=50] [-h|--help|-?] [-v]
+ bin/console user list all [-s|--start=0] [-c|--count=50] [-h|--help|-?] [-v]
+ bin/console user search id <UID> [-h|--help|-?] [-v]
+ bin/console user search nick <nick> [-h|--help|-?] [-v]
+ bin/console user search mail <mail> [-h|--help|-?] [-v]
+ bin/console user search guid <GUID> [-h|--help|-?] [-v]
Description
Modify user settings per console commands.
Options
-h|--help|-? Show help information
-v Show more debug information.
+ -q Quiet mode (don't ask for a command).
HELP;
return $help;
}
{
parent::__construct($argv);
- $this->appMode = $appMode;
- $this->l10n = $l10n;
- $this->dba = $dba;
+ $this->appMode = $appMode;
+ $this->l10n = $l10n;
+ $this->dba = $dba;
}
protected function doExecute()
return 0;
}
- if (count($this->args) < 2) {
- throw new \Asika\SimpleConsole\CommandArgsException('Not enough arguments.');
- }
-
if ($this->appMode->isInstall()) {
throw new RuntimeException('Database isn\'t ready or populated yet');
}
- $nick = $this->getArgument(0);
-
- $user = $this->dba->selectFirst('user', ['uid'], ['nickname' => $nick]);
- if (!$this->dba->isResult($user)) {
- throw new RuntimeException($this->l10n->t('User not found'));
- }
-
- $command = $this->getArgument(1);
+ $command = $this->getArgument(0);
switch ($command) {
case 'password':
- return $this->setPassword($user);
+ return $this->password();
+ case 'add':
+ return $this->addUser();
+ case 'allow':
+ return $this->pendingUser(true);
+ case 'deny':
+ return $this->pendingUser(false);
+ case 'block':
+ return $this->blockUser(true);
+ case 'unblock':
+ return $this->blockUser(false);
+ case 'delete':
+ return $this->deleteUser();
+ case 'list':
+ return $this->listUser();
+ case 'search':
+ return $this->searchUser();
default:
throw new \Asika\SimpleConsole\CommandArgsException('Wrong command.');
}
/**
* Sets a new password
*
- * @param array $user The user
- *
* @return int Return code of this command
+ *
+ * @throws \Exception
*/
- private function setPassword(array $user)
+ private function password()
{
+ $nick = $this->getArgument(1);
+
+ $user = $this->dba->selectFirst('user', ['uid'], ['nickname' => $nick]);
+ if (!$this->dba->isResult($user)) {
+ throw new RuntimeException($this->l10n->t('User not found'));
+ }
+
$password = $this->getArgument(2);
if (is_null($password)) {
$this->out($this->l10n->t('Enter new password: '), false);
- $password = \Seld\CliPrompt\CliPrompt::hiddenPrompt(true);
+ $password = CliPrompt::hiddenPrompt(true);
}
try {
return 0;
}
+
+ /**
+ * Adds a new user based on given console arguments
+ *
+ * @return bool True, if the command was successful
+ * @throws \ErrorException
+ * @throws \Friendica\Network\HTTPException\InternalServerErrorException
+ * @throws \ImagickException
+ */
+ private function addUser()
+ {
+ $name = $this->getArgument(1);
+ $nick = $this->getArgument(2);
+ $email = $this->getArgument(3);
+ $lang = $this->getArgument(4);
+
+ if (empty($name)) {
+ $this->out($this->l10n->t('Enter user name: '));
+ $name = CliPrompt::prompt();
+ if (empty($name)) {
+ throw new RuntimeException('A name must be set.');
+ }
+ }
+
+ if (empty($nick)) {
+ $this->out($this->l10n->t('Enter user nickname: '));
+ $nick = CliPrompt::prompt();
+ if (empty($nick)) {
+ throw new RuntimeException('A nick name must be set.');
+ }
+ }
+
+ if (empty($email)) {
+ $this->out($this->l10n->t('Enter user email address: '));
+ $email = CliPrompt::prompt();
+ if (empty($email)) {
+ throw new RuntimeException('A email address must be set.');
+ }
+ }
+
+ if (empty($lang)) {
+ $this->out($this->l10n->t('Enter a language (optional): '));
+ $lang = CliPrompt::prompt();
+ }
+
+ if (empty($lang)) {
+ return UserModel::createMinimal($name, $email, $nick);
+ } else {
+ return UserModel::createMinimal($name, $email, $nick, $lang);
+ }
+ }
+
+ /**
+ * Allows or denys a user based on it's nickname
+ *
+ * @param bool $allow True, if the pending user is allowed, false if denies
+ *
+ * @return bool True, if allow was successful
+ * @throws \Friendica\Network\HTTPException\InternalServerErrorException
+ */
+ private function pendingUser(bool $allow = true)
+ {
+ $nick = $this->getArgument(1);
+
+ if (!$nick) {
+ $this->out($this->l10n->t('Enter user nickname: '));
+ $nick = CliPrompt::prompt();
+ if (empty($nick)) {
+ throw new RuntimeException('A nick name must be set.');
+ }
+ }
+
+ $user = $this->dba->selectFirst('user', ['uid'], ['nickname' => $nick]);
+ if (empty($user)) {
+ throw new RuntimeException($this->l10n->t('User not found'));
+ }
+
+ $pending = Register::getPendingForUser($user['uid'] ?? 0);
+ if (empty($pending)) {
+ throw new RuntimeException($this->l10n->t('User is not pending.'));
+ }
+
+ return ($allow) ? UserModel::allow($pending['hash']) : UserModel::deny($pending['hash']);
+ }
+
+ /**
+ * Blocks/unblocks a user
+ *
+ * @param bool $block True, if the given user should get blocked
+ *
+ * @return bool True, if the command was successful
+ * @throws \Exception
+ */
+ private function blockUser(bool $block = true)
+ {
+ $nick = $this->getArgument(1);
+
+ if (!$nick) {
+ $this->out($this->l10n->t('Enter user nickname: '));
+ $nick = CliPrompt::prompt();
+ if (empty($nick)) {
+ throw new RuntimeException('A nick name must be set.');
+ }
+ }
+
+ $user = $this->dba->selectFirst('user', ['uid'], ['nickname' => $nick]);
+ if (empty($user)) {
+ throw new RuntimeException($this->l10n->t('User not found'));
+ }
+
+ return $block ? UserModel::block($user['uid'] ?? 0) : UserModel::block($user['uid'] ?? 0, false);
+ }
+
+ /**
+ * Deletes a user
+ *
+ * @return bool True, if the delete was successful
+ * @throws \Exception
+ */
+ private function deleteUser()
+ {
+ $nick = $this->getArgument(1);
+
+ if (!$nick) {
+ $this->out($this->l10n->t('Enter user nickname: '));
+ $nick = CliPrompt::prompt();
+ if (empty($nick)) {
+ throw new RuntimeException('A nick name must be set.');
+ }
+ }
+
+ $user = $this->dba->selectFirst('user', ['uid', 'account_removed'], ['nickname' => $nick]);
+ if (empty($user)) {
+ throw new RuntimeException($this->l10n->t('User not found'));
+ }
+
+ if (!empty($user['account_removed'])) {
+ $this->out($this->l10n->t('User has already been marked for deletion.'));
+ return true;
+ }
+
+ if (!$this->getOption('q')) {
+ $this->out($this->l10n->t('Type "yes" to delete %s', $nick));
+ if (CliPrompt::prompt() !== 'yes') {
+ throw new RuntimeException($this->l10n->t('Deletion aborted.'));
+ }
+ }
+
+ return UserModel::remove($user['uid']);
+ }
+
+ /**
+ * List users of the current node
+ *
+ * @return bool True, if the command was successful
+ */
+ private function listUser()
+ {
+ $subCmd = $this->getArgument(1);
+ $start = $this->getOption(['s', 'start'], 0);
+ $count = $this->getOption(['c', 'count'], Pager::ITEMS_PER_PAGE);
+
+ $table = new Console_Table();
+
+ switch ($subCmd) {
+ case 'pending':
+ $table->setHeaders(['Nick', 'Name', 'URL', 'E-Mail', 'Register Date', 'Comment']);
+ $pending = Register::getPending($start, $count);
+ foreach ($pending as $contact) {
+ $table->addRow([
+ $contact['nick'],
+ $contact['name'],
+ $contact['url'],
+ $contact['email'],
+ Temporal::getRelativeDate($contact['created']),
+ $contact['note'],
+ ]);
+ }
+ $this->out($table->getTable());
+ return true;
+ case 'all':
+ case 'active':
+ case 'removed':
+ $table->setHeaders(['Nick', 'Name', 'URL', 'E-Mail', 'Register', 'Login', 'Last Item']);
+ $contacts = UserModel::getList($start, $count, $subCmd);
+ foreach ($contacts as $contact) {
+ $table->addRow([
+ $contact['nick'],
+ $contact['name'],
+ $contact['url'],
+ $contact['email'],
+ Temporal::getRelativeDate($contact['created']),
+ Temporal::getRelativeDate($contact['login_date']),
+ Temporal::getRelativeDate($contact['last-item']),
+ ]);
+ }
+ $this->out($table->getTable());
+ return true;
+ default:
+ $this->out($this->getHelp());
+ return false;
+ }
+ }
+
+ /**
+ * Returns a user based on search parameter
+ *
+ * @return bool True, if the command was successful
+ */
+ private function searchUser()
+ {
+ $fields = [
+ 'uid',
+ 'guid',
+ 'username',
+ 'nickname',
+ 'email',
+ 'register_date',
+ 'login_date',
+ 'verified',
+ 'blocked',
+ ];
+
+ $subCmd = $this->getArgument(1);
+ $param = $this->getArgument(2);
+
+ $table = new Console_Table();
+ $table->setHeaders(['UID', 'GUID', 'Name', 'Nick', 'E-Mail', 'Register', 'Login', 'Verified', 'Blocked']);
+
+ switch ($subCmd) {
+ case 'id':
+ $user = UserModel::getById($param, $fields);
+ break;
+ case 'guid':
+ $user = UserModel::getByGuid($param, $fields);
+ break;
+ case 'email':
+ $user = UserModel::getByEmail($param, $fields);
+ break;
+ case 'nick':
+ $user = UserModel::getByNickname($param, $fields);
+ break;
+ default:
+ $this->out($this->getHelp());
+ return false;
+ }
+
+ $table->addRow($user);
+ $this->out($table->getTable());
+
+ return true;
+ }
}