[TASK] Add TYPO3 v12 compatible TypoScript event

Classes/Configuration/PackageHelper.php

@@ -16,6 +16,8 @@
 use TYPO3\CMS\Core\Package\Exception\UnknownPackageException;
 use TYPO3\CMS\Core\Package\PackageInterface;
 use TYPO3\CMS\Core\Package\PackageManager;
+use TYPO3\CMS\Core\Site\Entity\Site;
+use TYPO3\CMS\Core\Site\Entity\SiteInterface;
 use TYPO3\CMS\Core\Site\SiteFinder;
 
 /**
@@ -57,4 +59,18 @@ public function getSitePackage(int $pageId): ?PackageInterface
             return null;
         }
     }
+
+    public function getSitePackageFromSite(Site $site): ?PackageInterface
+    {
+        $configuration = $site->getConfiguration();
+        if (!isset($configuration['sitePackage'])) {
+            return null;
+        }
+        $packageKey = (string)$configuration['sitePackage'];
+        try {
+            return $this->packageManager->getPackage($packageKey);
+        } catch (UnknownPackageException $_) {
+            return null;
+        }
+    }
 }

Classes/TypoScript/AddTypoScriptFromSiteExtensionEvent.php

@@ -0,0 +1,178 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * This file is part of TYPO3 CMS-based extension "bolt" by b13.
+ *
+ * It is free software; you can redistribute it and/or modify it under
+ * the terms of the GNU General Public License, either version 2
+ * of the License, or any later version.
+ */
+
+namespace B13\Bolt\TypoScript;
+
+use B13\Bolt\Configuration\PackageHelper;
+use TYPO3\CMS\Core\Site\Entity\Site;
+use TYPO3\CMS\Core\TypoScript\IncludeTree\Event\AfterTemplatesHaveBeenDeterminedEvent;
+
+/**
+ * Event listener in FE and BE (ext:tstemplate) to add a typoscript template "fake" sys_template
+ * row that auto-adds TypoScript when the site has a 'sitePackage' set and has a
+ * "Configuration/TypoScript/constants.typoscript" or "Configuration/TypoScript/setup.typoscript" file.
+ *
+ * Works with TYPO3 >= v12
+ */
+final class AddTypoScriptFromSiteExtensionEvent
+{
+    protected PackageHelper $packageHelper;
+
+    public function __construct(PackageHelper $packageHelper)
+    {
+        $this->packageHelper = $packageHelper;
+    }
+
+    public function __invoke(AfterTemplatesHaveBeenDeterminedEvent $event): void
+    {
+        $site = $event->getSite();
+        if (!$site instanceof Site) {
+            return;
+        }
+        $package = $this->packageHelper->getSitePackageFromSite($site);
+        if ($package === null) {
+            return;
+        }
+
+        $constantsFile = $package->getPackagePath() . 'Configuration/TypoScript/constants.typoscript';
+        $setupFile = $package->getPackagePath() . 'Configuration/TypoScript/setup.typoscript';
+        if (!file_exists($constantsFile)) {
+            $constantsFile = $package->getPackagePath() . 'Configuration/TypoScript/constants.txt';
+        }
+        if (!file_exists($setupFile)) {
+            $setupFile = $package->getPackagePath() . 'Configuration/TypoScript/setup.txt';
+        }
+
+        $constants = null;
+        if (file_exists($constantsFile)) {
+            $constants = (string)@file_get_contents($constantsFile);
+        }
+        $setup = null;
+        if (file_exists($setupFile)) {
+            $setup = (string)@file_get_contents($setupFile);
+        }
+
+        if (empty($constants) && empty($setup)) {
+            return;
+        }
+
+        $siteRootPageId = $site->getRootPageId();
+        $rootline = $event->getRootline();
+        $sysTemplateRows = $event->getTemplateRows();
+
+        $highestUid = 1;
+        foreach ($sysTemplateRows as $sysTemplateRow) {
+            if ((int)($sysTemplateRow['uid'] ?? 0) > $highestUid) {
+                $highestUid = (int)$sysTemplateRow['uid'];
+            }
+        }
+
+        $fakeRow = [
+            'uid' => $highestUid + 1,
+            'pid' => $siteRootPageId,
+            'title' => 'Site extension include EXT:' . $package->getPackageKey() . ' by EXT:bolt',
+            'root' => 1,
+            'clear' => 3,
+            'include_static_file' => null,
+            'constants' => (string)$constants,
+            'config' => (string)$setup,
+            // Add a flag. This might be useful for other event listeners that may want to manipulate again.
+            'isExtBoltFakeRow' => true,
+        ];
+        // Set various "db" fields conditionally to be as robust as possible in case
+        // core or some other loaded extension fiddles with them.
+        $deleteField = $GLOBALS['TCA']['sys_template']['ctrl']['delete'] ?? null;
+        if ($deleteField) {
+            $fakeRow[$deleteField] = 0;
+        }
+        $disableField = $GLOBALS['TCA']['sys_template']['ctrl']['enablecolumns']['disabled'] ?? null;
+        if ($disableField) {
+            $fakeRow[$disableField] = 0;
+        }
+        $endtimeField = $GLOBALS['TCA']['sys_template']['ctrl']['enablecolumns']['endtime'] ?? null;
+        if ($endtimeField) {
+            $fakeRow[$endtimeField] = 0;
+        }
+        $starttimeField = $GLOBALS['TCA']['sys_template']['ctrl']['enablecolumns']['starttime'] ?? null;
+        if ($starttimeField) {
+            $fakeRow[$starttimeField] = 0;
+        }
+        $sortbyField = $GLOBALS['TCA']['sys_template']['ctrl']['sortby'] ?? null;
+        if ($sortbyField) {
+            $fakeRow[$sortbyField] = 0;
+        }
+        $tstampField = $GLOBALS['TCA']['sys_template']['ctrl']['tstamp'] ?? null;
+        if ($tstampField) {
+            $fakeRow[$tstampField] = ($setup ? filemtime($setupFile) : null) ?? ($constants ? filemtime($constantsFile) : null) ?? time();
+        }
+        if ($GLOBALS['TCA']['sys_template']['columns']['basedOn'] ?? false) {
+            $fakeRow['basedOn'] = null;
+        }
+        if ($GLOBALS['TCA']['sys_template']['columns']['includeStaticAfterBasedOn'] ?? false) {
+            $fakeRow['includeStaticAfterBasedOn'] = 0;
+        }
+        if ($GLOBALS['TCA']['sys_template']['columns']['static_file_mode'] ?? false) {
+            $fakeRow['static_file_mode'] = 0;
+        }
+
+        if (empty($sysTemplateRows)) {
+            // Simple things first: If there are no sys_template records yet, add our fake row and done.
+            $sysTemplateRows[] = $fakeRow;
+            $event->setTemplateRows($sysTemplateRows);
+            return;
+        }
+
+        // When there are existing sys_template rows, we try to add our fake row at the most useful position.
+        $newSysTemplateRows = [];
+        $pidsBeforeSite = [0];
+        $reversedRootline = array_reverse($rootline);
+        foreach ($reversedRootline as $page) {
+            if (($page['uid'] ?? 0) !== $siteRootPageId) {
+                $pidsBeforeSite[] = (int)($page['uid'] ?? 0);
+            } else {
+                break;
+            }
+        }
+        $pidsBeforeSite = array_unique($pidsBeforeSite);
+
+        $fakeRowAdded = false;
+        foreach ($sysTemplateRows as $sysTemplateRow) {
+            if ($fakeRowAdded) {
+                // We added the fake row already. Just add all other templates below this.
+                $newSysTemplateRows[] = $sysTemplateRow;
+                continue;
+            }
+            if (in_array((int)($sysTemplateRow['pid'] ?? 0), $pidsBeforeSite)) {
+                $newSysTemplateRows[] = $sysTemplateRow;
+                // If there is a sys_template row *before* our site, we assume settings from above
+                // templates should "fall through", so we unset the clear flags. If this is not
+                // wanted, an instance may need to register another event listener after this one
+                // to set the clear flag again.
+                $fakeRow['clear'] = 0;
+            } elseif ((int)($sysTemplateRow['pid'] ?? 0) === $siteRootPageId) {
+                // There is a sys_template on the site root page already. We add our fake row before
+                // this one, then force the root and the clear flag of the sys_template row to 0.
+                $newSysTemplateRows[] = $fakeRow;
+                $fakeRowAdded = true;
+                $sysTemplateRow['root'] = 0;
+                $sysTemplateRow['clear'] = 0;
+                $newSysTemplateRows[] = $sysTemplateRow;
+            } else {
+                // Not a sys_template row before, not an sys_template record on same page. Add our
+                // fake row and mark we added it.
+                $newSysTemplateRows[] = $fakeRow;
+                $fakeRowAdded = true;
+            }
+        }
+        $event->setTemplateRows($newSysTemplateRows);
+    }
+}

