Let `occ trashbin:restore` restore also from groupfolders and add filters #39818

R0Wi · 2023-08-11T17:30:21Z

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)

apps/files_trashbin/lib/Command/RestoreAllFiles.php

R0Wi · 2023-08-13T11:41:54Z

CI errors seems unrelated

apps/files_trashbin/lib/Command/RestoreAllFiles.php

come-nc

Nice improvement of the command

apps/files_trashbin/lib/Command/RestoreAllFiles.php

build/psalm-baseline.xml

come-nc · 2023-08-14T08:33:05Z

Did you test the command with groupfolders application not installed?

R0Wi · 2023-08-14T09:54:20Z

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 · 2023-08-14T17:20:10Z

@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 · 2023-08-16T08:42:53Z

@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

…ional 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 Signed-off-by: GitHub <noreply@github.com>

Signed-off-by: GitHub <noreply@github.com>

* Delete unnecessary function docs * Rename parameters to 'since' and 'until' * Style: use '&&' instead of 'and' * Add types Signed-off-by: GitHub <noreply@github.com>

Signed-off-by: GitHub <noreply@github.com>

R0Wi · 2023-08-18T10:44:11Z

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

solracsf · 2023-08-18T16:10:14Z

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 · 2023-08-21T07:44:52Z

apps/files_trashbin/lib/Command/RestoreAllFiles.php

+			// We use getTitle() here instead of getOriginalLocation() because
+			// for groupfolders this contains the groupfolder name itself as prefix
+			// which makes it more human readable
+			$location = $trashItem->getTitle();


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 · 2023-08-21T08:57:41Z

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 · 2023-09-03T19:55:04Z

@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 · 2023-09-16T19:17:24Z

@come-nc anything to add from your side?

come-nc · 2023-09-18T08:26:00Z

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

artonge · 2023-09-18T08:37:39Z

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

R0Wi · 2023-09-22T10:49:12Z

/backport to stable27

R0Wi requested review from PVince81, icewind1991 and solracsf August 11, 2023 17:30

github-advanced-security bot found potential problems Aug 11, 2023

View reviewed changes

apps/files_trashbin/lib/Command/RestoreAllFiles.php Fixed Show fixed Hide fixed

apps/files_trashbin/lib/Command/RestoreAllFiles.php Fixed Show fixed Hide fixed

apps/files_trashbin/lib/Command/RestoreAllFiles.php Fixed Show fixed Hide fixed

szaimen added enhancement 2. developing Work in progress labels Aug 11, 2023

szaimen added this to the Nextcloud 28 milestone Aug 11, 2023

github-advanced-security bot found potential problems Aug 12, 2023

View reviewed changes

apps/files_trashbin/lib/Command/RestoreAllFiles.php Fixed Show fixed Hide fixed

R0Wi force-pushed the feature/trashbin-restore-improvements#39724 branch from 627a517 to d2581e5 Compare August 12, 2023 13:36

github-advanced-security bot found potential problems Aug 12, 2023

View reviewed changes

apps/files_trashbin/lib/Command/RestoreAllFiles.php Fixed Show resolved Hide resolved

apps/files_trashbin/lib/Command/RestoreAllFiles.php Fixed Show resolved Hide resolved

R0Wi mentioned this pull request Aug 12, 2023

Doc adjustments for occ trashbin:restore nextcloud/documentation#11011

Merged

1 task

AndyScherzinger requested review from come-nc and removed request for PVince81 August 12, 2023 14:17

solracsf reviewed Aug 13, 2023

View reviewed changes

apps/files_trashbin/lib/Command/RestoreAllFiles.php Outdated Show resolved Hide resolved

solracsf reviewed Aug 13, 2023

View reviewed changes

apps/files_trashbin/lib/Command/RestoreAllFiles.php Show resolved Hide resolved

solracsf changed the title ~~Let occ trashbin:restore restore also from groupfolders and add filters~~ Let occ trashbin:restore restore also from groupfolders and add filters Aug 13, 2023

solracsf added feature: trashbin feature: occ labels Aug 13, 2023

github-advanced-security bot found potential problems Aug 13, 2023

View reviewed changes

