Skip to content
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.

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

Support import of HTML variant for detail text #65

Merged
merged 1 commit into from
Aug 20, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
9 changes: 8 additions & 1 deletion Classes/Domain/Model/Import.php
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@

use TYPO3\CMS\Core\Resource\Folder;
use TYPO3\CMS\Extbase\DomainObject\AbstractDomainObject;
use WerkraumMedia\Events\Domain\Model\Import\Features;

/**
* Actual request to import.
Expand All @@ -26,7 +27,8 @@ public function __construct(
protected ?Category $categoryParent = null,
int $featuresPid = 0,
protected ?Category $featuresParent = null,
protected ?Region $region = null
protected ?Region $region = null,
protected int $importFeatures = 0,
) {
// Do not allow categories on pid 0
if ($categoriesPid === 0) {
Expand Down Expand Up @@ -85,4 +87,9 @@ public function getSearchQuery(): string
{
return $this->restSearchQuery;
}

public function getFeatures(): Features
{
return new Features($this->importFeatures);
}
}
36 changes: 36 additions & 0 deletions Classes/Domain/Model/Import/Features.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
<?php

declare(strict_types=1);

/*
* Copyright (C) 2024 Daniel Siepmann <[email protected]>
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation; either version 2
* of the License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
* 02110-1301, USA.
*/

namespace WerkraumMedia\Events\Domain\Model\Import;

use TYPO3\CMS\Core\Type\BitSet;

final class Features extends BitSet
{
public const HTML_FOR_DETAIL = 0b1;

public function hasHtmlForDetailEnabled(): bool
{
return $this->get(self::HTML_FOR_DETAIL);
}
}
45 changes: 39 additions & 6 deletions Classes/Service/DestinationDataImportService.php
Original file line number Diff line number Diff line change
Expand Up @@ -356,25 +356,58 @@ private function hasRelation(string $needle, array $haystack): bool
private function setTexts(array $texts): void
{
$shouldSetPrice = true;
$detailText = '';

foreach ($texts as $text) {
if (isset($text['value']) === false) {
if (
isset($text['value']) === false
|| is_string($text['value']) === false
) {
continue;
}

if ($text['rel'] == 'details' && $text['type'] == 'text/plain') {
$this->tmpCurrentEvent->setDetails(str_replace("\n\n", "\n", (string)$text['value']));
$value = str_replace("\n\n", "\n", $text['value']);

if (
$text['rel'] == 'details'
&& $text['type'] == 'text/html'
&& $this->import->getFeatures()->hasHtmlForDetailEnabled()
&& $value
) {
$detailText = $value;
continue;
}

if (
$text['rel'] == 'details'
&& $text['type'] == 'text/plain'
&& (
$this->import->getFeatures()->hasHtmlForDetailEnabled() === false
|| $detailText === ''
)
) {
$detailText = $value;
continue;
}

if ($text['rel'] == 'teaser' && $text['type'] == 'text/plain') {
$this->tmpCurrentEvent->setTeaser(str_replace("\n\n", "\n", (string)$text['value']));
$this->tmpCurrentEvent->setTeaser($value);
continue;
}

if ($shouldSetPrice && $text['rel'] == 'PRICE_INFO_EXTRA' && $text['type'] == 'text/plain') {
$shouldSetPrice = false;
$this->tmpCurrentEvent->setPriceInfo(str_replace("\n\n", "\n", (string)$text['value']));
$this->tmpCurrentEvent->setPriceInfo($value);
continue;
}

if ($shouldSetPrice && $text['rel'] == 'PRICE_INFO' && $text['type'] == 'text/plain') {
$this->tmpCurrentEvent->setPriceInfo(str_replace("\n\n", "\n", (string)$text['value']));
$this->tmpCurrentEvent->setPriceInfo($value);
continue;
}
}

$this->tmpCurrentEvent->setDetails($detailText);
}

private function getOrCreateEvent(string $globalId, string $title): Event
Expand Down
30 changes: 29 additions & 1 deletion Configuration/TCA/tx_events_domain_model_import.php
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,20 @@
],
'types' => [
'1' => [
'showitem' => 'title, hidden, --div--;LLL:EXT:events/Resources/Private/Language/locallang_csh_import.xlf:tx_events_domain_model_import.div.typo3, --palette--;;typo3_storage, --palette--;;categories, --palette--;;features,--palette--;;relations, --div--;LLL:EXT:events/Resources/Private/Language/locallang_csh_import.xlf:tx_events_domain_model_import.div.rest, rest_experience, rest_search_query',
'showitem' => implode(',', [
'title',
'hidden',
'--div--;LLL:EXT:events/Resources/Private/Language/locallang_csh_import.xlf:tx_events_domain_model_import.div.typo3',
'--palette--;;typo3_storage',
'--palette--;;categories',
'--palette--;;features',
'-palette--;;relations',
'--div--;LLL:EXT:events/Resources/Private/Language/locallang_csh_import.xlf:tx_events_domain_model_import.div.rest',
'rest_experience',
'rest_search_query',
'--div--;LLL:EXT:events/Resources/Private/Language/locallang_csh_import.xlf:tx_events_domain_model_import.div.import',
'import_features',
]),
],
],
'palettes' => [
Expand Down Expand Up @@ -169,5 +182,20 @@
'max' => 255,
],
],
'import_features' => [
'exclude' => true,
'label' => 'LLL:EXT:events/Resources/Private/Language/locallang_csh_import.xlf:tx_events_domain_model_import.import_features',
'description' => 'LLL:EXT:events/Resources/Private/Language/locallang_csh_import.xlf:tx_events_domain_model_import.import_features.description',
'config' => [
'type' => 'check',
'cols' => 'inline',
'default' => '0',
'items' => [
[
'label' => 'LLL:EXT:events/Resources/Private/Language/locallang_csh_import.xlf:tx_events_domain_model_import.import_features.html_for_detail',
],
],
],
],
],
];
33 changes: 33 additions & 0 deletions Documentation/Changelog/4.2.0.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
4.2.0
=====

