Let occ trashbin:restore restore also from groupfolders and add filters

[R0Wi]

Resolves: #39724

Summary

Let occ trashbin:restore restore also from groupfolders and add additional filters

• Using the TrashManager allows access to all deleted files
• Add 'scope' parameter to choose where to restore from (user or groupfolders)
• Add 'restore-from' and 'restore-to' date parameters to filter files to be
  restored by their deletion date
• Add 'dry-run' flag to be able to see which files would be restored and being
  able to adjust the filter parameters accordingly

Manual testcases

# Will still only restore user deleted files (backward compat)
php occ trashbin:restore --all-users
# Will only restore files from groupfolders visible to user "admin"
php occ trashbin:restore --scope groupfolders admin
# Will only list files to be restored
php occ trashbin:restore --all-users --dry-run
# Will only restore files from groupfolders which have been deleted between 01.08.2023 10:00 and 02.08.2023 11:55:02
php occ trashbin:restore --scope groupfolders --all-users --restore-from "01.08.2023 10:00" --restore-to "02.08.2023 11:55:02"# Will restore all files from all users (user-files and groupfolders)
php occ trashbin:restore --all-users --scope all

Showcase

Assume we have two files in our trashbin. One is Userfile.txt which was deleted from a users private directory. The other one is GroupfoldersFile.jpg which was deleted from a groupfolder gf1 where user admin (which we use for restore) has access to.

# Lets get a list of all deleted files ...
devcontainer@b03e2fb2a292:/var/www/html$ php occ trashbin:restore --dry-run --all-users --scope all 2>/dev/null Restoring deleted files for all users
Restoring deleted files for users on backend Database
admin
Would restore 2 files...
Would restore Userfile.txt originally deleted at August 12, 2023, 1:04:52 PM UTC to /Userfile.txt
Would restore GroupfoldersFile.jpg originally deleted at August 12, 2023, 1:04:45 PM UTC to /gf1/GroupfoldersFile.jpg

# Only show me the local ones and activate verbose output...
devcontainer@b03e2fb2a292:/var/www/html$ php occ trashbin:restore --dry-run --all-users --scope user -v 2>/dev/null Restoring deleted files for all users
Restoring deleted files for users on backend Database
admin
Skipping GroupfoldersFile.jpg because it is not a user trash item
Would restore 1 files...
Would restore Userfile.txt originally deleted at August 12, 2023, 1:04:52 PM UTC to /Userfile.txt

# Ok, only groupfolder ones please ...
devcontainer@b03e2fb2a292:/var/www/html$ php occ trashbin:restore --dry-run --all-users --scope groupfolders -v 2>/dev/null Restoring deleted files for all users
Restoring deleted files for users on backend Database
admin
Skipping Userfile.txt because it is not a groupfolders trash item
Would restore 1 files...
Would restore GroupfoldersFile.jpg originally deleted at August 12, 2023, 1:04:45 PM UTC to /gf1/GroupfoldersFile.jpg

# Let's try some time filtering, again with "all" deleted files and please be verbose about the filters...
devcontainer@b03e2fb2a292:/var/www/html$ php occ trashbin:restore --dry-run --all-users --scope all --restore-from "12.08.2023 13:04:44" --restore-to "12.08.2023 13:04:46" -v 2>/dev/null Restoring deleted files for all users
Restoring deleted files for users on backend Database
admin
Skipping Userfile.txt because it was deleted after the restore-to timestamp
Would restore 1 files...
Would restore GroupfoldersFile.jpg originally deleted at August 12, 2023, 1:04:45 PM UTC to /gf1/GroupfoldersFile.jpg

Note: I only used 2>/dev/null to cleanup the output in my dev environment. Should not be needed in production environments.

TODO

• Add new parameters and samples to occ documentation (done: Doc adjustments for occ trashbin:restore documentation#11011)
• Feedback about other implementations of ITrashBackend which would be found by the TrashManager: are there any of them and if yes, how to deal with them?

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)

[R0Wi]

CI errors seems unrelated

[come-nc]

Nice improvement of the command

[come-nc]

Did you test the command with groupfolders application not installed?

[R0Wi]

Did you test the command with groupfolders application not installed?

First of all thanks for your thorough review. Will try to incorporate the changes ASAP. Indeed I did not yet test it without the Groupfolders app installed but since there's no direct reference to it, it should work. I can do that after I've improved the code 👍

