add command for getting fileinfo for debugging by icewind1991 · Pull Request #37525 · nextcloud/server

icewind1991 · 2023-03-31T17:10:38Z

Attempts to provide information that might be useful when debugging issues as well as perform some sanity checks.
This hopefully allows people without knowledge of the Nextcloud internals to access debug information that is currently only accessible trough manual database querying or other convoluted steps.

occ info:file <fileid or path>

Currently includes:

basic file metadata
bucket + object info when using objectstore
validate object existence and size
list of users with access, their permissions and how they got their access
basic groupfolder and external storage info
option to list contents of folder
validate folder size against children

(Possible) future work

validate encrypted files
validate folder size
option to show versions
more details from storage backends
anything else that might be useful that currently isn't exposed

github-advanced-security

Psalm found more than 10 potential problems in the proposed changes. Check the Files changed tab for more details.

come-nc

Awesome tool.

Maybe instead of adding debug to the description, just remove debug mention from the command name since this may be useful in a whole number of usecase outside of debug? (like an admin wanting a list of shares of a file to check who has access)

icewind1991 · 2023-04-14T12:33:39Z

Changed the naming from debug:file to info:file
added (optional) listing of folder children
added size to output

+ $bucket = array_pop($parts);
+ $output->writeln(" bucket: " . $bucket);
+ if ($node instanceof \OC\Files\Node\File) {
+ $output->writeln(" object id: " . $storage->getURN($node->getId()));


Signed-off-by: Robin Appelman <robin@icewind.nl>

Pytal · 2023-04-18T00:16:21Z

In-place of the manual stdout formatting we could use the built-in Symfony methods https://symfony.com/doc/current/console/style.html#helper-methods ?

icewind1991 · 2023-05-01T13:40:03Z

/backport to stable26

icewind1991 · 2023-05-01T13:40:07Z

/backport to stable25

icewind1991 added the 3. to review Waiting for reviews label Mar 31, 2023

icewind1991 added this to the Nextcloud 27 milestone Mar 31, 2023

icewind1991 requested review from a team, ArtificialOwl, blizzz and come-nc and removed request for a teamMarch 31, 2023 17:10

github-advanced-securityAI found potential problems Mar 31, 2023
View reviewed changes

come-nc reviewed Apr 3, 2023
View reviewed changes

icewind1991 mentioned this pull request Apr 5, 2023
occ command to retrieve file information #35211
Closed

icewind1991 force-pushed the file-debug-info branch from 2743ec1 to c7410ffCompare April 14, 2023 12:34

github-advanced-securityAI found potential problems Apr 14, 2023
View reviewed changes

icewind1991 force-pushed the file-debug-info branch 2 times, most recently from 7858d4b to bbb2474Compare April 14, 2023 14:18

github-advanced-securityAI found potential problems Apr 14, 2023
View reviewed changes

Comment threadcore/Command/Info/File.php Fixed
Comment threadcore/Command/Info/File.php Fixed

icewind1991 force-pushed the file-debug-info branch 2 times, most recently from 1b6381a to 96f9c17Compare April 14, 2023 15:07

github-advanced-securityAI found potential problems Apr 14, 2023
View reviewed changes

Comment threadcore/Command/Info/File.php Fixed
Comment threadcore/Command/Info/File.php Fixed
Comment threadcore/Command/Info/File.php Fixed

icewind1991 force-pushed the file-debug-info branch from 96f9c17 to c99f3aeCompare April 14, 2023 15:16

github-advanced-securityAI found potential problems Apr 14, 2023
View reviewed changes

Comment threadcore/Command/Info/File.php Fixed

icewind1991 force-pushed the file-debug-info branch from c99f3ae to 579d37aCompare April 14, 2023 15:21

icewind1991 requested review from Pytal, artonge and juliusknorr April 14, 2023 15:56

icewind1991 mentioned this pull request Apr 14, 2023
command for getting user file information #37742
Closed

Pytal reviewed Apr 14, 2023
View reviewed changes

Comment threadcore/Command/Info/File.php Outdated

icewind1991 added 2 commits April 17, 2023 16:23

add command for getting fileinfo for debugging
60cf0c8
Signed-off-by: Robin Appelman <robin@icewind.nl>

validate that folder size sums to children
c5dfa1c
Signed-off-by: Robin Appelman <robin@icewind.nl>

icewind1991 force-pushed the file-debug-info branch from 579d37a to c5dfa1cCompare April 17, 2023 14:24

Pytal reviewed Apr 18, 2023
View reviewed changes

come-nc approved these changes Apr 20, 2023
View reviewed changes

blizzz approved these changes Apr 20, 2023
View reviewed changes

icewind1991 merged commit 1bff4e2 into masterApr 21, 2023

icewind1991 deleted the file-debug-info branch April 21, 2023 12:18

backportbot-nextcloudBot added the backport-request label Apr 21, 2023

nextcloud deleted a comment from backportbot-nextcloudBotApr 24, 2023

nextcloud deleted a comment from backportbot-nextcloudBotMay 1, 2023

This was referenced May 1, 2023
[stable26] add command for getting fileinfo for debugging #38005
Merged
[stable25] add command for getting fileinfo for debugging #38006
Merged

backportbot-nextcloudBot removed the backport-request label May 1, 2023

Uh oh!

Uh oh!

Conversation

icewind1991 commented Mar 31, 2023• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-advanced-securityAI left a comment

Choose a reason for hiding this comment

Uh oh!

come-nc left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

icewind1991 commented Apr 14, 2023

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Check notice

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

PytalApr 18, 2023

Choose a reason for hiding this comment

Uh oh!

icewind1991 commented May 1, 2023

Uh oh!

icewind1991 commented May 1, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

icewind1991 commented Mar 31, 2023•
edited
Loading