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