fix: catch ManuallyLockedException and use app context by max-nextcloud · Pull Request #37787 · nextcloud/server

max-nextcloud · 2023-04-18T08:24:21Z

Resolves: Old versions can not be restored from the sidebar because file is locked files_lock#123

Summary

The files_lock app may throw ManuallyLockedExceptions when attempting to revert a file that is currently opened. This would prevent the user from rolling back a opened file.

Text and Richdocuments handle changes of the file while editing. Allow reverting files even when they are locked by these apps and let the apps handle the conflict.

Alternatives considered

I tried to tackle this in lower levels first:

Inside the Storage\LockWrapper in files_lock - but it turns out we use different functions (rename and fopen) to rollback to an old version depending on the storage type. The fopen happens separatedly for the source and the target and therefore it's impossible to detect that it was triggered by a version rollback.
Inside the Storage of files_version - it's possible to get a hold of the actual node there. But it would only fix the issue in the normal version storage. Separate fixes would still be required for collectives and group_folders and any other versioning implementation.

So i think this is the easiest way to go.

TODO

checked if this could be moved into the files_lock app - looks like it cannot due to load order issues. Once the files_lock app is loaded other apps might already have dependency injected the VersionsManager. So we cannot change it from within the files_lock app.

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)

artonge

Typo, else nice 👍

max-nextcloud · 2023-04-19T07:02:26Z

/backport to stable26

max-nextcloud · 2023-04-19T07:02:43Z

/backport to stable25

max-nextcloud · 2023-04-19T07:02:50Z

/backport to stable24

