Feature/files list occ command #43342
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -0,0 +1,304 @@ | ||||||
| <?php | ||||||
| /** | ||||||
| * @copyright Copyright (c) 2024, Nextcloud GmbH | ||||||
| * | ||||||
| * @author Kareem <[email protected]> | ||||||
| * @license AGPL-3.0 | ||||||
| * | ||||||
| * This code is free software: you can redistribute it and/or modify | ||||||
| * it under the terms of the GNU Affero General Public License, version 3, | ||||||
| * as published by the Free Software Foundation. | ||||||
| * | ||||||
| * This program is distributed in the hope that it will be useful, | ||||||
| * but WITHOUT ANY WARRANTY; without even the implied warranty of | ||||||
| * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | ||||||
| * GNU Affero General Public License for more details. | ||||||
| * | ||||||
| * You should have received a copy of the GNU Affero General Public License, version 3, | ||||||
| * along with this program. If not, see <http://www.gnu.org/licenses/> | ||||||
| * | ||||||
| */ | ||||||
| namespace OCA\Files\Command; | ||||||
|
|
||||||
| use OC\Core\Command\Base; | ||||||
| use OC\Core\Command\InterruptedException; | ||||||
| use OC\FilesMetadata\FilesMetadataManager; | ||||||
| use OC\ForbiddenException; | ||||||
| use OCP\EventDispatcher\IEventDispatcher; | ||||||
| use OCP\Files\File; | ||||||
| use OCP\Files\Folder; | ||||||
| use OCP\Files\IRootFolder; | ||||||
| use OCP\Files\NotFoundException; | ||||||
| use OCP\IUserManager; | ||||||
| use Psr\Log\LoggerInterface; | ||||||
| use Symfony\Component\Console\Helper\Table; | ||||||
| use Symfony\Component\Console\Input\InputArgument; | ||||||
| use Symfony\Component\Console\Input\InputInterface; | ||||||
| use Symfony\Component\Console\Output\OutputInterface; | ||||||
|
|
||||||
| class ListFiles extends Base { | ||||||
| protected array $fileInfo = []; | ||||||
| protected array $dirInfo = []; | ||||||
| public function __construct( | ||||||
| private IUserManager $userManager, | ||||||
| private IRootFolder $rootFolder, | ||||||
| private FilesMetadataManager $filesMetadataManager, | ||||||
| private IEventDispatcher $eventDispatcher, | ||||||
| private LoggerInterface $logger | ||||||
| ) { | ||||||
| parent::__construct(); | ||||||
| } | ||||||
|
|
||||||
| protected function configure(): void { | ||||||
| parent::configure(); | ||||||
|
|
||||||
| $this->setName("files:list") | ||||||
| ->setDescription("List filesystem") | ||||||
| ->addArgument( | ||||||
| "path", | ||||||
| InputArgument::REQUIRED, | ||||||
| 'Limit list to this path, eg. path="/alice/files/Music", the user_id is determined by the path parameter' | ||||||
|
||||||
| ) | ||||||
| ->addOption("type", "", InputArgument::OPTIONAL, "Filter by type like application, image, video etc") | ||||||
| ->addOption( | ||||||
| "minSize", | ||||||
| '0', | ||||||
| InputArgument::OPTIONAL, | ||||||
| "Filter by min size" | ||||||
| ) | ||||||
| ->addOption( | ||||||
| "maxSize", | ||||||
| '0', | ||||||
| InputArgument::OPTIONAL, | ||||||
| "Filter by max size" | ||||||
| ) | ||||||
| ->addOption( | ||||||
| "sort", | ||||||
| "name", | ||||||
| InputArgument::OPTIONAL, | ||||||
| "Sort by name, path, size, owner, type, perm, created-at" | ||||||
| ) | ||||||
| ->addOption("order", "ASC", InputArgument::OPTIONAL, "Order is either ASC or DESC"); | ||||||
| } | ||||||
|
|
||||||
| private function getNodeInfo(File|Folder $node): array { | ||||||
| return [ | ||||||
| "name" => $node->getName(), | ||||||
| "size" => $node->getSize() . " bytes", | ||||||
| "perm" => $node->getPermissions(), | ||||||
| "owner" => $node->getOwner()->getDisplayName(), | ||||||
Check noticeCode scanning / Psalm PossiblyNullReference
Contributor
There was a problem hiding this comment.
Suggested change
|
||||||
| "created-at" => $node->getCreationTime(), | ||||||
| "type" => $node->getMimePart(), | ||||||
yemkareems marked this conversation as resolved.
Show resolved
Hide resolved
|
||||||
| ]; | ||||||
| } | ||||||
|
|
||||||
| protected function listFiles( | ||||||
| string $user, | ||||||
| string $path, | ||||||
| OutputInterface $output, | ||||||
| ?string $type = "", | ||||||
| ?int $minSize = 0, | ||||||
| ?int $maxSize = 0 | ||||||
| ): void { | ||||||
| try { | ||||||
| /** @ var OC\Files\Node\Folder $userFolder **/ | ||||||
artonge marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||||||
| $userFolder = $this->rootFolder->get($path); | ||||||
|
||||||
|
|
||||||
| $files = $userFolder->getDirectoryListing(); | ||||||
github-advanced-security[bot] marked this conversation as resolved.
Fixed
Show fixed
Hide fixed
|
||||||
| foreach ($files as $file) { | ||||||
| $includeType = $includeMin = $includeMax = true; | ||||||
| if ($type != "" && $type != $file->getMimePart()) { | ||||||
| $includeType = false; | ||||||
| } | ||||||
| if ($minSize > 0) { | ||||||
| $includeMin = $file->getSize() >= $minSize; | ||||||
| } | ||||||
| if ($maxSize > 0) { | ||||||
| $includeMax = $file->getSize() <= $maxSize; | ||||||
| } | ||||||
| if ($file instanceof File) { | ||||||
| if ($includeType && $includeMin && $includeMax) { | ||||||
| $this->fileInfo[] = $this->getNodeInfo($file); | ||||||
|
||||||
| } | ||||||
| } elseif ($file instanceof Folder) { | ||||||
| if ($includeType && $includeMin && $includeMax) { | ||||||
| $this->dirInfo[] = $this->getNodeInfo($file); | ||||||
|
||||||
| } | ||||||
| } | ||||||
| } | ||||||
| } catch (ForbiddenException $e) { | ||||||
| $output->writeln( | ||||||
| "<error>Home storage for user $user not writable or 'files' subdirectory missing</error>" | ||||||
| ); | ||||||
| $output->writeln(" " . $e->getMessage()); | ||||||
| $output->writeln( | ||||||
| 'Make sure you\'re running the list command only as the user the web server runs as' | ||||||
| ); | ||||||
| } catch (InterruptedException $e) { | ||||||
| # exit the function if ctrl-c has been pressed | ||||||
| $output->writeln("Interrupted by user"); | ||||||
| } catch (NotFoundException $e) { | ||||||
| $output->writeln( | ||||||
| "<error>Path not found: " . $e->getMessage() . "</error>" | ||||||
| ); | ||||||
| } catch (\Exception $e) { | ||||||
| $output->writeln( | ||||||
| "<error>Exception during list: " . $e->getMessage() . "</error>" | ||||||
| ); | ||||||
| $output->writeln("<error>" . $e->getTraceAsString() . "</error>"); | ||||||
| } | ||||||
| } | ||||||
|
|
||||||
| protected function execute( | ||||||
| InputInterface $input, | ||||||
| OutputInterface $output | ||||||
| ): int { | ||||||
| $inputPath = $input->getArgument("path"); | ||||||
| if ($inputPath) { | ||||||
| $inputPath = ltrim($inputPath, "path="); | ||||||
| [, $user] = explode("/", rtrim($inputPath, "/").'/', 4); | ||||||
| } | ||||||
|
|
||||||
| $this->initTools($output); | ||||||
|
|
||||||
| if (is_object($user)) { | ||||||
Check noticeCode scanning / Psalm PossiblyUndefinedVariable |
||||||
| $user = $user->getUID(); | ||||||
| } | ||||||
| $path = $inputPath ?: "/" . $user; | ||||||
|
|
||||||
| if ($this->userManager->userExists($user)) { | ||||||
| $output->writeln( | ||||||
| "Starting list for user ($user)" | ||||||
| ); | ||||||
| $this->listFiles( | ||||||
| $user, | ||||||
| $path, | ||||||
| $output, | ||||||
| $input->getOption("type"), | ||||||
| $input->getOption("minSize"), | ||||||
| $input->getOption("maxSize") | ||||||
| ); | ||||||
| } else { | ||||||
| $output->writeln( | ||||||
| "<error>Unknown user $user</error>" | ||||||
| ); | ||||||
| $output->writeln("", OutputInterface::VERBOSITY_VERBOSE); | ||||||
| return self::FAILURE; | ||||||
| } | ||||||
|
|
||||||
|
|
||||||
| $this->presentStats($input, $output); | ||||||
| return self::SUCCESS; | ||||||
| } | ||||||
|
|
||||||
| /** | ||||||
| * Initialises some useful tools for the Command | ||||||
| */ | ||||||
| protected function initTools(OutputInterface $output): void { | ||||||
| // Convert PHP errors to exceptions | ||||||
| set_error_handler( | ||||||
| fn ( | ||||||
| int $severity, | ||||||
| string $message, | ||||||
| string $file, | ||||||
| int $line | ||||||
| ): bool => $this->exceptionErrorHandler( | ||||||
| $output, | ||||||
| $severity, | ||||||
| $message, | ||||||
| $file, | ||||||
| $line | ||||||
| ), | ||||||
| E_ALL | ||||||
| ); | ||||||
| } | ||||||
|
|
||||||
| /** | ||||||
| * Processes PHP errors in order to be able to show them in the output | ||||||
| * | ||||||
| * @see https://www.php.net/manual/en/function.set-error-handler.php | ||||||
| * | ||||||
| * @param int $severity the level of the error raised | ||||||
| * @param string $message | ||||||
| * @param string $file the filename that the error was raised in | ||||||
| * @param int $line the line number the error was raised | ||||||
| */ | ||||||
| public function exceptionErrorHandler( | ||||||
| OutputInterface $output, | ||||||
| int $severity, | ||||||
| string $message, | ||||||
| string $file, | ||||||
| int $line | ||||||
| ): bool { | ||||||
| if ($severity === E_DEPRECATED || $severity === E_USER_DEPRECATED) { | ||||||
| // Do not show deprecation warnings | ||||||
| return false; | ||||||
| } | ||||||
| $e = new \ErrorException($message, 0, $severity, $file, $line); | ||||||
| $output->writeln( | ||||||
| "<error>Error during list: " . $e->getMessage() . "</error>" | ||||||
| ); | ||||||
| $output->writeln( | ||||||
| "<error>" . $e->getTraceAsString() . "</error>", | ||||||
| OutputInterface::VERBOSITY_VERY_VERBOSE | ||||||
| ); | ||||||
| return true; | ||||||
| } | ||||||
|
|
||||||
| protected function presentStats( | ||||||
| InputInterface $input, | ||||||
| OutputInterface $output | ||||||
| ): void { | ||||||
| $headers = [ | ||||||
| "Permission", | ||||||
| "Size", | ||||||
| "Owner", | ||||||
| "Created at", | ||||||
| "Filename", | ||||||
| "Type", | ||||||
| ]; | ||||||
| $rows = []; | ||||||
| $fileInfo = $this->fileInfo[0] ?? []; | ||||||
| $sortKey = array_key_exists($input->getOption("sort"), $fileInfo) | ||||||
| ? $input->getOption("sort") | ||||||
| : "name"; | ||||||
| $order = $input->getOption("order") == "ASC" ? SORT_ASC : SORT_DESC; | ||||||
| $fileArr = array_column($this->fileInfo, $sortKey); | ||||||
| $dirArr = array_column($this->dirInfo, $sortKey); | ||||||
| array_multisort( | ||||||
| $fileArr, | ||||||
| $order, | ||||||
| $this->fileInfo | ||||||
| ); | ||||||
| array_multisort( | ||||||
| $dirArr, | ||||||
| $order, | ||||||
| $this->dirInfo | ||||||
| ); | ||||||
|
|
||||||
| foreach ($this->fileInfo as $k => $item) { | ||||||
| $rows[$k] = [ | ||||||
| $item["perm"], | ||||||
| $item["size"], | ||||||
| $item["owner"], | ||||||
| $item["created-at"], | ||||||
| $item["name"], | ||||||
| $item["type"], | ||||||
| ]; | ||||||
| } | ||||||
| foreach ($this->dirInfo as $k => $item) { | ||||||
| $rows[] = [ | ||||||
| $item["perm"], | ||||||
| $item["size"], | ||||||
| $item["owner"], | ||||||
| $item["created-at"], | ||||||
| $item["name"], | ||||||
| $item["type"], | ||||||
| ]; | ||||||
| } | ||||||
|
|
||||||
| $table = new Table($output); | ||||||
| $table->setHeaders($headers)->setRows($rows); | ||||||
| $table->render(); | ||||||
| } | ||||||
| } | ||||||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.