feat: Allow to move files from external storage folder to cloudinary folder

SomeBdyElse · SomeBdyElse · commit bddd62e65043 · 2025-06-02T15:48:08.000+02:00
Instead of moving from storage to storage, allow to move
files from folder to cloudinary folder.
diff --git a/Classes/Command/AbstractCloudinaryCommand.php b/Classes/Command/AbstractCloudinaryCommand.php
@@ -9,12 +9,13 @@
  * LICENSE.md file that was distributed with this source code.
  */
 
-use Doctrine\DBAL\Driver\Connection;
 use Symfony\Component\Console\Input\InputInterface;
 use Symfony\Component\Console\Style\SymfonyStyle;
 use Symfony\Component\Console\Command\Command;
+use TYPO3\CMS\Core\Database\Connection;
 use TYPO3\CMS\Core\Database\ConnectionPool;
 use TYPO3\CMS\Core\Database\Query\QueryBuilder;
+use TYPO3\CMS\Core\Resource\Folder;
 use TYPO3\CMS\Core\Resource\ResourceStorage;
 use TYPO3\CMS\Core\Utility\GeneralUtility;
 use Visol\Cloudinary\Driver\CloudinaryDriver;
@@ -35,14 +36,15 @@ abstract class AbstractCloudinaryCommand extends Command
 
     protected string $tableName = 'sys_file';
 
-    protected function getFiles(ResourceStorage $storage, InputInterface $input): array
+    protected function getFiles(Folder $folder, InputInterface $input): array
     {
         $query = $this->getQueryBuilder($this->tableName);
         $query
             ->select('*')
             ->from($this->tableName)
             ->where(
-                $query->expr()->eq('storage', $storage->getUid()),
+                $query->expr()->eq('storage', $folder->getStorage()->getUid()),
+                $query->expr()->like('identifier', $query->createNamedParameter($query->escapeLikeWildcards($folder->getIdentifier(), Connection::PARAM_STR) . '%')),
                 $query->expr()->eq('missing', 0)
             );
 
diff --git a/Classes/Command/CloudinaryCopyCommand.php b/Classes/Command/CloudinaryCopyCommand.php
@@ -67,7 +67,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int
             return Command::INVALID;
         }
 
