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