[TASK] Mark ExtJS related API calls as deprecated
[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 * @param string $extensionName
829 * @param string $mainModuleName Is the main module key
830 * @param string $subModuleName Is the submodule key, if blank a plain main module is generated
831 * @param string $position Passed to \TYPO3\CMS\Core\Utility\ExtensionManagementUtility::addModule, see reference there
832 * @param array $moduleConfiguration Icon with array keys: access, icon, labels to configure the module
833 * @throws \InvalidArgumentException
834 * @deprecated since TYPO3 v8, will be removed in TYPO3 v9, use addModule instead for a regular module, as ExtJS usage is discouraged,
835 */
836 public static function addExtJSModule($extensionName, $mainModuleName, $subModuleName = '', $position = '', array $moduleConfiguration = [])
837 {
838 GeneralUtility::logDeprecatedFunction();
839 if (empty($extensionName)) {
840 throw new \InvalidArgumentException('The extension name must not be empty', 1325938973);
841 }
842 $extensionName = str_replace(' ', '', ucwords(str_replace('_', ' ', $extensionName)));
843 $defaultModuleConfiguration = [
844 'access' => 'admin',
845 'icon' => 'EXT:backend/Resources/Public/Images/Logo.png',
846 'labels' => '',
847 ];
848 // Add mandatory parameter to use new pagetree
849 if ($mainModuleName === 'web') {
850 $defaultModuleConfiguration['navigationComponentId'] = 'typo3-pagetree';
851 }
852 ArrayUtility::mergeRecursiveWithOverrule($defaultModuleConfiguration, $moduleConfiguration);
853 $moduleConfiguration = $defaultModuleConfiguration;
854 if ($subModuleName !== '') {
855 $moduleSignature = $mainModuleName . '_' . $subModuleName;
856 } else {
857 $moduleSignature = $mainModuleName;
858 }
859 $moduleConfiguration['name'] = $moduleSignature;
860 $moduleConfiguration['script'] = 'extjspaneldummy.html';
861 $moduleConfiguration['extensionName'] = $extensionName;
862 $moduleConfiguration['configureModuleFunction'] = [self::class, 'configureModule'];
863 $GLOBALS['TBE_MODULES']['_configuration'][$moduleSignature] = $moduleConfiguration;
864 self::addModule($mainModuleName, $subModuleName, $position);
865 }
866
867 /**
868 * This method is called from \TYPO3\CMS\Backend\Module\ModuleLoader::checkMod
869 * and it replaces old conf.php.
870 *
871 * @param string $moduleSignature The module name
872 * @return array Configuration of the module
873 */
874 public static function configureModule($moduleSignature)
875 {
876 $moduleConfiguration = $GLOBALS['TBE_MODULES']['_configuration'][$moduleSignature];
877 if (!empty($moduleConfiguration['labels']['tabs_images']['tab'])) {
878 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.');
879 $moduleConfiguration['icon'] = $moduleConfiguration['labels']['tabs_images']['tab'];
880 unset($moduleConfiguration['labels']['tabs_images']['tab']);
881 }
882
883 // Register the icon and move it too "iconIdentifier"
884 if (!empty($moduleConfiguration['icon'])) {
885 $iconIdentifier = 'module-' . $moduleSignature;
886 $iconRegistry = GeneralUtility::makeInstance(IconRegistry::class);
887 $iconRegistry->registerIcon($iconIdentifier, BitmapIconProvider::class, [
888 'source' => GeneralUtility::getFileAbsFileName($moduleConfiguration['icon'])
889 ]);
890 $moduleConfiguration['iconIdentifier'] = $iconIdentifier;
891 unset($moduleConfiguration['icon']);
892 }
893
894 return $moduleConfiguration;
895 }
896
897 /**
898 * Adds a module (main or sub) to the backend interface
899 * FOR USE IN ext_tables.php FILES
900 *
901 * @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.
902 * @param string $sub The submodule key. If $sub is not set a blank $main module is created.
903 * @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.
904 * @param string $path The absolute path to the module. Was used prior to TYPO3 v8, use $moduleConfiguration[routeTarget] now
905 * @param array $moduleConfiguration additional configuration, previously put in "conf.php" of the module directory
906 * @return void
907 */
908 public static function addModule($main, $sub = '', $position = '', $path = null, $moduleConfiguration = [])
909 {
910 // If there is already a main module by this name:
911 // Adding the submodule to the correct position:
912 if (isset($GLOBALS['TBE_MODULES'][$main]) && $sub) {
913 list($place, $modRef) = GeneralUtility::trimExplode(':', $position, true);
914 $modules = ',' . $GLOBALS['TBE_MODULES'][$main] . ',';
915 if ($place === null || ($modRef !== null && !GeneralUtility::inList($modules, $modRef))) {
916 $place = 'bottom';
917 }
918 $modRef = ',' . $modRef . ',';
919 if (!GeneralUtility::inList($modules, $sub)) {
920 switch (strtolower($place)) {
921 case 'after':
922 $modules = str_replace($modRef, $modRef . $sub . ',', $modules);
923 break;
924 case 'before':
925 $modules = str_replace($modRef, ',' . $sub . $modRef, $modules);
926 break;
927 case 'top':
928 $modules = $sub . $modules;
929 break;
930 case 'bottom':
931 default:
932 $modules = $modules . $sub;
933 }
934 }
935 // Re-inserting the submodule list:
936 $GLOBALS['TBE_MODULES'][$main] = trim($modules, ',');
937 } else {
938 // Create new main modules with only one submodule, $sub (or none if $sub is blank)
939 $GLOBALS['TBE_MODULES'][$main] = $sub;
940 }
941
942 // add additional configuration
943 if (is_array($moduleConfiguration) && !empty($moduleConfiguration)) {
944 $fullModuleSignature = $main . ($sub ? '_' . $sub : '');
945
946 if (!empty($moduleConfiguration['labels']['tabs_images']['tab'])) {
947 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.');
948 $moduleConfiguration['icon'] = $moduleConfiguration['labels']['tabs_images']['tab'];
949 unset($moduleConfiguration['labels']['tabs_images']['tab']);
950 }
951
952 if (!empty($moduleConfiguration['icon'])) {
953 $iconIdentifier = 'module-' . $fullModuleSignature;
954 $iconRegistry = GeneralUtility::makeInstance(IconRegistry::class);
955 $iconRegistry->registerIcon($iconIdentifier, BitmapIconProvider::class, [
956 'source' => GeneralUtility::getFileAbsFileName($moduleConfiguration['icon'])
957 ]);
958 $moduleConfiguration['iconIdentifier'] = $iconIdentifier;
959 unset($moduleConfiguration['icon']);
960 }
961
962 $GLOBALS['TBE_MODULES']['_configuration'][$fullModuleSignature] = $moduleConfiguration;
963 }
964 }
965
966 /**
967 * Registers an Ext.Direct component with access restrictions.
968 *
969 * @param string $endpointName
970 * @param string $callbackClass
971 * @param string $moduleName Optional: must be <mainmodule> or <mainmodule>_<submodule>
972 * @param string $accessLevel Optional: can be 'admin' or 'user,group'
973 * @return void
974 * @deprecated since TYPO3 v8, will be removed in TYPO3 v9
975 */
976 public static function registerExtDirectComponent($endpointName, $callbackClass, $moduleName = null, $accessLevel = null)
977 {
978 $GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['ExtDirect'][$endpointName] = [
979 'callbackClass' => $callbackClass,
980 'moduleName' => $moduleName,
981 'accessLevel' => $accessLevel
982 ];
983 }
984
985 /**
986 * Registers an Ajax Handler
987 *
988 * @param string $ajaxId Identifier of the handler, that is used in the request
989 * @param string $callbackMethod TYPO3 callback method (className->methodName).
990 * @param bool $csrfTokenCheck Only set this to FALSE if you are sure that the registered handler does not modify any data!
991 * @deprecated since TYPO3 v8, will be removed in TYPO3 v9
992 */
993 public static function registerAjaxHandler($ajaxId, $callbackMethod, $csrfTokenCheck = true)
994 {
995 GeneralUtility::logDeprecatedFunction();
996 $GLOBALS['TYPO3_CONF_VARS']['BE']['AJAX'][$ajaxId] = [
997 'callbackMethod' => $callbackMethod,
998 'csrfTokenCheck' => $csrfTokenCheck
999 ];
1000 }
1001
1002 /**
1003 * Adds a "Function menu module" ('third level module') to an existing function menu for some other backend module
1004 * The arguments values are generally determined by which function menu this is supposed to interact with
1005 * See Inside TYPO3 for information on how to use this function.
1006 * FOR USE IN ext_tables.php FILES
1007 *
1008 * @param string $modname Module name
1009 * @param string $className Class name
1010 * @param string $classPath Class path, deprecated since 6.2, use auto-loading instead
1011 * @param string $title Title of module
1012 * @param string $MM_key Menu array key - default is "function
1013 * @param string $WS Workspace conditions. Blank means all workspaces, any other string can be a comma list of "online", "offline" and "custom
1014 * @return void
1015 * @see \TYPO3\CMS\Backend\Module\BaseScriptClass::mergeExternalItems()
1016 */
1017 public static function insertModuleFunction($modname, $className, $classPath = null, $title, $MM_key = 'function', $WS = '')
1018 {
1019 $GLOBALS['TBE_MODULES_EXT'][$modname]['MOD_MENU'][$MM_key][$className] = [
1020 'name' => $className,
1021 'title' => $title,
1022 'ws' => $WS
1023 ];
1024 }
1025
1026 /**
1027 * Adds some more content to a key of TYPO3_CONF_VARS array.
1028 *
1029 * This also tracks which content was added by extensions (in TYPO3_CONF_VARS_extensionAdded)
1030 * so that they cannot be editted again through the Install Tool.
1031 *
1032 * @param string $group The group ('FE', 'BE', 'SYS' ...)
1033 * @param string $key The key of this setting within the group
1034 * @param string $content The text to add (include leading "\n" in case of multi-line entries)
1035 * @return void
1036 */
1037 public static function appendToTypoConfVars($group, $key, $content)
1038 {
1039 $GLOBALS['TYPO3_CONF_VARS_extensionAdded'][$group][$key] .= $content;
1040 $GLOBALS['TYPO3_CONF_VARS'][$group][$key] .= $content;
1041 }
1042
1043 /**
1044 * Adds $content to the default Page TSconfig as set in $GLOBALS['TYPO3_CONF_VARS'][BE]['defaultPageTSconfig']
1045 * Prefixed with a [GLOBAL] line
1046 * FOR USE IN ext_tables.php/ext_localconf.php FILES
1047 *
1048 * @param string $content Page TSconfig content
1049 * @return void
1050 */
1051 public static function addPageTSConfig($content)
1052 {
1053 self::appendToTypoConfVars('BE', 'defaultPageTSconfig', '
1054 [GLOBAL]
1055 ' . $content);
1056 }
1057
1058 /**
1059 * Adds $content to the default User TSconfig as set in $GLOBALS['TYPO3_CONF_VARS'][BE]['defaultUserTSconfig']
1060 * Prefixed with a [GLOBAL] line
1061 * FOR USE IN ext_tables.php/ext_localconf.php FILES
1062 *
1063 * @param string $content User TSconfig content
1064 * @return void
1065 */
1066 public static function addUserTSConfig($content)
1067 {
1068 self::appendToTypoConfVars('BE', 'defaultUserTSconfig', '
1069 [GLOBAL]
1070 ' . $content);
1071 }
1072
1073 /**
1074 * Adds a reference to a locallang file with $GLOBALS['TCA_DESCR'] labels
1075 * FOR USE IN ext_tables.php FILES
1076 * 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.
1077 *
1078 * @param string $tca_descr_key Description key. Typically a database table (like "pages") but for applications can be other strings, but prefixed with "_MOD_")
1079 * @param string $file_ref File reference to locallang file, eg. "EXT:lang/Resources/Private/Language/locallang_csh_pages.xlf" (or ".xml")
1080 * @return void
1081 */
1082 public static function addLLrefForTCAdescr($tca_descr_key, $file_ref)
1083 {
1084 if ($tca_descr_key) {
1085 if (!is_array($GLOBALS['TCA_DESCR'][$tca_descr_key])) {
1086 $GLOBALS['TCA_DESCR'][$tca_descr_key] = [];
1087 }
1088 if (!is_array($GLOBALS['TCA_DESCR'][$tca_descr_key]['refs'])) {
1089 $GLOBALS['TCA_DESCR'][$tca_descr_key]['refs'] = [];
1090 }
1091 $GLOBALS['TCA_DESCR'][$tca_descr_key]['refs'][] = $file_ref;
1092 }
1093 }
1094
1095 /**
1096 * Registers a navigation component
1097 *
1098 * @param string $module
1099 * @param string $componentId
1100 * @param string $extensionKey
1101 * @throws \RuntimeException
1102 * @return void
1103 */
1104 public static function addNavigationComponent($module, $componentId, $extensionKey = null)
1105 {
1106 $extensionKey = $extensionKey ?: $GLOBALS['_EXTKEY'];
1107 if (!isset($extensionKey)) {
1108 throw new \RuntimeException('No extensionKey set in addNavigationComponent(). Provide it as third Parameter', 1404068039);
1109 }
1110 $GLOBALS['TBE_MODULES']['_navigationComponents'][$module] = [
1111 'componentId' => $componentId,
1112 'extKey' => $extensionKey,
1113 'isCoreComponent' => false
1114 ];
1115 }
1116
1117 /**
1118 * Registers a core navigation component
1119 *
1120 * @param string $module
1121 * @param string $componentId
1122 * @return void
1123 */
1124 public static function addCoreNavigationComponent($module, $componentId)
1125 {
1126 self::addNavigationComponent($module, $componentId);
1127 $GLOBALS['TBE_MODULES']['_navigationComponents'][$module]['isCoreComponent'] = true;
1128 }
1129
1130 /**************************************
1131 *
1132 * Adding SERVICES features
1133 *
1134 ***************************************/
1135 /**
1136 * Adds a service to the global services array
1137 *
1138 * @param string $extKey Extension key
1139 * @param string $serviceType Service type, must not be prefixed "tx_" or "Tx_"
1140 * @param string $serviceKey Service key, must be prefixed "tx_", "Tx_" or "user_"
1141 * @param array $info Service description array
1142 * @return void
1143 */
1144 public static function addService($extKey, $serviceType, $serviceKey, $info)
1145 {
1146 if ($serviceType && is_array($info)) {
1147 $info['priority'] = max(0, min(100, $info['priority']));
1148 $GLOBALS['T3_SERVICES'][$serviceType][$serviceKey] = $info;
1149 $GLOBALS['T3_SERVICES'][$serviceType][$serviceKey]['extKey'] = $extKey;
1150 $GLOBALS['T3_SERVICES'][$serviceType][$serviceKey]['serviceKey'] = $serviceKey;
1151 $GLOBALS['T3_SERVICES'][$serviceType][$serviceKey]['serviceType'] = $serviceType;
1152 // Change the priority (and other values) from $GLOBALS['TYPO3_CONF_VARS']
1153 // $GLOBALS['TYPO3_CONF_VARS']['T3_SERVICES'][$serviceType][$serviceKey]['priority']
1154 // even the activation is possible (a unix service might be possible on windows for some reasons)
1155 if (is_array($GLOBALS['TYPO3_CONF_VARS']['T3_SERVICES'][$serviceType][$serviceKey])) {
1156 // No check is done here - there might be configuration values only the service type knows about, so
1157 // we pass everything
1158 $GLOBALS['T3_SERVICES'][$serviceType][$serviceKey] = array_merge($GLOBALS['T3_SERVICES'][$serviceType][$serviceKey], $GLOBALS['TYPO3_CONF_VARS']['T3_SERVICES'][$serviceType][$serviceKey]);
1159 }
1160 // OS check
1161 // Empty $os means 'not limited to one OS', therefore a check is not needed
1162 if ($GLOBALS['T3_SERVICES'][$serviceType][$serviceKey]['available'] && $GLOBALS['T3_SERVICES'][$serviceType][$serviceKey]['os'] != '') {
1163 // TYPO3_OS is not yet defined
1164 $os_type = stripos(PHP_OS, 'win') !== false && !stripos(PHP_OS, 'darwin') !== false ? 'WIN' : 'UNIX';
1165 $os = GeneralUtility::trimExplode(',', strtoupper($GLOBALS['T3_SERVICES'][$serviceType][$serviceKey]['os']));
1166 if (!in_array($os_type, $os)) {
1167 self::deactivateService($serviceType, $serviceKey);
1168 }
1169 }
1170 // Convert subtype list to array for quicker access
1171 $GLOBALS['T3_SERVICES'][$serviceType][$serviceKey]['serviceSubTypes'] = [];
1172 $serviceSubTypes = GeneralUtility::trimExplode(',', $info['subtype']);
1173 foreach ($serviceSubTypes as $subtype) {
1174 $GLOBALS['T3_SERVICES'][$serviceType][$serviceKey]['serviceSubTypes'][$subtype] = $subtype;
1175 }
1176 }
1177 }
1178
1179 /**
1180 * Find the available service with highest priority
1181 *
1182 * @param string $serviceType Service type
1183 * @param string $serviceSubType Service sub type
1184 * @param mixed $excludeServiceKeys Service keys that should be excluded in the search for a service. Array or comma list.
1185 * @return mixed Service info array if a service was found, FALSE otherwise
1186 */
1187 public static function findService($serviceType, $serviceSubType = '', $excludeServiceKeys = [])
1188 {
1189 $serviceKey = false;
1190 $serviceInfo = false;
1191 $priority = 0;
1192 $quality = 0;
1193 if (!is_array($excludeServiceKeys)) {
1194 $excludeServiceKeys = GeneralUtility::trimExplode(',', $excludeServiceKeys, true);
1195 }
1196 if (is_array($GLOBALS['T3_SERVICES'][$serviceType])) {
1197 foreach ($GLOBALS['T3_SERVICES'][$serviceType] as $key => $info) {
1198 if (in_array($key, $excludeServiceKeys)) {
1199 continue;
1200 }
1201 // Select a subtype randomly
1202 // Useful to start a service by service key without knowing his subtypes - for testing purposes
1203 if ($serviceSubType === '*') {
1204 $serviceSubType = key($info['serviceSubTypes']);
1205 }
1206 // This matches empty subtype too
1207 if ($info['available'] && ($info['subtype'] == $serviceSubType || $info['serviceSubTypes'][$serviceSubType]) && $info['priority'] >= $priority) {
1208 // Has a lower quality than the already found, therefore we skip this service
1209 if ($info['priority'] == $priority && $info['quality'] < $quality) {
1210 continue;
1211 }
1212 // Check if the service is available
1213 $info['available'] = self::isServiceAvailable($serviceType, $key, $info);
1214 // Still available after exec check?
1215 if ($info['available']) {
1216 $serviceKey = $key;
1217 $priority = $info['priority'];
1218 $quality = $info['quality'];
1219 }
1220 }
1221 }
1222 }
1223 if ($serviceKey) {
1224 $serviceInfo = $GLOBALS['T3_SERVICES'][$serviceType][$serviceKey];
1225 }
1226 return $serviceInfo;
1227 }
1228
1229 /**
1230 * Find a specific service identified by its key
1231 * Note that this completely bypasses the notions of priority and quality
1232 *
1233 * @param string $serviceKey Service key
1234 * @return array Service info array if a service was found
1235 * @throws \TYPO3\CMS\Core\Exception
1236 */
1237 public static function findServiceByKey($serviceKey)
1238 {
1239 if (is_array($GLOBALS['T3_SERVICES'])) {
1240 // Loop on all service types
1241 // NOTE: we don't care about the actual type, we are looking for a specific key
1242 foreach ($GLOBALS['T3_SERVICES'] as $serviceType => $servicesPerType) {
1243 if (isset($servicesPerType[$serviceKey])) {
1244 $serviceDetails = $servicesPerType[$serviceKey];
1245 // Test if service is available
1246 if (self::isServiceAvailable($serviceType, $serviceKey, $serviceDetails)) {
1247 // We have found the right service, return its information
1248 return $serviceDetails;
1249 }
1250 }
1251 }
1252 }
1253 throw new \TYPO3\CMS\Core\Exception('Service not found for key: ' . $serviceKey, 1319217244);
1254 }
1255
1256 /**
1257 * Check if a given service is available, based on the executable files it depends on
1258 *
1259 * @param string $serviceType Type of service
1260 * @param string $serviceKey Specific key of the service
1261 * @param array $serviceDetails Information about the service
1262 * @return bool Service availability
1263 */
1264 public static function isServiceAvailable($serviceType, $serviceKey, $serviceDetails)
1265 {
1266 // If the service depends on external programs - check if they exists
1267 if (trim($serviceDetails['exec'])) {
1268 $executables = GeneralUtility::trimExplode(',', $serviceDetails['exec'], true);
1269 foreach ($executables as $executable) {
1270 // If at least one executable file is not available, exit early returning FALSE
1271 if (!CommandUtility::checkCommand($executable)) {
1272 self::deactivateService($serviceType, $serviceKey);
1273 return false;
1274 }
1275 }
1276 }
1277 // The service is available
1278 return true;
1279 }
1280
1281 /**
1282 * Deactivate a service
1283 *
1284 * @param string $serviceType Service type
1285 * @param string $serviceKey Service key
1286 * @return void
1287 */
1288 public static function deactivateService($serviceType, $serviceKey)
1289 {
1290 // ... maybe it's better to move non-available services to a different array??
1291 $GLOBALS['T3_SERVICES'][$serviceType][$serviceKey]['available'] = false;
1292 }
1293
1294 /**************************************
1295 *
1296 * Adding FRONTEND features
1297 *
1298 ***************************************/
1299 /**
1300 * Adds an entry to the list of plugins in content elements of type "Insert plugin"
1301 * 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)
1302 * 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.
1303 * 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
1304 * FOR USE IN ext_tables.php FILES or files in Configuration/TCA/Overrides/*.php Use the latter to benefit from TCA caching!
1305 *
1306 * @param array $itemArray Numerical array: [0] => Plugin label, [1] => Underscored extension key, [2] => Path to plugin icon relative to TYPO3_mainDir
1307 * @param string $type Type (eg. "list_type") - basically a field from "tt_content" table
1308 * @param string $extensionKey The extension key
1309 * @throws \RuntimeException
1310 * @return void
1311 */
1312 public static function addPlugin($itemArray, $type = 'list_type', $extensionKey = null)
1313 {
1314 $extensionKey = $extensionKey ?: $GLOBALS['_EXTKEY'];
1315 if (!isset($extensionKey)) {
1316 throw new \RuntimeException(
1317 'No extension key could be determined when calling addPlugin()!'
1318 . LF
1319 . 'This method is meant to be called from an ext_tables.php or Configuration/TCA/Overrides file. '
1320 . 'If you call it from Configuration/TCA/Overrides, the extension key needs to be specified as third parameter. '
1321 . 'Calling it from any other place e.g. ext_localconf.php does not work and is not supported.',
1322 1404068038
1323 );
1324 }
1325 if ($extensionKey && !$itemArray[2] && isset($GLOBALS['TYPO3_LOADED_EXT'][$extensionKey]['ext_icon'])) {
1326 $itemArray[2] = 'EXT:' . $extensionKey . '/' . $GLOBALS['TYPO3_LOADED_EXT'][$extensionKey]['ext_icon'];
1327 }
1328 if (is_array($GLOBALS['TCA']['tt_content']['columns']) && is_array($GLOBALS['TCA']['tt_content']['columns'][$type]['config']['items'])) {
1329 foreach ($GLOBALS['TCA']['tt_content']['columns'][$type]['config']['items'] as $k => $v) {
1330 if ((string)$v[1] === (string)$itemArray[1]) {
1331 $GLOBALS['TCA']['tt_content']['columns'][$type]['config']['items'][$k] = $itemArray;
1332 return;
1333 }
1334 }
1335 $GLOBALS['TCA']['tt_content']['columns'][$type]['config']['items'][] = $itemArray;
1336 }
1337 }
1338
1339 /**
1340 * Adds an entry to the "ds" array of the tt_content field "pi_flexform".
1341 * This is used by plugins to add a flexform XML reference / content for use when they are selected as plugin or content element.
1342 *
1343 * @param string $piKeyToMatch Plugin key as used in the list_type field. Use the asterisk * to match all list_type values.
1344 * @param string $value Either a reference to a flex-form XML file (eg. "FILE:EXT:newloginbox/flexform_ds.xml") or the XML directly.
1345 * @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.
1346 * @return void
1347 * @see addPlugin()
1348 */
1349 public static function addPiFlexFormValue($piKeyToMatch, $value, $CTypeToMatch = 'list')
1350 {
1351 if (is_array($GLOBALS['TCA']['tt_content']['columns']) && is_array($GLOBALS['TCA']['tt_content']['columns']['pi_flexform']['config']['ds'])) {
1352 $GLOBALS['TCA']['tt_content']['columns']['pi_flexform']['config']['ds'][$piKeyToMatch . ',' . $CTypeToMatch] = $value;
1353 }
1354 }
1355
1356 /**
1357 * Adds the $table tablename to the list of tables allowed to be includes by content element type "Insert records"
1358 * By using $content_table and $content_field you can also use the function for other tables.
1359 * FOR USE IN ext_tables.php FILES or files in Configuration/TCA/Overrides/*.php Use the latter to benefit from TCA caching!
1360 *
1361 * @param string $table Table name to allow for "insert record
1362 * @param string $content_table Table name TO WHICH the $table name is applied. See $content_field as well.
1363 * @param string $content_field Field name in the database $content_table in which $table is allowed to be added as a reference ("Insert Record")
1364 * @return void
1365 */
1366 public static function addToInsertRecords($table, $content_table = 'tt_content', $content_field = 'records')
1367 {
1368 if (is_array($GLOBALS['TCA'][$content_table]['columns']) && isset($GLOBALS['TCA'][$content_table]['columns'][$content_field]['config']['allowed'])) {
1369 $GLOBALS['TCA'][$content_table]['columns'][$content_field]['config']['allowed'] .= ',' . $table;
1370 }
1371 }
1372
1373 /**
1374 * Add PlugIn to the default template rendering (previously called "Static Template #43")
1375 *
1376 * 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.
1377 *
1378 * The naming of #43 has historic reason and is rooted inside code which is now put into a TER extension called
1379 * "statictemplates". Since the static template with uid 43 is the "content.default" and practically always used
1380 * for rendering the content elements it's very useful to have this function automatically adding the necessary
1381 * TypoScript for calling your plugin. It will also work for the extension "css_styled_content".
1382 * The logic is now generalized and called "defaultContentRendering", see addTypoScript() as well.
1383 *
1384 * $type determines the type of frontend plugin:
1385 * + list_type (default) - the good old "Insert plugin" entry
1386 * + menu_type - a "Menu/Sitemap" entry
1387 * + CType - a new content element type
1388 * + header_layout - an additional header type (added to the selection of layout1-5)
1389 * + includeLib - just includes the library for manual use somewhere in TypoScript.
1390 * (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)
1391 * FOR USE IN ext_localconf.php FILES
1392 *
1393 * @param string $key The extension key
1394 * @param string $_ unused since TYPO3 CMS 8
1395 * @param string $suffix Is used as a suffix of the class name (e.g. "_pi1")
1396 * @param string $type See description above
1397 * @param int $cached If $cached is set as USER content object (cObject) is created - otherwise a USER_INT object is created.
1398 *
1399 * @return void
1400 */
1401 public static function addPItoST43($key, $_, $suffix = '', $type = 'list_type', $cached = 0)
1402 {
1403 $cN = self::getCN($key);
1404 // General plugin
1405 $pluginContent = trim('
1406 plugin.' . $cN . $suffix . ' = USER' . ($cached ? '' : '_INT') . '
1407 plugin.' . $cN . $suffix . '.userFunc = ' . $cN . $suffix . '->main
1408 ');
1409 self::addTypoScript($key, 'setup', '
1410 # Setting ' . $key . ' plugin TypoScript
1411 ' . $pluginContent);
1412 // Add after defaultContentRendering
1413 switch ($type) {
1414 case 'list_type':
1415 $addLine = 'tt_content.list.20.' . $key . $suffix . ' = < plugin.' . $cN . $suffix;
1416 break;
1417 case 'menu_type':
1418 $addLine = 'tt_content.menu.20.' . $key . $suffix . ' = < plugin.' . $cN . $suffix;
1419 break;
1420 case 'CType':
1421 $addLine = trim('
1422 tt_content.' . $key . $suffix . ' = COA
1423 tt_content.' . $key . $suffix . ' {
1424 10 = < lib.stdheader
1425 20 = < plugin.' . $cN . $suffix . '
1426 }
1427 ');
1428 break;
1429 case 'header_layout':
1430 $addLine = 'lib.stdheader.10.' . $key . $suffix . ' = < plugin.' . $cN . $suffix;
1431 break;
1432 case 'includeLib':
1433 $addLine = 'page.1000 = < plugin.' . $cN . $suffix;
1434 break;
1435 default:
1436 $addLine = '';
1437 }
1438 if ($addLine) {
1439 self::addTypoScript($key, 'setup', '
1440 # Setting ' . $key . ' plugin TypoScript
1441 ' . $addLine . '
1442 ', 'defaultContentRendering');
1443 }
1444 }
1445
1446 /**
1447 * Call this method to add an entry in the static template list found in sys_templates
1448 * FOR USE IN ext_tables.php FILES or in Configuration/TCA/Overrides/sys_template.php Use the latter to benefit from TCA caching!
1449 *
1450 * @param string $extKey Is of course the extension key
1451 * @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/
1452 * @param string $title Is the title in the selector box.
1453 * @return void
1454 * @see addTypoScript()
1455 */
1456 public static function addStaticFile($extKey, $path, $title)
1457 {
1458 if ($extKey && $path && is_array($GLOBALS['TCA']['sys_template']['columns'])) {
1459 $value = str_replace(',', '', 'EXT:' . $extKey . '/' . $path);
1460 $itemArray = [trim($title . ' (' . $extKey . ')'), $value];
1461 $GLOBALS['TCA']['sys_template']['columns']['include_static_file']['config']['items'][] = $itemArray;
1462 }
1463 }
1464
1465 /**
1466 * Call this method to add an entry in the pageTSconfig list found in pages
1467 * FOR USE in Configuration/TCA/Overrides/pages.php Use the latter to benefit from TCA caching!
1468 *
1469 * @param string $extKey The extension key
1470 * @param string $filePath The path where the TSconfig file is located
1471 * @param string $title The title in the selector box
1472 * @return void
1473 */
1474 public static function registerPageTSConfigFile($extKey, $filePath, $title)
1475 {
1476 if (!$extKey) {
1477 throw new \InvalidArgumentException('No extension key given.', 1447789490);
1478 }
1479 if (!$filePath) {
1480 throw new \InvalidArgumentException('No file path given.', 1447789491);
1481 }
1482 if (!isset($GLOBALS['TCA']['pages']['columns']) || !is_array($GLOBALS['TCA']['pages']['columns'])) {
1483 throw new \InvalidArgumentException('No TCA definition for table "pages".', 1447789492);
1484 }
1485
1486 $value = str_replace(',', '', 'EXT:' . $extKey . '/' . $filePath);
1487 $itemArray = [trim($title . ' (' . $extKey . ')'), $value];
1488 $GLOBALS['TCA']['pages']['columns']['tsconfig_includes']['config']['items'][] = $itemArray;
1489 }
1490
1491 /**
1492 * Adds $content to the default TypoScript setup code as set in $GLOBALS['TYPO3_CONF_VARS'][FE]['defaultTypoScript_setup']
1493 * Prefixed with a [GLOBAL] line
1494 * FOR USE IN ext_localconf.php FILES
1495 *
1496 * @param string $content TypoScript Setup string
1497 * @return void
1498 */
1499 public static function addTypoScriptSetup($content)
1500 {
1501 self::appendToTypoConfVars('FE', 'defaultTypoScript_setup', '
1502 [GLOBAL]
1503 ' . $content);
1504 }
1505
1506 /**
1507 * Adds $content to the default TypoScript constants code as set in $GLOBALS['TYPO3_CONF_VARS'][FE]['defaultTypoScript_constants']
1508 * Prefixed with a [GLOBAL] line
1509 * FOR USE IN ext_localconf.php FILES
1510 *
1511 * @param string $content TypoScript Constants string
1512 * @return void
1513 */
1514 public static function addTypoScriptConstants($content)
1515 {
1516 self::appendToTypoConfVars('FE', 'defaultTypoScript_constants', '
1517 [GLOBAL]
1518 ' . $content);
1519 }
1520
1521 /**
1522 * Adds $content to the default TypoScript code for either setup or constants as set in $GLOBALS['TYPO3_CONF_VARS'][FE]['defaultTypoScript_*']
1523 * (Basically this function can do the same as addTypoScriptSetup and addTypoScriptConstants - just with a little more hazzle, but also with some more options!)
1524 * FOR USE IN ext_localconf.php FILES
1525 * Note: As of TYPO3 CMS 6.2, static template #43 (content: default) was replaced with "defaultContentRendering" which makes it
1526 * possible that a first extension like css_styled_content registers a "contentRendering" template (= a template that defines default content rendering TypoScript)
1527 * by adding itself to $TYPO3_CONF_VARS[FE][contentRenderingTemplates][] = 'myext/Configuration/TypoScript'.
1528 * An extension calling addTypoScript('myext', 'setup', $typoScript, 'defaultContentRendering') will add its TypoScript directly after;
1529 * For now, "43" and "defaultContentRendering" can be used, but "defaultContentRendering" is more descriptive and
1530 * should be used in the future.
1531 *
1532 * @param string $key Is the extension key (informative only).
1533 * @param string $type Is either "setup" or "constants" and obviously determines which kind of TypoScript code we are adding.
1534 * @param string $content Is the TS content, will be prefixed with a [GLOBAL] line and a comment-header.
1535 * @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.
1536 *
1537 * @return void
1538 */
1539 public static function addTypoScript($key, $type, $content, $afterStaticUid = 0)
1540 {
1541 if ($type === 'setup' || $type === 'constants') {
1542 $content = '
1543
1544 [GLOBAL]
1545 #############################################
1546 ## TypoScript added by extension "' . $key . '"
1547 #############################################
1548
1549 ' . $content;
1550 if ($afterStaticUid) {
1551 // If 'content (default)' is targeted (static uid 43),
1552 // 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
1553 if ($afterStaticUid === 'defaultContentRendering' || $afterStaticUid == 43) {
1554 $GLOBALS['TYPO3_CONF_VARS']['FE']['defaultTypoScript_' . $type . '.']['defaultContentRendering'] .= $content;
1555 } else {
1556 $GLOBALS['TYPO3_CONF_VARS']['FE']['defaultTypoScript_' . $type . '.'][$afterStaticUid] .= $content;
1557 }
1558 } else {
1559 $GLOBALS['TYPO3_CONF_VARS']['FE']['defaultTypoScript_' . $type] .= $content;
1560 }
1561 }
1562 }
1563
1564 /***************************************
1565 *
1566 * Internal extension management methods
1567 *
1568 ***************************************/
1569 /**
1570 * Find extension icon
1571 *
1572 * @param string $extensionPath Path to extension directory.
1573 * @param bool $returnFullPath Return full path of file.
1574 *
1575 * @return string
1576 */
1577 public static function getExtensionIcon($extensionPath, $returnFullPath = false)
1578 {
1579 $icon = '';
1580 $locationsToCheckFor = [
1581 'Resources/Public/Icons/Extension.png',
1582 'Resources/Public/Icons/Extension.svg',
1583 'Resources/Public/Icons/Extension.gif',
1584 'ext_icon.png',
1585 'ext_icon.svg',
1586 'ext_icon.gif',
1587 ];
1588 foreach ($locationsToCheckFor as $fileLocation) {
1589 if (file_exists($extensionPath . $fileLocation)) {
1590 $icon = $fileLocation;
1591 break;
1592 }
1593 }
1594 return $returnFullPath ? $extensionPath . $icon : $icon;
1595 }
1596
1597 /**
1598 * Execute all ext_localconf.php files of loaded extensions.
1599 * The method implements an optionally used caching mechanism that concatenates all
1600 * ext_localconf.php files in one file.
1601 *
1602 * This is an internal method. It is only used during bootstrap and
1603 * extensions should not use it!
1604 *
1605 * @param bool $allowCaching Whether or not to load / create concatenated cache file
1606 * @return void
1607 * @access private
1608 */
1609 public static function loadExtLocalconf($allowCaching = true)
1610 {
1611 if ($allowCaching) {
1612 $cacheIdentifier = self::getExtLocalconfCacheIdentifier();
1613 /** @var $codeCache \TYPO3\CMS\Core\Cache\Frontend\PhpFrontend */
1614 $codeCache = self::getCacheManager()->getCache('cache_core');
1615 if ($codeCache->has($cacheIdentifier)) {
1616 $codeCache->requireOnce($cacheIdentifier);
1617 } else {
1618 self::loadSingleExtLocalconfFiles();
1619 self::createExtLocalconfCacheEntry();
1620 }
1621 } else {
1622 self::loadSingleExtLocalconfFiles();
1623 }
1624 }
1625
1626 /**
1627 * Execute ext_localconf.php files from extensions
1628 *
1629 * @return void
1630 */
1631 protected static function loadSingleExtLocalconfFiles()
1632 {
1633 // This is the main array meant to be manipulated in the ext_localconf.php files
1634 // In general it is recommended to not rely on it to be globally defined in that
1635 // scope but to use $GLOBALS['TYPO3_CONF_VARS'] instead.
1636 // Nevertheless we define it here as global for backwards compatibility.
1637 global $TYPO3_CONF_VARS;
1638 foreach ($GLOBALS['TYPO3_LOADED_EXT'] as $_EXTKEY => $extensionInformation) {
1639 if ((is_array($extensionInformation) || $extensionInformation instanceof \ArrayAccess) && isset($extensionInformation['ext_localconf.php'])) {
1640 // $_EXTKEY and $_EXTCONF are available in ext_localconf.php
1641 // and are explicitly set in cached file as well
1642 $_EXTCONF = isset($GLOBALS['TYPO3_CONF_VARS']['EXT']['extConf'][$_EXTKEY]) ? $GLOBALS['TYPO3_CONF_VARS']['EXT']['extConf'][$_EXTKEY] : null;
1643 require $extensionInformation['ext_localconf.php'];
1644 }
1645 }
1646 }
1647
1648 /**
1649 * Create cache entry for concatenated ext_localconf.php files
1650 *
1651 * @return void
1652 */
1653 protected static function createExtLocalconfCacheEntry()
1654 {
1655 $extensionInformation = $GLOBALS['TYPO3_LOADED_EXT'];
1656 $phpCodeToCache = [];
1657 // Set same globals as in loadSingleExtLocalconfFiles()
1658 $phpCodeToCache[] = '/**';
1659 $phpCodeToCache[] = ' * Compiled ext_localconf.php cache file';
1660 $phpCodeToCache[] = ' */';
1661 $phpCodeToCache[] = '';
1662 $phpCodeToCache[] = 'global $TYPO3_CONF_VARS, $T3_SERVICES, $T3_VAR;';
1663 $phpCodeToCache[] = '';
1664 // Iterate through loaded extensions and add ext_localconf content
1665 foreach ($extensionInformation as $extensionKey => $extensionDetails) {
1666 if (isset($extensionDetails['ext_localconf.php']) && $extensionDetails['ext_localconf.php']) {
1667 // Include a header per extension to make the cache file more readable
1668 $phpCodeToCache[] = '/**';
1669 $phpCodeToCache[] = ' * Extension: ' . $extensionKey;
1670 $phpCodeToCache[] = ' * File: ' . $extensionDetails['ext_localconf.php'];
1671 $phpCodeToCache[] = ' */';
1672 $phpCodeToCache[] = '';
1673 // Set $_EXTKEY and $_EXTCONF for this extension
1674 $phpCodeToCache[] = '$_EXTKEY = \'' . $extensionKey . '\';';
1675 $phpCodeToCache[] = '$_EXTCONF = $GLOBALS[\'TYPO3_CONF_VARS\'][\'EXT\'][\'extConf\'][$_EXTKEY];';
1676 $phpCodeToCache[] = '';
1677 // Add ext_localconf.php content of extension
1678 $phpCodeToCache[] = trim(file_get_contents($extensionDetails['ext_localconf.php']));
1679 $phpCodeToCache[] = '';
1680 $phpCodeToCache[] = '';
1681 }
1682 }
1683 $phpCodeToCache = implode(LF, $phpCodeToCache);
1684 // Remove all start and ending php tags from content
1685 $phpCodeToCache = preg_replace('/<\\?php|\\?>/is', '', $phpCodeToCache);
1686 self::getCacheManager()->getCache('cache_core')->set(self::getExtLocalconfCacheIdentifier(), $phpCodeToCache);
1687 }
1688
1689 /**
1690 * Cache identifier of concatenated ext_localconf file
1691 *
1692 * @return string
1693 */
1694 protected static function getExtLocalconfCacheIdentifier()
1695 {
1696 return 'ext_localconf_' . sha1(TYPO3_version . PATH_site . 'extLocalconf' . serialize($GLOBALS['TYPO3_CONF_VARS']['EXT']['runtimeActivatedPackages']));
1697 }
1698
1699 /**
1700 * Wrapper for buildBaseTcaFromSingleFiles handling caching.
1701 *
1702 * This builds 'base' TCA that is later overloaded by ext_tables.php.
1703 *
1704 * Use a cache file if exists and caching is allowed.
1705 *
1706 * This is an internal method. It is only used during bootstrap and
1707 * extensions should not use it!
1708 *
1709 * @param bool $allowCaching Whether or not to load / create concatenated cache file
1710 * @return void
1711 * @access private
1712 */
1713 public static function loadBaseTca($allowCaching = true)
1714 {
1715 if ($allowCaching) {
1716 $cacheIdentifier = static::getBaseTcaCacheIdentifier();
1717 /** @var $codeCache \TYPO3\CMS\Core\Cache\Frontend\PhpFrontend */
1718 $codeCache = static::getCacheManager()->getCache('cache_core');
1719 if ($codeCache->has($cacheIdentifier)) {
1720 // substr is necessary, because the php frontend wraps php code around the cache value
1721 $cacheData = unserialize(substr($codeCache->get($cacheIdentifier), 6, -2));
1722 $GLOBALS['TCA'] = $cacheData['tca'];
1723 GeneralUtility::setSingletonInstance(CategoryRegistry::class, $cacheData['categoryRegistry']);
1724 } else {
1725 static::buildBaseTcaFromSingleFiles();
1726 static::createBaseTcaCacheFile();
1727 }
1728 } else {
1729 static::buildBaseTcaFromSingleFiles();
1730 }
1731 }
1732
1733 /**
1734 * Find all Configuration/TCA/* files of extensions and create base TCA from it.
1735 * The filename must be the table name in $GLOBALS['TCA'], and the content of
1736 * the file should return an array with content of a specific table.
1737 *
1738 * @return void
1739 * @see Extension core, extensionmanager and others for examples.
1740 */
1741 protected static function buildBaseTcaFromSingleFiles()
1742 {
1743 $GLOBALS['TCA'] = [];
1744
1745 $activePackages = static::$packageManager->getActivePackages();
1746
1747 // First load "full table" files from Configuration/TCA
1748 foreach ($activePackages as $package) {
1749 $tcaConfigurationDirectory = $package->getPackagePath() . 'Configuration/TCA';
1750 if (is_dir($tcaConfigurationDirectory)) {
1751 $files = scandir($tcaConfigurationDirectory);
1752 foreach ($files as $file) {
1753 if (
1754 is_file($tcaConfigurationDirectory . '/' . $file)
1755 && ($file !== '.')
1756 && ($file !== '..')
1757 && (substr($file, -4, 4) === '.php')
1758 ) {
1759 $tcaOfTable = require($tcaConfigurationDirectory . '/' . $file);
1760 if (is_array($tcaOfTable)) {
1761 // TCA table name is filename without .php suffix, eg 'sys_notes', not 'sys_notes.php'
1762 $tcaTableName = substr($file, 0, -4);
1763 $GLOBALS['TCA'][$tcaTableName] = $tcaOfTable;
1764 }
1765 }
1766 }
1767 }
1768 }
1769
1770 // Apply category stuff
1771 CategoryRegistry::getInstance()->applyTcaForPreRegisteredTables();
1772
1773 // Execute override files from Configuration/TCA/Overrides
1774 foreach ($activePackages as $package) {
1775 $tcaOverridesPathForPackage = $package->getPackagePath() . 'Configuration/TCA/Overrides';
1776 if (is_dir($tcaOverridesPathForPackage)) {
1777 $files = scandir($tcaOverridesPathForPackage);
1778 foreach ($files as $file) {
1779 if (
1780 is_file($tcaOverridesPathForPackage . '/' . $file)
1781 && ($file !== '.')
1782 && ($file !== '..')
1783 && (substr($file, -4, 4) === '.php')
1784 ) {
1785 require($tcaOverridesPathForPackage . '/' . $file);
1786 }
1787 }
1788 }
1789 }
1790
1791 // TCA migration
1792 // @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.
1793 $tcaMigration = GeneralUtility::makeInstance(TcaMigration::class);
1794 $GLOBALS['TCA'] = $tcaMigration->migrate($GLOBALS['TCA']);
1795 $messages = $tcaMigration->getMessages();
1796 if (!empty($messages)) {
1797 $context = 'Automatic TCA migration done during bootstrap. Please adapt TCA accordingly, these migrations'
1798 . ' will be removed. The backend module "Configuration -> TCA" shows the modified values.'
1799 . ' Please adapt these areas:';
1800 array_unshift($messages, $context);
1801 GeneralUtility::deprecationLog(implode(LF, $messages));
1802 }
1803
1804 static::emitTcaIsBeingBuiltSignal($GLOBALS['TCA']);
1805 }
1806
1807 /**
1808 * Emits the signal and uses the result of slots for the final TCA
1809 * This means, that *all* slots *must* return the complete TCA to
1810 * be effective. If a slot calls methods that manipulate the global array,
1811 * it needs to return the global array in the end. To be future proof,
1812 * a slot should manipulate the signal argument only and return it
1813 * after manipulation.
1814 *
1815 * @param array $tca
1816 */
1817 protected static function emitTcaIsBeingBuiltSignal(array $tca)
1818 {
1819 list($tca) = static::getSignalSlotDispatcher()->dispatch(__CLASS__, 'tcaIsBeingBuilt', [$tca]);
1820 $GLOBALS['TCA'] = $tca;
1821 }
1822
1823 /**
1824 * Cache base $GLOBALS['TCA'] to cache file to require the whole thing in one
1825 * file for next access instead of cycling through all extensions again.
1826 *
1827 * @return void
1828 */
1829 protected static function createBaseTcaCacheFile()
1830 {
1831 /** @var $codeCache \TYPO3\CMS\Core\Cache\Frontend\PhpFrontend */
1832 $codeCache = self::getCacheManager()->getCache('cache_core');
1833 $codeCache->set(static::getBaseTcaCacheIdentifier(), serialize(['tca' => $GLOBALS['TCA'], 'categoryRegistry' => CategoryRegistry::getInstance()]));
1834 }
1835
1836 /**
1837 * Cache identifier of base TCA cache entry.
1838 *
1839 * @return string
1840 */
1841 protected static function getBaseTcaCacheIdentifier()
1842 {
1843 return 'tca_base_' . sha1(TYPO3_version . PATH_site . 'tca_with_category_registry' . serialize($GLOBALS['TYPO3_CONF_VARS']['EXT']['runtimeActivatedPackages']));
1844 }
1845
1846 /**
1847 * Execute all ext_tables.php files of loaded extensions.
1848 * The method implements an optionally used caching mechanism that concatenates all
1849 * ext_tables.php files in one file.
1850 *
1851 * This is an internal method. It is only used during bootstrap and
1852 * extensions should not use it!
1853 *
1854 * @param bool $allowCaching Whether to load / create concatenated cache file
1855 * @return void
1856 * @access private
1857 */
1858 public static function loadExtTables($allowCaching = true)
1859 {
1860 if ($allowCaching && !self::$extTablesWasReadFromCacheOnce) {
1861 self::$extTablesWasReadFromCacheOnce = true;
1862 $cacheIdentifier = self::getExtTablesCacheIdentifier();
1863 /** @var $codeCache \TYPO3\CMS\Core\Cache\Frontend\PhpFrontend */
1864 $codeCache = self::getCacheManager()->getCache('cache_core');
1865 if ($codeCache->has($cacheIdentifier)) {
1866 $codeCache->requireOnce($cacheIdentifier);
1867 } else {
1868 self::loadSingleExtTablesFiles();
1869 self::createExtTablesCacheEntry();
1870 }
1871 } else {
1872 self::loadSingleExtTablesFiles();
1873 }
1874 }
1875
1876 /**
1877 * Load ext_tables.php as single files
1878 *
1879 * @return void
1880 */
1881 protected static function loadSingleExtTablesFiles()
1882 {
1883 // In general it is recommended to not rely on it to be globally defined in that
1884 // scope, but we can not prohibit this without breaking backwards compatibility
1885 global $T3_SERVICES, $T3_VAR, $TYPO3_CONF_VARS;
1886 global $TBE_MODULES, $TBE_MODULES_EXT, $TCA;
1887 global $PAGES_TYPES, $TBE_STYLES;
1888 global $_EXTKEY;
1889 // Load each ext_tables.php file of loaded extensions
1890 foreach ($GLOBALS['TYPO3_LOADED_EXT'] as $_EXTKEY => $extensionInformation) {
1891 if ((is_array($extensionInformation) || $extensionInformation instanceof \ArrayAccess) && $extensionInformation['ext_tables.php']) {
1892 // $_EXTKEY and $_EXTCONF are available in ext_tables.php
1893 // and are explicitly set in cached file as well
1894 $_EXTCONF = $GLOBALS['TYPO3_CONF_VARS']['EXT']['extConf'][$_EXTKEY];
1895 require $extensionInformation['ext_tables.php'];
1896 }
1897 }
1898 }
1899
1900 /**
1901 * Create concatenated ext_tables.php cache file
1902 *
1903 * @return void
1904 */
1905 protected static function createExtTablesCacheEntry()
1906 {
1907 $extensionInformation = $GLOBALS['TYPO3_LOADED_EXT'];
1908 $phpCodeToCache = [];
1909 // Set same globals as in loadSingleExtTablesFiles()
1910 $phpCodeToCache[] = '/**';
1911 $phpCodeToCache[] = ' * Compiled ext_tables.php cache file';
1912 $phpCodeToCache[] = ' */';
1913 $phpCodeToCache[] = '';
1914 $phpCodeToCache[] = 'global $T3_SERVICES, $T3_VAR, $TYPO3_CONF_VARS;';
1915 $phpCodeToCache[] = 'global $TBE_MODULES, $TBE_MODULES_EXT, $TCA;';
1916 $phpCodeToCache[] = 'global $PAGES_TYPES, $TBE_STYLES;';
1917 $phpCodeToCache[] = 'global $_EXTKEY;';
1918 $phpCodeToCache[] = '';
1919 // Iterate through loaded extensions and add ext_tables content
1920 foreach ($extensionInformation as $extensionKey => $extensionDetails) {
1921 if (isset($extensionDetails['ext_tables.php']) && $extensionDetails['ext_tables.php']) {
1922 // Include a header per extension to make the cache file more readable
1923 $phpCodeToCache[] = '/**';
1924 $phpCodeToCache[] = ' * Extension: ' . $extensionKey;
1925 $phpCodeToCache[] = ' * File: ' . $extensionDetails['ext_tables.php'];
1926 $phpCodeToCache[] = ' */';
1927 $phpCodeToCache[] = '';
1928 // Set $_EXTKEY and $_EXTCONF for this extension
1929 $phpCodeToCache[] = '$_EXTKEY = \'' . $extensionKey . '\';';
1930 $phpCodeToCache[] = '$_EXTCONF = $GLOBALS[\'TYPO3_CONF_VARS\'][\'EXT\'][\'extConf\'][$_EXTKEY];';
1931 $phpCodeToCache[] = '';
1932 // Add ext_tables.php content of extension
1933 $phpCodeToCache[] = trim(file_get_contents($extensionDetails['ext_tables.php']));
1934 $phpCodeToCache[] = '';
1935 }
1936 }
1937 $phpCodeToCache = implode(LF, $phpCodeToCache);
1938 // Remove all start and ending php tags from content
1939 $phpCodeToCache = preg_replace('/<\\?php|\\?>/is', '', $phpCodeToCache);
1940 self::getCacheManager()->getCache('cache_core')->set(self::getExtTablesCacheIdentifier(), $phpCodeToCache);
1941 }
1942
1943 /**
1944 * Cache identifier for concatenated ext_tables.php files
1945 *
1946 * @return string
1947 */
1948 protected static function getExtTablesCacheIdentifier()
1949 {
1950 return 'ext_tables_' . sha1(TYPO3_version . PATH_site . 'extTables' . serialize($GLOBALS['TYPO3_CONF_VARS']['EXT']['runtimeActivatedPackages']));
1951 }
1952
1953 /**
1954 * Remove cache files from php code cache, grouped by 'system'
1955 *
1956 * This removes the following cache entries:
1957 * - autoloader cache registry
1958 * - cache loaded extension array
1959 * - ext_localconf concatenation
1960 * - ext_tables concatenation
1961 *
1962 * This method is usually only used by extension that fiddle
1963 * with the loaded extensions. An example is the extension
1964 * manager and the install tool.
1965 *
1966 * @return void
1967 */
1968 public static function removeCacheFiles()
1969 {
1970 self::getCacheManager()->flushCachesInGroup('system');
1971 }
1972
1973 /**
1974 * Gets an array of loaded extension keys
1975 *
1976 * @return array Loaded extensions
1977 */
1978 public static function getLoadedExtensionListArray()
1979 {
1980 return array_keys(static::$packageManager->getActivePackages());
1981 }
1982
1983 /**
1984 * Loads given extension
1985 *
1986 * Warning: This method only works if the ugrade wizard to transform
1987 * localconf.php to LocalConfiguration.php was already run
1988 *
1989 * @param string $extensionKey Extension key to load
1990 * @return void
1991 * @throws \RuntimeException
1992 */
1993 public static function loadExtension($extensionKey)
1994 {
1995 if (static::$packageManager->isPackageActive($extensionKey)) {
1996 throw new \RuntimeException('Extension already loaded', 1342345486);
1997 }
1998 static::$packageManager->activatePackage($extensionKey);
1999 }
2000
2001 /**
2002 * Unloads given extension
2003 *
2004 * Warning: This method only works if the ugrade wizard to transform
2005 * localconf.php to LocalConfiguration.php was already run
2006 *
2007 * @param string $extensionKey Extension key to remove
2008 * @return void
2009 * @throws \RuntimeException
2010 */
2011 public static function unloadExtension($extensionKey)
2012 {
2013 if (!static::$packageManager->isPackageActive($extensionKey)) {
2014 throw new \RuntimeException('Extension not loaded', 1342345487);
2015 }
2016 static::$packageManager->deactivatePackage($extensionKey);
2017 }
2018
2019 /**
2020 * Makes a table categorizable by adding value into the category registry.
2021 * FOR USE IN ext_localconf.php FILES or files in Configuration/TCA/Overrides/*.php Use the latter to benefit from TCA caching!
2022 *
2023 * @param string $extensionKey Extension key to be used
2024 * @param string $tableName Name of the table to be categorized
2025 * @param string $fieldName Name of the field to be used to store categories
2026 * @param array $options Additional configuration options
2027 * @param bool $override If TRUE, any category configuration for the same table / field is removed before the new configuration is added
2028 * @see addTCAcolumns
2029 * @see addToAllTCAtypes
2030 */
2031 public static function makeCategorizable($extensionKey, $tableName, $fieldName = 'categories', array $options = [], $override = false)
2032 {
2033 // Update the category registry
2034 $result = CategoryRegistry::getInstance()->add($extensionKey, $tableName, $fieldName, $options, $override);
2035 if ($result === false) {
2036 $message = CategoryRegistry::class . ': no category registered for table "%s". Key was already registered.';
2037 /** @var $logger \TYPO3\CMS\Core\Log\Logger */
2038 $logger = GeneralUtility::makeInstance(\TYPO3\CMS\Core\Log\LogManager::class)->getLogger(__CLASS__);
2039 $logger->warning(
2040 sprintf($message, $tableName)
2041 );
2042 }
2043 }
2044 }