Classes/TypoScript/Loader.php

@@ -13,11 +13,13 @@
  */
 
 use B13\Bolt\Configuration\PackageHelper;
+use TYPO3\CMS\Core\Information\Typo3Version;
 use TYPO3\CMS\Core\TypoScript\TemplateService;
+use TYPO3\CMS\Core\Utility\GeneralUtility;
 
 /**
- * Hooks into the process of building TypoScript templates
- * only works with TYPO3 v8.6.0 natively, otherwise the XCLASS kicks in
+ * Hooks into the process of building TypoScript templates.
+ * Works with TYPO3 >= 8.6.0 and <= 11, with TYPO3 v12 event kicks in.
  */
 class Loader
 {
@@ -49,6 +51,14 @@ public function addSiteConfiguration(&$hookParameters, TemplateService $template
         if (!is_array($rootLine) || empty($rootLine)) {
             return;
         }
+
+        if (GeneralUtility::makeInstance(Typo3Version::class)->getMajorVersion() >= 12) {
+            // TYPO3 12.0 still has hook 'runThroughTemplatesPostProcessing', but we use the
+            // event already. This if can be removed when TYPO3 12.1 has been released and
+            // the hook is removed in the core.
+            return;
+        }
+
         foreach ($rootLine as $level => $pageRecord) {
             $package = $this->packageHelper->getSitePackage((int)$pageRecord['uid']);
             if ($package !== null) {
@@ -72,11 +82,6 @@ public function addSiteConfiguration(&$hookParameters, TemplateService $template
                     $setup = '';
                 }
 
-                // pre-process the lines of the constants and setup and check for "@" syntax
-                // @import
-                // @sitetitle
-                // @clear
-                // are the currently allowed syntax (must be on the head of each line)
                 $hasRootTemplate = (bool)$templateService->getRootId();
                 $fakeRow = [
                     'config' => $setup,

Configuration/Services.yaml

@@ -16,3 +16,11 @@ services:
 
   B13\Bolt\TypoScript\Loader:
     public: true
+
+  B13\Bolt\TypoScript\AddTypoScriptFromSiteExtensionEvent:
+    public: true
+    tags:
+      - name: event.listener
+        identifier: 'b13-bolt/add-typoscript-from-site-extension'
+        # for v10 compat, optional since v11
+        event: TYPO3\CMS\Core\TypoScript\IncludeTree\Event\AfterTemplatesHaveBeenDeterminedEvent

ext_localconf.php

@@ -2,5 +2,5 @@
 
 defined('TYPO3') or die();
 
-// Register autoloading for TypoScript
+// Register autoloading for TypoScript for TYPO3 v10 and v11
 $GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['Core/TypoScript/TemplateService']['runThroughTemplatesPostProcessing']['bolt'] = \B13\Bolt\TypoScript\Loader::class . '->addSiteConfiguration';