X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;f=src%2FConsole%2FUser.php;h=eb061ede31b10af8e751f40e80678cb9bd7bf24c;hb=d4a5a8051ad34a7be72238967afb3e6b140afdc8;hp=68e25818b1246041ad50db38d612c3101e49ad01;hpb=3a317c5c0dbcb159f02bac339261bedbd351078a;p=friendica.git diff --git a/src/Console/User.php b/src/Console/User.php index 68e25818b1..eb061ede31 100644 --- a/src/Console/User.php +++ b/src/Console/User.php @@ -1,6 +1,6 @@ [] [-h|--help|-?] [-v] bin/console user add [ [ [ []]]] [-h|--help|-?] [-v] - bin/console user delete [] [-q] [-h|--help|-?] [-v] + bin/console user delete [] [-y] [-h|--help|-?] [-v] bin/console user allow [] [-h|--help|-?] [-v] bin/console user deny [] [-h|--help|-?] [-v] bin/console user block [] [-h|--help|-?] [-v] bin/console user unblock [] [-h|--help|-?] [-v] - bin/console user list pending [start=0 [count=50]] [-h|--help|-?] [-v] - bin/console user list removed [start=0 [count=50]] [-h|--help|-?] [-v] - bin/console user list all [start=0 [count=50]] [-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 [-h|--help|-?] [-v] + bin/console user search nick [-h|--help|-?] [-v] + bin/console user search mail [-h|--help|-?] [-v] + bin/console user search guid [-h|--help|-?] [-v] + bin/console user config list [] [] [-h|--help|-?] [-v] + bin/console user config get [] [] [] [-h|--help|-?] [-v] + bin/console user config set [] [] [] [] [-h|--help|-?] [-v] + bin/console user config delete [] [] [] [-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). + -v Show more debug information + -y Non-interactive mode, assume "yes" as answer to the user deletion prompt HELP; return $help; } - public function __construct(App\Mode $appMode, L10n $l10n, Database $dba, array $argv = null) + public function __construct(App\Mode $appMode, L10n $l10n, IManagePersonalConfigValues $pConfig, array $argv = null) { parent::__construct($argv); - $this->appMode = $appMode; - $this->l10n = $l10n; - $this->dba = $dba; + $this->appMode = $appMode; + $this->l10n = $l10n; + $this->pConfig = $pConfig; } - protected function doExecute() + protected function doExecute(): int { if ($this->getOption('v')) { $this->out('Class: ' . __CLASS__); @@ -124,11 +133,58 @@ HELP; return $this->deleteUser(); case 'list': return $this->listUser(); + case 'search': + return $this->searchUser(); + case 'config': + return $this->configUser(); default: throw new \Asika\SimpleConsole\CommandArgsException('Wrong command.'); } } + /** + * Retrieves the user nick, either as an argument or from a prompt + * + * @param int $arg_index Index of the nick argument in the arguments list + * + * @return string nick of the user + * @throws \Friendica\Network\HTTPException\InternalServerErrorException + */ + private function getNick($arg_index) + { + $nick = $this->getArgument($arg_index); + + 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.'); + } + } + + return $nick; + } + + /** + * Retrieves the user from a nick supplied as an argument or from a prompt + * + * @param int $arg_index Index of the nick argument in the arguments list + * + * @return array|boolean User record with uid field, or false if user is not found + * @throws \Friendica\Network\HTTPException\InternalServerErrorException + */ + private function getUserByNick($arg_index) + { + $nick = $this->getNick($arg_index); + + $user = UserModel::getByNickname($nick, ['uid']); + if (empty($user)) { + throw new RuntimeException($this->l10n->t('User not found')); + } + + return $user; + } + /** * Sets a new password * @@ -138,12 +194,7 @@ HELP; */ 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')); - } + $user = $this->getUserByNick(1); $password = $this->getArgument(2); @@ -155,7 +206,7 @@ HELP; try { $result = UserModel::updatePassword($user['uid'], $password); - if (!$this->dba->isResult($result)) { + if (empty($result)) { throw new \Exception($this->l10n->t('Password update failed. Please try again.')); } @@ -219,7 +270,7 @@ HELP; } /** - * Allows or denys a user based on it's nickname + * Allows or denies a user based on it's nickname * * @param bool $allow True, if the pending user is allowed, false if denies * @@ -228,20 +279,7 @@ HELP; */ 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')); - } + $user = $this->getUserByNick(1); $pending = Register::getPendingForUser($user['uid'] ?? 0); if (empty($pending)) { @@ -261,20 +299,7 @@ HELP; */ 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')); - } + $user = $this->getUserByNick(1); return $block ? UserModel::block($user['uid'] ?? 0) : UserModel::block($user['uid'] ?? 0, false); } @@ -285,43 +310,35 @@ HELP; * @return bool True, if the delete was successful * @throws \Exception */ - private function deleteUser() + private function deleteUser(): bool { - $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->getUserByNick(1); - $user = $this->dba->selectFirst('user', ['uid'], ['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 (!$this->getOption('y')) { + $this->out($this->l10n->t('Type "yes" to delete %s', $this->getArgument(1))); if (CliPrompt::prompt() !== 'yes') { - throw new RuntimeException('Delete abort.'); + throw new RuntimeException($this->l10n->t('Deletion aborted.')); } } - return UserModel::remove($user['uid'] ?? -1); + return UserModel::remove($user['uid']); } /** - * List user of the current node + * List users of the current node * * @return bool True, if the command was successful */ private function listUser() { $subCmd = $this->getArgument(1); - $start = $this->getArgument(2, 0); - $count = $this->getArgument(3, Pager::ITEMS_PER_PAGE); + $start = $this->getOption(['s', 'start'], 0); + $count = $this->getOption(['c', 'count'], Pager::ITEMS_PER_PAGE); $table = new Console_Table(); @@ -342,28 +359,166 @@ HELP; $this->out($table->getTable()); return true; case 'all': + case 'active': case 'removed': - default: $table->setHeaders(['Nick', 'Name', 'URL', 'E-Mail', 'Register', 'Login', 'Last Item']); - $contacts = UserModel::getUsers($start, $count); + $contacts = UserModel::getList($start, $count, $subCmd); foreach ($contacts as $contact) { - if (($subCmd != 'removed') && !empty($contact['account_removed']) || - ($subCmd == 'removed') && empty($contact['account_removed'])) { - continue; - } - $table->addRow([ $contact['nick'], $contact['name'], $contact['url'], $contact['email'], Temporal::getRelativeDate($contact['created']), - Temporal::getRelativeDate($contact['login_date']), - Temporal::getRelativeDate($contact['lastitem_date']), + Temporal::getRelativeDate($contact['last-activity']), + 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', + 'last-activity', + '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 'mail': + $user = UserModel::getByEmail($param, $fields); + break; + case 'nick': + $user = UserModel::getByNickname($param, $fields); + break; + default: + $this->out($this->getHelp()); + return false; + } + + if (!empty($user)) { + $table->addRow($user); + } + $this->out($table->getTable()); + + return true; + } + + /** + * Queries and modifies user-specific configuration + * + * @return bool True, if the command was successful + */ + private function configUser() + { + $subCmd = $this->getArgument(1); + + $user = $this->getUserByNick(2); + + $category = $this->getArgument(3); + + if (is_null($category)) { + $this->out($this->l10n->t('Enter category: '), false); + $category = CliPrompt::prompt(); + if (empty($category)) { + throw new RuntimeException('A category must be selected.'); + } + } + + $key = $this->getArgument(4); + + if ($subCmd != 'list' and is_null($key)) { + $this->out($this->l10n->t('Enter key: '), false); + $key = CliPrompt::prompt(); + if (empty($key)) { + throw new RuntimeException('A key must be selected.'); + } + } + + $values = $this->pConfig->load($user['uid'], $category); + + switch ($subCmd) { + case 'list': + $table = new Console_Table(); + $table->setHeaders(['Key', 'Value']); + if (array_key_exists($category, $values)) { + foreach (array_keys($values[$category]) as $key) { + $table->addRow([$key, $values[$category][$key]]); + } + } + $this->out($table->getTable()); + break; + case 'get': + if (!array_key_exists($category, $values)) { + throw new RuntimeException('Category does not exist'); + } + if (!array_key_exists($key, $values[$category])) { + throw new RuntimeException('Key does not exist'); + } + + $this->out($this->pConfig->get($user['uid'], $category, $key)); + break; + case 'set': + $value = $this->getArgument(5); + + if (is_null($value)) { + $this->out($this->l10n->t('Enter value: '), false); + $value = CliPrompt::prompt(); + if (empty($value)) { + throw new RuntimeException('A value must be specified.'); + } + } + + if (array_key_exists($category, $values) and + array_key_exists($key, $values[$category]) and + $values[$category][$key] == $value) { + throw new RuntimeException('Value not changed'); + } + + $this->pConfig->set($user['uid'], $category, $key, $value); + break; + case 'delete': + if (!array_key_exists($category, $values)) { + throw new RuntimeException('Category does not exist'); + } + if (!array_key_exists($key, $values[$category])) { + throw new RuntimeException('Key does not exist'); + } + + $this->pConfig->delete($user['uid'], $category, $key); + break; + default: + $this->out($this->getHelp()); + return false; } } }