Skip to content

fix(files): Also restore shares after ownership transfer for object storage #44904

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

Merged
susnux merged 1 commit into from
Apr 18, 2024
Merged

fix(files): Also restore shares after ownership transfer for object storage #44904

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
fix(files): Also restore shares after ownership transfer for object s… 
…torage

When a file is moved between different storages then the file id is not (always) preserved.
This means the file id has to be adjusted for all shares.

So in case the file id does not exist anymore we try to find the new file id based on the
target path of the transfer and the path suffix of the share.

Signed-off-by: Ferdinand Thiessen <[email protected]>
  • Loading branch information
@susnux
susnux committed Apr 18, 2024
commit 38f4451a2368626d563aa27aa671df6fe2f9101d
111 changes: 73 additions & 38 deletions apps/files/lib/Service/OwnershipTransferService.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
* @author Roeland Jago Douma <[email protected]>
* @author Sascha Wiswedel <[email protected]>
* @author Tobia De Koninck <[email protected]>
* @author Ferdinand Thiessen <[email protected]>
*
* @license GNU AGPL version 3 or any later version
*
Expand All @@ -33,6 +34,7 @@
namespace OCA\Files\Service;

use Closure;
use OC\Encryption\Manager as EncryptionManager;
use OC\Files\Filesystem;
use OC\Files\View;
use OCA\Files\Exception\TransferOwnershipException;
Expand All @@ -41,6 +43,7 @@
use OCP\Files\FileInfo;
use OCP\Files\IHomeStorage;
use OCP\Files\InvalidPathException;
use OCP\Files\IRootFolder;
use OCP\Files\Mount\IMountManager;
use OCP\IUser;
use OCP\IUserManager;
Expand All @@ -58,31 +61,16 @@

