[TASK] Add require() to php capable cache backend
[Packages/TYPO3.CMS.git] / typo3 / sysext / core / Classes / Utility / ExtensionManagementUtility.php
1 <?php
2 namespace TYPO3\CMS\Core\Utility;
3
4 /*
5 * This file is part of the TYPO3 CMS project.
6 *
7 * It is free software; you can redistribute it and/or modify it under
8 * the terms of the GNU General Public License, either version 2
9 * of the License, or any later version.
10 *
11 * For the full copyright and license information, please read the
12 * LICENSE.txt file that was distributed with this source code.
13 *
14 * The TYPO3 project - inspiring people to share!
15 */
16
17 use Symfony\Component\Finder\Finder;
18 use TYPO3\CMS\Backend\Routing\Route;
19 use TYPO3\CMS\Backend\Routing\Router;
20 use TYPO3\CMS\Core\Category\CategoryRegistry;
21 use TYPO3\CMS\Core\Core\Environment;
22 use TYPO3\CMS\Core\Imaging\IconRegistry;
23 use TYPO3\CMS\Core\Log\LogManager;
24 use TYPO3\CMS\Core\Migrations\TcaMigration;
25 use TYPO3\CMS\Core\Package\PackageManager;
26 use TYPO3\CMS\Core\Preparations\TcaPreparation;
27
28 /**
29 * Extension Management functions
30 *
31 * This class is never instantiated, rather the methods inside is called as functions like
32 * \TYPO3\CMS\Core\Utility\ExtensionManagementUtility::isLoaded('my_extension');
33 */
34 class ExtensionManagementUtility
35 {
36 /**
37 * @var array
38 */
39 protected static $extensionKeyMap;
40
41 /**
42 * TRUE, if ext_tables file was read from cache for this script run.
43 * The frontend tends to do that multiple times, but the caching framework does
44 * not allow this (via a require_once call). This variable is used to track
45 * the access to the cache file to read the single ext_tables.php if it was
46 * already read from cache
47 *
48 * @todo See if we can get rid of the 'load multiple times' scenario in fe
49 * @var bool
50 */
51 protected static $extTablesWasReadFromCacheOnce = false;
52
53 /**
54 * @var PackageManager
55 */
56 protected static $packageManager;
57
58 /**
59 * Sets the package manager for all that backwards compatibility stuff,
60 * so it doesn't have to be fetched through the bootstap.
61 *
62 * @param PackageManager $packageManager
63 * @internal
64 */
65 public static function setPackageManager(PackageManager $packageManager)
66 {
67 static::$packageManager = $packageManager;
68 }
69
70 /**
71 * @var \TYPO3\CMS\Core\Cache\CacheManager
72 */
73 protected static $cacheManager;
74
75 /**
76 * Getter for the cache manager
77 *
78 * @return \TYPO3\CMS\Core\Cache\CacheManager
79 */
80 protected static function getCacheManager()
81 {
82 if (static::$cacheManager === null) {
83 static::$cacheManager = GeneralUtility::makeInstance(\TYPO3\CMS\Core\Cache\CacheManager::class);
84 }
85 return static::$cacheManager;
86 }
87
88 /**
89 * @var \TYPO3\CMS\Extbase\SignalSlot\Dispatcher
90 */
91 protected static $signalSlotDispatcher;
92
93 /**
94 * Getter for the signal slot dispatcher
95 *
96 * @return \TYPO3\CMS\Extbase\SignalSlot\Dispatcher
97 */
98 protected static function getSignalSlotDispatcher()
99 {
100 if (static::$signalSlotDispatcher === null) {
101 static::$signalSlotDispatcher = GeneralUtility::makeInstance(\TYPO3\CMS\Extbase\SignalSlot\Dispatcher::class);
102 }
103 return static::$signalSlotDispatcher;
104 }
105
106 /**************************************
107 *
108 * PATHS and other evaluation
109 *
110 ***************************************/
111 /**
112 * Returns TRUE if the extension with extension key $key is loaded.
113 *
114 * @param string $key Extension key to test
115 * @param bool $exitOnError If $exitOnError is TRUE and the extension is not loaded the function will die with an error message, this is deprecated and will be removed in TYPO3 v10
116 * @return bool
117 * @throws \BadFunctionCallException
118 */
119 public static function isLoaded($key, $exitOnError = null)
120 {
121 // safety net for extensions checking for "EXT:version", can be removed in TYPO3 v10.
122 if ($key === 'version') {
123 trigger_error('EXT:version has been moved into EXT:workspaces, you should check against "workspaces", as this might lead to unexpected behaviour in the future.', E_USER_DEPRECATED);
124 $key = 'workspaces';
125 }
126 if ($exitOnError !== null) {
127 trigger_error('Calling isLoaded() with a second argument via "exitOnError" will be removed in TYPO3 v10, handle an unloaded package yourself in the future.', E_USER_DEPRECATED);
128 }
129 $isLoaded = static::$packageManager->isPackageActive($key);
130 if ($exitOnError && !$isLoaded) {
131 // @deprecated, once $exitOnError is gone, this check can be removed.
132 throw new \BadFunctionCallException('TYPO3 Fatal Error: Extension "' . $key . '" is not loaded!', 1270853910);
133 }
134 return $isLoaded;
135 }
136
137 /**
138 * Returns the absolute path to the extension with extension key $key.
139 *
140 * @param $key string Extension key
141 * @param $script string $script is appended to the output if set.
142 * @throws \BadFunctionCallException
143 * @return string
144 */
145 public static function extPath($key, $script = '')
146 {
147 if (!static::$packageManager->isPackageActive($key)) {
148 throw new \BadFunctionCallException('TYPO3 Fatal Error: Extension key "' . $key . '" is NOT loaded!', 1365429656);
149 }
150 return static::$packageManager->getPackage($key)->getPackagePath() . $script;
151 }
152
153 /**
154 * Returns the relative path to the extension as measured from the public web path
155 * If the extension is not loaded the function will die with an error message
156 * Useful for images and links from the frontend
157 *
158 * @param string $key Extension key
159 * @return string
160 * @deprecated use extPath() or GeneralUtility::getFileAbsFileName() together with PathUtility::getAbsoluteWebPath() instead.
161 */
162 public static function siteRelPath($key)
163 {
164 trigger_error('Calling siteRelPath() is deprecated. This method will be removed in TYPO3 v10, use extPath() in conjunction with PathUtility::getAbsoluteWebPath() instead.', E_USER_DEPRECATED);
165 return PathUtility::stripPathSitePrefix(self::extPath($key));
166 }
167
168 /**
169 * Returns the correct class name prefix for the extension key $key
170 *
171 * @param string $key Extension key
172 * @return string
173 * @internal
174 */
175 public static function getCN($key)
176 {
177 return strpos($key, 'user_') === 0 ? 'user_' . str_replace('_', '', substr($key, 5)) : 'tx_' . str_replace('_', '', $key);
178 }
179
180 /**
181 * Returns the real extension key like 'tt_news' from an extension prefix like 'tx_ttnews'.
182 *
183 * @param string $prefix The extension prefix (e.g. 'tx_ttnews')
184 * @return mixed Real extension key (string)or FALSE (bool) if something went wrong
185 * @deprecated since TYPO3 v9, just use the proper extension key directly
186 */
187 public static function getExtensionKeyByPrefix($prefix)
188 {
189 trigger_error('Calling getExtensionKeyByPrefix() is deprecated and will be removed in TYPO3 v10. Use extension keys directly', E_USER_DEPRECATED);
190 $result = false;
191 // Build map of short keys referencing to real keys:
192 if (!isset(self::$extensionKeyMap)) {
193 self::$extensionKeyMap = [];
194 foreach (static::$packageManager->getActivePackages() as $package) {
195 $shortKey = str_replace('_', '', $package->getPackageKey());
196 self::$extensionKeyMap[$shortKey] = $package->getPackageKey();
197 }
198 }
199 // Lookup by the given short key:
200 $parts = explode('_', $prefix);
201 if (isset(self::$extensionKeyMap[$parts[1]])) {
202 $result = self::$extensionKeyMap[$parts[1]];
203 }
204 return $result;
205 }
206
207 /**
208 * Clears the extension key map.
209 */
210 public static function clearExtensionKeyMap()
211 {
212 self::$extensionKeyMap = null;
213 }
214
215 /**
216 * Retrieves the version of an installed extension.
217 * If the extension is not installed, this function returns an empty string.
218 *
219 * @param string $key The key of the extension to look up, must not be empty
220 *
221 * @throws \InvalidArgumentException
222 * @throws \TYPO3\CMS\Core\Package\Exception
223 * @return string The extension version as a string in the format "x.y.z",
224 */
225 public static function getExtensionVersion($key)
226 {
227 if (!is_string($key) || empty($key)) {
228 throw new \InvalidArgumentException('Extension key must be a non-empty string.', 1294586096);
229 }
230 if (!static::isLoaded($key)) {
231 return '';
232 }
233 $version = static::$packageManager->getPackage($key)->getPackageMetaData()->getVersion();
234 if (empty($version)) {
235 throw new \TYPO3\CMS\Core\Package\Exception('Version number in composer manifest of package "' . $key . '" is missing or invalid', 1395614959);
236 }
237 return $version;
238 }
239
240 /**************************************
241 *
242 * Adding BACKEND features
243 * (related to core features)
244 *
245 ***************************************/
246 /**
247 * Adding fields to an existing table definition in $GLOBALS['TCA']
248 * Adds an array with $GLOBALS['TCA'] column-configuration to the $GLOBALS['TCA']-entry for that table.
249 * This function adds the configuration needed for rendering of the field in TCEFORMS - but it does NOT add the field names to the types lists!
250 * So to have the fields displayed you must also call fx. addToAllTCAtypes or manually add the fields to the types list.
251 * FOR USE IN files in Configuration/TCA/Overrides/*.php . Use in ext_tables.php FILES may break the frontend.
252 *
253 * @param string $table The table name of a table already present in $GLOBALS['TCA'] with a columns section
254 * @param array $columnArray The array with the additional columns (typical some fields an extension wants to add)
255 */
256 public static function addTCAcolumns($table, $columnArray)
257 {
258 if (is_array($columnArray) && is_array($GLOBALS['TCA'][$table]) && is_array($GLOBALS['TCA'][$table]['columns'])) {
259 // Candidate for array_merge() if integer-keys will some day make trouble...
260 $GLOBALS['TCA'][$table]['columns'] = array_merge($GLOBALS['TCA'][$table]['columns'], $columnArray);
261 }
262 }
263
264 /**
265 * Makes fields visible in the TCEforms, adding them to the end of (all) "types"-configurations
266 *
267 * Adds a string $string (comma separated list of field names) to all ["types"][xxx]["showitem"] entries for table $table (unless limited by $typeList)
268 * This is needed to have new fields shown automatically in the TCEFORMS of a record from $table.
269 * Typically this function is called after having added new columns (database fields) with the addTCAcolumns function
270 * FOR USE IN files in Configuration/TCA/Overrides/*.php Use in ext_tables.php FILES may break the frontend.
271 *
272 * @param string $table Table name
273 * @param string $newFieldsString Field list to add.
274 * @param string $typeList List of specific types to add the field list to. (If empty, all type entries are affected)
275 * @param string $position Insert fields before (default) or after one, or replace a field
276 */
277 public static function addToAllTCAtypes($table, $newFieldsString, $typeList = '', $position = '')
278 {
279 $newFieldsString = trim($newFieldsString);
280 if ($newFieldsString === '' || !is_array($GLOBALS['TCA'][$table]['types'] ?? false)) {
281 return;
282 }
283 if ($position !== '') {
284 list($positionIdentifier, $entityName) = GeneralUtility::trimExplode(':', $position);
285 } else {
286 $positionIdentifier = '';
287 $entityName = '';
288 }
289 $palettesChanged = [];
290
291 foreach ($GLOBALS['TCA'][$table]['types'] as $type => &$typeDetails) {
292 // skip if we don't want to add the field for this type
293 if ($typeList !== '' && !GeneralUtility::inList($typeList, $type)) {
294 continue;
295 }
296 // skip if fields were already added
297 if (!isset($typeDetails['showitem'])) {
298 continue;
299 }
300
301 $fieldArray = GeneralUtility::trimExplode(',', $typeDetails['showitem'], true);
302 if (in_array($newFieldsString, $fieldArray, true)) {
303 continue;
304 }
305
306 $fieldExists = false;
307 $newPosition = '';
308 if (is_array($GLOBALS['TCA'][$table]['palettes'] ?? false)) {
309 // Get the palette names used in current showitem
310 $paletteCount = preg_match_all('/(?:^|,) # Line start or a comma
311 (?:
312 \\s*\\-\\-palette\\-\\-;[^;]*;([^,$]*)| # --palette--;label;paletteName
313 \\s*\\b[^;,]+\\b(?:;[^;]*;([^;,]+))?[^,]* # field;label;paletteName
314 )/x', $typeDetails['showitem'], $paletteMatches);
315 if ($paletteCount > 0) {
316 $paletteNames = array_filter(array_merge($paletteMatches[1], $paletteMatches[2]));
317 if (!empty($paletteNames)) {
318 foreach ($paletteNames as $paletteName) {
319 if (!isset($GLOBALS['TCA'][$table]['palettes'][$paletteName])) {
320 continue;
321 }
322 $palette = $GLOBALS['TCA'][$table]['palettes'][$paletteName];
323 switch ($positionIdentifier) {
324 case 'after':
325 case 'before':
326 if (preg_match('/\\b' . $entityName . '\\b/', $palette['showitem']) > 0) {
327 $newPosition = $positionIdentifier . ':--palette--;;' . $paletteName;
328 }
329 break;
330 case 'replace':
331 // check if fields have been added to palette before
332 if (isset($palettesChanged[$paletteName])) {
333 $fieldExists = true;
334 continue;
335 }
336 if (preg_match('/\\b' . $entityName . '\\b/', $palette['showitem']) > 0) {
337 self::addFieldsToPalette($table, $paletteName, $newFieldsString, $position);
338 // Memorize that we already changed this palette, in case other types also use it
339 $palettesChanged[$paletteName] = true;
340 $fieldExists = true;
341 continue;
342 }
343 break;
344 default:
345 // Intentionally left blank
346 }
347 }
348 }
349 }
350 }
351 if ($fieldExists === false) {
352 $typeDetails['showitem'] = self::executePositionedStringInsertion(
353 $typeDetails['showitem'],
354 $newFieldsString,
355 $newPosition !== '' ? $newPosition : $position
356 );
357 }
358 }
359 unset($typeDetails);
360 }
361
362 /**
363 * Adds new fields to all palettes that is defined after an existing field.
364 * If the field does not have a following palette yet, it's created automatically
365 * and gets called "generatedFor-$field".
366 * FOR USE IN files in Configuration/TCA/Overrides/*.php Use in ext_tables.php FILES may break the frontend.
367 *
368 * See unit tests for more examples and edge cases.
369 *
370 * Example:
371 *
372 * 'aTable' => array(
373 * 'types' => array(
374 * 'aType' => array(
375 * 'showitem' => 'aField, --palette--;;aPalette',
376 * ),
377 * ),
378 * 'palettes' => array(
379 * 'aPallete' => array(
380 * 'showitem' => 'fieldB, fieldC',
381 * ),
382 * ),
383 * ),
384 *
385 * Calling addFieldsToAllPalettesOfField('aTable', 'aField', 'newA', 'before: fieldC') results in:
386 *
387 * 'aTable' => array(
388 * 'types' => array(
389 * 'aType' => array(
390 * 'showitem' => 'aField, --palette--;;aPalette',
391 * ),
392 * ),
393 * 'palettes' => array(
394 * 'aPallete' => array(
395 * 'showitem' => 'fieldB, newA, fieldC',
396 * ),
397 * ),
398 * ),
399 *
400 * @param string $table Name of the table
401 * @param string $field Name of the field that has the palette to be extended
402 * @param string $addFields List of fields to be added to the palette
403 * @param string $insertionPosition Insert fields before (default) or after one
404 */
405 public static function addFieldsToAllPalettesOfField($table, $field, $addFields, $insertionPosition = '')
406 {
407 if (!isset($GLOBALS['TCA'][$table]['columns'][$field])) {
408 return;
409 }
410 if (!is_array($GLOBALS['TCA'][$table]['types'])) {
411 return;
412 }
413
414 // Iterate through all types and search for the field that defines the palette to be extended
415 foreach ($GLOBALS['TCA'][$table]['types'] as $typeName => $typeArray) {
416 // Continue if types has no showitem at all or if requested field is not in it
417 if (!isset($typeArray['showitem']) || strpos($typeArray['showitem'], $field) === false) {
418 continue;
419 }
420 $fieldArrayWithOptions = GeneralUtility::trimExplode(',', $typeArray['showitem']);
421 // Find the field we're handling
422 $newFieldStringArray = [];
423 foreach ($fieldArrayWithOptions as $fieldNumber => $fieldString) {
424 $newFieldStringArray[] = $fieldString;
425 $fieldArray = GeneralUtility::trimExplode(';', $fieldString);
426 if ($fieldArray[0] !== $field) {
427 continue;
428 }
429 if (
430 isset($fieldArrayWithOptions[$fieldNumber + 1])
431 && strpos($fieldArrayWithOptions[$fieldNumber + 1], '--palette--') === 0
432 ) {
433 // Match for $field and next field is a palette - add fields to this one
434 $paletteName = GeneralUtility::trimExplode(';', $fieldArrayWithOptions[$fieldNumber + 1]);
435 $paletteName = $paletteName[2];
436 self::addFieldsToPalette($table, $paletteName, $addFields, $insertionPosition);
437 } else {
438 // Match for $field but next field is no palette - create a new one
439 $newPaletteName = 'generatedFor-' . $field;
440 self::addFieldsToPalette($table, 'generatedFor-' . $field, $addFields, $insertionPosition);
441 $newFieldStringArray[] = '--palette--;;' . $newPaletteName;
442 }
443 }
444 $GLOBALS['TCA'][$table]['types'][$typeName]['showitem'] = implode(', ', $newFieldStringArray);
445 }
446 }
447
448 /**
449 * Adds new fields to a palette.
450 * If the palette does not exist yet, it's created automatically.
451 * FOR USE IN files in Configuration/TCA/Overrides/*.php Use in ext_tables.php FILES may break the frontend.
452 *
453 * @param string $table Name of the table
454 * @param string $palette Name of the palette to be extended
455 * @param string $addFields List of fields to be added to the palette
456 * @param string $insertionPosition Insert fields before (default) or after one
457 */
458 public static function addFieldsToPalette($table, $palette, $addFields, $insertionPosition = '')
459 {
460 if (isset($GLOBALS['TCA'][$table])) {
461 $paletteData = &$GLOBALS['TCA'][$table]['palettes'][$palette];
462 // If palette already exists, merge the data:
463 if (is_array($paletteData)) {
464 $paletteData['showitem'] = self::executePositionedStringInsertion($paletteData['showitem'], $addFields, $insertionPosition);
465 } else {
466 $paletteData['showitem'] = self::removeDuplicatesForInsertion($addFields);
467 }
468 }
469 }
470
471 /**
472 * Add an item to a select field item list.
473 *
474 * Warning: Do not use this method for radio or check types, especially not
475 * with $relativeToField and $relativePosition parameters. This would shift
476 * existing database data 'off by one'.
477 * FOR USE IN files in Configuration/TCA/Overrides/*.php Use in ext_tables.php FILES may break the frontend.
478 *
479 * As an example, this can be used to add an item to tt_content CType select
480 * drop-down after the existing 'mailform' field with these parameters:
481 * - $table = 'tt_content'
482 * - $field = 'CType'
483 * - $item = array(
484 * 'LLL:EXT:frontend/Resources/Private/Language/locallang_ttc.xlf:CType.I.10',
485 * 'login',
486 * 'i/imagename.gif',
487 * ),
488 * - $relativeToField = mailform
489 * - $relativePosition = after
490 *
491 * @throws \InvalidArgumentException If given parameters are not of correct
492 * @throws \RuntimeException If reference to related position fields can not
493 * @param string $table Name of TCA table
494 * @param string $field Name of TCA field
495 * @param array $item New item to add
496 * @param string $relativeToField Add item relative to existing field
497 * @param string $relativePosition Valid keywords: 'before', 'after'
498 */
499 public static function addTcaSelectItem($table, $field, array $item, $relativeToField = '', $relativePosition = '')
500 {
501 if (!is_string($table)) {
502 throw new \InvalidArgumentException('Given table is of type "' . gettype($table) . '" but a string is expected.', 1303236963);
503 }
504 if (!is_string($field)) {
505 throw new \InvalidArgumentException('Given field is of type "' . gettype($field) . '" but a string is expected.', 1303236964);
506 }
507 if (!is_string($relativeToField)) {
508 throw new \InvalidArgumentException('Given relative field is of type "' . gettype($relativeToField) . '" but a string is expected.', 1303236965);
509 }
510 if (!is_string($relativePosition)) {
511 throw new \InvalidArgumentException('Given relative position is of type "' . gettype($relativePosition) . '" but a string is expected.', 1303236966);
512 }
513 if ($relativePosition !== '' && $relativePosition !== 'before' && $relativePosition !== 'after' && $relativePosition !== 'replace') {
514 throw new \InvalidArgumentException('Relative position must be either empty or one of "before", "after", "replace".', 1303236967);
515 }
516 if (!is_array($GLOBALS['TCA'][$table]['columns'][$field]['config']['items'])) {
517 throw new \RuntimeException('Given select field item list was not found.', 1303237468);
518 }
519 // Make sure item keys are integers
520 $GLOBALS['TCA'][$table]['columns'][$field]['config']['items'] = array_values($GLOBALS['TCA'][$table]['columns'][$field]['config']['items']);
521 if ($relativePosition !== '') {
522 // Insert at specified position
523 $matchedPosition = ArrayUtility::filterByValueRecursive($relativeToField, $GLOBALS['TCA'][$table]['columns'][$field]['config']['items']);
524 if (!empty($matchedPosition)) {
525 $relativeItemKey = key($matchedPosition);
526 if ($relativePosition === 'replace') {
527 $GLOBALS['TCA'][$table]['columns'][$field]['config']['items'][$relativeItemKey] = $item;
528 } else {
529 if ($relativePosition === 'before') {
530 $offset = $relativeItemKey;
531 } else {
532 $offset = $relativeItemKey + 1;
533 }
534 array_splice($GLOBALS['TCA'][$table]['columns'][$field]['config']['items'], $offset, 0, [0 => $item]);
535 }
536 } else {
537 // Insert at new item at the end of the array if relative position was not found
538 $GLOBALS['TCA'][$table]['columns'][$field]['config']['items'][] = $item;
539 }
540 } else {
541 // Insert at new item at the end of the array
542 $GLOBALS['TCA'][$table]['columns'][$field]['config']['items'][] = $item;
543 }
544 }
545
546 /**
547 * Gets the TCA configuration for a field handling (FAL) files.
548 *
549 * @param string $fieldName Name of the field to be used
550 * @param array $customSettingOverride Custom field settings overriding the basics
551 * @param string $allowedFileExtensions Comma list of allowed file extensions (e.g. "jpg,gif,pdf")
552 * @param string $disallowedFileExtensions
553 *
554 * @return array
555 */
556 public static function getFileFieldTCAConfig($fieldName, array $customSettingOverride = [], $allowedFileExtensions = '', $disallowedFileExtensions = '')
557 {
558 $fileFieldTCAConfig = [
559 'type' => 'inline',
560 'foreign_table' => 'sys_file_reference',
561 'foreign_field' => 'uid_foreign',
562 'foreign_sortby' => 'sorting_foreign',
563 'foreign_table_field' => 'tablenames',
564 'foreign_match_fields' => [
565 'fieldname' => $fieldName
566 ],
567 'foreign_label' => 'uid_local',
568 'foreign_selector' => 'uid_local',
569 'overrideChildTca' => [
570 'columns' => [
571 'uid_local' => [
572 'config' => [
573 'appearance' => [
574 'elementBrowserType' => 'file',
575 'elementBrowserAllowed' => $allowedFileExtensions
576 ],
577 ],
578 ],
579 ],
580 ],
581 'filter' => [
582 [
583 'userFunc' => \TYPO3\CMS\Core\Resource\Filter\FileExtensionFilter::class . '->filterInlineChildren',
584 'parameters' => [
585 'allowedFileExtensions' => $allowedFileExtensions,
586 'disallowedFileExtensions' => $disallowedFileExtensions
587 ]
588 ]
589 ],
590 'appearance' => [
591 'useSortable' => true,
592 'headerThumbnail' => [
593 'field' => 'uid_local',
594 'width' => '45',
595 'height' => '45c',
596 ],
597
598 'enabledControls' => [
599 'info' => true,
600 'new' => false,
601 'dragdrop' => true,
602 'sort' => false,
603 'hide' => true,
604 'delete' => true,
605 ],
606 ]
607 ];
608 ArrayUtility::mergeRecursiveWithOverrule($fileFieldTCAConfig, $customSettingOverride);
609 return $fileFieldTCAConfig;
610 }
611
612 /**
613 * Adds a list of new fields to the TYPO3 USER SETTINGS configuration "showitem" list, the array with
614 * the new fields itself needs to be added additionally to show up in the user setup, like
615 * $GLOBALS['TYPO3_USER_SETTINGS']['columns'] += $tempColumns
616 *
617 * @param string $addFields List of fields to be added to the user settings
618 * @param string $insertionPosition Insert fields before (default) or after one
619 */
620 public static function addFieldsToUserSettings($addFields, $insertionPosition = '')
621 {
622 $GLOBALS['TYPO3_USER_SETTINGS']['showitem'] = self::executePositionedStringInsertion($GLOBALS['TYPO3_USER_SETTINGS']['showitem'], $addFields, $insertionPosition);
623 }
624
625 /**
626 * Inserts as list of data into an existing list.
627 * The insertion position can be defined accordant before of after existing list items.
628 *
629 * Example:
630 * + list: 'field_a, field_b, field_c'
631 * + insertionList: 'field_d, field_e'
632 * + insertionPosition: 'after:field_b'
633 * -> 'field_a, field_b, field_d, field_e, field_c'
634 *
635 * $insertPosition may contain ; and - characters: after:--palette--;;title
636 *
637 * @param string $list The list of items to be extended
638 * @param string $insertionList The list of items to inserted
639 * @param string $insertionPosition Insert fields before (default) or after one
640 * @return string The extended list
641 */
642 protected static function executePositionedStringInsertion($list, $insertionList, $insertionPosition = '')
643 {
644 $list = $newList = trim($list, ", \t\n\r\0\x0B");
645
646 if ($insertionPosition !== '') {
647 list($location, $positionName) = GeneralUtility::trimExplode(':', $insertionPosition, false, 2);
648 } else {
649 $location = '';
650 $positionName = '';
651 }
652
653 if ($location !== 'replace') {
654 $insertionList = self::removeDuplicatesForInsertion($insertionList, $list);
655 }
656
657 if ($insertionList === '') {
658 return $list;
659 }
660 if ($list === '') {
661 return $insertionList;
662 }
663 if ($insertionPosition === '') {
664 return $list . ', ' . $insertionList;
665 }
666
667 // The $insertPosition may be a palette: after:--palette--;;title
668 // In the $list the palette may contain a LLL string in between the ;;
669 // Adjust the regex to match that
670 $positionName = preg_quote($positionName, '/');
671 if (strpos($positionName, ';;') !== false) {
672 $positionName = str_replace(';;', ';[^;]*;', $positionName);
673 }
674
675 $pattern = ('/(^|,\\s*)(' . $positionName . ')(;[^,$]+)?(,|$)/');
676 switch ($location) {
677 case 'after':
678 $newList = preg_replace($pattern, '$1$2$3, ' . $insertionList . '$4', $list);
679 break;
680 case 'before':
681 $newList = preg_replace($pattern, '$1' . $insertionList . ', $2$3$4', $list);
682 break;
683 case 'replace':
684 $newList = preg_replace($pattern, '$1' . $insertionList . '$4', $list);
685 break;
686 default:
687 }
688
689 // When preg_replace did not replace anything; append the $insertionList.
690 if ($list === $newList) {
691 return $list . ', ' . $insertionList;
692 }
693 return $newList;
694 }
695
696 /**
697 * Compares an existing list of items and a list of items to be inserted
698 * and returns a duplicate-free variant of that insertion list.
699 *
700 * Example:
701 * + list: 'field_a, field_b, field_c'
702 * + insertion: 'field_b, field_d, field_c'
703 * -> new insertion: 'field_d'
704 *
705 * Duplicate values in $insertionList are removed.
706 *
707 * @param string $insertionList The list of items to inserted
708 * @param string $list The list of items to be extended (default: '')
709 * @return string Duplicate-free list of items to be inserted
710 */
711 protected static function removeDuplicatesForInsertion($insertionList, $list = '')
712 {
713 $insertionListParts = preg_split('/\\s*,\\s*/', $insertionList);
714 $listMatches = [];
715 if ($list !== '') {
716 preg_match_all('/(?:^|,)\\s*\\b([^;,]+)\\b[^,]*/', $list, $listMatches);
717 $listMatches = $listMatches[1];
718 }
719
720 $cleanInsertionListParts = [];
721 foreach ($insertionListParts as $fieldName) {
722 $fieldNameParts = explode(';', $fieldName, 2);
723 $cleanFieldName = $fieldNameParts[0];
724 if (
725 $cleanFieldName === '--linebreak--'
726 || (
727 !in_array($cleanFieldName, $cleanInsertionListParts, true)
728 && !in_array($cleanFieldName, $listMatches, true)
729 )
730 ) {
731 $cleanInsertionListParts[] = $fieldName;
732 }
733 }
734 return implode(', ', $cleanInsertionListParts);
735 }
736
737 /**
738 * Generates an array of fields/items with additional information such as e.g. the name of the palette.
739 *
740 * @param string $itemList List of fields/items to be splitted up
741 * @return array An array with the names of the fields/items as keys and additional information
742 */
743 protected static function explodeItemList($itemList)
744 {
745 $items = [];
746 $itemParts = GeneralUtility::trimExplode(',', $itemList, true);
747 foreach ($itemParts as $itemPart) {
748 $itemDetails = GeneralUtility::trimExplode(';', $itemPart, false, 5);
749 $key = $itemDetails[0];
750 if (strpos($key, '--') !== false) {
751 // If $key is a separator (--div--) or palette (--palette--) then it will be appended by a unique number. This must be removed again when using this value!
752 $key .= count($items);
753 }
754 if (!isset($items[$key])) {
755 $items[$key] = [
756 'rawData' => $itemPart,
757 'details' => []
758 ];
759 $details = [0 => 'field', 1 => 'label', 2 => 'palette'];
760 foreach ($details as $id => $property) {
761 $items[$key]['details'][$property] = $itemDetails[$id] ?? '';
762 }
763 }
764 }
765 return $items;
766 }
767
768 /**
769 * Generates a list of fields/items out of an array provided by the function getFieldsOfFieldList().
770 *
771 * @see explodeItemList
772 * @param array $items The array of fields/items with optional additional information
773 * @param bool $useRawData Use raw data instead of building by using the details (default: FALSE)
774 * @return string The list of fields/items which gets used for $GLOBALS['TCA'][<table>]['types'][<type>]['showitem']
775 */
776 protected static function generateItemList(array $items, $useRawData = false)
777 {
778 $itemParts = [];
779 foreach ($items as $item => $itemDetails) {
780 if (strpos($item, '--') !== false) {
781 // If $item is a separator (--div--) or palette (--palette--) then it may have been appended by a unique number. This must be stripped away here.
782 $item = str_replace([0, 1, 2, 3, 4, 5, 6, 7, 8, 9], '', $item);
783 }
784 if ($useRawData) {
785 $itemParts[] = $itemDetails['rawData'];
786 } else {
787 if (count($itemDetails['details']) > 1) {
788 $details = ['palette', 'label', 'field'];
789 $elements = [];
790 $addEmpty = false;
791 foreach ($details as $property) {
792 if ($itemDetails['details'][$property] !== '' || $addEmpty) {
793 $addEmpty = true;
794 array_unshift($elements, $itemDetails['details'][$property]);
795 }
796 }
797 $item = implode(';', $elements);
798 }
799 $itemParts[] = $item;
800 }
801 }
802 return implode(', ', $itemParts);
803 }
804
805 /**
806 * Add tablename to default list of allowed tables on pages (in $PAGES_TYPES)
807 * Will add the $table to the list of tables allowed by default on pages as setup by $PAGES_TYPES['default']['allowedTables']
808 * FOR USE IN ext_tables.php FILES
809 *
810 * @param string $table Table name
811 */
812 public static function allowTableOnStandardPages($table)
813 {
814 $GLOBALS['PAGES_TYPES']['default']['allowedTables'] .= ',' . $table;
815 }
816
817 /**
818 * This method is called from \TYPO3\CMS\Backend\Module\ModuleLoader::checkMod
819 * and it replaces old conf.php.
820 *
821 * @param string $moduleSignature The module name
822 * @return array Configuration of the module
823 * @deprecated since TYPO3 v9, will be removed in TYPO3 v10, addModule() works the same way nowadays.
824 */
825 public static function configureModule($moduleSignature)
826 {
827 trigger_error('This method will be removed in TYPO3 v10, as the same functionality is found in addModule() as well.', E_USER_DEPRECATED);
828 $moduleConfiguration = $GLOBALS['TBE_MODULES']['_configuration'][$moduleSignature];
829
830 // Register the icon and move it too "iconIdentifier"
831 if (!empty($moduleConfiguration['icon'])) {
832 $iconRegistry = GeneralUtility::makeInstance(IconRegistry::class);
833 $iconIdentifier = 'module-' . $moduleSignature;
834 $iconProvider = $iconRegistry->detectIconProvider($moduleConfiguration['icon']);
835 $iconRegistry->registerIcon(
836 $iconIdentifier,
837 $iconProvider,
838 ['source' => GeneralUtility::getFileAbsFileName($moduleConfiguration['icon'])]
839 );
840 $moduleConfiguration['iconIdentifier'] = $iconIdentifier;
841 unset($moduleConfiguration['icon']);
842 }
843
844 return $moduleConfiguration;
845 }
846
847 /**
848 * Adds a module (main or sub) to the backend interface
849 * FOR USE IN ext_tables.php FILES
850 *
851 * @param string $main The main module key, $sub is the submodule key. So $main would be an index in the $TBE_MODULES array and $sub could be an element in the lists there.
852 * @param string $sub The submodule key. If $sub is not set a blank $main module is created.
853 * @param string $position Can be used to set the position of the $sub module within the list of existing submodules for the main module. $position has this syntax: [cmd]:[submodule-key]. cmd can be "after", "before" or "top" (or blank which is default). If "after"/"before" then submodule will be inserted after/before the existing submodule with [submodule-key] if found. If not found, the bottom of list. If "top" the module is inserted in the top of the submodule list.
854 * @param string $path The absolute path to the module. Was used prior to TYPO3 v8, use $moduleConfiguration[routeTarget] now
855 * @param array $moduleConfiguration additional configuration, previously put in "conf.php" of the module directory
856 */
857 public static function addModule($main, $sub = '', $position = '', $path = null, $moduleConfiguration = [])
858 {
859 if (($moduleConfiguration['navigationComponentId'] ?? '') === 'typo3-pagetree') {
860 trigger_error(
861 'Navigation component ID "typo3-pagetree" has been deprecated and will be removed in TYPO3 v10.'
862 . 'Use "TYPO3/CMS/Backend/PageTree/PageTreeElement" instead. Module key: ' . $main . '-' . $sub,
863 E_USER_DEPRECATED
864 );
865 $moduleConfiguration['navigationComponentId'] = 'TYPO3/CMS/Backend/PageTree/PageTreeElement';
866 }
867
868 // If there is already a main module by this name:
869 // Adding the submodule to the correct position:
870 if (isset($GLOBALS['TBE_MODULES'][$main]) && $sub) {
871 list($place, $modRef) = array_pad(GeneralUtility::trimExplode(':', $position, true), 2, null);
872 $modules = ',' . $GLOBALS['TBE_MODULES'][$main] . ',';
873 if ($place === null || ($modRef !== null && !GeneralUtility::inList($modules, $modRef))) {
874 $place = 'bottom';
875 }
876 $modRef = ',' . $modRef . ',';
877 if (!GeneralUtility::inList($modules, $sub)) {
878 switch (strtolower($place)) {
879 case 'after':
880 $modules = str_replace($modRef, $modRef . $sub . ',', $modules);
881 break;
882 case 'before':
883 $modules = str_replace($modRef, ',' . $sub . $modRef, $modules);
884 break;
885 case 'top':
886 $modules = $sub . $modules;
887 break;
888 case 'bottom':
889 default:
890 $modules = $modules . $sub;
891 }
892 }
893 // Re-inserting the submodule list:
894 $GLOBALS['TBE_MODULES'][$main] = trim($modules, ',');
895 } else {
896 // Create new main modules with only one submodule, $sub (or none if $sub is blank)
897 $GLOBALS['TBE_MODULES'][$main] = $sub;
898 }
899
900 // add additional configuration
901 $fullModuleSignature = $main . ($sub ? '_' . $sub : '');
902 if (is_array($moduleConfiguration) && !empty($moduleConfiguration)) {
903 if (!empty($moduleConfiguration['icon'])) {
904 $iconRegistry = GeneralUtility::makeInstance(IconRegistry::class);
905 $iconIdentifier = 'module-' . $fullModuleSignature;
906 $iconProvider = $iconRegistry->detectIconProvider($moduleConfiguration['icon']);
907 $iconRegistry->registerIcon(
908 $iconIdentifier,
909 $iconProvider,
910 ['source' => GeneralUtility::getFileAbsFileName($moduleConfiguration['icon'])]
911 );
912 $moduleConfiguration['iconIdentifier'] = $iconIdentifier;
913 unset($moduleConfiguration['icon']);
914 }
915
916 $GLOBALS['TBE_MODULES']['_configuration'][$fullModuleSignature] = $moduleConfiguration;
917 }
918
919 // Also register the module as regular route
920 $routeName = $moduleConfiguration['id'] ?? $fullModuleSignature;
921 // Build Route objects from the data
922 $path = $moduleConfiguration['path'] ?? str_replace('_', '/', $fullModuleSignature);
923 $path = '/' . trim($path, '/') . '/';
924
925 $options = [
926 'module' => true,
927 'moduleName' => $fullModuleSignature,
928 'access' => !empty($moduleConfiguration['access']) ? $moduleConfiguration['access'] : 'user,group'
929 ];
930 if (!empty($moduleConfiguration['routeTarget'])) {
931 $options['target'] = $moduleConfiguration['routeTarget'];
932 }
933
934 $router = GeneralUtility::makeInstance(Router::class);
935 $router->addRoute($routeName, GeneralUtility::makeInstance(Route::class, $path, $options));
936 }
937
938 /**
939 * Adds a "Function menu module" ('third level module') to an existing function menu for some other backend module
940 * The arguments values are generally determined by which function menu this is supposed to interact with
941 * See Inside TYPO3 for information on how to use this function.
942 * FOR USE IN ext_tables.php FILES
943 *
944 * @param string $modname Module name
945 * @param string $className Class name
946 * @param string $_ unused
947 * @param string $title Title of module
948 * @param string $MM_key Menu array key - default is "function
949 * @param string $WS Workspace conditions. Blank means all workspaces, any other string can be a comma list of "online", "offline" and "custom
950 * @see \TYPO3\CMS\Backend\Module\BaseScriptClass::mergeExternalItems()
951 */
952 public static function insertModuleFunction($modname, $className, $_ = null, $title, $MM_key = 'function', $WS = '')
953 {
954 $GLOBALS['TBE_MODULES_EXT'][$modname]['MOD_MENU'][$MM_key][$className] = [
955 'name' => $className,
956 'title' => $title,
957 'ws' => $WS
958 ];
959 }
960
961 /**
962 * Adds $content to the default Page TSconfig as set in $GLOBALS['TYPO3_CONF_VARS'][BE]['defaultPageTSconfig']
963 * Prefixed with a [GLOBAL] line
964 * FOR USE IN ext_localconf.php FILE
965 *
966 * @param string $content Page TSconfig content
967 */
968 public static function addPageTSConfig($content)
969 {
970 $GLOBALS['TYPO3_CONF_VARS']['BE']['defaultPageTSconfig'] .= '
971 [GLOBAL]
972 ' . $content;
973 }
974
975 /**
976 * Adds $content to the default User TSconfig as set in $GLOBALS['TYPO3_CONF_VARS'][BE]['defaultUserTSconfig']
977 * Prefixed with a [GLOBAL] line
978 * FOR USE IN ext_localconf.php FILE
979 *
980 * @param string $content User TSconfig content
981 */
982 public static function addUserTSConfig($content)
983 {
984 $GLOBALS['TYPO3_CONF_VARS']['BE']['defaultUserTSconfig'] .= '
985 [GLOBAL]
986 ' . $content;
987 }
988
989 /**
990 * Adds a reference to a locallang file with $GLOBALS['TCA_DESCR'] labels
991 * FOR USE IN ext_tables.php FILES
992 * eg. \TYPO3\CMS\Core\Utility\ExtensionManagementUtility::addLLrefForTCAdescr('pages', 'EXT:core/Resources/Private/Language/locallang_csh_pages.xlf'); for the pages table or \TYPO3\CMS\Core\Utility\ExtensionManagementUtility::addLLrefForTCAdescr('_MOD_web_layout', 'EXT:frontend/Resources/Private/Language/locallang_csh_weblayout.xlf'); for the Web > Page module.
993 *
994 * @param string $key Description key. Typically a database table (like "pages") but for applications can be other strings, but prefixed with "_MOD_")
995 * @param string $file File reference to locallang file, eg. "EXT:core/Resources/Private/Language/locallang_csh_pages.xlf" (or ".xml")
996 */
997 public static function addLLrefForTCAdescr($key, $file)
998 {
999 if (empty($key)) {
1000 throw new \RuntimeException('No description key set in addLLrefForTCAdescr(). Provide it as first parameter', 1507321596);
1001 }
1002 if (!is_array($GLOBALS['TCA_DESCR'][$key] ?? false)) {
1003 $GLOBALS['TCA_DESCR'][$key] = [];
1004 }
1005 if (!is_array($GLOBALS['TCA_DESCR'][$key]['refs'] ?? false)) {
1006 $GLOBALS['TCA_DESCR'][$key]['refs'] = [];
1007 }
1008 $GLOBALS['TCA_DESCR'][$key]['refs'][] = $file;
1009 }
1010
1011 /**
1012 * Registers a navigation component e.g. page tree
1013 *
1014 * @param string $module
1015 * @param string $componentId componentId is also an RequireJS module name e.g. 'TYPO3/CMS/MyExt/MyNavComponent'
1016 * @param string $extensionKey
1017 * @throws \RuntimeException
1018 */
1019 public static function addNavigationComponent($module, $componentId, $extensionKey)
1020 {
1021 if (empty($extensionKey)) {
1022 throw new \RuntimeException('No extensionKey set in addNavigationComponent(). Provide it as third parameter', 1404068039);
1023 }
1024 $GLOBALS['TBE_MODULES']['_navigationComponents'][$module] = [
1025 'componentId' => $componentId,
1026 'extKey' => $extensionKey,
1027 'isCoreComponent' => false
1028 ];
1029 }
1030
1031 /**
1032 * Registers a core navigation component
1033 *
1034 * @param string $module
1035 * @param string $componentId
1036 */
1037 public static function addCoreNavigationComponent($module, $componentId)
1038 {
1039 self::addNavigationComponent($module, $componentId, 'core');
1040 $GLOBALS['TBE_MODULES']['_navigationComponents'][$module]['isCoreComponent'] = true;
1041 }
1042
1043 /**************************************
1044 *
1045 * Adding SERVICES features
1046 *
1047 ***************************************/
1048 /**
1049 * Adds a service to the global services array
1050 *
1051 * @param string $extKey Extension key
1052 * @param string $serviceType Service type, must not be prefixed "tx_" or "Tx_"
1053 * @param string $serviceKey Service key, must be prefixed "tx_", "Tx_" or "user_"
1054 * @param array $info Service description array
1055 */
1056 public static function addService($extKey, $serviceType, $serviceKey, $info)
1057 {
1058 if (!$serviceType) {
1059 throw new \InvalidArgumentException('No serviceType given.', 1507321535);
1060 }
1061 if (!is_array($info)) {
1062 throw new \InvalidArgumentException('No information array given.', 1507321542);
1063 }
1064 $info['priority'] = max(0, min(100, $info['priority']));
1065 $GLOBALS['T3_SERVICES'][$serviceType][$serviceKey] = $info;
1066 $GLOBALS['T3_SERVICES'][$serviceType][$serviceKey]['extKey'] = $extKey;
1067 $GLOBALS['T3_SERVICES'][$serviceType][$serviceKey]['serviceKey'] = $serviceKey;
1068 $GLOBALS['T3_SERVICES'][$serviceType][$serviceKey]['serviceType'] = $serviceType;
1069 // Change the priority (and other values) from $GLOBALS['TYPO3_CONF_VARS']
1070 // $GLOBALS['TYPO3_CONF_VARS']['T3_SERVICES'][$serviceType][$serviceKey]['priority']
1071 // even the activation is possible (a unix service might be possible on windows for some reasons)
1072 if (is_array($GLOBALS['TYPO3_CONF_VARS']['T3_SERVICES'][$serviceType][$serviceKey] ?? false)) {
1073 // No check is done here - there might be configuration values only the service type knows about, so
1074 // we pass everything
1075 $GLOBALS['T3_SERVICES'][$serviceType][$serviceKey] = array_merge($GLOBALS['T3_SERVICES'][$serviceType][$serviceKey], $GLOBALS['TYPO3_CONF_VARS']['T3_SERVICES'][$serviceType][$serviceKey]);
1076 }
1077 // OS check
1078 // Empty $os means 'not limited to one OS', therefore a check is not needed
1079 if ($GLOBALS['T3_SERVICES'][$serviceType][$serviceKey]['available'] && $GLOBALS['T3_SERVICES'][$serviceType][$serviceKey]['os'] != '') {
1080 $os_type = Environment::isWindows() ? 'WIN' : 'UNIX';
1081 $os = GeneralUtility::trimExplode(',', strtoupper($GLOBALS['T3_SERVICES'][$serviceType][$serviceKey]['os']));
1082 if (!in_array($os_type, $os, true)) {
1083 self::deactivateService($serviceType, $serviceKey);
1084 }
1085 }
1086 // Convert subtype list to array for quicker access
1087 $GLOBALS['T3_SERVICES'][$serviceType][$serviceKey]['serviceSubTypes'] = [];
1088 $serviceSubTypes = GeneralUtility::trimExplode(',', $info['subtype']);
1089 foreach ($serviceSubTypes as $subtype) {
1090 $GLOBALS['T3_SERVICES'][$serviceType][$serviceKey]['serviceSubTypes'][$subtype] = $subtype;
1091 }
1092 }
1093
1094 /**
1095 * Find the available service with highest priority
1096 *
1097 * @param string $serviceType Service type
1098 * @param string $serviceSubType Service sub type
1099 * @param mixed $excludeServiceKeys Service keys that should be excluded in the search for a service. Array or comma list.
1100 * @return mixed Service info array if a service was found, FALSE otherwise
1101 */
1102 public static function findService($serviceType, $serviceSubType = '', $excludeServiceKeys = [])
1103 {
1104 $serviceKey = false;
1105 $serviceInfo = false;
1106 $priority = 0;
1107 $quality = 0;
1108 if (!is_array($excludeServiceKeys)) {
1109 $excludeServiceKeys = GeneralUtility::trimExplode(',', $excludeServiceKeys, true);
1110 }
1111 if (is_array($GLOBALS['T3_SERVICES'][$serviceType])) {
1112 foreach ($GLOBALS['T3_SERVICES'][$serviceType] as $key => $info) {
1113 if (in_array($key, $excludeServiceKeys)) {
1114 continue;
1115 }
1116 // Select a subtype randomly
1117 // Useful to start a service by service key without knowing his subtypes - for testing purposes
1118 if ($serviceSubType === '*') {
1119 $serviceSubType = key($info['serviceSubTypes']);
1120 }
1121 // This matches empty subtype too
1122 if ($info['available'] && ($info['subtype'] == $serviceSubType || $info['serviceSubTypes'][$serviceSubType]) && $info['priority'] >= $priority) {
1123 // Has a lower quality than the already found, therefore we skip this service
1124 if ($info['priority'] == $priority && $info['quality'] < $quality) {
1125 continue;
1126 }
1127 // Check if the service is available
1128 $info['available'] = self::isServiceAvailable($serviceType, $key, $info);
1129 // Still available after exec check?
1130 if ($info['available']) {
1131 $serviceKey = $key;
1132 $priority = $info['priority'];
1133 $quality = $info['quality'];
1134 }
1135 }
1136 }
1137 }
1138 if ($serviceKey) {
1139 $serviceInfo = $GLOBALS['T3_SERVICES'][$serviceType][$serviceKey];
1140 }
1141 return $serviceInfo;
1142 }
1143
1144 /**
1145 * Find a specific service identified by its key
1146 * Note that this completely bypasses the notions of priority and quality
1147 *
1148 * @param string $serviceKey Service key
1149 * @return array Service info array if a service was found
1150 * @throws \TYPO3\CMS\Core\Exception
1151 */
1152 public static function findServiceByKey($serviceKey)
1153 {
1154 if (is_array($GLOBALS['T3_SERVICES'])) {
1155 // Loop on all service types
1156 // NOTE: we don't care about the actual type, we are looking for a specific key
1157 foreach ($GLOBALS['T3_SERVICES'] as $serviceType => $servicesPerType) {
1158 if (isset($servicesPerType[$serviceKey])) {
1159 $serviceDetails = $servicesPerType[$serviceKey];
1160 // Test if service is available
1161 if (self::isServiceAvailable($serviceType, $serviceKey, $serviceDetails)) {
1162 // We have found the right service, return its information
1163 return $serviceDetails;
1164 }
1165 }
1166 }
1167 }
1168 throw new \TYPO3\CMS\Core\Exception('Service not found for key: ' . $serviceKey, 1319217244);
1169 }
1170
1171 /**
1172 * Check if a given service is available, based on the executable files it depends on
1173 *
1174 * @param string $serviceType Type of service
1175 * @param string $serviceKey Specific key of the service
1176 * @param array $serviceDetails Information about the service
1177 * @return bool Service availability
1178 */
1179 public static function isServiceAvailable($serviceType, $serviceKey, $serviceDetails)
1180 {
1181 // If the service depends on external programs - check if they exists
1182 if (trim($serviceDetails['exec'])) {
1183 $executables = GeneralUtility::trimExplode(',', $serviceDetails['exec'], true);
1184 foreach ($executables as $executable) {
1185 // If at least one executable file is not available, exit early returning FALSE
1186 if (!CommandUtility::checkCommand($executable)) {
1187 self::deactivateService($serviceType, $serviceKey);
1188 return false;
1189 }
1190 }
1191 }
1192 // The service is available
1193 return true;
1194 }
1195
1196 /**
1197 * Deactivate a service
1198 *
1199 * @param string $serviceType Service type
1200 * @param string $serviceKey Service key
1201 */
1202 public static function deactivateService($serviceType, $serviceKey)
1203 {
1204 // ... maybe it's better to move non-available services to a different array??
1205 $GLOBALS['T3_SERVICES'][$serviceType][$serviceKey]['available'] = false;
1206 }
1207
1208 /**************************************
1209 *
1210 * Adding FRONTEND features
1211 *
1212 ***************************************/
1213 /**
1214 * Adds an entry to the list of plugins in content elements of type "Insert plugin"
1215 * Takes the $itemArray (label, value[,icon]) and adds to the items-array of $GLOBALS['TCA'][tt_content] elements with CType "listtype" (or another field if $type points to another fieldname)
1216 * If the value (array pos. 1) is already found in that items-array, the entry is substituted, otherwise the input array is added to the bottom.
1217 * Use this function to add a frontend plugin to this list of plugin-types - or more generally use this function to add an entry to any selectorbox/radio-button set in the TCEFORMS
1218 * FOR USE IN files in Configuration/TCA/Overrides/*.php Use in ext_tables.php FILES may break the frontend.
1219 *
1220 * @param array $itemArray Numerical array: [0] => Plugin label, [1] => Underscored extension key, [2] => Path to plugin icon relative to TYPO3_mainDir
1221 * @param string $type Type (eg. "list_type") - basically a field from "tt_content" table
1222 * @param string $extensionKey The extension key
1223 * @throws \RuntimeException
1224 */
1225 public static function addPlugin($itemArray, $type = 'list_type', $extensionKey = null)
1226 {
1227 if (!isset($extensionKey)) {
1228 throw new \InvalidArgumentException(
1229 'No extension key could be determined when calling addPlugin()!'
1230 . LF
1231 . 'This method is meant to be called from Configuration/TCA/Overrides files. '
1232 . 'The extension key needs to be specified as third parameter. '
1233 . 'Calling it from any other place e.g. ext_localconf.php does not work and is not supported.',
1234 1404068038
1235 );
1236 }
1237 if (!$itemArray[2] && isset($GLOBALS['TYPO3_LOADED_EXT'][$extensionKey]['ext_icon'])) {
1238 $itemArray[2] = 'EXT:' . $extensionKey . '/' . $GLOBALS['TYPO3_LOADED_EXT'][$extensionKey]['ext_icon'];
1239 }
1240 if (is_array($GLOBALS['TCA']['tt_content']['columns']) && is_array($GLOBALS['TCA']['tt_content']['columns'][$type]['config']['items'])) {
1241 foreach ($GLOBALS['TCA']['tt_content']['columns'][$type]['config']['items'] as $k => $v) {
1242 if ((string)$v[1] === (string)$itemArray[1]) {
1243 $GLOBALS['TCA']['tt_content']['columns'][$type]['config']['items'][$k] = $itemArray;
1244 return;
1245 }
1246 }
1247 $GLOBALS['TCA']['tt_content']['columns'][$type]['config']['items'][] = $itemArray;
1248 }
1249 }
1250
1251 /**
1252 * Adds an entry to the "ds" array of the tt_content field "pi_flexform".
1253 * This is used by plugins to add a flexform XML reference / content for use when they are selected as plugin or content element.
1254 * FOR USE IN files in Configuration/TCA/Overrides/*.php Use in ext_tables.php FILES may break the frontend.
1255 *
1256 * @param string $piKeyToMatch Plugin key as used in the list_type field. Use the asterisk * to match all list_type values.
1257 * @param string $value Either a reference to a flex-form XML file (eg. "FILE:EXT:newloginbox/flexform_ds.xml") or the XML directly.
1258 * @param string $CTypeToMatch Value of tt_content.CType (Content Type) to match. The default is "list" which corresponds to the "Insert Plugin" content element. Use the asterisk * to match all CType values.
1259 * @see addPlugin()
1260 */
1261 public static function addPiFlexFormValue($piKeyToMatch, $value, $CTypeToMatch = 'list')
1262 {
1263 if (is_array($GLOBALS['TCA']['tt_content']['columns']) && is_array($GLOBALS['TCA']['tt_content']['columns']['pi_flexform']['config']['ds'])) {
1264 $GLOBALS['TCA']['tt_content']['columns']['pi_flexform']['config']['ds'][$piKeyToMatch . ',' . $CTypeToMatch] = $value;
1265 }
1266 }
1267
1268 /**
1269 * Adds the $table tablename to the list of tables allowed to be includes by content element type "Insert records"
1270 * By using $content_table and $content_field you can also use the function for other tables.
1271 * FOR USE IN files in Configuration/TCA/Overrides/*.php Use in ext_tables.php FILES may break the frontend.
1272 *
1273 * @param string $table Table name to allow for "insert record
1274 * @param string $content_table Table name TO WHICH the $table name is applied. See $content_field as well.
1275 * @param string $content_field Field name in the database $content_table in which $table is allowed to be added as a reference ("Insert Record")
1276 */
1277 public static function addToInsertRecords($table, $content_table = 'tt_content', $content_field = 'records')
1278 {
1279 if (is_array($GLOBALS['TCA'][$content_table]['columns']) && isset($GLOBALS['TCA'][$content_table]['columns'][$content_field]['config']['allowed'])) {
1280 $GLOBALS['TCA'][$content_table]['columns'][$content_field]['config']['allowed'] .= ',' . $table;
1281 }
1282 }
1283
1284 /**
1285 * Add PlugIn to the default template rendering (previously called "Static Template #43")
1286 *
1287 * When adding a frontend plugin you will have to add both an entry to the TCA definition of tt_content table AND to the TypoScript template which must initiate the rendering.
1288 *
1289 * The naming of #43 has historic reason and is rooted inside code which is now put into a TER extension called
1290 * "statictemplates". Since the static template with uid 43 is the "content.default" and practically always used
1291 * for rendering the content elements it's very useful to have this function automatically adding the necessary
1292 * TypoScript for calling your plugin.
1293 * The logic is now generalized and called "defaultContentRendering", see addTypoScript() as well.
1294 *
1295 * $type determines the type of frontend plugin:
1296 * + list_type (default) - the good old "Insert plugin" entry
1297 * + menu_type - a "Menu/Sitemap" entry
1298 * + CType - a new content element type
1299 * + header_layout - an additional header type (added to the selection of layout1-5)
1300 * + includeLib - just includes the library for manual use somewhere in TypoScript.
1301 * (Remember that your $type definition should correspond to the column/items array in $GLOBALS['TCA'][tt_content] where you added the selector item for the element! See addPlugin() function)
1302 * FOR USE IN ext_localconf.php FILES
1303 *
1304 * @param string $key The extension key
1305 * @param string $_ unused since TYPO3 CMS 8
1306 * @param string $suffix Is used as a suffix of the class name (e.g. "_pi1")
1307 * @param string $type See description above
1308 * @param bool $cacheable If $cached is set as USER content object (cObject) is created - otherwise a USER_INT object is created.
1309 */
1310 public static function addPItoST43($key, $_, $suffix = '', $type = 'list_type', $cacheable = false)
1311 {
1312 $cN = self::getCN($key);
1313 // General plugin
1314 $pluginContent = trim('
1315 plugin.' . $cN . $suffix . ' = USER' . ($cacheable ? '' : '_INT') . '
1316 plugin.' . $cN . $suffix . '.userFunc = ' . $cN . $suffix . '->main
1317 ');
1318 self::addTypoScript($key, 'setup', '
1319 # Setting ' . $key . ' plugin TypoScript
1320 ' . $pluginContent);
1321 // Add after defaultContentRendering
1322 switch ($type) {
1323 case 'list_type':
1324 $addLine = 'tt_content.list.20.' . $key . $suffix . ' = < plugin.' . $cN . $suffix;
1325 break;
1326 case 'menu_type':
1327 $addLine = 'tt_content.menu.20.' . $key . $suffix . ' = < plugin.' . $cN . $suffix;
1328 break;
1329 case 'CType':
1330 $addLine = trim('
1331 tt_content.' . $key . $suffix . ' =< lib.contentElement
1332 tt_content.' . $key . $suffix . ' {
1333 templateName = Generic
1334 20 =< plugin.' . $cN . $suffix . '
1335 }
1336 ');
1337 break;
1338 case 'header_layout':
1339 $addLine = 'lib.stdheader.10.' . $key . $suffix . ' = < plugin.' . $cN . $suffix;
1340 break;
1341 case 'includeLib':
1342 $addLine = 'page.1000 = < plugin.' . $cN . $suffix;
1343 break;
1344 default:
1345 $addLine = '';
1346 }
1347 if ($addLine) {
1348 self::addTypoScript($key, 'setup', '
1349 # Setting ' . $key . ' plugin TypoScript
1350 ' . $addLine . '
1351 ', 'defaultContentRendering');
1352 }
1353 }
1354
1355 /**
1356 * Call this method to add an entry in the static template list found in sys_templates
1357 * FOR USE IN Configuration/TCA/Overrides/sys_template.php Use in ext_tables.php may break the frontend.
1358 *
1359 * @param string $extKey Is of course the extension key
1360 * @param string $path Is the path where the template files (fixed names) include_static.txt, constants.txt, setup.txt, and include_static_file.txt is found (relative to extPath, eg. 'static/'). The file include_static_file.txt, allows you to include other static templates defined in files, from your static template, and thus corresponds to the field 'include_static_file' in the sys_template table. The syntax for this is a comma separated list of static templates to include, like: EXT:fluid_styled_content/Configuration/TypoScript/,EXT:da_newsletter_subscription/static/,EXT:cc_random_image/pi2/static/
1361 * @param string $title Is the title in the selector box.
1362 * @throws \InvalidArgumentException
1363 * @see addTypoScript()
1364 */
1365 public static function addStaticFile($extKey, $path, $title)
1366 {
1367 if (!$extKey) {
1368 throw new \InvalidArgumentException('No extension key given.', 1507321291);
1369 }
1370 if (!$path) {
1371 throw new \InvalidArgumentException('No file path given.', 1507321297);
1372 }
1373 if (is_array($GLOBALS['TCA']['sys_template']['columns'])) {
1374 $value = str_replace(',', '', 'EXT:' . $extKey . '/' . $path);
1375 $itemArray = [trim($title . ' (' . $extKey . ')'), $value];
1376 $GLOBALS['TCA']['sys_template']['columns']['include_static_file']['config']['items'][] = $itemArray;
1377 }
1378 }
1379
1380 /**
1381 * Call this method to add an entry in the pageTSconfig list found in pages
1382 * FOR USE in Configuration/TCA/Overrides/pages.php
1383 *
1384 * @param string $extKey The extension key
1385 * @param string $filePath The path where the TSconfig file is located
1386 * @param string $title The title in the selector box
1387 * @throws \InvalidArgumentException
1388 */
1389 public static function registerPageTSConfigFile($extKey, $filePath, $title)
1390 {
1391 if (!$extKey) {
1392 throw new \InvalidArgumentException('No extension key given.', 1447789490);
1393 }
1394 if (!$filePath) {
1395 throw new \InvalidArgumentException('No file path given.', 1447789491);
1396 }
1397 if (!isset($GLOBALS['TCA']['pages']['columns']) || !is_array($GLOBALS['TCA']['pages']['columns'])) {
1398 throw new \InvalidArgumentException('No TCA definition for table "pages".', 1447789492);
1399 }
1400
1401 $value = str_replace(',', '', 'EXT:' . $extKey . '/' . $filePath);
1402 $itemArray = [trim($title . ' (' . $extKey . ')'), $value];
1403 $GLOBALS['TCA']['pages']['columns']['tsconfig_includes']['config']['items'][] = $itemArray;
1404 }
1405
1406 /**
1407 * Adds $content to the default TypoScript setup code as set in $GLOBALS['TYPO3_CONF_VARS'][FE]['defaultTypoScript_setup']
1408 * Prefixed with a [GLOBAL] line
1409 * FOR USE IN ext_localconf.php FILES
1410 *
1411 * @param string $content TypoScript Setup string
1412 */
1413 public static function addTypoScriptSetup($content)
1414 {
1415 $GLOBALS['TYPO3_CONF_VARS']['FE']['defaultTypoScript_setup'] .= '
1416 [GLOBAL]
1417 ' . $content;
1418 }
1419
1420 /**
1421 * Adds $content to the default TypoScript constants code as set in $GLOBALS['TYPO3_CONF_VARS'][FE]['defaultTypoScript_constants']
1422 * Prefixed with a [GLOBAL] line
1423 * FOR USE IN ext_localconf.php FILES
1424 *
1425 * @param string $content TypoScript Constants string
1426 */
1427 public static function addTypoScriptConstants($content)
1428 {
1429 $GLOBALS['TYPO3_CONF_VARS']['FE']['defaultTypoScript_constants'] .= '
1430 [GLOBAL]
1431 ' . $content;
1432 }
1433
1434 /**
1435 * Adds $content to the default TypoScript code for either setup or constants as set in $GLOBALS['TYPO3_CONF_VARS'][FE]['defaultTypoScript_*']
1436 * (Basically this function can do the same as addTypoScriptSetup and addTypoScriptConstants - just with a little more hazzle, but also with some more options!)
1437 * FOR USE IN ext_localconf.php FILES
1438 * Note: As of TYPO3 CMS 6.2, static template #43 (content: default) was replaced with "defaultContentRendering" which makes it
1439 * possible that a first extension like fluid_styled_content registers a "contentRendering" template (= a template that defines default content rendering TypoScript)
1440 * by adding itself to $TYPO3_CONF_VARS[FE][contentRenderingTemplates][] = 'myext/Configuration/TypoScript'.
1441 * An extension calling addTypoScript('myext', 'setup', $typoScript, 'defaultContentRendering') will add its TypoScript directly after;
1442 * For now, "43" and "defaultContentRendering" can be used, but "defaultContentRendering" is more descriptive and
1443 * should be used in the future.
1444 *
1445 * @param string $key Is the extension key (informative only).
1446 * @param string $type Is either "setup" or "constants" and obviously determines which kind of TypoScript code we are adding.
1447 * @param string $content Is the TS content, will be prefixed with a [GLOBAL] line and a comment-header.
1448 * @param int|string string pointing to the "key" of a static_file template ([reduced extension_key]/[local path]). The points is that the TypoScript you add is included only IF that static template is included (and in that case, right after). So effectively the TypoScript you set can specifically overrule settings from those static templates.
1449 * @throws \InvalidArgumentException
1450 */
1451 public static function addTypoScript(string $key, string $type, string $content, $afterStaticUid = 0)
1452 {
1453 if ($type !== 'setup' && $type !== 'constants') {
1454 throw new \InvalidArgumentException('Argument $type must be set to either "setup" or "constants" when calling addTypoScript from extension "' . $key . '"', 1507321200);
1455 }
1456 $content = '
1457
1458 [GLOBAL]
1459 #############################################
1460 ## TypoScript added by extension "' . $key . '"
1461 #############################################
1462
1463 ' . $content;
1464 if ($afterStaticUid) {
1465 // If 'content (default)' is targeted (static uid 43),
1466 // the content is added after typoscript of type contentRendering, eg. fluid_styled_content, see EXT:frontend/TemplateService for more information on how the code is parsed
1467 if ($afterStaticUid === 'defaultContentRendering' || $afterStaticUid == 43) {
1468 if (!isset($GLOBALS['TYPO3_CONF_VARS']['FE']['defaultTypoScript_' . $type . '.']['defaultContentRendering'])) {
1469 $GLOBALS['TYPO3_CONF_VARS']['FE']['defaultTypoScript_' . $type . '.']['defaultContentRendering'] = '';
1470 }
1471 $GLOBALS['TYPO3_CONF_VARS']['FE']['defaultTypoScript_' . $type . '.']['defaultContentRendering'] .= $content;
1472 } else {
1473 if (!isset($GLOBALS['TYPO3_CONF_VARS']['FE']['defaultTypoScript_' . $type . '.'][$afterStaticUid])) {
1474 $GLOBALS['TYPO3_CONF_VARS']['FE']['defaultTypoScript_' . $type . '.'][$afterStaticUid] = '';
1475 }
1476 $GLOBALS['TYPO3_CONF_VARS']['FE']['defaultTypoScript_' . $type . '.'][$afterStaticUid] .= $content;
1477 }
1478 } else {
1479 if (!isset($GLOBALS['TYPO3_CONF_VARS']['FE']['defaultTypoScript_' . $type])) {
1480 $GLOBALS['TYPO3_CONF_VARS']['FE']['defaultTypoScript_' . $type] = '';
1481 }
1482 $GLOBALS['TYPO3_CONF_VARS']['FE']['defaultTypoScript_' . $type] .= $content;
1483 }
1484 }
1485
1486 /***************************************
1487 *
1488 * Internal extension management methods
1489 *
1490 ***************************************/
1491 /**
1492 * Find extension icon
1493 *
1494 * @param string $extensionPath Path to extension directory.
1495 * @param bool $returnFullPath Return full path of file.
1496 *
1497 * @return string
1498 */
1499 public static function getExtensionIcon($extensionPath, $returnFullPath = false)
1500 {
1501 $icon = '';
1502 $locationsToCheckFor = [
1503 'Resources/Public/Icons/Extension.svg',
1504 'Resources/Public/Icons/Extension.png',
1505 'Resources/Public/Icons/Extension.gif',
1506 'ext_icon.svg',
1507 'ext_icon.png',
1508 'ext_icon.gif',
1509 ];
1510 foreach ($locationsToCheckFor as $fileLocation) {
1511 if (file_exists($extensionPath . $fileLocation)) {
1512 $icon = $fileLocation;
1513 break;
1514 }
1515 }
1516 return $returnFullPath ? $extensionPath . $icon : $icon;
1517 }
1518
1519 /**
1520 * Execute all ext_localconf.php files of loaded extensions.
1521 * The method implements an optionally used caching mechanism that concatenates all
1522 * ext_localconf.php files in one file.
1523 *
1524 * This is an internal method. It is only used during bootstrap and
1525 * extensions should not use it!
1526 *
1527 * @param bool $allowCaching Whether or not to load / create concatenated cache file
1528 * @access private
1529 */
1530 public static function loadExtLocalconf($allowCaching = true)
1531 {
1532 if ($allowCaching) {
1533 $cacheIdentifier = self::getExtLocalconfCacheIdentifier();
1534 /** @var $codeCache \TYPO3\CMS\Core\Cache\Frontend\FrontendInterface */
1535 $codeCache = self::getCacheManager()->getCache('cache_core');
1536 if ($codeCache->has($cacheIdentifier)) {
1537 $codeCache->require($cacheIdentifier);
1538 } else {
1539 self::loadSingleExtLocalconfFiles();
1540 self::createExtLocalconfCacheEntry();
1541 }
1542 } else {
1543 self::loadSingleExtLocalconfFiles();
1544 }
1545 }
1546
1547 /**
1548 * Execute ext_localconf.php files from extensions
1549 */
1550 protected static function loadSingleExtLocalconfFiles()
1551 {
1552 // This is the main array meant to be manipulated in the ext_localconf.php files
1553 // In general it is recommended to not rely on it to be globally defined in that
1554 // scope but to use $GLOBALS['TYPO3_CONF_VARS'] instead.
1555 // Nevertheless we define it here as global for backwards compatibility.
1556 global $TYPO3_CONF_VARS;
1557 foreach ($GLOBALS['TYPO3_LOADED_EXT'] as $_EXTKEY => $extensionInformation) {
1558 if ((is_array($extensionInformation) || $extensionInformation instanceof \ArrayAccess) && isset($extensionInformation['ext_localconf.php'])) {
1559 // $_EXTKEY and $_EXTCONF are available in ext_localconf.php
1560 // and are explicitly set in cached file as well
1561 $_EXTCONF = $GLOBALS['TYPO3_CONF_VARS']['EXT']['extConf'][$_EXTKEY] ?? null;
1562 require $extensionInformation['ext_localconf.php'];
1563 }
1564 }
1565 }
1566
1567 /**
1568 * Create cache entry for concatenated ext_localconf.php files
1569 */
1570 protected static function createExtLocalconfCacheEntry()
1571 {
1572 $extensionInformation = $GLOBALS['TYPO3_LOADED_EXT'];
1573 $phpCodeToCache = [];
1574 // Set same globals as in loadSingleExtLocalconfFiles()
1575 $phpCodeToCache[] = '/**';
1576 $phpCodeToCache[] = ' * Compiled ext_localconf.php cache file';
1577 $phpCodeToCache[] = ' */';
1578 $phpCodeToCache[] = '';
1579 $phpCodeToCache[] = 'global $TYPO3_CONF_VARS, $T3_SERVICES, $T3_VAR;';
1580 $phpCodeToCache[] = '';
1581 // Iterate through loaded extensions and add ext_localconf content
1582 foreach ($extensionInformation as $extensionKey => $extensionDetails) {
1583 if (isset($extensionDetails['ext_localconf.php']) && $extensionDetails['ext_localconf.php']) {
1584 // Include a header per extension to make the cache file more readable
1585 $phpCodeToCache[] = '/**';
1586 $phpCodeToCache[] = ' * Extension: ' . $extensionKey;
1587 $phpCodeToCache[] = ' * File: ' . $extensionDetails['ext_localconf.php'];
1588 $phpCodeToCache[] = ' */';
1589 $phpCodeToCache[] = '';
1590 // Set $_EXTKEY and $_EXTCONF for this extension
1591 $phpCodeToCache[] = '$_EXTKEY = \'' . $extensionKey . '\';';
1592 $phpCodeToCache[] = '$_EXTCONF = $GLOBALS[\'TYPO3_CONF_VARS\'][\'EXT\'][\'extConf\'][$_EXTKEY] ?? null;';
1593 $phpCodeToCache[] = '';
1594 // Add ext_localconf.php content of extension
1595 $phpCodeToCache[] = trim(file_get_contents($extensionDetails['ext_localconf.php']));
1596 $phpCodeToCache[] = '';
1597 $phpCodeToCache[] = '';
1598 }
1599 }
1600 $phpCodeToCache = implode(LF, $phpCodeToCache);
1601 // Remove all start and ending php tags from content
1602 $phpCodeToCache = preg_replace('/<\\?php|\\?>/is', '', $phpCodeToCache);
1603 self::getCacheManager()->getCache('cache_core')->set(self::getExtLocalconfCacheIdentifier(), $phpCodeToCache);
1604 }
1605
1606 /**
1607 * Cache identifier of concatenated ext_localconf file
1608 *
1609 * @return string
1610 */
1611 protected static function getExtLocalconfCacheIdentifier()
1612 {
1613 return 'ext_localconf_' . sha1(TYPO3_version . Environment::getProjectPath() . 'extLocalconf' . serialize($GLOBALS['TYPO3_CONF_VARS']['EXT']['runtimeActivatedPackages']));
1614 }
1615
1616 /**
1617 * Wrapper for buildBaseTcaFromSingleFiles handling caching.
1618 *
1619 * This builds 'base' TCA that is later overloaded by ext_tables.php.
1620 *
1621 * Use a cache file if exists and caching is allowed.
1622 *
1623 * This is an internal method. It is only used during bootstrap and
1624 * extensions should not use it!
1625 *
1626 * @param bool $allowCaching Whether or not to load / create concatenated cache file
1627 * @access private
1628 */
1629 public static function loadBaseTca($allowCaching = true)
1630 {
1631 if ($allowCaching) {
1632 $cacheIdentifier = static::getBaseTcaCacheIdentifier();
1633 /** @var $codeCache \TYPO3\CMS\Core\Cache\Frontend\FrontendInterface */
1634 $codeCache = static::getCacheManager()->getCache('cache_core');
1635 $cacheData = $codeCache->require($cacheIdentifier);
1636 if ($cacheData) {
1637 $GLOBALS['TCA'] = $cacheData['tca'];
1638 GeneralUtility::setSingletonInstance(
1639 CategoryRegistry::class,
1640 unserialize(
1641 $cacheData['categoryRegistry'],
1642 ['allowed_classes' => [CategoryRegistry::class]]
1643 )
1644 );
1645 } else {
1646 static::buildBaseTcaFromSingleFiles();
1647 static::createBaseTcaCacheFile();
1648 }
1649 } else {
1650 static::buildBaseTcaFromSingleFiles();
1651 }
1652 }
1653
1654 /**
1655 * Find all Configuration/TCA/* files of extensions and create base TCA from it.
1656 * The filename must be the table name in $GLOBALS['TCA'], and the content of
1657 * the file should return an array with content of a specific table.
1658 *
1659 * @see Extension core, extensionmanager and others for examples.
1660 */
1661 protected static function buildBaseTcaFromSingleFiles()
1662 {
1663 $GLOBALS['TCA'] = [];
1664
1665 $activePackages = static::$packageManager->getActivePackages();
1666
1667 // First load "full table" files from Configuration/TCA
1668 foreach ($activePackages as $package) {
1669 try {
1670 $finder = Finder::create()->files()->sortByName()->depth(0)->name('*.php')->in($package->getPackagePath() . 'Configuration/TCA');
1671 } catch (\InvalidArgumentException $e) {
1672 // No such directory in this package
1673 continue;
1674 }
1675 foreach ($finder as $fileInfo) {
1676 $tcaOfTable = require $fileInfo->getPathname();
1677 if (is_array($tcaOfTable)) {
1678 $tcaTableName = substr($fileInfo->getBasename(), 0, -4);
1679 $GLOBALS['TCA'][$tcaTableName] = $tcaOfTable;
1680 }
1681 }
1682 }
1683
1684 // Apply category stuff
1685 CategoryRegistry::getInstance()->applyTcaForPreRegisteredTables();
1686
1687 // Execute override files from Configuration/TCA/Overrides
1688 foreach ($activePackages as $package) {
1689 try {
1690 $finder = Finder::create()->files()->sortByName()->depth(0)->name('*.php')->in($package->getPackagePath() . 'Configuration/TCA/Overrides');
1691 } catch (\InvalidArgumentException $e) {
1692 // No such directory in this package
1693 continue;
1694 }
1695 foreach ($finder as $fileInfo) {
1696 require $fileInfo->getPathname();
1697 }
1698 }
1699
1700 // TCA migration
1701 // @deprecated since TYPO3 CMS 7. Not removed in TYPO3 CMS 8 though. This call will stay for now to allow further TCA migrations in 8.
1702 $tcaMigration = GeneralUtility::makeInstance(TcaMigration::class);
1703 $GLOBALS['TCA'] = $tcaMigration->migrate($GLOBALS['TCA']);
1704 $messages = $tcaMigration->getMessages();
1705 if (!empty($messages)) {
1706 $context = 'Automatic TCA migration done during bootstrap. Please adapt TCA accordingly, these migrations'
1707 . ' will be removed. The backend module "Configuration -> TCA" shows the modified values.'
1708 . ' Please adapt these areas:';
1709 array_unshift($messages, $context);
1710 trigger_error(implode(LF, $messages), E_USER_DEPRECATED);
1711 }
1712
1713 // TCA preparation
1714 $tcaPreparation = GeneralUtility::makeInstance(TcaPreparation::class);
1715 $GLOBALS['TCA'] = $tcaPreparation->prepare($GLOBALS['TCA']);
1716
1717 static::emitTcaIsBeingBuiltSignal($GLOBALS['TCA']);
1718 }
1719
1720 /**
1721 * Emits the signal and uses the result of slots for the final TCA
1722 * This means, that *all* slots *must* return the complete TCA to
1723 * be effective. If a slot calls methods that manipulate the global array,
1724 * it needs to return the global array in the end. To be future proof,
1725 * a slot should manipulate the signal argument only and return it
1726 * after manipulation.
1727 *
1728 * @param array $tca
1729 */
1730 protected static function emitTcaIsBeingBuiltSignal(array $tca)
1731 {
1732 list($tca) = static::getSignalSlotDispatcher()->dispatch(__CLASS__, 'tcaIsBeingBuilt', [$tca]);
1733 $GLOBALS['TCA'] = $tca;
1734 }
1735
1736 /**
1737 * Cache base $GLOBALS['TCA'] to cache file to require the whole thing in one
1738 * file for next access instead of cycling through all extensions again.
1739 */
1740 protected static function createBaseTcaCacheFile()
1741 {
1742 /** @var $codeCache \TYPO3\CMS\Core\Cache\Frontend\FrontendInterface */
1743 $codeCache = self::getCacheManager()->getCache('cache_core');
1744 $codeCache->set(
1745 static::getBaseTcaCacheIdentifier(),
1746 'return '
1747 . var_export(['tca' => $GLOBALS['TCA'], 'categoryRegistry' => serialize(CategoryRegistry::getInstance())], true)
1748 . ';'
1749 );
1750 }
1751
1752 /**
1753 * Cache identifier of base TCA cache entry.
1754 *
1755 * @return string
1756 */
1757 protected static function getBaseTcaCacheIdentifier()
1758 {
1759 return 'tca_base_' . sha1(TYPO3_version . Environment::getProjectPath() . 'tca_code' . serialize($GLOBALS['TYPO3_CONF_VARS']['EXT']['runtimeActivatedPackages']));
1760 }
1761
1762 /**
1763 * Execute all ext_tables.php files of loaded extensions.
1764 * The method implements an optionally used caching mechanism that concatenates all
1765 * ext_tables.php files in one file.
1766 *
1767 * This is an internal method. It is only used during bootstrap and
1768 * extensions should not use it!
1769 *
1770 * @param bool $allowCaching Whether to load / create concatenated cache file
1771 * @access private
1772 */
1773 public static function loadExtTables($allowCaching = true)
1774 {
1775 if ($allowCaching && !self::$extTablesWasReadFromCacheOnce) {
1776 self::$extTablesWasReadFromCacheOnce = true;
1777 $cacheIdentifier = self::getExtTablesCacheIdentifier();
1778 /** @var $codeCache \TYPO3\CMS\Core\Cache\Frontend\FrontendInterface */
1779 $codeCache = self::getCacheManager()->getCache('cache_core');
1780 if ($codeCache->has($cacheIdentifier)) {
1781 $codeCache->require($cacheIdentifier);
1782 } else {
1783 self::loadSingleExtTablesFiles();
1784 self::createExtTablesCacheEntry();
1785 }
1786 } else {
1787 self::loadSingleExtTablesFiles();
1788 }
1789 }
1790
1791 /**
1792 * Load ext_tables.php as single files
1793 */
1794 protected static function loadSingleExtTablesFiles()
1795 {
1796 // In general it is recommended to not rely on it to be globally defined in that
1797 // scope, but we can not prohibit this without breaking backwards compatibility
1798 global $T3_SERVICES, $T3_VAR, $TYPO3_CONF_VARS;
1799 global $TBE_MODULES, $TBE_MODULES_EXT, $TCA;
1800 global $PAGES_TYPES, $TBE_STYLES;
1801 global $_EXTKEY;
1802 // Load each ext_tables.php file of loaded extensions
1803 foreach ($GLOBALS['TYPO3_LOADED_EXT'] as $_EXTKEY => $extensionInformation) {
1804 if ((is_array($extensionInformation) || $extensionInformation instanceof \ArrayAccess) && !empty($extensionInformation['ext_tables.php'])) {
1805 // $_EXTKEY and $_EXTCONF are available in ext_tables.php
1806 // and are explicitly set in cached file as well
1807 $_EXTCONF = $GLOBALS['TYPO3_CONF_VARS']['EXT']['extConf'][$_EXTKEY] ?? null;
1808 require $extensionInformation['ext_tables.php'];
1809 }
1810 }
1811 }
1812
1813 /**
1814 * Create concatenated ext_tables.php cache file
1815 */
1816 protected static function createExtTablesCacheEntry()
1817 {
1818 $extensionInformation = $GLOBALS['TYPO3_LOADED_EXT'];
1819 $phpCodeToCache = [];
1820 // Set same globals as in loadSingleExtTablesFiles()
1821 $phpCodeToCache[] = '/**';
1822 $phpCodeToCache[] = ' * Compiled ext_tables.php cache file';
1823 $phpCodeToCache[] = ' */';
1824 $phpCodeToCache[] = '';
1825 $phpCodeToCache[] = 'global $T3_SERVICES, $T3_VAR, $TYPO3_CONF_VARS;';
1826 $phpCodeToCache[] = 'global $TBE_MODULES, $TBE_MODULES_EXT, $TCA;';
1827 $phpCodeToCache[] = 'global $PAGES_TYPES, $TBE_STYLES;';
1828 $phpCodeToCache[] = 'global $_EXTKEY;';
1829 $phpCodeToCache[] = '';
1830 // Iterate through loaded extensions and add ext_tables content
1831 foreach ($extensionInformation as $extensionKey => $extensionDetails) {
1832 if (isset($extensionDetails['ext_tables.php']) && $extensionDetails['ext_tables.php']) {
1833 // Include a header per extension to make the cache file more readable
1834 $phpCodeToCache[] = '/**';
1835 $phpCodeToCache[] = ' * Extension: ' . $extensionKey;
1836 $phpCodeToCache[] = ' * File: ' . $extensionDetails['ext_tables.php'];
1837 $phpCodeToCache[] = ' */';
1838 $phpCodeToCache[] = '';
1839 // Set $_EXTKEY and $_EXTCONF for this extension
1840 $phpCodeToCache[] = '$_EXTKEY = \'' . $extensionKey . '\';';
1841 $phpCodeToCache[] = '$_EXTCONF = $GLOBALS[\'TYPO3_CONF_VARS\'][\'EXT\'][\'extConf\'][$_EXTKEY] ?? null;';
1842 $phpCodeToCache[] = '';
1843 // Add ext_tables.php content of extension
1844 $phpCodeToCache[] = trim(file_get_contents($extensionDetails['ext_tables.php']));
1845 $phpCodeToCache[] = '';
1846 }
1847 }
1848 $phpCodeToCache = implode(LF, $phpCodeToCache);
1849 // Remove all start and ending php tags from content
1850 $phpCodeToCache = preg_replace('/<\\?php|\\?>/is', '', $phpCodeToCache);
1851 self::getCacheManager()->getCache('cache_core')->set(self::getExtTablesCacheIdentifier(), $phpCodeToCache);
1852 }
1853
1854 /**
1855 * Cache identifier for concatenated ext_tables.php files
1856 *
1857 * @return string
1858 */
1859 protected static function getExtTablesCacheIdentifier()
1860 {
1861 return 'ext_tables_' . sha1(TYPO3_version . Environment::getProjectPath() . 'extTables' . serialize($GLOBALS['TYPO3_CONF_VARS']['EXT']['runtimeActivatedPackages']));
1862 }
1863
1864 /**
1865 * Remove cache files from php code cache, grouped by 'system'
1866 *
1867 * This removes the following cache entries:
1868 * - autoloader cache registry
1869 * - cache loaded extension array
1870 * - ext_localconf concatenation
1871 * - ext_tables concatenation
1872 *
1873 * This method is usually only used by extension that fiddle
1874 * with the loaded extensions. An example is the extension
1875 * manager and the install tool.
1876 *
1877 * @deprecated CacheManager provides the functionality directly
1878 */
1879 public static function removeCacheFiles()
1880 {
1881 trigger_error('removeCacheFiles() will be removed in TYPO3 v10. Use CacheManager directly to flush all system caches.', E_USER_DEPRECATED);
1882 self::getCacheManager()->flushCachesInGroup('system');
1883 }
1884
1885 /**
1886 * Gets an array of loaded extension keys
1887 *
1888 * @return array Loaded extensions
1889 */
1890 public static function getLoadedExtensionListArray()
1891 {
1892 return array_keys(static::$packageManager->getActivePackages());
1893 }
1894
1895 /**
1896 * Loads given extension
1897 *
1898 * Warning: This method only works if the ugrade wizard to transform
1899 * localconf.php to LocalConfiguration.php was already run
1900 *
1901 * @param string $extensionKey Extension key to load
1902 * @throws \RuntimeException
1903 */
1904 public static function loadExtension($extensionKey)
1905 {
1906 if (static::$packageManager->isPackageActive($extensionKey)) {
1907 throw new \RuntimeException('Extension already loaded', 1342345486);
1908 }
1909 static::$packageManager->activatePackage($extensionKey);
1910 }
1911
1912 /**
1913 * Unloads given extension
1914 *
1915 * Warning: This method only works if the ugrade wizard to transform
1916 * localconf.php to LocalConfiguration.php was already run
1917 *
1918 * @param string $extensionKey Extension key to remove
1919 * @throws \RuntimeException
1920 */
1921 public static function unloadExtension($extensionKey)
1922 {
1923 if (!static::$packageManager->isPackageActive($extensionKey)) {
1924 throw new \RuntimeException('Extension not loaded', 1342345487);
1925 }
1926 static::$packageManager->deactivatePackage($extensionKey);
1927 }
1928
1929 /**
1930 * Makes a table categorizable by adding value into the category registry.
1931 * FOR USE IN ext_localconf.php FILES or files in Configuration/TCA/Overrides/*.php Use the latter to benefit from TCA caching!
1932 *
1933 * @param string $extensionKey Extension key to be used
1934 * @param string $tableName Name of the table to be categorized
1935 * @param string $fieldName Name of the field to be used to store categories
1936 * @param array $options Additional configuration options
1937 * @param bool $override If TRUE, any category configuration for the same table / field is removed before the new configuration is added
1938 * @see addTCAcolumns
1939 * @see addToAllTCAtypes
1940 */
1941 public static function makeCategorizable($extensionKey, $tableName, $fieldName = 'categories', array $options = [], $override = false)
1942 {
1943 // Update the category registry
1944 $result = CategoryRegistry::getInstance()->add($extensionKey, $tableName, $fieldName, $options, $override);
1945 if ($result === false) {
1946 GeneralUtility::makeInstance(LogManager::class)
1947 ->getLogger(__CLASS__)
1948 ->warning(sprintf(
1949 CategoryRegistry::class . ': no category registered for table "%s". Key was already registered.',
1950 $tableName
1951 ));
1952 }
1953 }
1954 }