Feature/files list occ command by yemkareems · Pull Request #43342 · nextcloud/server

yemkareems · 2024-02-05T01:16:53Z

files:list implemented based on files:scan
List of possible usage

all user based search
occ files:list --all

path based search
occ files:list --path /admin/files
scans the directory and sub directory also

Filter by type

occ files:list --path /admin/files/Media --type video
occ files:list --path /admin/files/Media --type image
occ files:list --path /admin/files/ --type application

Filter by file size

occ files:list --path /admin/files/Media --minSize 9622690
occ files:list --path /admin/files/Media --maxSize 9622690

default sort order is desc
occ files:list --all --sort name
to do asc
occ files:list --all --sort name --order ASC

Non recursive scan and list
occ files:list --path /admin/files/ --shallow
The above does not scan sub directories recursively

All the above params can be combined to have different result sets

Resolves: #

Summary

TODO

...

Checklist

Code is properly formatted
Sign-off message is added to all commits
Tests (unit, integration, api and/or acceptance) are included
Screenshots before/after for front-end changes
Documentation (manuals or wiki) has been updated or is not required
Backports requested where applicable (ex: critical bugfixes)

…e for files. path or --all is required to search files in the path or based on all users

…ected

…se in file info if no files in dir covered

yemkareems · 2024-02-05T01:20:21Z

@AndyScherzinger @sorbaugh Please find the above file list implemented based on files:scan. I am not able add you as reviewers so tagged both of you in the comment here.

Psalm errors fixed Signed-off-by: yemkareems <yemkareems@gmail.com>

composer run cs:fix Signed-off-by: yemkareems <yemkareems@gmail.com>

exectime variable removed to fix psalm error Signed-off-by: yemkareems <yemkareems@gmail.com>

type hinting corrected Signed-off-by: yemkareems <yemkareems@gmail.com>

Scan files replaced with listFiles and all methods refactored accordingly Signed-off-by: yemkareems <yemkareems@gmail.com>

path made a argument and user extraction logic based on path changed Signed-off-by: yemkareems <yemkareems@gmail.com>

help doc content changed to start with all first caps Signed-off-by: yemkareems <yemkareems@gmail.com>

artonge · 2024-02-12T17:34:51Z

+ "name" => $node->getName(),
+ "size" => $node->getSize() . " bytes",
+ "perm" => $node->getPermissions(),
+ "owner" => $node->getOwner()->getDisplayName(),


Suggested change
"owner" => $node->getOwner()->getDisplayName(),
"owner" => $node->getOwner()?->getDisplayName(),

…hors removed removed the user loop since only one user is there and copy right authors removed Signed-off-by: yemkareems <yemkareems@gmail.com>

type hinting corrected Signed-off-by: yemkareems <yemkareems@gmail.com>

