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
{
Usage
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;
}
case 'add':
return $this->addUser();
case 'allow':
- return $this->allowUser();
+ 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.');
}
}
/**
- * Allows a user based on it's nickname
+ * 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
*/
- public function allowUser()
+ private function pendingUser(bool $allow = true)
{
$nick = $this->getArgument(1);
throw new RuntimeException($this->l10n->t('User is not pending.'));
}
- return UserModel::allow($pending['hash']);
+ 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;
}
}