ListCommand.php 3.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113
  1. <?php
  2. /**
  3. * @copyright Copyright (c) 2016 Robin Appelman <robin@icewind.nl>
  4. *
  5. * @author Joas Schilling <coding@schilljs.com>
  6. * @author John Molakvoæ <skjnldsv@protonmail.com>
  7. * @author Robin Appelman <robin@icewind.nl>
  8. *
  9. * @license GNU AGPL version 3 or any later version
  10. *
  11. * This program is free software: you can redistribute it and/or modify
  12. * it under the terms of the GNU Affero General Public License as
  13. * published by the Free Software Foundation, either version 3 of the
  14. * License, or (at your option) any later version.
  15. *
  16. * This program is distributed in the hope that it will be useful,
  17. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  19. * GNU Affero General Public License for more details.
  20. *
  21. * You should have received a copy of the GNU Affero General Public License
  22. * along with this program. If not, see <http://www.gnu.org/licenses/>.
  23. *
  24. */
  25. namespace OC\Core\Command\User;
  26. use OC\Core\Command\Base;
  27. use OCP\IGroupManager;
  28. use OCP\IUser;
  29. use OCP\IUserManager;
  30. use Symfony\Component\Console\Input\InputInterface;
  31. use Symfony\Component\Console\Input\InputOption;
  32. use Symfony\Component\Console\Output\OutputInterface;
  33. class ListCommand extends Base {
  34. protected IUserManager $userManager;
  35. protected IGroupManager $groupManager;
  36. public function __construct(IUserManager $userManager,
  37. IGroupManager $groupManager) {
  38. $this->userManager = $userManager;
  39. $this->groupManager = $groupManager;
  40. parent::__construct();
  41. }
  42. protected function configure() {
  43. $this
  44. ->setName('user:list')
  45. ->setDescription('list configured users')
  46. ->addOption(
  47. 'limit',
  48. 'l',
  49. InputOption::VALUE_OPTIONAL,
  50. 'Number of users to retrieve',
  51. '500'
  52. )->addOption(
  53. 'offset',
  54. 'o',
  55. InputOption::VALUE_OPTIONAL,
  56. 'Offset for retrieving users',
  57. '0'
  58. )->addOption(
  59. 'output',
  60. null,
  61. InputOption::VALUE_OPTIONAL,
  62. 'Output format (plain, json or json_pretty, default is plain)',
  63. $this->defaultOutputFormat
  64. )->addOption(
  65. 'info',
  66. 'i',
  67. InputOption::VALUE_NONE,
  68. 'Show detailed info'
  69. );
  70. }
  71. protected function execute(InputInterface $input, OutputInterface $output): int {
  72. $users = $this->userManager->searchDisplayName('', (int) $input->getOption('limit'), (int) $input->getOption('offset'));
  73. $this->writeArrayInOutputFormat($input, $output, $this->formatUsers($users, (bool)$input->getOption('info')));
  74. return 0;
  75. }
  76. /**
  77. * @param IUser[] $users
  78. * @param bool [$detailed=false]
  79. * @return array
  80. */
  81. private function formatUsers(array $users, bool $detailed = false) {
  82. $keys = array_map(function (IUser $user) {
  83. return $user->getUID();
  84. }, $users);
  85. $values = array_map(function (IUser $user) use ($detailed) {
  86. if ($detailed) {
  87. $groups = $this->groupManager->getUserGroupIds($user);
  88. return [
  89. 'user_id' => $user->getUID(),
  90. 'display_name' => $user->getDisplayName(),
  91. 'email' => (string)$user->getSystemEMailAddress(),
  92. 'cloud_id' => $user->getCloudId(),
  93. 'enabled' => $user->isEnabled(),
  94. 'groups' => $groups,
  95. 'quota' => $user->getQuota(),
  96. 'last_seen' => date(\DateTimeInterface::ATOM, $user->getLastLogin()), // ISO-8601
  97. 'user_directory' => $user->getHome(),
  98. 'backend' => $user->getBackendClassName()
  99. ];
  100. }
  101. return $user->getDisplayName();
  102. }, $users);
  103. return array_combine($keys, $values);
  104. }
  105. }