Skip to content

[stable31] fix(trashbin): keep cache and db consistent #59565

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
backportbot wants to merge 8 commits into
base: stable31
Choose a base branch
from
+171 −30
Open

[stable31] fix(trashbin): keep cache and db consistent #59565

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
efb1be9
fix: keep trashbin cache and db in sync
hweihwang Jan 6, 2026
dc90d59
fix(trashbin): keep metadata consistent on move
hweihwang Jan 6, 2026
e7641f7
perf(trashbin): avoid full rescan for uncached moves
hweihwang Jan 6, 2026
92c4a22
chore: deduplicate trashbin row delete logic
icewind1991 Apr 1, 2026
3ff73d0
test: add test for trashbin when cross-storage move fails
icewind1991 Apr 1, 2026
c9ae798
fix: catch all exceptions during trashbin cache move
icewind1991 Apr 1, 2026
9c3416e
chore: psalm fix
icewind1991 Apr 1, 2026
185f427
test: skip testTrashEntryCreatedWhenSourceNotInCache on object store
icewind1991 Apr 1, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
118 changes: 88 additions & 30 deletions apps/files_trashbin/lib/Trashbin.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -291,18 +291,65 @@ public static function move2trash($file_path, $ownerOnly = false) {

$configuredTrashbinSize = static::getConfiguredTrashbinSize($owner);
if ($configuredTrashbinSize >= 0 && $sourceInfo->getSize() >= $configuredTrashbinSize) {
$trashStorage->releaseLock($trashInternalPath, ILockingProvider::LOCK_EXCLUSIVE, $lockingProvider);
return false;
}

// there is still a possibility that the file has been deleted by a remote user
$deletedBy = self::overwriteDeletedBy($user);

$query = Server::get(IDBConnection::class)->getQueryBuilder();
$query->insert('files_trash')
->setValue('id', $query->createNamedParameter($filename))
->setValue('timestamp', $query->createNamedParameter($timestamp))
->setValue('location', $query->createNamedParameter($location))
->setValue('user', $query->createNamedParameter($owner))
->setValue('deleted_by', $query->createNamedParameter($deletedBy));
$inserted = false;
try {
$moveSuccessful = true;
$inserted = ($query->executeStatement() === 1);
} catch (\Throwable $e) {
Server::get(LoggerInterface::class)->error(
'trash bin database insert failed',
[
'app' => 'files_trashbin',
'exception' => $e,
'user' => $owner,
'filename' => $filename,
'timestamp' => $timestamp,
]
);
}
if (!$inserted) {
Server::get(LoggerInterface::class)->error(
'trash bin database couldn\'t be updated, skipping trash move',
[
'app' => 'files_trashbin',
'user' => $owner,
'filename' => $filename,
'timestamp' => $timestamp,
]
);
$trashStorage->releaseLock($trashInternalPath, ILockingProvider::LOCK_EXCLUSIVE, $lockingProvider);
return false;
}

$moveSuccessful = true;
try {
$inCache = $sourceStorage->getCache()->inCache($sourceInternalPath);
$trashStorage->moveFromStorage($sourceStorage, $sourceInternalPath, $trashInternalPath);
if ($inCache) {
$trashStorage->getUpdater()->renameFromStorage($sourceStorage, $sourceInternalPath, $trashInternalPath);
} else {
$sizeDifference = $sourceInfo->getSize();
if ($sizeDifference < 0) {
$sizeDifference = null;
} else {
$sizeDifference = (int)$sizeDifference;
}
$trashStorage->getUpdater()->update($trashInternalPath, null, $sizeDifference);
}
} catch (CopyRecursiveException $e) {
} catch (\Exception $e) {
$moveSuccessful = false;
if ($trashStorage->file_exists($trashInternalPath)) {
$trashStorage->unlink($trashInternalPath);
Expand All @@ -323,24 +370,31 @@ public static function move2trash($file_path, $ownerOnly = false) {
} else {
$trashStorage->getUpdater()->remove($trashInternalPath);
}
return false;
$moveSuccessful = false;
}

if ($moveSuccessful) {
// there is still a possibility that the file has been deleted by a remote user
$deletedBy = self::overwriteDeletedBy($user);

$query = \OC::$server->getDatabaseConnection()->getQueryBuilder();
$query->insert('files_trash')
->setValue('id', $query->createNamedParameter($filename))
->setValue('timestamp', $query->createNamedParameter($timestamp))
->setValue('location', $query->createNamedParameter($location))
->setValue('user', $query->createNamedParameter($owner))
->setValue('deleted_by', $query->createNamedParameter($deletedBy));
$result = $query->executeStatement();
if (!$result) {
\OC::$server->get(LoggerInterface::class)->error('trash bin database couldn\'t be updated', ['app' => 'files_trashbin']);
if (!$moveSuccessful) {
Server::get(LoggerInterface::class)->error(
'trash move failed, removing trash metadata and payload',
[
'app' => 'files_trashbin',
'user' => $owner,
'filename' => $filename,
'timestamp' => $timestamp,
]
);
self::deleteTrashRow($user, $filename, $timestamp);
if ($trashStorage->file_exists($trashInternalPath)) {
if ($trashStorage->is_dir($trashInternalPath)) {
$trashStorage->rmdir($trashInternalPath);
} else {
$trashStorage->unlink($trashInternalPath);
}
}
$trashStorage->getUpdater()->remove($trashInternalPath);
}

if ($moveSuccessful) {
Util::emitHook('\OCA\Files_Trashbin\Trashbin', 'post_moveToTrash', ['filePath' => Filesystem::normalizePath($file_path),
'trashPath' => Filesystem::normalizePath(static::getTrashFilename($filename, $timestamp))]);

Expand Down Expand Up @@ -528,12 +582,7 @@ public static function restore($file, $filename, $timestamp) {
self::restoreVersions($view, $file, $filename, $uniqueFilename, $location, $timestamp);

if ($timestamp) {
$query = \OC::$server->getDatabaseConnection()->getQueryBuilder();
$query->delete('files_trash')
->where($query->expr()->eq('user', $query->createNamedParameter($user)))
->andWhere($query->expr()->eq('id', $query->createNamedParameter($filename)))
->andWhere($query->expr()->eq('timestamp', $query->createNamedParameter($timestamp)));
$query->executeStatement();
self::deleteTrashRow($user, $filename, $timestamp);
}

return true;
Expand Down Expand Up @@ -672,13 +721,6 @@ public static function delete($filename, $user, $timestamp = null) {
$size = 0;

if ($timestamp) {
$query = \OC::$server->getDatabaseConnection()->getQueryBuilder();
$query->delete('files_trash')
->where($query->expr()->eq('user', $query->createNamedParameter($user)))
->andWhere($query->expr()->eq('id', $query->createNamedParameter($filename)))
->andWhere($query->expr()->eq('timestamp', $query->createNamedParameter($timestamp)));
$query->executeStatement();

$file = static::getTrashFilename($filename, $timestamp);
} else {
$file = $filename;
Expand All @@ -689,6 +731,9 @@ public static function delete($filename, $user, $timestamp = null) {
try {
$node = $userRoot->get('/files_trashbin/files/' . $file);
} catch (NotFoundException $e) {
if ($timestamp) {
self::deleteTrashRow($user, $filename, $timestamp);
}
return $size;
}

Expand All @@ -702,9 +747,22 @@ public static function delete($filename, $user, $timestamp = null) {
$node->delete();
self::emitTrashbinPostDelete('/files_trashbin/files/' . $file);

if ($timestamp) {
self::deleteTrashRow($user, $filename, $timestamp);
}

return $size;
}

private static function deleteTrashRow(string $user, string $filename, int $timestamp): void {
$query = Server::get(IDBConnection::class)->getQueryBuilder();
$query->delete('files_trash')
->where($query->expr()->eq('user', $query->createNamedParameter($user)))
->andWhere($query->expr()->eq('id', $query->createNamedParameter($filename)))
->andWhere($query->expr()->eq('timestamp', $query->createNamedParameter($timestamp)));
$query->executeStatement();
}

/**
* @param string $file
* @param string $filename
Expand Down
83 changes: 83 additions & 0 deletions apps/files_trashbin/tests/StorageTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,16 +4,21 @@
* SPDX-FileCopyrightText: 2016 ownCloud, Inc.
* SPDX-License-Identifier: AGPL-3.0-only
*/

namespace OCA\Files_Trashbin\Tests;

use OC\Files\Cache\Updater;
use OC\Files\Filesystem;
use OC\Files\ObjectStore\ObjectStoreStorage;
use OC\Files\Storage\Common;
use OC\Files\Storage\Local;
use OC\Files\Storage\Temporary;
use OC\Files\View;
use OCA\Files_Trashbin\AppInfo\Application;
use OCA\Files_Trashbin\Events\MoveToTrashEvent;
use OCA\Files_Trashbin\Storage;
use OCA\Files_Trashbin\Trash\ITrashManager;
use OCA\Files_Trashbin\Trashbin;
use OCP\AppFramework\Bootstrap\IBootContext;
use OCP\AppFramework\Utility\ITimeFactory;
use OCP\Constants;
Expand Down Expand Up @@ -125,6 +130,84 @@ public function testSingleStorageDeleteFile(): void {
$this->assertEquals('test.txt', substr($name, 0, strrpos($name, '.')));
}

public function testTrashEntryCreatedWhenSourceNotInCache(): void {
$this->userView->file_put_contents('uncached.txt', 'foo');

[$storage, $internalPath] = $this->userView->resolvePath('uncached.txt');
if ($storage->instanceOfStorage(ObjectStoreStorage::class)) {
$this->markTestSkipped('object store always has the file in cache');
}
$cache = $storage->getCache();
$cache->remove($internalPath);
$this->assertFalse($cache->inCache($internalPath));

$this->userView->unlink('uncached.txt');

$results = $this->rootView->getDirectoryContent($this->user . '/files_trashbin/files/');
$this->assertCount(1, $results);
$name = $results[0]->getName();
$this->assertEquals('uncached.txt', substr($name, 0, strrpos($name, '.')));

[$trashStorage, $trashInternalPath] = $this->rootView->resolvePath('/' . $this->user . '/files_trashbin/files/' . $name);
$this->assertTrue($trashStorage->getCache()->inCache($trashInternalPath));
}

public function testTrashEntryNotCreatedWhenDeleteFailed(): void {
$storage2 = $this->getMockBuilder(Temporary::class)
->setConstructorArgs([])
->onlyMethods(['unlink', 'instanceOfStorage'])
->getMock();
$storage2->method('unlink')
->willReturn(false);

// disable same-storage move optimization
$storage2->method('instanceOfStorage')
->willReturnCallback(fn (string $class) => ($class !== Local::class) && (new Temporary([]))->instanceOfStorage($class));


Filesystem::mount($storage2, [], $this->user . '/files/substorage');
$this->userView->file_put_contents('substorage/test.txt', 'foo');

$this->assertFalse($this->userView->unlink('substorage/test.txt'));

$results = $this->rootView->getDirectoryContent($this->user . '/files_trashbin/files/');
$this->assertEmpty($results);

$trashData = Trashbin::getExtraData($this->user);
$this->assertEmpty($trashData);
}

public function testTrashEntryNotCreatedWhenCacheRowFailed(): void {
$trashStorage = $this->getMockBuilder(Temporary::class)
->setConstructorArgs([])
->onlyMethods(['getUpdater'])
->getMock();
$updater = $this->getMockBuilder(Updater::class)
->setConstructorArgs([$trashStorage])
->onlyMethods(['renameFromStorage'])
->getMock();
$trashStorage->method('getUpdater')
->willReturn($updater);
$updater->method('renameFromStorage')
->willThrowException(new \Exception());

Filesystem::mount($trashStorage, [], $this->user . '/files_trashbin');
$this->userView->file_put_contents('test.txt', 'foo');

try {
$this->assertFalse($this->userView->unlink('test.txt'));
$this->fail();
} catch (\Exception) {
// expected
}

$results = $this->rootView->getDirectoryContent($this->user . '/files_trashbin/files/');
$this->assertEmpty($results);

$trashData = Trashbin::getExtraData($this->user);
$this->assertEmpty($trashData);
}

/**
* Test that deleting a folder puts it into the trashbin.
*/
Expand Down
Loading