Skip to content

feat: add option to include external storage when transfering files #52378

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
icewind1991 merged 2 commits into from
May 14, 2025
Merged

feat: add option to include external storage when transfering files #52378

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2c0e576
feat: add option to include external storage when transfering files
icewind1991 Apr 23, 2025
3a02d94
fix: handle transfering the root of a mountpoint
icewind1991 Apr 23, 2025
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
46 changes: 44 additions & 2 deletions apps/files/lib/Command/TransferOwnership.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,20 +11,26 @@

use OCA\Files\Exception\TransferOwnershipException;
use OCA\Files\Service\OwnershipTransferService;
use OCA\Files_External\Config\ConfigAdapter;
use OCP\Files\Mount\IMountManager;
use OCP\Files\Mount\IMountPoint;
use OCP\IConfig;
use OCP\IUser;
use OCP\IUserManager;
use Symfony\Component\Console\Command\Command;
use Symfony\Component\Console\Helper\QuestionHelper;
use Symfony\Component\Console\Input\InputArgument;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Input\InputOption;
use Symfony\Component\Console\Output\OutputInterface;
use Symfony\Component\Console\Question\ConfirmationQuestion;

class TransferOwnership extends Command {
public function __construct(
private IUserManager $userManager,
private OwnershipTransferService $transferService,
private IConfig $config,
private IMountManager $mountManager,
) {
parent::__construct();
}
Expand Down Expand Up @@ -60,6 +66,16 @@ protected function configure(): void {
InputOption::VALUE_OPTIONAL,
'transfer incoming user file shares to destination user. Usage: --transfer-incoming-shares=1 (value required)',
'2'
)->addOption(
'include-external-storage',
null,
InputOption::VALUE_NONE,
'include files on external storages, this will _not_ setup an external storage for the target user, but instead moves all the files from the external storages into the target users home directory',
)->addOption(
'force-include-external-storage',
null,
InputOption::VALUE_NONE,
'don\'t ask for confirmation for transferring external storages',
);
}

Expand Down Expand Up @@ -87,6 +103,31 @@ protected function execute(InputInterface $input, OutputInterface $output): int
return self::FAILURE;
}

$path = ltrim($input->getOption('path'), '/');
$includeExternalStorage = $input->getOption('include-external-storage');
if ($includeExternalStorage) {
$mounts = $this->mountManager->findIn('/' . rtrim($sourceUserObject->getUID() . '/files/' . $path, '/'));
/** @var IMountPoint[] $mounts */
$mounts = array_filter($mounts, fn ($mount) => $mount->getMountProvider() === ConfigAdapter::class);
if (count($mounts) > 0) {
$output->writeln(count($mounts) . ' external storages will be transferred:');
foreach ($mounts as $mount) {
$output->writeln(' - <info>' . $mount->getMountPoint() . '</info>');
}
$output->writeln('');
$output->writeln('<comment>Any other users with access to these external storages will lose access to the files.</comment>');
$output->writeln('');
if (!$input->getOption('force-include-external-storage')) {
/** @var QuestionHelper $helper */
$helper = $this->getHelper('question');
$question = new ConfirmationQuestion('Are you sure you want to transfer external storages? (y/N) ', false);
if (!$helper->ask($input, $output, $question)) {
return self::FAILURE;
}
}
}
}