+
+ $this->initTools($output);
+
+ if (is_object($user)) {


cs fix ran Signed-off-by: yemkareems <yemkareems@gmail.com>

Signed-off-by: yemkareems <yemkareems@gmail.com>

userFolder type hint to fix psalm error Signed-off-by: yemkareems <yemkareems@gmail.com>

Co-authored-by: Andy Scherzinger <info@andy-scherzinger.de> Signed-off-by: yemkareems <yemkareems@gmail.com>

icewind1991 · 2024-02-16T11:00:02Z

+ ->addArgument(
+ "path",
+ InputArgument::REQUIRED,
+ 'Limit list to this path, eg. path="/alice/files/Music", the user_id is determined by the path parameter'


The description no longer matches with it being moved to and argument. (the path=)

@icewind1991 Updated the description of the path argument

I mean the path=... doesn't match anymore as it's no longer an option, so you no longer specify the path= part

Hi @icewind1991 not sure if i understood it correctly because i still do occ files:list path=/admin/files/Media --type=video where path is required and the above lists all the video files in the path

updated the description of path Signed-off-by: yemkareems <yemkareems@gmail.com>

making changes to list folders as directory type Signed-off-by: yemkareems <yemkareems@gmail.com>

cs fix run for the file Signed-off-by: yemkareems <yemkareems@gmail.com>

artonge · 2024-02-12T17:29:33Z

@@ -0,0 +1,301 @@
+<?php
+/**
+ * @copyright Copyright (c) 2024, ownCloud, Inc.


Suggested change
* @copyright Copyright (c) 2024, ownCloud, Inc.
* @copyright Copyright (c) 2024 Kareem <yemkareems@gmail.com>

artonge · 2024-02-12T17:34:51Z

+ "name" => $node->getName(),
+ "size" => $node->getSize() . " bytes",
+ "perm" => $node->getPermissions(),
+ "owner" => $node->getOwner()->getDisplayName(),


Suggested change
"owner" => $node->getOwner()->getDisplayName(),
"owner" => $node->getOwner()?->getDisplayName(),

+ $files = $userFolder->getDirectoryListing();
+ foreach ($files as $file) {
+ $includeType = $includeMin = $includeMax = true;
+ $nodeInfo = $this->getNodeInfo($file);


artonge · 2024-07-08T09:45:12Z

Closing as it move here: #46352

yemkareems added 4 commits February 3, 2024 07:52

files:list added as a occ command. filter added based on type and siz…
027d692
…e for files. path or --all is required to search files in the path or based on all users

basic sorting added to list, could be improvised
b9caee2

listing files and folders separately as sorting is not working as exp…
f90b106
…ected

general refactoring to remove unused variables and functions, edge ca…
1503053
…se in file info if no files in dir covered

yemkareems requested review from ArtificialOwl, Pytal, artonge, come-nc, icewind1991, nfebe, skjnldsv, susnux and szaimen as code owners February 5, 2024 01:16

yemkareems marked this pull request as draft February 5, 2024 01:17

yemkareems marked this pull request as ready for review February 5, 2024 01:20

yemkareems mentioned this pull request Feb 5, 2024
Feature/files list occ command yemkareems/server#1
Draft

szaimen removed their request for review February 5, 2024 07:21

github-advanced-securityAI found potential problems Feb 5, 2024
View reviewed changes

yemkareems added 4 commits February 7, 2024 10:09

Update ListFiles.php
2b915f3
Psalm errors fixed Signed-off-by: yemkareems <yemkareems@gmail.com>

composer run cs:fix
7e27fbe
composer run cs:fix Signed-off-by: yemkareems <yemkareems@gmail.com>

Update ListFiles.php
d82b3b3
exectime variable removed to fix psalm error Signed-off-by: yemkareems <yemkareems@gmail.com>

type hinting
a035d41
type hinting corrected Signed-off-by: yemkareems <yemkareems@gmail.com>

artonge reviewed Feb 8, 2024
View reviewed changes

PR review comments by Louis done
ac4efa8
Scan files replaced with listFiles and all methods refactored accordingly Signed-off-by: yemkareems <yemkareems@gmail.com>

icewind1991 reviewed Feb 9, 2024
View reviewed changes

Comment threadapps/files/lib/Command/ListFiles.php Outdated

yemkareems added 2 commits February 9, 2024 19:29

path made a argument and user extraction logic based on path changed
92e5516
path made a argument and user extraction logic based on path changed Signed-off-by: yemkareems <yemkareems@gmail.com>

help doc content changed to start with all first caps
d59769e
help doc content changed to start with all first caps Signed-off-by: yemkareems <yemkareems@gmail.com>

artonge reviewed Feb 12, 2024
View reviewed changes

Comment threadapps/files/lib/Command/ListFiles.php Outdated
Comment threadapps/files/lib/Command/ListFiles.php Outdated

github-advanced-securityAI found potential problems Feb 12, 2024
View reviewed changes

AndyScherzinger added enhancement feature: occ labels Feb 12, 2024

AndyScherzinger requested a review from sorbaugh February 12, 2024 16:20

yemkareems added 2 commits February 12, 2024 22:44

removed the user loop since only one user is there and copy right aut…
1764794
…hors removed removed the user loop since only one user is there and copy right authors removed Signed-off-by: yemkareems <yemkareems@gmail.com>

type hinting corrected
5638ef2
type hinting corrected Signed-off-by: yemkareems <yemkareems@gmail.com>

github-advanced-securityAI found potential problems Feb 12, 2024
View reviewed changes

Comment threadapps/files/lib/Command/ListFiles.php

$this->initTools($output);

if (is_object($user)) {
Check notice
Code scanning / Psalm
PossiblyUndefinedVariable
Possibly undefined variable $user, first seen on line 158

yemkareems added 3 commits February 13, 2024 09:05

cs fix ran
79b5410
cs fix ran Signed-off-by: yemkareems <yemkareems@gmail.com>

array multisort assigning to var and passing it
4058838
Signed-off-by: yemkareems <yemkareems@gmail.com>

userFolder type hint to fix psalm error
90f5d26
userFolder type hint to fix psalm error Signed-off-by: yemkareems <yemkareems@gmail.com>

AndyScherzinger reviewed Feb 13, 2024
View reviewed changes

Comment threadapps/files/lib/Command/ListFiles.php Outdated

Update apps/files/lib/Command/ListFiles.php
351d671
Co-authored-by: Andy Scherzinger <info@andy-scherzinger.de> Signed-off-by: yemkareems <yemkareems@gmail.com>

icewind1991 reviewed Feb 16, 2024
View reviewed changes

updated the description of path
0cfb4dd
updated the description of path Signed-off-by: yemkareems <yemkareems@gmail.com>

icewind1991 reviewed Feb 16, 2024
View reviewed changes

Comment threadapps/files/lib/Command/ListFiles.php

yemkareems added 2 commits February 18, 2024 09:01

making changes to list folders as directory type
fc20909
making changes to list folders as directory type Signed-off-by: yemkareems <yemkareems@gmail.com>

cs fix run for the file
14078fc
cs fix run for the file Signed-off-by: yemkareems <yemkareems@gmail.com>

artonge reviewed Apr 3, 2024
View reviewed changes

telling psalm correct path of folder
9b129a6

artonge reviewed Apr 4, 2024
View reviewed changes

Comment threadapps/files/lib/Command/ListFiles.php Outdated

feat: tell psalm the correct type associated with userFolder
57752e6

github-advanced-securityAI found potential problems Apr 4, 2024
View reviewed changes

Comment threadapps/files/lib/Command/ListFiles.php Fixed
Comment threadapps/files/lib/Command/ListFiles.php Fixed

feat: tell psalm the correct type associated with userFolder
e8573aa

github-advanced-securityAI found potential problems Apr 4, 2024
View reviewed changes

susnux reviewed Apr 4, 2024
View reviewed changes

Comment threadapps/files/lib/Command/ListFiles.php Outdated

feat: license wording changed as suggested
c5ded86

susnux added this to the Nextcloud 30 milestone Apr 18, 2024

yemkareems mentioned this pull request Jul 8, 2024
feat: add occ command files:list #46352
Draft
5 tasks

artonge closed this Jul 8, 2024

AndyScherzinger removed this from the Nextcloud 30 milestone Jul 8, 2024

	"owner" => $node->getOwner()->getDisplayName(),
	"owner" => $node->getOwner()?->getDisplayName(),

	* @copyright Copyright (c) 2024, ownCloud, Inc.
	* @copyright Copyright (c) 2024 Kareem <yemkareems@gmail.com>

Uh oh!

Uh oh!

Conversation

yemkareems commented Feb 5, 2024• edited by AndyScherzinger Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

TODO

Checklist

Uh oh!

yemkareems commented Feb 5, 2024

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Check notice

artongeFeb 12, 2024

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Check notice

Uh oh!

icewind1991Feb 16, 2024

Choose a reason for hiding this comment

Uh oh!

yemkareemsFeb 16, 2024

Choose a reason for hiding this comment

Uh oh!

icewind1991Feb 16, 2024

Choose a reason for hiding this comment

Uh oh!

yemkareemsFeb 18, 2024

Choose a reason for hiding this comment

Uh oh!

Uh oh!

artongeFeb 12, 2024

Choose a reason for hiding this comment

Uh oh!

artongeFeb 12, 2024

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Check notice

Uh oh!

artonge commented Jul 8, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

yemkareems commented Feb 5, 2024•
edited by AndyScherzinger
Loading