Skip to content

Commit

Permalink
Merge pull request #38253 from nextcloud/backport/37865/stable25
Browse files Browse the repository at this point in the history
[stable25] add command to summarize space usage
  • Loading branch information
blizzz authored Jun 13, 2023
2 parents c4b7219 + b95b23a commit 6379223
Show file tree
Hide file tree
Showing 6 changed files with 333 additions and 131 deletions.
138 changes: 7 additions & 131 deletions core/Command/Info/File.php
Original file line number Diff line number Diff line change
Expand Up @@ -5,22 +5,15 @@
namespace OC\Core\Command\Info;

use OC\Files\ObjectStore\ObjectStoreStorage;
use OCA\Circles\MountManager\CircleMount;
use OCA\Files_External\Config\ExternalMountPoint;
use OCA\Files_Sharing\SharedMount;
use OCA\GroupFolders\Mount\GroupMountPoint;
use OCP\Constants;
use OCP\Files\Config\IUserMountCache;
use OCP\Files\FileInfo;
use OCP\Files\Folder;
use OCP\Files\IHomeStorage;
use OCP\Files\IRootFolder;
use OCP\Files\Mount\IMountPoint;
use OCP\Files\Node;
use OCP\Files\NotFoundException;
use OCP\IL10N;
use OCP\L10N\IFactory;
use OCP\Share\IShare;
use OCP\Util;
use Symfony\Component\Console\Command\Command;
use Symfony\Component\Console\Input\InputArgument;
Expand All @@ -29,14 +22,12 @@
use Symfony\Component\Console\Output\OutputInterface;

class File extends Command {
private IRootFolder $rootFolder;
private IUserMountCache $userMountCache;
private IL10N $l10n;
private FileUtils $fileUtils;

public function __construct(IRootFolder $rootFolder, IUserMountCache $userMountCache, IFactory $l10nFactory) {
$this->rootFolder = $rootFolder;
$this->userMountCache = $userMountCache;
public function __construct(IFactory $l10nFactory, FileUtils $fileUtils) {
$this->l10n = $l10nFactory->get("core");
$this->fileUtils = $fileUtils;
parent::__construct();
}

Expand All @@ -51,7 +42,7 @@ protected function configure(): void {
public function execute(InputInterface $input, OutputInterface $output): int {
$fileInput = $input->getArgument('file');
$showChildren = $input->getOption('children');
$node = $this->getNode($fileInput);
$node = $this->fileUtils->getNode($fileInput);
if (!$node) {
$output->writeln("<error>file $fileInput not found</error>");
return 1;
Expand Down Expand Up @@ -83,137 +74,22 @@ public function execute(InputInterface $input, OutputInterface $output): int {
}
$this->outputStorageDetails($node->getMountPoint(), $node, $output);

$filesPerUser = $this->getFilesByUser($node);
$filesPerUser = $this->fileUtils->getFilesByUser($node);
$output->writeln("");
$output->writeln("The following users have access to the file");
$output->writeln("");
foreach ($filesPerUser as $user => $files) {
$output->writeln("$user:");
foreach ($files as $userFile) {
$output->writeln(" " . $userFile->getPath() . ": " . $this->formatPermissions($userFile->getType(), $userFile->getPermissions()));
$output->writeln(" " . $userFile->getPath() . ": " . $this->fileUtils->formatPermissions($userFile->getType(), $userFile->getPermissions()));
$mount = $userFile->getMountPoint();
$output->writeln(" " . $this->formatMountType($mount));
$output->writeln(" " . $this->fileUtils->formatMountType($mount));
}
}

return 0;
}

private function getNode(string $fileInput): ?Node {
if (is_numeric($fileInput)) {
$mounts = $this->userMountCache->getMountsForFileId((int)$fileInput);
if (!$mounts) {
return null;
}
$mount = $mounts[0];
$userFolder = $this->rootFolder->getUserFolder($mount->getUser()->getUID());
$nodes = $userFolder->getById((int)$fileInput);
if (!$nodes) {
return null;
}
return $nodes[0];
} else {
try {
return $this->rootFolder->get($fileInput);
} catch (NotFoundException $e) {
return null;
}
}
}

/**
* @param FileInfo $file
* @return array<string, Node[]>
* @throws \OCP\Files\NotPermittedException
* @throws \OC\User\NoUserException
*/
private function getFilesByUser(FileInfo $file): array {
$id = $file->getId();
if (!$id) {
return [];
}

$mounts = $this->userMountCache->getMountsForFileId($id);
$result = [];
foreach ($mounts as $mount) {
if (isset($result[$mount->getUser()->getUID()])) {
continue;
}

$userFolder = $this->rootFolder->getUserFolder($mount->getUser()->getUID());
$result[$mount->getUser()->getUID()] = $userFolder->getById($id);
}

return $result;
}

private function formatPermissions(string $type, int $permissions): string {
if ($permissions == Constants::PERMISSION_ALL || ($type === 'file' && $permissions == (Constants::PERMISSION_ALL - Constants::PERMISSION_CREATE))) {
return "full permissions";
}

$perms = [];
$allPerms = [Constants::PERMISSION_READ => "read", Constants::PERMISSION_UPDATE => "update", Constants::PERMISSION_CREATE => "create", Constants::PERMISSION_DELETE => "delete", Constants::PERMISSION_SHARE => "share"];
foreach ($allPerms as $perm => $name) {
if (($permissions & $perm) === $perm) {
$perms[] = $name;
}
}

return implode(", ", $perms);
}

/**
* @psalm-suppress UndefinedClass
* @psalm-suppress UndefinedInterfaceMethod
*/
private function formatMountType(IMountPoint $mountPoint): string {
$storage = $mountPoint->getStorage();
if ($storage && $storage->instanceOfStorage(IHomeStorage::class)) {
return "home storage";
} elseif ($mountPoint instanceof SharedMount) {
$share = $mountPoint->getShare();
$shares = $mountPoint->getGroupedShares();
$sharedBy = array_map(function (IShare $share) {
$shareType = $this->formatShareType($share);
if ($shareType) {
return $share->getSharedBy() . " (via " . $shareType . " " . $share->getSharedWith() . ")";
} else {
return $share->getSharedBy();
}
}, $shares);
$description = "shared by " . implode(', ', $sharedBy);
if ($share->getSharedBy() !== $share->getShareOwner()) {
$description .= " owned by " . $share->getShareOwner();
}
return $description;
} elseif ($mountPoint instanceof GroupMountPoint) {
return "groupfolder " . $mountPoint->getFolderId();
} elseif ($mountPoint instanceof ExternalMountPoint) {
return "external storage " . $mountPoint->getStorageConfig()->getId();
} elseif ($mountPoint instanceof CircleMount) {
return "circle";
}
return get_class($mountPoint);
}

private function formatShareType(IShare $share): ?string {
switch ($share->getShareType()) {
case IShare::TYPE_GROUP:
return "group";
case IShare::TYPE_CIRCLE:
return "circle";
case IShare::TYPE_DECK:
return "deck";
case IShare::TYPE_ROOM:
return "room";
case IShare::TYPE_USER:
return null;
default:
return "Unknown (".$share->getShareType().")";
}
}

/**
* @psalm-suppress UndefinedClass
* @psalm-suppress UndefinedInterfaceMethod
Expand Down
Loading

0 comments on commit 6379223

Please sign in to comment.