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