try {
$includeIncomingArgument = $input->getOption('transfer-incoming-shares');

Expand All @@ -112,11 +153,12 @@ protected function execute(InputInterface $input, OutputInterface $output): int
$this->transferService->transfer(
$sourceUserObject,
$destinationUserObject,
ltrim($input->getOption('path'), '/'),
$path,
$output,
$input->getOption('move') === true,
false,
$includeIncoming
$includeIncoming,
$includeExternalStorage,
);
} catch (TransferOwnershipException $e) {
$output->writeln('<error>' . $e->getMessage() . '</error>');
Expand Down
79 changes: 64 additions & 15 deletions apps/files/lib/Service/OwnershipTransferService.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,10 +15,11 @@
use OC\User\NoUserException;
use OCA\Encryption\Util;
use OCA\Files\Exception\TransferOwnershipException;
use OCA\Files_External\Config\ConfigAdapter;
use OCP\Encryption\IManager as IEncryptionManager;
use OCP\Files\Config\IHomeMountProvider;
use OCP\Files\Config\IUserMountCache;
use OCP\Files\FileInfo;
use OCP\Files\IHomeStorage;
use OCP\Files\InvalidPathException;
use OCP\Files\IRootFolder;
use OCP\Files\Mount\IMountManager;
Expand Down Expand Up @@ -70,6 +71,7 @@ public function transfer(
bool $move = false,
bool $firstLogin = false,
bool $transferIncomingShares = false,
bool $includeExternalStorage = false,
): void {
$output = $output ?? new NullOutput();
$sourceUid = $sourceUser->getUID();
Expand Down Expand Up @@ -149,7 +151,8 @@ public function transfer(
$sourcePath,
$finalTarget,
$view,
$output
$output,
$includeExternalStorage,
);
$sizeDifference = $sourceSize - $view->getFileInfo($finalTarget)->getSize();

Expand Down Expand Up @@ -215,11 +218,14 @@ private function walkFiles(View $view, $path, Closure $callBack) {
*
* @throws TransferOwnershipException
*/
protected function analyse(string $sourceUid,
protected function analyse(
string $sourceUid,
string $destinationUid,
string $sourcePath,
View $view,
OutputInterface $output): void {
OutputInterface $output,
bool $includeExternalStorage = false,
): void {
$output->writeln('Validating quota');
$sourceFileInfo = $view->getFileInfo($sourcePath, false);
if ($sourceFileInfo === false) {
Expand Down Expand Up @@ -247,17 +253,22 @@ protected function analyse(string $sourceUid,
$encryptedFiles[] = $sourceFileInfo;
} else {
$this->walkFiles($view, $sourcePath,
function (FileInfo $fileInfo) use ($progress, $masterKeyEnabled, &$encryptedFiles) {
function (FileInfo $fileInfo) use ($progress, $masterKeyEnabled, &$encryptedFiles, $includeExternalStorage) {
if ($fileInfo->getType() === FileInfo::TYPE_FOLDER) {
$mount = $fileInfo->getMountPoint();
// only analyze into folders from main storage,
if (!$fileInfo->getStorage()->instanceOfStorage(IHomeStorage::class)) {
if (
$mount->getMountProvider() instanceof IHomeMountProvider ||
($includeExternalStorage && $mount->getMountProvider() instanceof ConfigAdapter)
) {
if ($fileInfo->isEncrypted()) {
/* Encrypted folder means e2ee encrypted, we cannot transfer it */
$encryptedFiles[] = $fileInfo;
}
return true;
} else {
return false;
}
if ($fileInfo->isEncrypted()) {
/* Encrypted folder means e2ee encrypted, we cannot transfer it */
$encryptedFiles[] = $fileInfo;
}
return true;
}
$progress->advance();
if ($fileInfo->isEncrypted() && !$masterKeyEnabled) {
Expand Down Expand Up @@ -399,11 +410,14 @@ private function collectIncomingShares(string $sourceUid,
/**
* @throws TransferOwnershipException
*/
protected function transferFiles(string $sourceUid,
protected function transferFiles(
string $sourceUid,
string $sourcePath,
string $finalTarget,
View $view,
OutputInterface $output): void {
OutputInterface $output,
bool $includeExternalStorage,
): void {
$output->writeln("Transferring files to $finalTarget ...");

// This change will help user to transfer the folder specified using --path option.
Expand All @@ -412,15 +426,50 @@ protected function transferFiles(string $sourceUid,
$view->mkdir($finalTarget);
$finalTarget = $finalTarget . '/' . basename($sourcePath);
}
if ($view->rename($sourcePath, $finalTarget, ['checkSubMounts' => false]) === false) {
throw new TransferOwnershipException('Could not transfer files.', 1);
$sourceInfo = $view->getFileInfo($sourcePath);

/// handle the external storages mounted at the root, or the admin specifying an external storage with --path
if ($sourceInfo->getInternalPath() === '' && $includeExternalStorage) {
$this->moveMountContents($view, $sourcePath, $finalTarget);
} else {
if ($view->rename($sourcePath, $finalTarget, ['checkSubMounts' => false]) === false) {
throw new TransferOwnershipException('Could not transfer files.', 1);
}
}

if ($includeExternalStorage) {
$nestedMounts = $this->mountManager->findIn($sourcePath);
foreach ($nestedMounts as $mount) {
if ($mount->getMountProvider() === ConfigAdapter::class) {
$relativePath = substr(trim($mount->getMountPoint(), '/'), strlen($sourcePath));
$this->moveMountContents($view, $mount->getMountPoint(), $finalTarget . $relativePath);
}
}
}

if (!is_dir("$sourceUid/files")) {
// because the files folder is moved away we need to recreate it
$view->mkdir("$sourceUid/files");
}
}

private function moveMountContents(View $rootView, string $source, string $target) {
if ($rootView->copy($source, $target)) {
// just doing `rmdir` on the mountpoint would cause it to try and unmount the storage
// we need to empty the contents instead
$content = $rootView->getDirectoryContent($source);
foreach ($content as $item) {
if ($item->getType() === FileInfo::TYPE_FOLDER) {
$rootView->rmdir($item->getPath());
} else {
$rootView->unlink($item->getPath());
}
}
} else {
throw new TransferOwnershipException("Could not transfer $source to $target");
}
}

/**
* @param string $targetLocation New location of the transfered node
* @param array<array{share: IShare, suffix: string}> $shares previously collected share information
Expand Down
Loading