Skip to content

Commit

Permalink
Handle destination.one files without file name.
Browse files Browse the repository at this point in the history 
It is possible to have files such as
`https://dam.destination.one/2675868/3dc0a9dccd0dad46c73e669ece428c634ff8324ea3d01a4858a1c43169deed41/.jpg`.
Those were not handled correctly yet.
We now also handle those cases.
We will generate a hash from the URL as file name in order to still use those files.

Relates: #11396
  • Loading branch information
@d-s-codappix
d-s-codappix committed Sep 17, 2024
1 parent 17fae72 commit 404b5ae
Show file tree
Hide file tree
Showing 5 changed files with 177 additions and 13 deletions.
39 changes: 26 additions & 13 deletions Classes/Service/DestinationDataImportService/FilesAssignment.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@
use TYPO3\CMS\Core\Log\LogManager;
use TYPO3\CMS\Core\Resource\DuplicationBehavior;
use TYPO3\CMS\Core\Resource\File;
use TYPO3\CMS\Core\Resource\Folder;
use TYPO3\CMS\Core\Resource\Index\MetaDataRepository;
use TYPO3\CMS\Core\Resource\ResourceFactory;
use TYPO3\CMS\Core\Utility\GeneralUtility;
Expand Down Expand Up @@ -67,27 +68,26 @@ public function getImages(
}

$fileUrl = urldecode((string)$mediaObject['url']);
$orgFileNameSanitized = $importFolder->getStorage()->sanitizeFileName(basename($fileUrl));

$this->logger->info('File attached.', [$fileUrl, $orgFileNameSanitized]);

