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