Breaking
--------

Nothing

Features
--------

* Support HTML for detail text of events when importing data from destination.one.

This can be enabled within the import configuration. That way one can restrict the
HTML import to certain import configurations.

Ensure to adjust the templates when turning on the feature.
Either use `f:format.html` or `f:sanitize.html` as content might be unsafe.

Fixes
-----

Nothing

Tasks
-----

Nothing

Deprecation
-----------

Nothing
12 changes: 12 additions & 0 deletions Resources/Private/Language/locallang_csh_import.xlf
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,9 @@
<trans-unit id="tx_events_domain_model_import.div.rest">
<source>REST</source>
</trans-unit>
<trans-unit id="tx_events_domain_model_import.div.import">
<source>Import</source>
</trans-unit>
<trans-unit id="tx_events_domain_model_import.palette.relations">
<source>Relations</source>
</trans-unit>
Expand Down Expand Up @@ -81,6 +84,15 @@
<trans-unit id="tx_events_domain_model_import.rest_search_query.description">
<source>See: https://developer.et4.de/reference/current/#eT4META-search-param-q.html (todo check, was not loadable)</source>
</trans-unit>
<trans-unit id="tx_events_domain_model_import.import_features">
<source>Import Features</source>
</trans-unit>
<trans-unit id="tx_events_domain_model_import.import_features.description">
<source>Enable certain features related to the import.</source>
</trans-unit>
<trans-unit id="tx_events_domain_model_import.import_features.html_for_detail">
<source>HTML for Event Details</source>
</trans-unit>
</body>
</file>
</xliff>
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
<?php

declare(strict_types=1);

return [
'tx_events_domain_model_event' => [
0 => [
'uid' => '1',
'global_id' => 'e_100354481',
'details' => '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>',
],
],
];
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
<?php

declare(strict_types=1);

return [
'tx_events_domain_model_event' => [
0 => [
'uid' => '1',
'global_id' => 'e_100354481',
'details' => implode("\n", [
'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.',
'Eintritt: 10 € (inkl. Gedeck mit weihnachtlicher Schillerlocke)',
'Um Voranmeldung unter 03672-486470 oder [email protected] wird gebeten.',
'Es gilt die 2G-PLUS-Regel.',
]),
],
],
];
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
<?php

declare(strict_types=1);

return [
'tx_events_domain_model_event' => [
0 => [
'uid' => '1',
'global_id' => 'e_100354481',
'details' => implode("\n", [
'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.',
'Eintritt: 10 € (inkl. Gedeck mit weihnachtlicher Schillerlocke)',
'Um Voranmeldung unter 03672-486470 oder [email protected] wird gebeten.',
'Es gilt die 2G-PLUS-Regel.',
]),
],
],
];
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
<?php

declare(strict_types=1);

return [
'tx_events_domain_model_import' => [
[
'uid' => '1',
'pid' => '2',
'title' => 'Example import configuration',
'storage_pid' => '2',
'files_folder' => '1:/staedte/beispielstadt/events/',
'region' => '1',
'rest_experience' => 'beispielstadt',
'import_features' => '1',
],
],
];
Original file line number Diff line number Diff line change
@@ -0,0 +1,84 @@
{
"status": "OK",
"count": 1,
"overallcount": 50,
"channels": [],
"facetGroups": [],
"items": [
{
"global_id": "e_100354481",
"id": "100354481",
"type": "Event",
"country": "Deutschland",
"areas": [
"Rudolstadt und Umgebung"
],
"city": "Rudolstadt",
"zip": "07407",
"street": "Schulplatz 13",
"phone": "0 36 72 - 48 64 20",
"fax": "0 36 72 - 48 64 30",
"web": "http://www.stadtbibliothek-rudolstadt.de/",
"email": "[email protected]",
"author": "[email protected]",
"cuisine_types": [],
"payment": [],
"keywords": [],
"timeIntervals": [
{
"weekdays": [],
"start": "2022-07-13T15:00:00+02:00",
"end": "2022-07-13T16:30:00+02:00",
"tz": "Europe/Berlin",
"interval": 1
}
],
"numbers": [],
"name": "Stadtbibliothek Rudolstadt",
"attributes": [
],
"features": [
],
"addresses": [
{
"name": "Städtetourismus in Thüringen e.V.",
"city": "Weimar",
"zip": "99423",
"street": "UNESCO-Platz 1",
"phone": "+49 (3643) 745 314",
"web": "http://www.thueringer-staedte.de",
"email": "[email protected]",
"rel": "author"
}
],
"created": "2099-11-10T23:02:00+00:00",
"changed": "2099-12-14T08:28:00+00:00",
"source": {
"url": "http://destination.one/",
"value": "destination.one"
},
"company": "",
"district": "",
"postoffice": "",
"phone2": "",
"seasons": [],
"subitems": [],
"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."
}
],
"title": "Kurzf\u00fchrung - Historische Altstadt",
"type": "Event",
"web": "http://www.erfurt-tourismus.de/stadtfuehrung/individuell/kurzfuehrung-historische-altstadt/",
"zip": "99084"
}
]
}
Loading
Loading