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