Make time zone for slugs configurable (#66)

Slugs of dates are generated during import.
This might lead to confusion if the time zone differs from frontend.
Therefore the time zone is now configurable to allow adjustments for the
actual website.

A new interface `TimeZoneProviderInterface` is provided which can be re
configured to a different implementation.

The default implementation will use TYPO3s `SYS.phpTimeZone` setting,
with fall back to `date_default_timezone_get()` call.
That way it should be useful for most systems out of the box.

Resolves: #11345

Classes/Domain/TimeZone/TimeZoneProviderInterface.php

@@ -0,0 +1,31 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * Copyright (C) 2024 Daniel Siepmann <daniel.siepmann@codappix.com>
+ *
+ * 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\TimeZone;
+
+use DateTimeZone;
+
+interface TimeZoneProviderInterface
+{
+    public function getTimeZone(): DateTimeZone;
+}

Classes/Domain/TimeZone/Typo3ConfiguredTimeZoneProvider.php

@@ -0,0 +1,37 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * Copyright (C) 2024 Daniel Siepmann <daniel.siepmann@codappix.com>
+ *
+ * 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\TimeZone;
+
+use DateTimeZone;
+
+final class Typo3ConfiguredTimeZoneProvider implements TimeZoneProviderInterface
+{
+    public function getTimeZone(): DateTimeZone
+    {
+        $timeZone = $GLOBALS['TYPO3_CONF_VARS']['SYS']['phpTimeZone'] ?? null;
+        $timeZone = $timeZone ?: date_default_timezone_get();
+
+        return new DateTimeZone($timeZone);
+    }
+}

Classes/Service/DestinationDataImportService/Slugger/Date.php

@@ -24,18 +24,22 @@ declare(strict_types=1);
 namespace WerkraumMedia\Events\Service\DestinationDataImportService\Slugger;
 
 use DateTimeImmutable;
+use DateTimeZone;
 use TYPO3\CMS\Core\Database\ConnectionPool;
+use WerkraumMedia\Events\Domain\TimeZone\TimeZoneProviderInterface;
 
 final class Date implements SluggerType
 {
     public function __construct(
-        private readonly ConnectionPool $connectionPool
+        private readonly ConnectionPool $connectionPool,
+        private readonly TimeZoneProviderInterface $timeZoneProvider,
     ) {
     }
 
     public function prepareRecordForSlugGeneration(array $record): array
     {
-        $start = new DateTimeImmutable('@' . $record['start']);
+        $start = new DateTimeImmutable('@' . $record['start'], new DateTimeZone('UTC'));
+        $start = $start->setTimezone($this->timeZoneProvider->getTimeZone());
 
         $record['event-title'] = $this->getEventTitle((int)$record['event']);
         $record['start'] = $start->format('Y-m-d');

Documentation/Changelog/4.2.1.rst

@@ -0,0 +1,39 @@
+4.3.0
+=====
+
+Breaking
+--------
+
+Nothing
+
+Features
+--------
+
+Nothing
+
+Fixes
+-----
+
+* Make time zone for slugs configurable.
+
+  Slugs of dates are generated during import.
+  This might lead to confusion if the time zone differs from frontend.
+  Therefore the time zone is now configurable to allow adjustments for the actual
+  website.
+
+  A new interface `TimeZoneProviderInterface` is provided which can be re configured to a
+  different implementation.
+
+  The default implementation will use TYPO3s `SYS.phpTimeZone` setting, with fall
+  back to `date_default_timezone_get()` call.
+  That way it should be useful for most systems out of the box.
+
+Tasks
+-----
+
+Nothing
+
+Deprecation
+-----------
+
+Nothing

Tests/Functional/Import/DestinationDataTest/ImportsWithSystemConfiguredTimeZoneTest.php

@@ -0,0 +1,46 @@
+<?php
+
+declare(strict_types=1);
+
+namespace WerkraumMedia\Events\Tests\Functional\Import\DestinationDataTest;
+
+use DateTimeImmutable;
+use DateTimeZone;
+use GuzzleHttp\Psr7\Response;
+use PHPUnit\Framework\Attributes\Test;
+use PHPUnit\Framework\Attributes\TestDox;
+use TYPO3\CMS\Core\Utility\ArrayUtility;
+
+#[TestDox('DestinationData import')]
+class ImportsWithSystemConfiguredTimeZoneTest extends AbstractTestCase
+{
+    public function setUp(): void
+    {
+        ArrayUtility::mergeRecursiveWithOverrule($this->configurationToUseInTestInstance, [
+            'SYS' => [
+                'phpTimeZone' => 'Europe/Berlin',
+            ],
+        ]);
+
+        parent::setUp();
+
+        $this->setUpConfiguration([
+            'restUrl = https://example.com/some-path/',
+        ]);
+        $this->importPHPDataSet(__DIR__ . '/Fixtures/Database/DefaultImportConfiguration.php');
+        $this->setDateAspect(new DateTimeImmutable('2022-07-13', new DateTimeZone('UTC')));
+    }
+
+    #[Test]
+    public function withTYPO3TimeZone(): void
+    {
+        $this->setUpResponses([new Response(200, [], file_get_contents(__DIR__ . '/Fixtures/ResponseWithSingleDate.json') ?: '')]);
+
+        $this->executeCommand();
+
+        $dates = $this->getAllRecords('tx_events_domain_model_date');
+        self::assertSame('kurzfuehrung-historische-altstadt-2022-07-13t15-00-00', $dates[0]['slug']);
+
+        $this->assertEmptyLog();
+    }
+}

ext_emconf.php

@@ -9,7 +9,7 @@ $EM_CONF['events'] = [
     'author' => 'Dirk Koritnik, Daniel Siepmann',
     'author_email' => 'koritnik@werkraum-media.de, coding@daniel-siepmann.de',
     'state' => 'stable',
-    'version' => '4.2.0',
+    'version' => '4.2.1',
     'constraints' => [
         'depends' => [
             'typo3' => '',