TYPO3 v15 dev-main snapshot ()

2026-08-10 22:31:24 +02:00
commit aad9daaefd
1506 changed files with 94005 additions and 0 deletions
@@ -0,0 +1,116 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * This file is part of the TYPO3 CMS project.
+ *
+ * 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.
+ *
+ * For the full copyright and license information, please read the
+ * LICENSE.txt file that was distributed with this source code.
+ *
+ * The TYPO3 project - inspiring people to share!
+ */
+
+namespace TYPO3\CMS\Form\SoftReference;
+
+use TYPO3\CMS\Core\DataHandling\SoftReference\AbstractSoftReferenceParser;
+use TYPO3\CMS\Core\DataHandling\SoftReference\SoftReferenceParserResult;
+use TYPO3\CMS\Core\Resource\ResourceFactory;
+use TYPO3\CMS\Core\Utility\MathUtility;
+use TYPO3\CMS\Core\Utility\PathUtility;
+use TYPO3\CMS\Form\Domain\Repository\FormDefinitionRepository;
+
+/**
+ * Register new referenced formDefinitions within a plugin as a soft reference.
+ *
+ * This is used in BE to track how often a specific form is used in a content
+ * element. The number is shown in the form module "Manage forms".
+ *
+ * Scope: backend
+ * @internal
+ */
+class FormPersistenceIdentifierSoftReferenceParser extends AbstractSoftReferenceParser
+{
+    public function __construct(
+        private readonly ResourceFactory $resourceFactory,
+    ) {}
+
+    public function parse(string $table, string $field, int $uid, string $content, string $structurePath = ''): SoftReferenceParserResult
+    {
+        $this->setTokenIdBasePrefix($table, (string)$uid, $field, $structurePath);
+        $tokenId = $this->makeTokenID($content);
+
+        // Handle extension paths (EXT:extension_key/...)
+        if (PathUtility::isExtensionPath($content)) {
+            return $this->createResultForExtensionReference($content, $tokenId);
+        }
+
+        // Handle numeric database identifiers (uid)
+        if (MathUtility::canBeInterpretedAsInteger($content)) {
+            return $this->createResultForDatabaseReference($content, $tokenId);
+        }
+
+        // Handle file storage identifiers (storage:/path)
+        try {
+            $file = $this->resourceFactory->retrieveFileOrFolderObject($content);
+        } catch (\Exception $e) {
+            // Top level catch to ensure useful following exception handling, because FAL throws top level exceptions.
+            // TYPO3\CMS\Core\Database\ReferenceIndex::getRelations() will check the return value of this hook with is_array()
+            // so we return null to tell getRelations() to do nothing.
+            return SoftReferenceParserResult::createWithoutMatches();
+        }
+
+        if ($file === null) {
+            return SoftReferenceParserResult::createWithoutMatches();
+        }
+
+        return SoftReferenceParserResult::create('{softref:' . $tokenId . '}', [
+            $tokenId => [
+                'matchString' => $content,
+                'subst' => [
+                    'type' => 'db',
+                    'recordRef' => 'sys_file:' . $file->getUid(),
+                    'tokenID' => $tokenId,
+                    'tokenValue' => $content,
+                ],
+            ],
+        ]);
+    }
+
+    private function createResultForExtensionReference(string $extensionReference, string $tokenId): SoftReferenceParserResult
+    {
+        return SoftReferenceParserResult::create('{softref:' . $tokenId . '}', [
+            $tokenId => [
+                'matchString' => $extensionReference,
+                'subst' => [
+                    'type' => 'string',
+                    'tokenID' => $tokenId,
+                    'tokenValue' => $extensionReference,
+                ],
+            ],
+        ]);
+    }
+
+    /**
+     * Create soft reference result for database identifiers (numeric uid)
+     * These are stored as db references in sys_refindex for tracking usage
+     */
+    private function createResultForDatabaseReference(string $databaseReference, string $tokenId): SoftReferenceParserResult
+    {
+        return SoftReferenceParserResult::create('{softref:' . $tokenId . '}', [
+            $tokenId => [
+                'matchString' => $databaseReference,
+                'subst' => [
+                    'type' => 'db',
+                    'recordRef' => FormDefinitionRepository::TABLE_NAME . ':' . $databaseReference,
+                    'tokenID' => $tokenId,
+                    'tokenValue' => $databaseReference,
+                ],
+            ],
+        ]);
+    }
+}