class OwnershipTransferService {

/** @var IEncryptionManager */
private $encryptionManager;
private IEncryptionManager|EncryptionManager $encryptionManager;

/** @var IShareManager */
private $shareManager;

/** @var IMountManager */
private $mountManager;

/** @var IUserMountCache */
private $userMountCache;

/** @var IUserManager */
private $userManager;

public function __construct(IEncryptionManager $manager,
IShareManager $shareManager,
IMountManager $mountManager,
IUserMountCache $userMountCache,
IUserManager $userManager) {
$this->encryptionManager = $manager;
$this->shareManager = $shareManager;
$this->mountManager = $mountManager;
$this->userMountCache = $userMountCache;
$this->userManager = $userManager;
public function __construct(
IEncryptionManager $encryptionManager,
private IShareManager $shareManager,
private IMountManager $mountManager,
private IUserMountCache $userMountCache,
private IUserManager $userManager,
) {
$this->encryptionManager = $encryptionManager;
}

/**
Expand All @@ -95,13 +83,15 @@ public function __construct(IEncryptionManager $manager,
* @throws TransferOwnershipException
* @throws \OC\User\NoUserException
*/
public function transfer(IUser $sourceUser,
public function transfer(
IUser $sourceUser,
IUser $destinationUser,
string $path,
?OutputInterface $output = null,
bool $move = false,
bool $firstLogin = false,
bool $transferIncomingShares = false): void {
bool $transferIncomingShares = false,
): void {
$output = $output ?? new NullOutput();
$sourceUid = $sourceUser->getUID();
$destinationUid = $destinationUser->getUID();
Expand Down Expand Up @@ -183,10 +173,12 @@ public function transfer(IUser $sourceUser,
$output
);

$destinationPath = $finalTarget . '/' . $path;
// restore the shares
$this->restoreShares(
$sourceUid,
$destinationUid,
$destinationPath,
$shares,
$output
);
Expand Down Expand Up @@ -280,16 +272,35 @@ function (FileInfo $fileInfo) use ($progress) {
}
}

private function collectUsersShares(string $sourceUid,
/**
* @return array<array{share: IShare, suffix: string}>
*/
private function collectUsersShares(
string $sourceUid,
OutputInterface $output,
View $view,
string $path): array {
string $path,
): array {
$output->writeln("Collecting all share information for files and folders of $sourceUid ...");

$shares = [];
$progress = new ProgressBar($output);

foreach ([IShare::TYPE_GROUP, IShare::TYPE_USER, IShare::TYPE_LINK, IShare::TYPE_REMOTE, IShare::TYPE_ROOM, IShare::TYPE_EMAIL, IShare::TYPE_CIRCLE, IShare::TYPE_DECK, IShare::TYPE_SCIENCEMESH] as $shareType) {
$normalizedPath = Filesystem::normalizePath($path);

$supportedShareTypes = [
IShare::TYPE_GROUP,
IShare::TYPE_USER,
IShare::TYPE_LINK,
IShare::TYPE_REMOTE,
IShare::TYPE_ROOM,
IShare::TYPE_EMAIL,
IShare::TYPE_CIRCLE,
IShare::TYPE_DECK,
IShare::TYPE_SCIENCEMESH,
];

foreach ($supportedShareTypes as $shareType) {
$offset = 0;
while (true) {
$sharePage = $this->shareManager->getSharesBy($sourceUid, $shareType, null, true, 50, $offset);
Expand All @@ -298,17 +309,17 @@ private function collectUsersShares(string $sourceUid,
break;
}
if ($path !== "$sourceUid/files") {
$sharePage = array_filter($sharePage, function (IShare $share) use ($view, $path) {
$sharePage = array_filter($sharePage, function (IShare $share) use ($view, $normalizedPath) {
try {
$relativePath = $view->getPath($share->getNodeId());
$singleFileTranfer = $view->is_file($path);
$singleFileTranfer = $view->is_file($normalizedPath);
if ($singleFileTranfer) {
return Filesystem::normalizePath($relativePath) === Filesystem::normalizePath($path);
return Filesystem::normalizePath($relativePath) === $normalizedPath;
}

return mb_strpos(
Filesystem::normalizePath($relativePath . '/', false),
Filesystem::normalizePath($path . '/', false)) === 0;
$normalizedPath . '/') === 0;
} catch (\Exception $e) {
return false;
}
Expand All @@ -321,7 +332,11 @@ private function collectUsersShares(string $sourceUid,

$progress->finish();
$output->writeln('');
return $shares;

return array_map(fn (IShare $share) => [
'share' => $share,
'suffix' => substr(Filesystem::normalizePath($view->getPath($share->getNodeId())), strlen($normalizedPath)),
], $shares);
}

private function collectIncomingShares(string $sourceUid,
Expand Down Expand Up @@ -384,14 +399,22 @@ protected function transferFiles(string $sourceUid,
}
}

private function restoreShares(string $sourceUid,
/**
* @param string $targetLocation New location of the transfered node
* @param array<array{share: IShare, suffix: string}> $shares previously collected share information
*/
private function restoreShares(
string $sourceUid,
string $destinationUid,
string $targetLocation,
array $shares,
OutputInterface $output) {
OutputInterface $output,
):void {
$output->writeln("Restoring shares ...");
$progress = new ProgressBar($output, count($shares));
$rootFolder = \OCP\Server::get(IRootFolder::class);

foreach ($shares as $share) {
foreach ($shares as ['share' => $share, 'suffix' => $suffix]) {
try {
if ($share->getShareType() === IShare::TYPE_USER &&
$share->getSharedWith() === $destinationUid) {
Expand Down Expand Up @@ -419,7 +442,19 @@ private function restoreShares(string $sourceUid,
// trigger refetching of the node so that the new owner and mountpoint are taken into account
// otherwise the checks on the share update will fail due to the original node not being available in the new user scope
$this->userMountCache->clear();
$share->setNodeId($share->getNode()->getId());

try {
// Try to get the "old" id.
// Normally the ID is preserved,
// but for transferes between different storages the ID might change
$newNodeId = $share->getNode()->getId();
} catch (\OCP\Files\NotFoundException) {
// ID has changed due to transfer between different storages
// Try to get the new ID from the target path and suffix of the share
$node = $rootFolder->get(Filesystem::normalizePath($targetLocation . '/' . $suffix));
$newNodeId = $node->getId();
}
$share->setNodeId($newNodeId);

$this->shareManager->updateShare($share);
}
Expand Down