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