aboutsummaryrefslogtreecommitdiffstats
path: root/core/Command/User/Report.php
diff options
context:
space:
mode:
Diffstat (limited to 'core/Command/User/Report.php')
-rw-r--r--core/Command/User/Report.php89
1 files changed, 89 insertions, 0 deletions
diff --git a/core/Command/User/Report.php b/core/Command/User/Report.php
new file mode 100644
index 00000000000..c0f054adb00
--- /dev/null
+++ b/core/Command/User/Report.php
@@ -0,0 +1,89 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * SPDX-FileCopyrightText: 2016-2024 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-FileCopyrightText: 2016 ownCloud, Inc.
+ * SPDX-License-Identifier: AGPL-3.0-only
+ */
+namespace OC\Core\Command\User;
+
+use OC\Files\View;
+use OCP\IConfig;
+use OCP\IUserManager;
+use Symfony\Component\Console\Command\Command;
+use Symfony\Component\Console\Helper\Table;
+use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Input\InputOption;
+use Symfony\Component\Console\Output\OutputInterface;
+
+class Report extends Command {
+ public const DEFAULT_COUNT_DIRS_MAX_USERS = 500;
+
+ public function __construct(
+ protected IUserManager $userManager,
+ private IConfig $config,
+ ) {
+ parent::__construct();
+ }
+
+ protected function configure(): void {
+ $this
+ ->setName('user:report')
+ ->setDescription('shows how many users have access')
+ ->addOption(
+ 'count-dirs',
+ null,
+ InputOption::VALUE_NONE,
+ 'Also count the number of user directories in the database (could time out on huge installations, therefore defaults to no with ' . self::DEFAULT_COUNT_DIRS_MAX_USERS . '+ users)'
+ )
+ ;
+ }
+
+ protected function execute(InputInterface $input, OutputInterface $output): int {
+ $table = new Table($output);
+ $table->setHeaders(['Account Report', '']);
+ $userCountArray = $this->countUsers();
+ $total = 0;
+ if (!empty($userCountArray)) {
+ $rows = [];
+ foreach ($userCountArray as $classname => $users) {
+ $total += $users;
+ $rows[] = [$classname, $users];
+ }
+
+ $rows[] = [' '];
+ $rows[] = ['total users', $total];
+ } else {
+ $rows[] = ['No backend enabled that supports user counting', ''];
+ }
+ $rows[] = [' '];
+
+ if ($total <= self::DEFAULT_COUNT_DIRS_MAX_USERS || $input->getOption('count-dirs')) {
+ $userDirectoryCount = $this->countUserDirectories();
+ $rows[] = ['user directories', $userDirectoryCount];
+ }
+
+ $activeUsers = $this->userManager->countSeenUsers();
+ $rows[] = ['active users', $activeUsers];
+
+ $disabledUsers = $this->config->getUsersForUserValue('core', 'enabled', 'false');
+ $disabledUsersCount = count($disabledUsers);
+ $rows[] = ['disabled users', $disabledUsersCount];
+
+ $table->setRows($rows);
+ $table->render();
+ return 0;
+ }
+
+ private function countUsers(): array {
+ return $this->userManager->countUsers();
+ }
+
+ private function countUserDirectories(): int {
+ $dataview = new View('/');
+ $userDirectories = $dataview->getDirectoryContent('/', 'httpd/unix-directory');
+ return count($userDirectories);
+ }
+}