-        $files = $this->getFiles($this->sourceStorage, $input);
+        $files = $this->getFiles($this->sourceStorage->getRootLevelFolder(), $input);
 
         if (count($files) === 0) {
             $this->log('No files found, no work for me!');
diff --git a/Classes/Command/CloudinaryMoveCommand.php b/Classes/Command/CloudinaryMoveCommand.php
@@ -10,8 +10,13 @@
  */
 
 use Exception;
+use Psr\EventDispatcher\EventDispatcherInterface;
 use Symfony\Component\Console\Command\Command;
 use Symfony\Component\Console\Style\SymfonyStyle;
+use TYPO3\CMS\Core\Resource\Driver\DriverInterface;
+use TYPO3\CMS\Core\Resource\Event\AfterFileAddedEvent;
+use TYPO3\CMS\Core\Resource\Event\AfterFileMovedEvent;
+use TYPO3\CMS\Core\Resource\Index\Indexer;
 use TYPO3\CMS\Core\Resource\ResourceStorage;
 use TYPO3\CMS\Core\Utility\PathUtility;
 use Visol\Cloudinary\Services\FileMoveService;
@@ -31,13 +36,13 @@ class CloudinaryMoveCommand extends AbstractCloudinaryCommand
 
     protected array $missingFiles = [];
 
-    protected ResourceStorage $sourceStorage;
-
-    protected ResourceStorage $targetStorage;
+    public function __construct(
+        protected ResourceFactory $resourceFactory,
+        protected EventDispatcherInterface $eventDispatcher,
+    ) {
+        parent::__construct();
+    }
 
-    /**
-     * Configure the command by defining the name, options and arguments
-     */
     protected function configure(): void
     {
         $message = 'Move bunch of images to a cloudinary storage. Consult the README.md for more info.';
@@ -60,34 +65,38 @@ protected function initialize(InputInterface $input, OutputInterface $output): v
         $this->io = new SymfonyStyle($input, $output);
 
         $this->isSilent = $input->getOption('silent');
-
-        /** @var ResourceFactory $resourceFactory */
-        $resourceFactory = GeneralUtility::makeInstance(ResourceFactory::class);
-
-        $this->sourceStorage = $resourceFactory->getStorageObject($input->getArgument('source'));
-        $this->targetStorage = $resourceFactory->getStorageObject($input->getArgument('target'));
     }
 
     protected function execute(InputInterface $input, OutputInterface $output): int
     {
-        if (!$this->checkDriverType($this->targetStorage)) {
+        $source = $this->resourceFactory->getFolderObjectFromCombinedIdentifier($input->getArgument('source'));
+        $sourceStorage = $source->getStorage();
+        $sourceStorageDriver = $this->getStorageDriver($sourceStorage);
+
+        $target = $this->resourceFactory->getFolderObjectFromCombinedIdentifier($input->getArgument('target'));
+        $targetIndexer = GeneralUtility::makeInstance(Indexer::class, $target->getStorage());
+
+        if (!$sourceStorage->hasHierarchicalIdentifiers()) {
+            $this->log('Source storage must use hierarchical identifiers');
+            return Command::INVALID;
+        }
+        if (!$this->checkDriverType($target->getStorage())) {
             $this->log('Look out! target storage is not of type "cloudinary"');
             return Command::INVALID;
         }
 
-        $files = $this->getFiles($this->sourceStorage, $input);
-
+        $files = $this->getFiles($source, $input);
         if (count($files) === 0) {
             $this->log('No files found, no work for me!');
             return Command::SUCCESS;
         }
 
         $this->log('I will process %s files to be moved from storage "%s" (%s) to "%s" (%s)', [
             count($files),
-            $this->sourceStorage->getUid(),
-            $this->sourceStorage->getName(),
-            $this->targetStorage->getUid(),
-            $this->targetStorage->getName(),
+            $source->getCombinedIdentifier(),
+            $sourceStorage->getName(),
+            $target->getCombinedIdentifier(),
+            $target->getStorage()->getName(),
         ]);
 
         // A chance to the user to confirm the action
@@ -96,33 +105,36 @@ protected function execute(InputInterface $input, OutputInterface $output): int
 
             if (!$response) {
                 $this->log('Script aborted');
-
-        return Command::SUCCESS;
+                return Command::SUCCESS;
             }
         }
 
-        /** @var ResourceFactory $resourceFactory */
-        $resourceFactory = GeneralUtility::makeInstance(ResourceFactory::class);
-
         $counter = 0;
         foreach ($files as $file) {
             $this->log();
             $this->log('Starting migration with %s', [$file['identifier']]);
 
-            /** @var  $fileObject */
-            $fileObject = $resourceFactory->getFileObjectByStorageAndIdentifier($this->sourceStorage->getUid(), $file['identifier']);
+            /** @var File $fileObject */
+            $fileObject = $this->resourceFactory->getFileObject($file['uid'], $file);
+            $sourceFileExists = $fileObject->exists();
 
             if ($this->isFileSkipped($fileObject)) {
                 $this->log('Skipping file ' . $fileObject->getIdentifier());
                 // $this->skippedFiles[] = $fileObject->getIdentifier();
                 continue;
             }
 
-            if ($this->getFileMoveService()->fileExists($fileObject, $this->targetStorage)) {
+            if (! str_starts_with($fileObject->getIdentifier(), $source->getIdentifier())) {
+                throw new \LogicException('file is not in source folder', 1748004982814);
+            }
+
+            $newIdentifier = str_replace($source->getIdentifier(), $target->getIdentifier(), $fileObject->getIdentifier());
+
+            if ($this->getFileMoveService()->fileExists($target->getStorage(), $newIdentifier)) {
                 $this->log('File has already been uploaded, good for us %s', [$fileObject->getIdentifier()]);
             } else {
                 // Detect if the file is existing on storage "source" (1)
-                if (!$fileObject->exists() && !$input->getOption('base-url')) {
+                if (!$sourceFileExists && !$input->getOption('base-url')) {
                     $this->log('Missing file %s', [$fileObject->getIdentifier()], self::WARNING);
                     // We could log the missing files
                     $this->missingFiles[] = $fileObject->getIdentifier();
@@ -134,7 +146,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int
 
                 try {
                     $start = microtime(true);
-                    $this->getFileMoveService()->cloudinaryUploadFile($fileObject, $this->targetStorage, $input->getOption('base-url'));
+                    $this->getFileMoveService()->cloudinaryUploadFile($fileObject, $target, $newIdentifier, $input->getOption('base-url'));
                     $timeElapsedSeconds = microtime(true) - $start;
                     $this->log('File uploaded, Elapsed time %.3f', [$timeElapsedSeconds]);
                 } catch (Exception $e) {
@@ -148,9 +160,25 @@ protected function execute(InputInterface $input, OutputInterface $output): int
                 }
             }
 
-            // changing file storage and hard delete the file from the current storage
+            // Update sys_file entry
+            // See \TYPO3\CMS\Core\Resource\ResourceStorage::moveFile for reference
             $this->log('Changing storage for file %s', [$fileObject->getIdentifier()]);
-            $this->getFileMoveService()->changeStorage($fileObject, $this->targetStorage);
+            $oldIdentifier = $fileObject->getIdentifier();
+            $oldFolder = $fileObject->getParentFolder();
+            $fileObject->updateProperties(['storage' => $target->getStorage()->getUid(), 'identifier' => $newIdentifier]);
+            $newFolder = $fileObject->getParentFolder();
+            // clean up processed files
+            $this->eventDispatcher->dispatch(new AfterFileAddedEvent($fileObject, $newFolder));
+            $targetIndexer->updateIndexEntry($fileObject);
+
+            // Delete the file from the source storage without deleting the sys_file record
+            if ($sourceFileExists) {
+                $sourceStorageDriver->deleteFile($oldIdentifier);
+                $sourceFileExists = false;
+            }
+
+            $this->eventDispatcher->dispatch(new AfterFileMovedEvent($fileObject, $newFolder, $oldFolder));
+
             $counter++;
         }
         $this->log(LF);
@@ -208,4 +236,12 @@ protected function getFileMoveService(): FileMoveService
     {
         return GeneralUtility::makeInstance(FileMoveService::class);
     }
+
+    protected function getStorageDriver(ResourceStorage $storage): DriverInterface
+    {
+        $reflection = new \ReflectionClass($storage);
+        $property = $reflection->getProperty('driver');
+        $property->setAccessible(true);
+        return $property->getValue($storage);
+    }
 }
diff --git a/Classes/Services/FileMoveService.php b/Classes/Services/FileMoveService.php
@@ -16,6 +16,7 @@
 use TYPO3\CMS\Core\Database\ConnectionPool;
 use TYPO3\CMS\Core\Database\Query\QueryBuilder;
 use TYPO3\CMS\Core\Resource\File;
+use TYPO3\CMS\Core\Resource\Folder;
 use TYPO3\CMS\Core\Resource\ResourceStorage;
 use TYPO3\CMS\Core\Utility\GeneralUtility;
 use Visol\Cloudinary\Utility\CloudinaryApiUtility;
@@ -27,17 +28,19 @@ class FileMoveService
 
     protected ?CloudinaryPathService $cloudinaryPathService = null;
 
-    public function fileExists(File $fileObject, ResourceStorage $targetStorage): bool
+    public function fileExists(ResourceStorage $storage, string $identifier): bool
     {
-        $this->initializeCloudinaryService($targetStorage);
+        $this->initializeCloudinaryService($storage);
 
         // Retrieve the Public Id based on the file identifier
-        $publicId = $this->getCloudinaryPathService()
-            ->computeCloudinaryPublicId($fileObject->getIdentifier());
+        $publicId = $this->getCloudinaryPathService()->computeCloudinaryPublicId($identifier);
 
         try {
-            $resource = $this->getAdminApi($targetStorage)->asset($publicId);
+            $resource = $this->getAdminApi($storage)->asset($publicId);
             $fileExists = !empty($resource);
+            if ($fileExists) {
+                (new CloudinaryResourceService($storage))->save((array)$resource);
+            }
         } catch (Exception $exception) {
             $fileExists = false;
         }
@@ -74,34 +77,6 @@ public function fileExists(File $fileObject, ResourceStorage $targetStorage): bo
     #    return $isUpdated && $isDeletedFromSourceStorage;
     #}
 
-    public function changeStorage(File $fileObject, ResourceStorage $targetStorage, bool $removeFile = true): bool
-    {
-        // Update the storage uid
-        $isMigrated = (bool)$this->updateFile(
-            $fileObject,
-            [
-                'storage' => $targetStorage->getUid(),
-            ]
-        );
-
-        if ($removeFile) {
-            // Delete the file form the local storage
-            $isMigrated = unlink($this->getAbsolutePath($fileObject));
-        }
-
-        return $isMigrated;
-    }
-
-    protected function ensureDirectoryExistence(File $fileObject)
-    {
-
-        // Make sure the directory exists
-        $directory = dirname($this->getAbsolutePath($fileObject));
-        if (!is_dir($directory)) {
-            GeneralUtility::mkdir_deep($directory);
-        }
-    }
-
     protected function getAbsolutePath(File $fileObject): string
     {
         // Compute the absolute file name of the file to move
@@ -112,37 +87,34 @@ protected function getAbsolutePath(File $fileObject): string
 
     public function cloudinaryUploadFile(
         File $fileObject,
-        ResourceStorage $targetStorage,
+        Folder $targetFolder,
+        string $newIdentifier,
         string $baseUrl = ''
     ): void {
-
+        $targetStorage = $targetFolder->getStorage();
         $this->initializeCloudinaryService($targetStorage);
-
-        $this->ensureDirectoryExistence($fileObject);
-
-
-        $fileIdentifier = $fileObject->getIdentifier();
-        $publicId = $this->getCloudinaryPathService()
-            ->computeCloudinaryPublicId($fileIdentifier);
+        $publicId = $this->getCloudinaryPathService()->computeCloudinaryPublicId($newIdentifier);
 
         $options = [
             'public_id' => basename($publicId),
             'folder' => $this->getCloudinaryPathService()
                 ->computeCloudinaryFolderPath(
-                    $fileObject->getParentFolder()->getIdentifier()
+                    dirname($newIdentifier)
                 ),
-            'resource_type' => $this->getCloudinaryPathService()->getResourceType($fileIdentifier),
+            'resource_type' => $this->getCloudinaryPathService()->getResourceType($newIdentifier),
             'overwrite' => true,
         ];
         $fileNameAndPath = $baseUrl
-            ? rtrim($baseUrl, DIRECTORY_SEPARATOR) . $fileIdentifier
-            : $this->getAbsolutePath($fileObject);
+            ? rtrim($baseUrl, DIRECTORY_SEPARATOR) . $fileObject->getIdentifier()
+            : ($fileObject->getPublicUrl() ?: $fileObject->getForLocalProcessing(false));
 
         // Upload the file
-        $this->getUploadApi($targetStorage)->upload(
+        $response = $this->getUploadApi($targetStorage)->upload(
             $fileNameAndPath,
             $options
         );
+        $resource = (array)$response;
+        (new CloudinaryResourceService($targetStorage))->save($resource);
     }
 
     protected function getQueryBuilder(): QueryBuilder

Original file line number	Diff line number	Diff line change
`@@ -67,7 +67,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int`
`67`	`67`	`return Command::INVALID;`
`68`	`68`	`}`
`69`	`69`
`70`		`- $files = $this->getFiles($this->sourceStorage, $input);`
	`70`	`+ $files = $this->getFiles($this->sourceStorage->getRootLevelFolder(), $input);`
`71`	`71`
`72`	`72`	`if (count($files) === 0) {`
`73`	`73`	`$this->log('No files found, no work for me!');`