+ if ($storage1->instanceOfStorage('\OC\Files\ObjectStore\ObjectStoreStorage') || $storage2->instanceOfStorage('\OC\Files\ObjectStore\ObjectStoreStorage')) {
+ $source = $storage1->fopen($internalPath1, 'r');
+ $target = $storage2->fopen($internalPath2, 'w');
+ [, $result] = \OC_Helper::streamCopy($source, $target);


+ $source = $storage1->fopen($internalPath1, 'r');
+ $target = $storage2->fopen($internalPath2, 'w');
+ [, $result] = \OC_Helper::streamCopy($source, $target);
+ fclose($source);


+ $target = $storage2->fopen($internalPath2, 'w');
+ [, $result] = \OC_Helper::streamCopy($source, $target);
+ fclose($source);
+ fclose($target);


- $storage1->unlink($internalPath1);
+ try {
+ // TODO add a proper way of overwriting a file while maintaining file ids
+ if ($storage1->instanceOfStorage('\OC\Files\ObjectStore\ObjectStoreStorage') || $storage2->instanceOfStorage('\OC\Files\ObjectStore\ObjectStoreStorage')) {


- $storage1->unlink($internalPath1);
+ try {
+ // TODO add a proper way of overwriting a file while maintaining file ids
+ if ($storage1->instanceOfStorage('\OC\Files\ObjectStore\ObjectStoreStorage') || $storage2->instanceOfStorage('\OC\Files\ObjectStore\ObjectStoreStorage')) {


+ if ($storage1->instanceOfStorage('\OC\Files\ObjectStore\ObjectStoreStorage') || $storage2->instanceOfStorage('\OC\Files\ObjectStore\ObjectStoreStorage')) {
+ $source = $storage1->fopen($internalPath1, 'r');
+ $target = $storage2->fopen($internalPath2, 'w');
+ [, $result] = \OC_Helper::streamCopy($source, $target);


The files_lock app may throw ManuallyLockedExceptions when attempting to revert a file that is currently opened. This would prevent the user from rolling back a opened file. Text and Richdocuments handle changes of the file while editing. Allow reverting files even when they are locked by these apps and let the apps handle the conflict. Signed-off-by: Max <max@nextcloud.com>

- $storage1->unlink($internalPath1);
+ try {
+ // TODO add a proper way of overwriting a file while maintaining file ids
+ if ($storage1->instanceOfStorage('\OC\Files\ObjectStore\ObjectStoreStorage') || $storage2->instanceOfStorage('\OC\Files\ObjectStore\ObjectStoreStorage')) {


juliusknorr · 2023-05-03T11:18:30Z

Failure unrelated

backportbot-nextcloud · 2023-05-03T12:35:03Z

The backport to stable24 failed. Please do this backport manually.

# Switch to the target branch and update it
git checkout stable24
git pull origin/stable24
# Create the new backport branch
git checkout -b fix/foo-stable24
# Cherry pick the change from the commit sha1 of the change against the default branch# This might cause conflicts. Resolve them.
git cherry-pick abc123
# Push the cherry pick commit to the remote repository and open a pull request
git push origin fix/foo-stable24

More info at https://docs.nextcloud.com/server/latest/developer_manual/getting_started/development_process.html#manual-backport

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

Comment threadapps/files_versions/lib/Versions/VersionManager.php Fixed
Comment threadapps/files_versions/lib/Versions/VersionManager.php Fixed
Comment threadapps/files_versions/lib/Versions/VersionManager.php Fixed
Comment threadapps/files_versions/lib/Versions/VersionManager.php Fixed

max-nextcloud force-pushed the fix/rollback-files-locked-by-apps branch 2 times, most recently from 249f13b to 2e84a3fCompare April 18, 2023 08:46

solracsf added this to the Nextcloud 27 milestone Apr 18, 2023

solracsf added the 3. to review Waiting for reviews label Apr 18, 2023

max-nextcloud force-pushed the fix/rollback-files-locked-by-apps branch from 2e84a3f to 254c039Compare April 18, 2023 08:47

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

Comment threadapps/files_versions/lib/Versions/VersionManager.php Fixed
Comment threadapps/files_versions/lib/Versions/VersionManager.php Fixed

max-nextcloud force-pushed the fix/rollback-files-locked-by-apps branch from 254c039 to 52db34bCompare April 18, 2023 08:56

max-nextcloud requested review from artonge, icewind1991 and juliusknorr April 18, 2023 09:05

artonge reviewed Apr 18, 2023
View reviewed changes

Comment threadapps/files_versions/lib/Versions/VersionManager.php Outdated
Comment threadapps/files_versions/lib/Versions/VersionManager.php Outdated

max-nextcloud force-pushed the fix/rollback-files-locked-by-apps branch 2 times, most recently from eba9a67 to f45f75fCompare April 18, 2023 11:44

max-nextcloud requested a review from artonge April 18, 2023 11:44

artonge approved these changes Apr 18, 2023
View reviewed changes

Comment threadapps/files_versions/lib/Versions/VersionManager.php Outdated

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

max-nextcloud force-pushed the fix/rollback-files-locked-by-apps branch 2 times, most recently from 71cb044 to 5378aa5Compare April 20, 2023 11:29

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

juliusknorr approved these changes May 3, 2023
View reviewed changes

juliusknorr added bug 4. to release Ready to be released and/or waiting for tests to finish and removed 3. to review Waiting for reviews labels May 3, 2023

max-nextcloud force-pushed the fix/rollback-files-locked-by-apps branch from 5378aa5 to 337fc11Compare May 3, 2023 07:53

github-advanced-securityAI found potential problems May 3, 2023
View reviewed changes

skjnldsv mentioned this pull request May 3, 2023
27.0.0 beta 1 #38038
Merged

juliusknorr merged commit 2c60ad8 into masterMay 3, 2023

juliusknorr deleted the fix/rollback-files-locked-by-apps branch May 3, 2023 11:18

This was referenced May 3, 2023
[stable26] fix: catch ManuallyLockedException and use app context #38043
Merged
[stable25] fix: catch ManuallyLockedException and use app context #38044
Merged

This was referenced May 8, 2023
[stable24] fix: catch ManuallyLockedException and use app context #38120
Closed
[stable24] fix: catch ManuallyLockedException and use app context #38121
Merged

skjnldsv removed the backport-request label Jan 15, 2024

Uh oh!

Uh oh!

Conversation

max-nextcloud commented Apr 18, 2023• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Alternatives considered

TODO

Checklist

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

artonge left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

max-nextcloud commented Apr 19, 2023

Uh oh!

max-nextcloud commented Apr 19, 2023

Uh oh!

max-nextcloud commented Apr 19, 2023

Uh oh!

Check notice

Check notice

Check notice

Check notice

Check notice

Check notice

Check notice

juliusknorr commented May 3, 2023

Uh oh!

backportbot-nextcloudBot commented May 3, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

max-nextcloud commented Apr 18, 2023•
edited
Loading