if ($importFolder->hasFile($orgFileNameSanitized)) {
$this->logger->info('File already exists.', [$orgFileNameSanitized]);
} elseif ($filename = $this->loadFile($fileUrl)) {
$this->logger->info('Adding file to FAL.', [$filename]);
$importFolder->addFile($filename, basename($fileUrl), DuplicationBehavior::REPLACE);
$fileName = $this->createFileName($fileUrl, $importFolder);
$this->logger->info('File attached.', [$fileUrl, $fileName]);

if ($importFolder->hasFile($fileName)) {
$this->logger->info('File already exists.', [$fileName]);
} elseif ($tempFileName = $this->loadFile($fileUrl)) {
$this->logger->info('Adding file to FAL.', [$fileName]);
$importFolder->addFile($tempFileName, $fileName, DuplicationBehavior::REPLACE);
} else {
continue;
}

if ($importFolder->hasFile($orgFileNameSanitized) === false) {
$this->logger->warning('Could not find file.', [$orgFileNameSanitized]);
if ($importFolder->hasFile($fileName) === false) {
$this->logger->warning('Could not find file.', [$fileName]);
continue;
}

$file = $importFolder->getStorage()->getFileInFolder($orgFileNameSanitized, $importFolder);
$file = $importFolder->getStorage()->getFileInFolder($fileName, $importFolder);
if (!$file instanceof File) {
$this->logger->warning('Could not find file.', [$orgFileNameSanitized]);
$this->logger->warning('Could not find file.', [$fileName]);
continue;
}

Expand All @@ -98,6 +98,19 @@ public function getImages(
return $images;
}

private function createFileName(string $url, Folder $importFolder): string
{
$extension = pathinfo($url, PATHINFO_EXTENSION);
$fileName = pathinfo($url, PATHINFO_FILENAME);
if ($fileName !== '' && $extension !== '') {
$fileName = basename($url);
} else {
$fileName = hash('sha256', $url) . '.' . $extension;
}

return $importFolder->getStorage()->sanitizeFileName($fileName);
}

private function loadFile(string $fileUrl): string
{
$this->logger->info('Getting file.', [$fileUrl]);
Expand Down
7 changes: 7 additions & 0 deletions Documentation/Changelog/4.2.1.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,13 @@ Fixes
back to `date_default_timezone_get()` call.
That way it should be useful for most systems out of the box.

* Handle destination.one files without file name.

It is possible to have files such as `https://dam.destination.one/2675868/3dc0a9dccd0dad46c73e669ece428c634ff8324ea3d01a4858a1c43169deed41/.jpg`.
Those were not handled correctly yet.
We now also handle those cases.
We will generate a hash from the URL as file name in order to still use those files.

Tasks
-----

Expand Down
42 changes: 42 additions & 0 deletions Tests/Functional/Import/DestinationDataTest/Assertions/ImportHandlesImageWithoutFileName.php
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
<?php

declare(strict_types=1);

use TYPO3\CMS\Core\Resource\File;

return [
'sys_file' => [
[
'uid' => 1,
'pid' => 0,
'missing' => 0,
'storage' => 1,
'type' => File::FILETYPE_IMAGE,
'identifier' => '/staedte/beispielstadt/events/bf126089c94f95031fa07bf9d7d9b10c3e58aafebdef31f0b60604da13019b8d.jpg',
'extension' => 'jpg',
'name' => 'bf126089c94f95031fa07bf9d7d9b10c3e58aafebdef31f0b60604da13019b8d.jpg',
],
],
'sys_file_reference' => [
[
'uid' => 1,
'pid' => 2,
'uid_local' => 1,
'uid_foreign' => 1,
'tablenames' => 'tx_events_domain_model_event',
'fieldname' => 'images',
'sorting_foreign' => 1,
'title' => null,
'description' => null,
'alternative' => null,
],
],
'sys_file_metadata' => [
[
'uid' => 1,
'pid' => 0,
'file' => 1,
'title' => null,
],
],
];
77 changes: 77 additions & 0 deletions ...s/Functional/Import/DestinationDataTest/Fixtures/ResponseWithNewImageWithoutFileName.json
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,77 @@
{
"status": "OK",
"count": 3,
"overallcount": 50,
"channels": [],
"facetGroups": [],
"items": [
{
"global_id": "e_100347853",
"id": "100347853",
"title": "Allerlei Weihnachtliches (Heute mit Johannes Geißer)",
"type": "Event",
"categories": [
"Weihnachten"
],
"texts": [
{
"rel": "details",
"type": "text/html",
"value": "Die Lichter sind entzündet, die Plätzchen duften, man rückt endlich wieder näher zusammen und lauscht den Geschichten. Vier Schauspieler*innen unseres Theaters überraschen mit ihren weihnachtlichen Texten, die sie für uns ausgewählt haben. Dazu plaudern sie über persönliche Anekdoten und erinnern sich an ihre schönsten und verrücktesten Weihnachtsfeste. Und da der Genuss in der Vorweihnachtszeit nicht fehlen darf, wird an jedem Adventssonntag eine andere weihnachtliche Spezialität serviert.<br>Eintritt: 10 € (inkl. Gedeck mit weihnachtlicher Schillerlocke)<br>Um Voranmeldung unter 03672-486470 oder&nbsp;<a data-cke-saved-href=\"mailto:[email protected]\" href=\"mailto:[email protected]\">[email protected]</a>&nbsp;wird gebeten. <br><strong>Es gilt die 2G-PLUS-Regel.</strong>&nbsp;<br>"
},
{
"rel": "details",
"type": "text/plain",
"value": "Die Lichter sind entzündet, die Plätzchen duften, man rückt endlich wieder näher zusammen und lauscht den Geschichten. Vier Schauspieler*innen unseres Theaters überraschen mit ihren weihnachtlichen Texten, die sie für uns ausgewählt haben. Dazu plaudern sie über persönliche Anekdoten und erinnern sich an ihre schönsten und verrücktesten Weihnachtsfeste. Und da der Genuss in der Vorweihnachtszeit nicht fehlen darf, wird an jedem Adventssonntag eine andere weihnachtliche Spezialität serviert.\nEintritt: 10 € (inkl. Gedeck mit weihnachtlicher Schillerlocke)\nUm Voranmeldung unter 03672-486470 oder [email protected] wird gebeten.\nEs gilt die 2G-PLUS-Regel."
},
{
"rel": "teaser",
"type": "text/html"
},
{
"rel": "teaser",
"type": "text/plain"
}
],
"areas": [
"Rudolstadt und Umgebung"
],
"city": "Rudolstadt",
"zip": "07407",
"street": "Schillerstraße 25",
"phone": "+ 49 3672 / 486470",
"fax": "+ 49 3672 / 486475",
"web": "http://www.schillerhaus.rudolstadt.de/",
"email": "[email protected]",
"author": "[email protected]",
"media_objects": [
{
"rel": "default",
"url": "https://dam.destination.one/849917/279ac45b3fc701a7197131f627164fffd9f8cc77bc75165e2fc2b864ed606920/.jpg",
"type": "image/jpeg",
"latitude": null,
"longitude": null,
"width": 1920,
"height": 1080,
"value": ""
}
],
"timeIntervals": [
{
"weekdays": [],
"start": "2022-12-19T15:00:00+01:00",
"end": "2022-12-19T16:30:00+01:00",
"tz": "Europe/Berlin",
"interval": 1
}
],
"name": "Schillerhaus Rudolstadt",
"created": "2022-10-31T12:29:00+00:00",
"changed": "2022-12-14T08:29:00+00:00",
"source": {
"url": "http://destination.one/",
"value": "destination.one"
}
}
]
}
25 changes: 25 additions & 0 deletions Tests/Functional/Import/DestinationDataTest/ImportHandlesImagesTest.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,31 @@ public function addsNewImages(): void
$this->assertEmptyLog();
}

#[Test]
public function addsNewImageWithoutFileName(): void
{
$this->setUpResponses([
new Response(200, [], file_get_contents(__DIR__ . '/Fixtures/ResponseWithNewImageWithoutFileName.json') ?: ''),
new Response(200, [], file_get_contents(__DIR__ . '/Fixtures/ExampleImage.jpg') ?: ''),
]);

$this->executeCommand();

$this->assertPHPDataSet(__DIR__ . '/Assertions/ImportHandlesImageWithoutFileName.php');

$importedFiles = GeneralUtility::getFilesInDir($this->fileImportPath);
self::assertIsArray($importedFiles, 'Failed to retrieve imported files from filesystem.');
self::assertSame(
[
'bf126089c94f95031fa07bf9d7d9b10c3e58aafebdef31f0b60604da13019b8d.jpg',
],
array_values($importedFiles),
'Got unexpected number of files'
);

$this->assertEmptyLog();
}

#[Test]
public function addsMultipleImagesToSingleEvent(): void
{
Expand Down

0 comments on commit 404b5ae

Please sign in to comment.