[TASK] implement Symfony Translation Loader concept

solves: #15

Author: ulrichmathes

.github/workflows/release.yml

@@ -1,15 +1,17 @@
 name: release
 
 on:
-  push:
-    tags:
-      - "**"
+    push:
+        tags:
+            - "**"
 
 jobs:
-  terUpload:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v4
-      - uses: tomasnorre/typo3-upload-ter@v2.0.7
-        with:
-          api-token: ${{ secrets.TYPO3_API_TOKEN }}
+    terUpload:
+        runs-on: ubuntu-latest
+        steps:
+            -
+                uses: actions/checkout@v4
+            -
+                uses: tomasnorre/typo3-upload-ter@v2.0.7
+                with:
+                    api-token: ${{ secrets.TYPO3_API_TOKEN }}

Classes/Localization/CsvLocalizationParser.php

@@ -0,0 +1,92 @@
+<?php
+declare(strict_types=1);
+namespace Sitegeist\CsvLabels\Translation\Loader;
+
+use Symfony\Component\DependencyInjection\Attribute\Autoconfigure;
+use Symfony\Component\Translation\Exception\InvalidResourceException;
+use Symfony\Component\Translation\Exception\NotFoundResourceException;
+use Symfony\Component\Translation\Loader\LoaderInterface;
+use Symfony\Component\Translation\MessageCatalogue;
+use TYPO3\CMS\Core\Localization\Locales;
+use TYPO3\CMS\Core\Utility\GeneralUtility;
+
+#[Autoconfigure(tags: [['name' => 'translation.loader', 'format' => 'csv']])]
+class CsvLoader implements LoaderInterface
+{
+    private ?Locales $locales = null;
+
+    public function load(mixed $resource, string $locale, string $domain = 'messages'): MessageCatalogue
+    {
+        if (!file_exists($resource)) {
+            throw new NotFoundResourceException(\sprintf('File "%s" not found.', $resource), 1612282091);
+        }
+
+        try {
+            $file = new \SplFileObject($resource, 'r');
+            $file->setFlags(\SplFileObject::READ_CSV | \SplFileObject::SKIP_EMPTY);
+        } catch (\RuntimeException $e) {
+            throw new InvalidResourceException(\sprintf('File "%s" could not be opened.', $resource), 1767019766, $e);
+        }
+
+        if (!$file->valid()) {
+            throw new InvalidResourceException(\sprintf('File "%s" has invalid CSV content.', $resource), 1767623886);
+        }
+
+        $csvHeader = $file->current();
+        if ($csvHeader === false) {
+            return new MessageCatalogue($locale);
+        }
+
+        $this->locales = GeneralUtility::makeInstance(Locales::class);
+        $localeColumnIndex = $this->searchLocaleColumnIndex($csvHeader, $locale);
+        if ($localeColumnIndex === false) {
+            return new MessageCatalogue($locale);
+        }
+
+        foreach ($file as $lineNumber => $translation) {
+            if ($lineNumber === 0 || empty($translation[0])) {
+                continue;
+            }
+            $identifier = $translation[0];
+            if (isset($translation[$localeColumnIndex]) && $translation[$localeColumnIndex] !== '') {
+                $messages[$identifier] =  $translation[$localeColumnIndex];
+            }
+        }
+
+        return new MessageCatalogue($locale, [$domain => $messages]);
+    }
+
+    private function searchLocaleColumnIndex(array $csvHeader, string $locale): int|false
+    {
+        $localeChain = $this->buildLocaleFallbackChain($locale, $this->locales);
+
+        foreach ($localeChain as $currentLocale) {
+            $index = array_search($currentLocale, $csvHeader, true);
+            if ($index !== false) {
+                return $index;
+            }
+        }
+
+        return false;
+    }
+
+    private function buildLocaleFallbackChain(string $locale, Locales $locales): array
+    {
+        $chain = [$locale];
+
+        // e.g. de-DE -> de
+        if (str_contains($locale, '-')) {
+            [$baseLanguage] = explode('-', $locale, 2);
+            $chain[] = $baseLanguage;
+        } elseif (str_contains($locale, '_')) {
+            [$baseLanguage] = explode('_', $locale, 2);
+            $chain[] = $baseLanguage;
+        }
+
+        $chain = array_merge($chain, $this->locales->getLocaleDependencies($locale));
+
+        $chain[] = 'default';
+
+        return array_unique($chain);
+    }
+}

Classes/Translation/Loader/CsvLoader.php

@@ -18,7 +18,7 @@
         "issues": "https://github.com/sitegeist/csv-labels/issues"
     },
     "require": {
-        "typo3/cms-core": "^13.1 || ^12.2 || ^11.5 || ^10.4 || ^9.5"
+        "typo3/cms-core": "^14"
     },
     "require-dev": {
         "squizlabs/php_codesniffer": "^3.0",

composer.json

@@ -12,7 +12,7 @@
     'version' => '',
     'constraints' => [
         'depends' => [
-            'typo3' => '9.5.0-13.9.99',
+            'typo3' => '14.0.0-14.9.99',
             'php' => '7.4.0-8.9.99'
         ],
         'conflicts' => [

ext_emconf.php

@@ -1,14 +1,18 @@
 <?php
+declare(strict_types=1);
 
-call_user_func(function () {
-    // Add csv files to language format priorities
-    $languageFilePriority = \TYPO3\CMS\Core\Utility\GeneralUtility::trimExplode(
-        ',',
-        $GLOBALS['TYPO3_CONF_VARS']['SYS']['lang']['format']['priority']
-    );
-    $languageFilePriority[] = 'csv';
-    $GLOBALS['TYPO3_CONF_VARS']['SYS']['lang']['format']['priority'] = implode(',', $languageFilePriority);
-
-    // Register CSV parser for language files
-    $GLOBALS['TYPO3_CONF_VARS']['SYS']['lang']['parser']['csv'] = \Sitegeist\CsvLabels\Localization\CsvLocalizationParser::class;
-});
+use Sitegeist\CsvLabels\Translation\Loader\CsvLoader;
+use TYPO3\CMS\Core\Utility\GeneralUtility;
+
+defined('TYPO3') or die();
+
+// Add csv files to language format priorities
+$languageFilePriority = GeneralUtility::trimExplode(
+    ',',
+    $GLOBALS['TYPO3_CONF_VARS']['LANG']['format']['priority']
+);
+$languageFilePriority[] = 'csv';
+$GLOBALS['TYPO3_CONF_VARS']['LANG']['format']['priority'] = implode(',', $languageFilePriority);
+
+// Register CSV loader for language files
+$GLOBALS['TYPO3_CONF_VARS']['LANG']['loader']['csv'] = CsvLoader::class;