Skip to content

fix(files_sharing): don't abort share:list when orphaned shares exist #62060

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
Fantu wants to merge 1 commit into
base: master
Choose a base branch
from
+176 −13
Open

fix(files_sharing): don't abort share:list when orphaned shares exist #62060

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
37 changes: 24 additions & 13 deletions apps/files_sharing/lib/Command/ListShares.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,11 +72,17 @@ public function execute(InputInterface $input, OutputInterface $output): int {
});
$shares = iterator_to_array($shares);
$data = array_map(function (IShare $share) {
try {
$sourcePath = $share->getNode()->getPath();
} catch (NotFoundException) {
// orphaned share, source file no longer exists
$sourcePath = null;
}
return [
'id' => $share->getId(),
'file' => $share->getNodeId(),
'target-path' => $share->getTarget(),
'source-path' => $share->getNode()->getPath(),
'source-path' => $sourcePath,
'owner' => $share->getShareOwner(),
'recipient' => $share->getSharedWith(),
'by' => $share->getSharedBy(),
Expand Down Expand Up @@ -140,19 +146,24 @@ private function shouldShowShare(InputInterface $input, IShare $share): bool {
throw new \Exception("Parent {$parent->getPath()} is not a folder");
}
$recursive = $input->getOption('recursive');
if (!$recursive) {
$shareCacheEntry = $share->getNodeCacheEntry();
if (!$shareCacheEntry) {
$shareCacheEntry = $share->getNode();
}
if ($shareCacheEntry->getParentId() !== $parent->getId()) {
return false;
}
} else {
$shareNode = $share->getNode();
if ($parent->getRelativePath($shareNode->getPath()) === null) {
return false;
try {
if (!$recursive) {
$shareCacheEntry = $share->getNodeCacheEntry();
if (!$shareCacheEntry) {
$shareCacheEntry = $share->getNode();
}
if ($shareCacheEntry->getParentId() !== $parent->getId()) {
return false;
}
} else {
$shareNode = $share->getNode();
if ($parent->getRelativePath($shareNode->getPath()) === null) {
return false;
}
}
} catch (NotFoundException) {
// orphaned share, can't be inside the parent folder
return false;
}
}
if ($input->getOption('type') && $share->getShareType() !== $this->getShareType($input->getOption('type'))) {
Expand Down
152 changes: 152 additions & 0 deletions apps/files_sharing/tests/Command/ListSharesTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,152 @@
<?php

declare(strict_types=1);
/**
* SPDX-FileCopyrightText: 2026 Nextcloud GmbH and Nextcloud contributors
* SPDX-License-Identifier: AGPL-3.0-or-later
*/

namespace OCA\Files_Sharing\Tests\Command;

use OCA\Files_Sharing\Command\ListShares;
use OCP\Files\Cache\ICacheEntry;
use OCP\Files\Folder;
use OCP\Files\IRootFolder;
use OCP\Files\Node;
use OCP\Files\NotFoundException;
use OCP\Share\IManager;
use OCP\Share\IShare;
use PHPUnit\Framework\MockObject\MockObject;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Output\BufferedOutput;
use Test\TestCase;

class ListSharesTest extends TestCase {
private IManager&MockObject $shareManager;
private IRootFolder&MockObject $rootFolder;
private ListShares $command;

protected function setUp(): void {
parent::setUp();

$this->shareManager = $this->createMock(IManager::class);
$this->rootFolder = $this->createMock(IRootFolder::class);
$this->command = new ListShares($this->shareManager, $this->rootFolder);
}

private function createShare(int $id, ?Node $node, ?ICacheEntry $cacheEntry = null): IShare {
$share = $this->createMock(IShare::class);
$share->method('getId')->willReturn((string)$id);
$share->method('getNodeId')->willReturn($id * 100);
$share->method('getTarget')->willReturn("/target-$id");
$share->method('getShareOwner')->willReturn('owner');
$share->method('getSharedWith')->willReturn('recipient');
$share->method('getSharedBy')->willReturn('owner');
$share->method('getShareType')->willReturn(IShare::TYPE_USER);
$share->method('getNodeCacheEntry')->willReturn($cacheEntry);
if ($node === null) {
$share->method('getNode')->willThrowException(new NotFoundException('Node for share not found'));
} else {
$share->method('getNode')->willReturn($node);
}
return $share;
}

private function createNode(string $path, int $parentId = 0): Node {
$node = $this->createMock(Node::class);
$node->method('getPath')->willReturn($path);
$node->method('getParentId')->willReturn($parentId);
return $node;
}

private function createInput(array $options): InputInterface {
$options += [
'owner' => null,
'recipient' => null,
'by' => null,
'file' => null,
'parent' => null,
'recursive' => false,
'type' => null,
'status' => null,
'output' => 'json',
];
$input = $this->createMock(InputInterface::class);
$input->method('getOption')
->willReturnCallback(fn (string $name) => $options[$name] ?? null);
return $input;
}

public function testListIncludesOrphanShare(): void {
$shares = [
$this->createShare(1, $this->createNode('/owner/files/document.txt')),
$this->createShare(2, null),
];
$this->shareManager->method('getAllShares')
->willReturn(new \ArrayIterator($shares));

$output = new BufferedOutput();
$exitCode = $this->command->execute($this->createInput([]), $output);

$this->assertSame(0, $exitCode);
$rows = json_decode($output->fetch(), true);
$this->assertCount(2, $rows);
$this->assertSame('/owner/files/document.txt', $rows[0]['source-path']);
$this->assertNull($rows[1]['source-path']);
}

public function testParentFilterSkipsOrphanShare(): void {
$parent = $this->createMock(Folder::class);
$parent->method('getId')->willReturn(42);
$this->rootFolder->method('get')
->with('/owner/files/folder')
->willReturn($parent);

$cacheEntry = $this->createMock(ICacheEntry::class);
$cacheEntry->method('getParentId')->willReturn(42);
$shares = [
$this->createShare(1, $this->createNode('/owner/files/folder/document.txt'), $cacheEntry),
$this->createShare(2, null),
];
$this->shareManager->method('getAllShares')
->willReturn(new \ArrayIterator($shares));

$output = new BufferedOutput();
$exitCode = $this->command->execute($this->createInput(['parent' => '/owner/files/folder']), $output);

$this->assertSame(0, $exitCode);
$rows = json_decode($output->fetch(), true);
$this->assertCount(1, $rows);
$this->assertSame('1', $rows[0]['id']);
}

public function testRecursiveParentFilterSkipsOrphanShare(): void {
$parent = $this->createMock(Folder::class);
$parent->method('getId')->willReturn(42);
$parent->method('getRelativePath')
->willReturnCallback(fn (string $path) => str_starts_with($path, '/owner/files/folder/')
? substr($path, strlen('/owner/files/folder'))
: null);
$this->rootFolder->method('get')
->with('/owner/files/folder')
->willReturn($parent);

$shares = [
$this->createShare(1, $this->createNode('/owner/files/folder/sub/document.txt')),
$this->createShare(2, null),
];
$this->shareManager->method('getAllShares')
->willReturn(new \ArrayIterator($shares));

$output = new BufferedOutput();
$exitCode = $this->command->execute(
$this->createInput(['parent' => '/owner/files/folder', 'recursive' => true]),
$output,
);

$this->assertSame(0, $exitCode);
$rows = json_decode($output->fetch(), true);
$this->assertCount(1, $rows);
$this->assertSame('1', $rows[0]['id']);
}
}