EDIT

Code improved and also tested without Groupfolders app. Works fine

[solracsf]

@R0Wi sorry but can you just insert in the 1st post the result of commands but with GF disabled, like:

php occ trashbin:restore --dry-run --all-users --scope groupfolders -v

Thanks 👍

[R0Wi]

@solracsf please find the test-script attached. Note that no groupfolders app was installed.

devcontainer@a9176d865258:/var/www/html$ php occ app:list 2>/dev/null
Enabled:
- cloud_federation_api: 1.11.0
- comments: 1.18.0
- contactsinteraction: 1.9.0
- dashboard: 7.8.0
- dav: 1.28.0
- federatedfilesharing: 1.18.0
- federation: 1.18.0
- files: 1.23.0
- files_reminders: 1.0.0
- files_sharing: 1.20.0
- files_trashbin: 1.18.0
- files_versions: 1.21.0
- lookup_server_connector: 1.16.0
- oauth2: 1.16.2
- provisioning_api: 1.18.0
- settings: 1.10.0
- sharebymail: 1.18.0
- systemtags: 1.18.0
- theming: 2.3.0
- twofactor_backupcodes: 1.17.0
- updatenotification: 1.18.0
- user_status: 1.8.0
- weather_status: 1.8.0
- workflowengine: 2.10.0
Disabled:
- admin_audit: 1.18.0
- encryption: 2.16.0
- files_external: 1.20.0
- testing: 1.18.0
- user_ldap: 1.19.0
devcontainer@a9176d865258:/var/www/html$ php occ trashbin:restore --dry-run --all-users --scope groupfolders -v 2>/dev/null
Restoring deleted files for all users
Restoring deleted files for users on backend Database
admin
Skipping welcome.txt because it is not a groupfolders trash item
User has no deleted files in the trashbin matching the given filters
devcontainer@a9176d865258:/var/www/html$ php occ trashbin:restore --dry-run --all-users --scope all 2>/dev/null Restoring deleted files for all users
Restoring deleted files for users on backend Database
admin
Would restore 1 files...
Would restore welcome.txt originally deleted at 14. August 2023, 10:43:41 UTC to /welcome.txt
devcontainer@a9176d865258:/var/www/html$ php occ trashbin:restore --dry-run --all-users --scope user -v 2>/dev/null Restoring deleted files for all users
Restoring deleted files for users on backend Database
admin
Would restore 1 files...
Would restore welcome.txt originally deleted at 14. August 2023, 10:43:41 UTC to /welcome.txt
devcontainer@a9176d865258:/var/www/html$ php occ trashbin:restore --dry-run --all-users --scope all --since "12.08.2023 13:04:44" --until "12.08.2023 13:04:46" -v 2>/dev/null Restoring deleted files for all users
Restoring deleted files for users on backend Database
admin
Skipping welcome.txt because it was deleted after the 'until' timestamp
User has no deleted files in the trashbin matching the given filters

Note that I adjusted the verbose output of the last command to match the new parameter names in 66c88cc

[R0Wi]

@come-nc@solracsf anything else to add here?

[solracsf]

Just waiting from reviews from core developpers :)

[artonge]

Looks good overall.
From what I read, it should work if groudfolders is not installed. Can you confirm that?

[artonge]

The goal is to display the groupfolder name ? Could the following work?

$userFolder = $this->rootFolder->getUserFolder($user->getUID());
$userFolder->get($trashItem->getOriginalLocation())->getMountPoint()->getInternalPath();

[R0Wi]

Looks good overall. From what I read, it should work if groudfolders is not installed. Can you confirm that?

That's correct. I tested both situations where the groupfolders app was installed and also without it being installed. That's why I removed the reference to the groupfolders app in ee66518#diff-0ab8d076ba91033c02327893677784c2ba7b49a391221c0a8c974430c529388dR293 and instead used a string for class matching. Unfortunately I did not find an alternative way to distinguish between regular user trash items and items coming from the groupfolders trash implementation.

[R0Wi]

@artonge I don't want to put too much preasure on this but any additional feedback would be really appreciated. My customer would be highly interested in this new feature. Thanks 👍

[R0Wi]

@come-nc anything to add from your side?

[come-nc]

I’m still uneasy about this getTitle thing but I do not have a better idea.

[artonge]

@R0Wi I'll let you merge if everything is good on your side :)

[R0Wi]

/backport to stable27