apps/files_trashbin/lib/Command/RestoreAllFiles.php Fixed Show resolved Hide resolved

come-nc reviewed Aug 14, 2023

View reviewed changes

solracsf added pending documentation This pull request needs an associated documentation update and removed pending documentation This pull request needs an associated documentation update labels Aug 14, 2023

R0Wi added 3 commits August 18, 2023 07:25

Decouple from groupfolders app & remove PSALM warnings

ee66518

Signed-off-by: GitHub <noreply@github.com>

Make scope parsing more readable

52d77eb

Signed-off-by: GitHub <noreply@github.com>

R0Wi added 2 commits August 18, 2023 07:25

Code adjustments according to PR review

acf0b4c

* Delete unnecessary function docs * Rename parameters to 'since' and 'until' * Style: use '&&' instead of 'and' * Add types Signed-off-by: GitHub <noreply@github.com>

Rename since/until in verbose message

d7a73ff

Signed-off-by: GitHub <noreply@github.com>

R0Wi force-pushed the feature/trashbin-restore-improvements#39724 branch from 66c88cc to d7a73ff Compare August 18, 2023 05:25

susnux requested a review from come-nc August 19, 2023 13:12

susnux added 3. to review Waiting for reviews and removed 2. developing Work in progress labels Aug 19, 2023

artonge reviewed Aug 21, 2023

View reviewed changes

R0Wi requested review from artonge and solracsf September 16, 2023 19:16

solracsf removed their request for review September 17, 2023 06:46

come-nc approved these changes Sep 18, 2023

View reviewed changes

artonge approved these changes Sep 18, 2023

View reviewed changes

R0Wi merged commit 7afcacd into master Sep 18, 2023
39 checks passed

R0Wi deleted the feature/trashbin-restore-improvements#39724 branch September 18, 2023 10:38

backportbot-nextcloud bot added the backport-request label Sep 22, 2023

backportbot-nextcloud bot mentioned this pull request Sep 22, 2023

[stable27] Let occ trashbin:restore restore also from groupfolders and add filters #40581

Merged

backportbot-nextcloud bot removed the backport-request label Sep 22, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Let `occ trashbin:restore` restore also from groupfolders and add filters #39818

Let `occ trashbin:restore` restore also from groupfolders and add filters #39818

R0Wi commented Aug 11, 2023 •

edited

Loading

R0Wi commented Aug 13, 2023

come-nc left a comment

come-nc commented Aug 14, 2023

R0Wi commented Aug 14, 2023 •

edited

Loading

solracsf commented Aug 14, 2023

R0Wi commented Aug 16, 2023

R0Wi commented Aug 18, 2023

solracsf commented Aug 18, 2023

artonge left a comment

artonge Aug 21, 2023

R0Wi commented Aug 21, 2023

R0Wi commented Sep 3, 2023

R0Wi commented Sep 16, 2023

come-nc commented Sep 18, 2023

artonge commented Sep 18, 2023

R0Wi commented Sep 22, 2023

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

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

Conversation

R0Wi commented Aug 11, 2023 • edited Loading

Summary

Manual testcases

Showcase

TODO

Checklist

R0Wi commented Aug 13, 2023

come-nc left a comment

Choose a reason for hiding this comment

come-nc commented Aug 14, 2023

R0Wi commented Aug 14, 2023 • edited Loading

solracsf commented Aug 14, 2023

R0Wi commented Aug 16, 2023

R0Wi commented Aug 18, 2023

solracsf commented Aug 18, 2023

artonge left a comment

Choose a reason for hiding this comment

artonge Aug 21, 2023

Choose a reason for hiding this comment

R0Wi commented Aug 21, 2023

R0Wi commented Sep 3, 2023

R0Wi commented Sep 16, 2023

come-nc commented Sep 18, 2023

artonge commented Sep 18, 2023

R0Wi commented Sep 22, 2023

Let `occ trashbin:restore` restore also from groupfolders and add filters #39818

Let `occ trashbin:restore` restore also from groupfolders and add filters #39818

R0Wi commented Aug 11, 2023 •

edited

Loading

R0Wi commented Aug 14, 2023 •

edited

Loading