[FEATURE] Allow flexible configuration for BE submodules
[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 * @param array $moduleConfiguration additional configuration, previously put in "conf.php" of the module directory
800 * @return void
801 */
802 static public function addModule($main, $sub = '', $position = '', $path = '', $moduleConfiguration = array()) {
803 if (isset($GLOBALS['TBE_MODULES'][$main]) && $sub) {
804 // If there is already a main module by this name:
805 // Adding the submodule to the correct position:
806 list($place, $modRef) = \TYPO3\CMS\Core\Utility\GeneralUtility::trimExplode(':', $position, 1);
807 $mods = \TYPO3\CMS\Core\Utility\GeneralUtility::trimExplode(',', $GLOBALS['TBE_MODULES'][$main], 1);
808 if (!in_array($sub, $mods)) {
809 switch (strtolower($place)) {
810 case 'after':
811
812 case 'before':
813 $pointer = 0;
814 $found = FALSE;
815 foreach ($mods as $k => $m) {
816 if (!strcmp($m, $modRef)) {
817 $pointer = strtolower($place) == 'after' ? $k + 1 : $k;
818 $found = TRUE;
819 }
820 }
821 if ($found) {
822 array_splice($mods, $pointer, 0, $sub);
823 } else {
824 // If requested module is not found: Add at the end
825 array_push($mods, $sub);
826 }
827 break;
828 default:
829 if (strtolower($place) == 'top') {
830 array_unshift($mods, $sub);
831 } else {
832 array_push($mods, $sub);
833 }
834 break;
835 }
836 }
837 // Re-inserting the submodule list:
838 $GLOBALS['TBE_MODULES'][$main] = implode(',', $mods);
839 } else {
840 // Create new main modules with only one submodule, $sub (or none if $sub is blank)
841 $GLOBALS['TBE_MODULES'][$main] = $sub;
842 }
843 $fullModuleSignature = $main . ($sub ? '_' . $sub : '');
844 // Adding path:
845 if ($path) {
846 $GLOBALS['TBE_MODULES']['_PATHS'][$fullModuleSignature] = $path;
847 }
848
849 // add additional configuration
850 if (is_array($moduleConfiguration) && count($moduleConfiguration) > 0) {
851 $GLOBALS['TBE_MODULES']['_configuration'][$fullModuleSignature] = $moduleConfiguration;
852 }
853 }
854
855 /**
856 * Registers an Ext.Direct component with access restrictions.
857 *
858 * @param string $endpointName
859 * @param string $callbackClass
860 * @param string $moduleName Optional: must be <mainmodule> or <mainmodule>_<submodule>
861 * @param string $accessLevel Optional: can be 'admin' or 'user,group'
862 * @return void
863 */
864 static public function registerExtDirectComponent($endpointName, $callbackClass, $moduleName = NULL, $accessLevel = NULL) {
865 $GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['ExtDirect'][$endpointName] = array(
866 'callbackClass' => $callbackClass,
867 'moduleName' => $moduleName,
868 'accessLevel' => $accessLevel
869 );
870 }
871
872 /**
873 * Adds a module path to $GLOBALS['TBE_MODULES'] for used with the module dispatcher, mod.php
874 * Used only for modules that are not placed in the main/sub menu hierarchy by the traditional mechanism of addModule()
875 * Examples for this is context menu functionality (like import/export) which runs as an independent module through mod.php
876 * FOR USE IN ext_tables.php FILES
877 * Example: \TYPO3\CMS\Core\Utility\ExtensionManagementUtility::addModulePath('xMOD_tximpexp', \TYPO3\CMS\Core\Utility\ExtensionManagementUtility::extPath($_EXTKEY).'app/');
878 *
879 * @param string $name The name of the module, refer to conf.php of the module.
880 * @param string $path The absolute path to the module directory inside of which "index.php" and "conf.php" is found.
881 * @return void
882 */
883 static public function addModulePath($name, $path) {
884 $GLOBALS['TBE_MODULES']['_PATHS'][$name] = $path;
885 }
886
887 /**
888 * Adds a "Function menu module" ('third level module') to an existing function menu for some other backend module
889 * The arguments values are generally determined by which function menu this is supposed to interact with
890 * See Inside TYPO3 for information on how to use this function.
891 * FOR USE IN ext_tables.php FILES
892 *
893 * @param string $modname Module name
894 * @param string $className Class name
895 * @param string $classPath Class path
896 * @param string $title Title of module
897 * @param string $MM_key Menu array key - default is "function
898 * @param string $WS Workspace conditions. Blank means all workspaces, any other string can be a comma list of "online", "offline" and "custom
899 * @return void
900 * @see \TYPO3\CMS\Backend\Module\BaseScriptClass::mergeExternalItems()
901 */
902 static public function insertModuleFunction($modname, $className, $classPath, $title, $MM_key = 'function', $WS = '') {
903 $GLOBALS['TBE_MODULES_EXT'][$modname]['MOD_MENU'][$MM_key][$className] = array(
904 'name' => $className,
905 'path' => $classPath,
906 'title' => $title,
907 'ws' => $WS
908 );
909 }
910
911 /**
912 * Adds some more content to a key of TYPO3_CONF_VARS array.
913 *
914 * This also tracks which content was added by extensions (in TYPO3_CONF_VARS_extensionAdded)
915 * so that they cannot be editted again through the Install Tool.
916 *
917 * @static
918 * @param string $group The group ('FE', 'BE', 'SYS' ...)
919 * @param string $key The key of this setting within the group
920 * @param string $content The text to add (include leading "\n" in case of multi-line entries)
921 * @return void
922 */
923 static public function appendToTypoConfVars($group, $key, $content) {
924 $GLOBALS['TYPO3_CONF_VARS_extensionAdded'][$group][$key] .= $content;
925 $GLOBALS['TYPO3_CONF_VARS'][$group][$key] .= $content;
926 }
927
928 /**
929 * Adds $content to the default Page TSconfig as set in $GLOBALS['TYPO3_CONF_VARS'][BE]['defaultPageTSconfig']
930 * Prefixed with a [GLOBAL] line
931 * FOR USE IN ext_tables.php/ext_localconf.php FILES
932 *
933 * @param string $content Page TSconfig content
934 * @return void
935 */
936 static public function addPageTSConfig($content) {
937 self::appendToTypoConfVars('BE', 'defaultPageTSconfig', '
938 [GLOBAL]
939 ' . $content);
940 }
941
942 /**
943 * Adds $content to the default User TSconfig as set in $GLOBALS['TYPO3_CONF_VARS'][BE]['defaultUserTSconfig']
944 * Prefixed with a [GLOBAL] line
945 * FOR USE IN ext_tables.php/ext_localconf.php FILES
946 *
947 * @param string $content User TSconfig content
948 * @return void
949 */
950 static public function addUserTSConfig($content) {
951 self::appendToTypoConfVars('BE', 'defaultUserTSconfig', '
952 [GLOBAL]
953 ' . $content);
954 }
955
956 /**
957 * Adds a reference to a locallang file with $GLOBALS['TCA_DESCR'] labels
958 * FOR USE IN ext_tables.php FILES
959 * 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.
960 *
961 * @param string $tca_descr_key Description key. Typically a database table (like "pages") but for applications can be other strings, but prefixed with "_MOD_")
962 * @param string $file_ref File reference to locallang file, eg. "EXT:lang/locallang_csh_pages.xlf" (or ".xml")
963 * @return void
964 */
965 static public function addLLrefForTCAdescr($tca_descr_key, $file_ref) {
966 if ($tca_descr_key) {
967 if (!is_array($GLOBALS['TCA_DESCR'][$tca_descr_key])) {
968 $GLOBALS['TCA_DESCR'][$tca_descr_key] = array();
969 }
970 if (!is_array($GLOBALS['TCA_DESCR'][$tca_descr_key]['refs'])) {
971 $GLOBALS['TCA_DESCR'][$tca_descr_key]['refs'] = array();
972 }
973 $GLOBALS['TCA_DESCR'][$tca_descr_key]['refs'][] = $file_ref;
974 }
975 }
976
977 /**
978 * Registers a navigation component
979 *
980 * @param string $module
981 * @param string $componentId
982 * @return void
983 */
984 static public function addNavigationComponent($module, $componentId) {
985 $GLOBALS['TBE_MODULES']['_navigationComponents'][$module] = array(
986 'componentId' => $componentId,
987 'extKey' => $GLOBALS['_EXTKEY'],
988 'isCoreComponent' => FALSE
989 );
990 }
991
992 /**
993 * Registers a core navigation component
994 *
995 * @param string $module
996 * @param string $componentId
997 * @return void
998 */
999 static public function addCoreNavigationComponent($module, $componentId) {
1000 self::addNavigationComponent($module, $componentId);
1001 $GLOBALS['TBE_MODULES']['_navigationComponents'][$module]['isCoreComponent'] = TRUE;
1002 }
1003
1004 /**************************************
1005 *
1006 * Adding SERVICES features
1007 *
1008 ***************************************/
1009 /**
1010 * Adds a service to the global services array
1011 *
1012 * @param string $extKey Extension key
1013 * @param string $serviceType Service type, must not be prefixed "tx_" or "Tx_
1014 * @param string $serviceKey Service key, must be prefixed "tx_", "Tx_" or "user_
1015 * @param array $info Service description array
1016 * @return void
1017 */
1018 static public function addService($extKey, $serviceType, $serviceKey, $info) {
1019 if ($serviceType && is_array($info)) {
1020 $info['priority'] = max(0, min(100, $info['priority']));
1021 $GLOBALS['T3_SERVICES'][$serviceType][$serviceKey] = $info;
1022 $GLOBALS['T3_SERVICES'][$serviceType][$serviceKey]['extKey'] = $extKey;
1023 $GLOBALS['T3_SERVICES'][$serviceType][$serviceKey]['serviceKey'] = $serviceKey;
1024 $GLOBALS['T3_SERVICES'][$serviceType][$serviceKey]['serviceType'] = $serviceType;
1025 // Change the priority (and other values) from $GLOBALS['TYPO3_CONF_VARS']
1026 // $GLOBALS['TYPO3_CONF_VARS']['T3_SERVICES'][$serviceType][$serviceKey]['priority']
1027 // even the activation is possible (a unix service might be possible on windows for some reasons)
1028 if (is_array($GLOBALS['TYPO3_CONF_VARS']['T3_SERVICES'][$serviceType][$serviceKey])) {
1029 // No check is done here - there might be configuration values only the service type knows about, so
1030 // we pass everything
1031 $GLOBALS['T3_SERVICES'][$serviceType][$serviceKey] = array_merge($GLOBALS['T3_SERVICES'][$serviceType][$serviceKey], $GLOBALS['TYPO3_CONF_VARS']['T3_SERVICES'][$serviceType][$serviceKey]);
1032 }
1033 // OS check
1034 // Empty $os means 'not limited to one OS', therefore a check is not needed
1035 if ($GLOBALS['T3_SERVICES'][$serviceType][$serviceKey]['available'] && $GLOBALS['T3_SERVICES'][$serviceType][$serviceKey]['os'] != '') {
1036 // TYPO3_OS is not yet defined
1037 $os_type = stristr(PHP_OS, 'win') && !stristr(PHP_OS, 'darwin') ? 'WIN' : 'UNIX';
1038 $os = \TYPO3\CMS\Core\Utility\GeneralUtility::trimExplode(',', strtoupper($GLOBALS['T3_SERVICES'][$serviceType][$serviceKey]['os']));
1039 if (!in_array($os_type, $os)) {
1040 self::deactivateService($serviceType, $serviceKey);
1041 }
1042 }
1043 // Convert subtype list to array for quicker access
1044 $GLOBALS['T3_SERVICES'][$serviceType][$serviceKey]['serviceSubTypes'] = array();
1045 $serviceSubTypes = \TYPO3\CMS\Core\Utility\GeneralUtility::trimExplode(',', $info['subtype']);
1046 foreach ($serviceSubTypes as $subtype) {
1047 $GLOBALS['T3_SERVICES'][$serviceType][$serviceKey]['serviceSubTypes'][$subtype] = $subtype;
1048 }
1049 }
1050 }
1051
1052 /**
1053 * Find the available service with highest priority
1054 *
1055 * @param string $serviceType Service type
1056 * @param string $serviceSubType Service sub type
1057 * @param mixed $excludeServiceKeys Service keys that should be excluded in the search for a service. Array or comma list.
1058 * @return mixed Service info array if a service was found, FALSE otherwise
1059 */
1060 static public function findService($serviceType, $serviceSubType = '', $excludeServiceKeys = array()) {
1061 $serviceKey = FALSE;
1062 $serviceInfo = FALSE;
1063 $priority = 0;
1064 $quality = 0;
1065 if (!is_array($excludeServiceKeys)) {
1066 $excludeServiceKeys = \TYPO3\CMS\Core\Utility\GeneralUtility::trimExplode(',', $excludeServiceKeys, 1);
1067 }
1068 if (is_array($GLOBALS['T3_SERVICES'][$serviceType])) {
1069 foreach ($GLOBALS['T3_SERVICES'][$serviceType] as $key => $info) {
1070 if (in_array($key, $excludeServiceKeys)) {
1071 continue;
1072 }
1073 // Select a subtype randomly
1074 // Useful to start a service by service key without knowing his subtypes - for testing purposes
1075 if ($serviceSubType == '*') {
1076 $serviceSubType = key($info['serviceSubTypes']);
1077 }
1078 // This matches empty subtype too
1079 if ($info['available'] && ($info['subtype'] == $serviceSubType || $info['serviceSubTypes'][$serviceSubType]) && $info['priority'] >= $priority) {
1080 // Has a lower quality than the already found, therefore we skip this service
1081 if ($info['priority'] == $priority && $info['quality'] < $quality) {
1082 continue;
1083 }
1084 // Check if the service is available
1085 $info['available'] = self::isServiceAvailable($serviceType, $key, $info);
1086 // Still available after exec check?
1087 if ($info['available']) {
1088 $serviceKey = $key;
1089 $priority = $info['priority'];
1090 $quality = $info['quality'];
1091 }
1092 }
1093 }
1094 }
1095 if ($serviceKey) {
1096 $serviceInfo = $GLOBALS['T3_SERVICES'][$serviceType][$serviceKey];
1097 }
1098 return $serviceInfo;
1099 }
1100
1101 /**
1102 * Find a specific service identified by its key
1103 * Note that this completely bypasses the notions of priority and quality
1104 *
1105 * @param string $serviceKey Service key
1106 * @return array Service info array if a service was found
1107 * @throws \TYPO3\CMS\Core\Exception
1108 */
1109 static public function findServiceByKey($serviceKey) {
1110 if (is_array($GLOBALS['T3_SERVICES'])) {
1111 // Loop on all service types
1112 // NOTE: we don't care about the actual type, we are looking for a specific key
1113 foreach ($GLOBALS['T3_SERVICES'] as $serviceType => $servicesPerType) {
1114 if (isset($servicesPerType[$serviceKey])) {
1115 $serviceDetails = $servicesPerType[$serviceKey];
1116 // Test if service is available
1117 if (self::isServiceAvailable($serviceType, $serviceKey, $serviceDetails)) {
1118 // We have found the right service, return its information
1119 return $serviceDetails;
1120 }
1121 }
1122 }
1123 }
1124 throw new \TYPO3\CMS\Core\Exception('Service not found for key: ' . $serviceKey, 1319217244);
1125 }
1126
1127 /**
1128 * Check if a given service is available, based on the executable files it depends on
1129 *
1130 * @param string $serviceType Type of service
1131 * @param string $serviceKey Specific key of the service
1132 * @param array $serviceDetails Information about the service
1133 * @return boolean Service availability
1134 */
1135 static public function isServiceAvailable($serviceType, $serviceKey, $serviceDetails) {
1136 // If the service depends on external programs - check if they exists
1137 if (trim($serviceDetails['exec'])) {
1138 $executables = \TYPO3\CMS\Core\Utility\GeneralUtility::trimExplode(',', $serviceDetails['exec'], 1);
1139 foreach ($executables as $executable) {
1140 // If at least one executable file is not available, exit early returning FALSE
1141 if (!\TYPO3\CMS\Core\Utility\CommandUtility::checkCommand($executable)) {
1142 self::deactivateService($serviceType, $serviceKey);
1143 return FALSE;
1144 }
1145 }
1146 }
1147 // The service is available
1148 return TRUE;
1149 }
1150
1151 /**
1152 * Deactivate a service
1153 *
1154 * @param string $serviceType Service type
1155 * @param string $serviceKey Service key
1156 * @return void
1157 */
1158 static public function deactivateService($serviceType, $serviceKey) {
1159 // ... maybe it's better to move non-available services to a different array??
1160 $GLOBALS['T3_SERVICES'][$serviceType][$serviceKey]['available'] = FALSE;
1161 }
1162
1163 /**************************************
1164 *
1165 * Adding FRONTEND features
1166 * (related specifically to "cms" extension)
1167 *
1168 ***************************************/
1169 /**
1170 * Adds an entry to the list of plugins in content elements of type "Insert plugin"
1171 * 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)
1172 * 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.
1173 * 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
1174 * FOR USE IN ext_tables.php FILES
1175 *
1176 * @param array $itemArray Item Array
1177 * @param string $type Type (eg. "list_type") - basically a field from "tt_content" table
1178 * @return void
1179 */
1180 static public function addPlugin($itemArray, $type = 'list_type') {
1181 $_EXTKEY = $GLOBALS['_EXTKEY'];
1182 if ($_EXTKEY && !$itemArray[2]) {
1183 $itemArray[2] = self::extRelPath($_EXTKEY) . $GLOBALS['TYPO3_LOADED_EXT'][$_EXTKEY]['ext_icon'];
1184 }
1185 if (is_array($GLOBALS['TCA']['tt_content']['columns']) && is_array($GLOBALS['TCA']['tt_content']['columns'][$type]['config']['items'])) {
1186 foreach ($GLOBALS['TCA']['tt_content']['columns'][$type]['config']['items'] as $k => $v) {
1187 if (!strcmp($v[1], $itemArray[1])) {
1188 $GLOBALS['TCA']['tt_content']['columns'][$type]['config']['items'][$k] = $itemArray;
1189 return;
1190 }
1191 }
1192 $GLOBALS['TCA']['tt_content']['columns'][$type]['config']['items'][] = $itemArray;
1193 }
1194 }
1195
1196 /**
1197 * Adds an entry to the "ds" array of the tt_content field "pi_flexform".
1198 * This is used by plugins to add a flexform XML reference / content for use when they are selected as plugin or content element.
1199 *
1200 * @param string $piKeyToMatch Plugin key as used in the list_type field. Use the asterisk * to match all list_type values.
1201 * @param string $value Either a reference to a flex-form XML file (eg. "FILE:EXT:newloginbox/flexform_ds.xml") or the XML directly.
1202 * @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.
1203 * @return void
1204 * @see addPlugin()
1205 */
1206 static public function addPiFlexFormValue($piKeyToMatch, $value, $CTypeToMatch = 'list') {
1207 if (is_array($GLOBALS['TCA']['tt_content']['columns']) && is_array($GLOBALS['TCA']['tt_content']['columns']['pi_flexform']['config']['ds'])) {
1208 $GLOBALS['TCA']['tt_content']['columns']['pi_flexform']['config']['ds'][$piKeyToMatch . ',' . $CTypeToMatch] = $value;
1209 }
1210 }
1211
1212 /**
1213 * Adds the $table tablename to the list of tables allowed to be includes by content element type "Insert records"
1214 * By using $content_table and $content_field you can also use the function for other tables.
1215 * FOR USE IN ext_tables.php FILES
1216 *
1217 * @param string $table Table name to allow for "insert record
1218 * @param string $content_table Table name TO WHICH the $table name is applied. See $content_field as well.
1219 * @param string $content_field Field name in the database $content_table in which $table is allowed to be added as a reference ("Insert Record")
1220 * @return void
1221 */
1222 static public function addToInsertRecords($table, $content_table = 'tt_content', $content_field = 'records') {
1223 if (is_array($GLOBALS['TCA'][$content_table]['columns']) && isset($GLOBALS['TCA'][$content_table]['columns'][$content_field]['config']['allowed'])) {
1224 $GLOBALS['TCA'][$content_table]['columns'][$content_field]['config']['allowed'] .= ',' . $table;
1225 }
1226 }
1227
1228 /**
1229 * Add PlugIn to Static Template #43
1230 *
1231 * 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.
1232 * 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"
1233 * $type determines the type of frontend plugin:
1234 * "list_type" (default) - the good old "Insert plugin" entry
1235 * "menu_type" - a "Menu/Sitemap" entry
1236 * "CType" - a new content element type
1237 * "header_layout" - an additional header type (added to the selection of layout1-5)
1238 * "includeLib" - just includes the library for manual use somewhere in TypoScript.
1239 * (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)
1240 * FOR USE IN ext_localconf.php FILES
1241 *
1242 * @param string $key The extension key
1243 * @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.
1244 * @param string $prefix Is used as a - yes, suffix - of the class name (fx. "_pi1")
1245 * @param string $type See description above
1246 * @param boolean $cached If $cached is set as USER content object (cObject) is created - otherwise a USER_INT object is created.
1247 * @return void
1248 */
1249 static public function addPItoST43($key, $classFile = '', $prefix = '', $type = 'list_type', $cached = 0) {
1250 $classFile = $classFile ? $classFile : 'pi/class.tx_' . str_replace('_', '', $key) . $prefix . '.php';
1251 $cN = self::getCN($key);
1252 // General plugin
1253 $pluginContent = trim('
1254 plugin.' . $cN . $prefix . ' = USER' . ($cached ? '' : '_INT') . '
1255 plugin.' . $cN . $prefix . ' {
1256 includeLibs = ' . $GLOBALS['TYPO3_LOADED_EXT'][$key]['siteRelPath'] . $classFile . '
1257 userFunc = ' . $cN . $prefix . '->main
1258 }');
1259 self::addTypoScript($key, 'setup', '
1260 # Setting ' . $key . ' plugin TypoScript
1261 ' . $pluginContent);
1262 // After ST43
1263 switch ($type) {
1264 case 'list_type':
1265 $addLine = 'tt_content.list.20.' . $key . $prefix . ' = < plugin.' . $cN . $prefix;
1266 break;
1267 case 'menu_type':
1268 $addLine = 'tt_content.menu.20.' . $key . $prefix . ' = < plugin.' . $cN . $prefix;
1269 break;
1270 case 'CType':
1271 $addLine = trim('
1272 tt_content.' . $key . $prefix . ' = COA
1273 tt_content.' . $key . $prefix . ' {
1274 10 = < lib.stdheader
1275 20 = < plugin.' . $cN . $prefix . '
1276 }
1277 ');
1278 break;
1279 case 'header_layout':
1280 $addLine = 'lib.stdheader.10.' . $key . $prefix . ' = < plugin.' . $cN . $prefix;
1281 break;
1282 case 'includeLib':
1283 $addLine = 'page.1000 = < plugin.' . $cN . $prefix;
1284 break;
1285 default:
1286 $addLine = '';
1287 break;
1288 }
1289 if ($addLine) {
1290 self::addTypoScript($key, 'setup', '
1291 # Setting ' . $key . ' plugin TypoScript
1292 ' . $addLine . '
1293 ', 43);
1294 }
1295 }
1296
1297 /**
1298 * Call this method to add an entry in the static template list found in sys_templates
1299 * FOR USE IN ext_localconf.php FILES
1300 *
1301 * @param string $extKey Is of course the extension key
1302 * @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/
1303 * @param string $title Is the title in the selector box.
1304 * @return void
1305 * @see addTypoScript()
1306 */
1307 static public function addStaticFile($extKey, $path, $title) {
1308 if ($extKey && $path && is_array($GLOBALS['TCA']['sys_template']['columns'])) {
1309 $value = str_replace(',', '', 'EXT:' . $extKey . '/' . $path);
1310 $itemArray = array(trim($title . ' (' . $extKey . ')'), $value);
1311 $GLOBALS['TCA']['sys_template']['columns']['include_static_file']['config']['items'][] = $itemArray;
1312 }
1313 }
1314
1315 /**
1316 * Adds $content to the default TypoScript setup code as set in $GLOBALS['TYPO3_CONF_VARS'][FE]['defaultTypoScript_setup']
1317 * Prefixed with a [GLOBAL] line
1318 * FOR USE IN ext_localconf.php FILES
1319 *
1320 * @param string $content TypoScript Setup string
1321 * @return void
1322 */
1323 static public function addTypoScriptSetup($content) {
1324 self::appendToTypoConfVars('FE', 'defaultTypoScript_setup', '
1325 [GLOBAL]
1326 ' . $content);
1327 }
1328
1329 /**
1330 * Adds $content to the default TypoScript constants code as set in $GLOBALS['TYPO3_CONF_VARS'][FE]['defaultTypoScript_constants']
1331 * Prefixed with a [GLOBAL] line
1332 * FOR USE IN ext_localconf.php FILES
1333 *
1334 * @param string $content TypoScript Constants string
1335 * @return void
1336 */
1337 static public function addTypoScriptConstants($content) {
1338 self::appendToTypoConfVars('FE', 'defaultTypoScript_constants', '
1339 [GLOBAL]
1340 ' . $content);
1341 }
1342
1343 /**
1344 * Adds $content to the default TypoScript code for either setup or constants as set in $GLOBALS['TYPO3_CONF_VARS'][FE]['defaultTypoScript_*']
1345 * (Basically this function can do the same as addTypoScriptSetup and addTypoScriptConstants - just with a little more hazzle, but also with some more options!)
1346 * FOR USE IN ext_localconf.php FILES
1347 *
1348 * @param string $key Is the extension key (informative only).
1349 * @param string $type Is either "setup" or "constants" and obviously determines which kind of TypoScript code we are adding.
1350 * @param string $content Is the TS content, prefixed with a [GLOBAL] line and a comment-header.
1351 * @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.
1352 * @return void
1353 */
1354 static public function addTypoScript($key, $type, $content, $afterStaticUid = 0) {
1355 if ($type == 'setup' || $type == 'constants') {
1356 $content = '
1357
1358 [GLOBAL]
1359 #############################################
1360 ## TypoScript added by extension "' . $key . '"
1361 #############################################
1362
1363 ' . $content;
1364 if ($afterStaticUid) {
1365 $GLOBALS['TYPO3_CONF_VARS']['FE']['defaultTypoScript_' . $type . '.'][$afterStaticUid] .= $content;
1366 // If 'content (default)' is targeted, also add to other 'content rendering templates', eg. css_styled_content
1367 if ($afterStaticUid == 43 && is_array($GLOBALS['TYPO3_CONF_VARS']['FE']['contentRenderingTemplates'])) {
1368 foreach ($GLOBALS['TYPO3_CONF_VARS']['FE']['contentRenderingTemplates'] as $templateName) {
1369 $GLOBALS['TYPO3_CONF_VARS']['FE']['defaultTypoScript_' . $type . '.'][$templateName] .= $content;
1370 }
1371 }
1372 } else {
1373 $GLOBALS['TYPO3_CONF_VARS']['FE']['defaultTypoScript_' . $type] .= $content;
1374 }
1375 }
1376 }
1377
1378 /***************************************
1379 *
1380 * Internal extension management methods
1381 *
1382 ***************************************/
1383 /**
1384 * Load the extension information array. This array is set as
1385 * $GLOBALS['TYPO3_LOADED_EXT'] in bootstrap. It contains basic information
1386 * about every loaded extension.
1387 *
1388 * This is an internal method. It is only used during bootstrap and
1389 * extensions should not use it!
1390 *
1391 * @param boolean $allowCaching If FALSE, the array will not be read / created from cache
1392 * @return array Result array that will be set as $GLOBALS['TYPO3_LOADED_EXT']
1393 * @access private
1394 * @see createTypo3LoadedExtensionInformationArray
1395 */
1396 static public function loadTypo3LoadedExtensionInformation($allowCaching = TRUE) {
1397 if ($allowCaching) {
1398 $cacheIdentifier = self::getTypo3LoadedExtensionInformationCacheIdentifier();
1399 /** @var $codeCache \TYPO3\CMS\Core\Cache\Frontend\PhpFrontend */
1400 $codeCache = $GLOBALS['typo3CacheManager']->getCache('cache_core');
1401 if ($codeCache->has($cacheIdentifier)) {
1402 $typo3LoadedExtensionArray = $codeCache->requireOnce($cacheIdentifier);
1403 } else {
1404 $typo3LoadedExtensionArray = self::createTypo3LoadedExtensionInformationArray();
1405 $codeCache->set($cacheIdentifier, 'return ' . var_export($typo3LoadedExtensionArray, TRUE) . ';');
1406 }
1407 } else {
1408 $typo3LoadedExtensionArray = self::createTypo3LoadedExtensionInformationArray();
1409 }
1410 return $typo3LoadedExtensionArray;
1411 }
1412
1413 /**
1414 * Set up array with basic information about loaded extension:
1415 *
1416 * array(
1417 * 'extensionKey' => array(
1418 * 'type' => Either S, L or G, inidicating if the extension is a system, a local or a global extension
1419 * 'siteRelPath' => Relative path to the extension from document root
1420 * 'typo3RelPath' => Relative path to extension from typo3/ subdirectory
1421 * 'ext_localconf.php' => Absolute path to ext_localconf.php file of extension
1422 * 'ext_...' => Further absolute path of extension files, see $extensionFilesToCheckFor var for details
1423 * ),
1424 * );
1425 *
1426 * @return array Result array that will be set as $GLOBALS['TYPO3_LOADED_EXT']
1427 */
1428 static protected function createTypo3LoadedExtensionInformationArray() {
1429 $loadedExtensions = static::getLoadedExtensionListArray();
1430 $loadedExtensionInformation = array();
1431 $extensionFilesToCheckFor = array(
1432 'ext_localconf.php',
1433 'ext_tables.php',
1434 'ext_tables.sql',
1435 'ext_tables_static+adt.sql',
1436 'ext_typoscript_constants.txt',
1437 'ext_typoscript_setup.txt'
1438 );
1439 // Clear file status cache to make sure we get good results from is_dir()
1440 clearstatcache();
1441 foreach ($loadedExtensions as $extensionKey) {
1442 // Determine if extension is installed locally, globally or system (in this order)
1443 if (@is_dir((PATH_typo3conf . 'ext/' . $extensionKey . '/'))) {
1444 // local
1445 $loadedExtensionInformation[$extensionKey] = array(
1446 'type' => 'L',
1447 'siteRelPath' => 'typo3conf/ext/' . $extensionKey . '/',
1448 'typo3RelPath' => '../typo3conf/ext/' . $extensionKey . '/'
1449 );
1450 } elseif (@is_dir((PATH_typo3 . 'ext/' . $extensionKey . '/'))) {
1451 // global
1452 $loadedExtensionInformation[$extensionKey] = array(
1453 'type' => 'G',
1454 'siteRelPath' => TYPO3_mainDir . 'ext/' . $extensionKey . '/',
1455 'typo3RelPath' => 'ext/' . $extensionKey . '/'
1456 );
1457 } elseif (@is_dir((PATH_typo3 . 'sysext/' . $extensionKey . '/'))) {
1458 // system
1459 $loadedExtensionInformation[$extensionKey] = array(
1460 'type' => 'S',
1461 'siteRelPath' => TYPO3_mainDir . 'sysext/' . $extensionKey . '/',
1462 'typo3RelPath' => 'sysext/' . $extensionKey . '/'
1463 );
1464 }
1465 // Register found files in extension array if extension was found
1466 if (isset($loadedExtensionInformation[$extensionKey])) {
1467 foreach ($extensionFilesToCheckFor as $fileName) {
1468 $absolutePathToFile = PATH_site . $loadedExtensionInformation[$extensionKey]['siteRelPath'] . $fileName;
1469 if (@is_file($absolutePathToFile)) {
1470 $loadedExtensionInformation[$extensionKey][$fileName] = $absolutePathToFile;
1471 }
1472 }
1473 }
1474 // Register found extension icon
1475 $loadedExtensionInformation[$extensionKey]['ext_icon'] = self::getExtensionIcon(PATH_site . $loadedExtensionInformation[$extensionKey]['siteRelPath']);
1476 }
1477 return $loadedExtensionInformation;
1478 }
1479
1480 /**
1481 * Find extension icon
1482 *
1483 * @param string $extensionPath Path to extension directory.
1484 * @param string $returnFullPath Return full path of file.
1485 * @return string
1486 * @throws \BadFunctionCallException
1487 */
1488 static public function getExtensionIcon($extensionPath, $returnFullPath = FALSE) {
1489 $icon = '';
1490 $iconFileTypesToCheckFor = array('png', 'gif');
1491 foreach ($iconFileTypesToCheckFor as $fileType) {
1492 if (file_exists($extensionPath . 'ext_icon.' . $fileType)) {
1493 $icon = 'ext_icon.' . $fileType;
1494 break;
1495 }
1496 }
1497 return $returnFullPath ? $extensionPath . $icon : $icon;
1498 }
1499
1500 /**
1501 * Cache identifier of cached Typo3LoadedExtensionInformation array
1502 *
1503 * @return string
1504 */
1505 static protected function getTypo3LoadedExtensionInformationCacheIdentifier() {
1506 return 'loaded_extensions_' . sha1((TYPO3_version . PATH_site . 'loadedExtensions'));
1507 }
1508
1509 /**
1510 * Execute all ext_localconf.php files of loaded extensions.
1511 * The method implements an optionally used caching mechanism that concatenates all
1512 * ext_localconf.php files in one file.
1513 *
1514 * This is an internal method. It is only used during bootstrap and
1515 * extensions should not use it!
1516 *
1517 * @param boolean $allowCaching Whether or not to load / create concatenated cache file
1518 * @return void
1519 * @access private
1520 */
1521 static public function loadExtLocalconf($allowCaching = TRUE) {
1522 if ($allowCaching) {
1523 $cacheIdentifier = self::getExtLocalconfCacheIdentifier();
1524 /** @var $codeCache \TYPO3\CMS\Core\Cache\Frontend\PhpFrontend */
1525 $codeCache = $GLOBALS['typo3CacheManager']->getCache('cache_core');
1526 if ($codeCache->has($cacheIdentifier)) {
1527 $codeCache->requireOnce($cacheIdentifier);
1528 } else {
1529 self::loadSingleExtLocalconfFiles();
1530 self::createExtLocalconfCacheEntry();
1531 }
1532 } else {
1533 self::loadSingleExtLocalconfFiles();
1534 }
1535 }
1536
1537 /**
1538 * Execute ext_localconf.php files from extensions
1539 *
1540 * @return void
1541 */
1542 static protected function loadSingleExtLocalconfFiles() {
1543 // This is the main array meant to be manipulated in the ext_localconf.php files
1544 // In general it is recommended to not rely on it to be globally defined in that
1545 // scope but to use $GLOBALS['TYPO3_CONF_VARS'] instead.
1546 // Nevertheless we define it here as global for backwards compatibility.
1547 global $TYPO3_CONF_VARS;
1548 foreach ($GLOBALS['TYPO3_LOADED_EXT'] as $_EXTKEY => $extensionInformation) {
1549 if (is_array($extensionInformation) && $extensionInformation['ext_localconf.php']) {
1550 // $_EXTKEY and $_EXTCONF are available in ext_localconf.php
1551 // and are explicitly set in cached file as well
1552 $_EXTCONF = $GLOBALS['TYPO3_CONF_VARS']['EXT']['extConf'][$_EXTKEY];
1553 require $extensionInformation['ext_localconf.php'];
1554 }
1555 }
1556 }
1557
1558 /**
1559 * Create cache entry for concatenated ext_localconf.php files
1560 *
1561 * @return void
1562 */
1563 static protected function createExtLocalconfCacheEntry() {
1564 $extensionInformation = $GLOBALS['TYPO3_LOADED_EXT'];
1565 $phpCodeToCache = array();
1566 // Set same globals as in loadSingleExtLocalconfFiles()
1567 $phpCodeToCache[] = '/**';
1568 $phpCodeToCache[] = ' * Compiled ext_localconf.php cache file';
1569 $phpCodeToCache[] = ' */';
1570 $phpCodeToCache[] = '';
1571 $phpCodeToCache[] = 'global $TYPO3_CONF_VARS, $T3_SERVICES, $T3_VAR;';
1572 $phpCodeToCache[] = '';
1573 // Iterate through loaded extensions and add ext_localconf content
1574 foreach ($extensionInformation as $extensionKey => $extensionDetails) {
1575 if (isset($extensionDetails['ext_localconf.php']) && $extensionDetails['ext_localconf.php']) {
1576 // Include a header per extension to make the cache file more readable
1577 $phpCodeToCache[] = '/**';
1578 $phpCodeToCache[] = ' * Extension: ' . $extensionKey;
1579 $phpCodeToCache[] = ' * File: ' . $extensionDetails['ext_localconf.php'];
1580 $phpCodeToCache[] = ' */';
1581 $phpCodeToCache[] = '';
1582 // Set $_EXTKEY and $_EXTCONF for this extension
1583 $phpCodeToCache[] = '$_EXTKEY = \'' . $extensionKey . '\';';
1584 $phpCodeToCache[] = '$_EXTCONF = $GLOBALS[\'TYPO3_CONF_VARS\'][\'EXT\'][\'extConf\'][$_EXTKEY];';
1585 $phpCodeToCache[] = '';
1586 // Add ext_localconf.php content of extension
1587 $phpCodeToCache[] = trim(\TYPO3\CMS\Core\Utility\GeneralUtility::getUrl($extensionDetails['ext_localconf.php']));
1588 $phpCodeToCache[] = '';
1589 $phpCodeToCache[] = '';
1590 }
1591 }
1592 $phpCodeToCache = implode(LF, $phpCodeToCache);
1593 // Remove all start and ending php tags from content
1594 $phpCodeToCache = preg_replace('/<\\?php|\\?>/is', '', $phpCodeToCache);
1595 $GLOBALS['typo3CacheManager']->getCache('cache_core')->set(self::getExtLocalconfCacheIdentifier(), $phpCodeToCache);
1596 }
1597
1598 /**
1599 * Cache identifier of concatenated ext_localconf file
1600 *
1601 * @return string
1602 */
1603 static protected function getExtLocalconfCacheIdentifier() {
1604 return 'ext_localconf_' . sha1((TYPO3_version . PATH_site . 'extLocalconf'));
1605 }
1606
1607 /**
1608 * Wrapper for buildBaseTcaFromSingleFiles handling caching.
1609 *
1610 * This builds 'base' TCA that is later overloaded by ext_tables.php.
1611 *
1612 * Use a cache file if exists and caching is allowed.
1613 *
1614 * This is an internal method. It is only used during bootstrap and
1615 * extensions should not use it!
1616 *
1617 * @param boolean $allowCaching Whether or not to load / create concatenated cache file
1618 * @return void
1619 * @access private
1620 */
1621 static public function loadBaseTca($allowCaching = TRUE) {
1622 if ($allowCaching) {
1623 $cacheIdentifier = static::getBaseTcaCacheIdentifier();
1624 /** @var $codeCache \TYPO3\CMS\Core\Cache\Frontend\PhpFrontend */
1625 $codeCache = $GLOBALS['typo3CacheManager']->getCache('cache_core');
1626 if ($codeCache->has($cacheIdentifier)) {
1627 $codeCache->requireOnce($cacheIdentifier);
1628 } else {
1629 self::buildBaseTcaFromSingleFiles();
1630 self::createBaseTcaCacheFile();
1631 }
1632 } else {
1633 self::buildBaseTcaFromSingleFiles();
1634 }
1635 }
1636
1637 /**
1638 * Find all Configuration/TCA/* files of extensions and create base TCA from it.
1639 * The filename must be the table name in $GLOBALS['TCA'], and the content of
1640 * the file should return an array with content of a specific table.
1641 *
1642 * @return void
1643 * @see Extension core, cms, extensionmanager and others for examples.
1644 */
1645 static protected function buildBaseTcaFromSingleFiles() {
1646 $GLOBALS['TCA'] = array();
1647 foreach (self::getLoadedExtensionListArray() as $extensionName) {
1648 $tcaConfigurationDirectory = self::extPath($extensionName) . 'Configuration/TCA';
1649 if (is_dir($tcaConfigurationDirectory)) {
1650 $files = scandir($tcaConfigurationDirectory);
1651 foreach ($files as $file) {
1652 if (
1653 is_file($tcaConfigurationDirectory . '/' . $file)
1654 && ($file !== '.')
1655 && ($file !== '..')
1656 && (substr($file, -4, 4) === '.php')
1657 ) {
1658 $tcaOfTable = require($tcaConfigurationDirectory . '/' . $file);
1659 if (is_array($tcaOfTable)) {
1660 // TCA table name is filename without .php suffix, eg 'sys_notes', not 'sys_notes.php'
1661 $tcaTableName = substr($file, 0, -4);
1662 $GLOBALS['TCA'][$tcaTableName] = $tcaOfTable;
1663 }
1664 }
1665 }
1666 }
1667 }
1668 }
1669
1670 /**
1671 * Cache base $GLOBALS['TCA'] to cache file to require the whole thing in one
1672 * file for next access instead of cycling through all extensions again.
1673 *
1674 * @return void
1675 */
1676 static protected function createBaseTcaCacheFile() {
1677 $phpCodeToCache = '$GLOBALS[\'TCA\'] = ';
1678 $phpCodeToCache .= ArrayUtility::arrayExport($GLOBALS['TCA']);
1679 $phpCodeToCache .= ';';
1680 /** @var $codeCache \TYPO3\CMS\Core\Cache\Frontend\PhpFrontend */
1681 $codeCache = $GLOBALS['typo3CacheManager']->getCache('cache_core');
1682 $codeCache->set(static::getBaseTcaCacheIdentifier(), $phpCodeToCache);
1683 }
1684
1685 /**
1686 * Cache identifier of base TCA cache entry.
1687 *
1688 * @return string
1689 */
1690 static protected function getBaseTcaCacheIdentifier() {
1691 return 'tca_base_' . sha1((TYPO3_version . PATH_site . 'tca'));
1692 }
1693
1694 /**
1695 * Execute all ext_tables.php files of loaded extensions.
1696 * The method implements an optionally used caching mechanism that concatenates all
1697 * ext_tables.php files in one file.
1698 *
1699 * This is an internal method. It is only used during bootstrap and
1700 * extensions should not use it!
1701 *
1702 * @param boolean $allowCaching Whether to load / create concatenated cache file
1703 * @return void
1704 * @access private
1705 */
1706 static public function loadExtTables($allowCaching = TRUE) {
1707 if ($allowCaching && !self::$extTablesWasReadFromCacheOnce) {
1708 self::$extTablesWasReadFromCacheOnce = TRUE;
1709 $cacheIdentifier = self::getExtTablesCacheIdentifier();
1710 /** @var $codeCache \TYPO3\CMS\Core\Cache\Frontend\PhpFrontend */
1711 $codeCache = $GLOBALS['typo3CacheManager']->getCache('cache_core');
1712 if ($codeCache->has($cacheIdentifier)) {
1713 $codeCache->requireOnce($cacheIdentifier);
1714 } else {
1715 self::loadSingleExtTablesFiles();
1716 self::createExtTablesCacheEntry();
1717 }
1718 } else {
1719 self::loadSingleExtTablesFiles();
1720 }
1721 }
1722
1723 /**
1724 * Load ext_tables.php as single files
1725 *
1726 * @return void
1727 */
1728 static protected function loadSingleExtTablesFiles() {
1729 // In general it is recommended to not rely on it to be globally defined in that
1730 // scope, but we can not prohibit this without breaking backwards compatibility
1731 global $T3_SERVICES, $T3_VAR, $TYPO3_CONF_VARS;
1732 global $TBE_MODULES, $TBE_MODULES_EXT, $TCA;
1733 global $PAGES_TYPES, $TBE_STYLES, $FILEICONS;
1734 global $_EXTKEY;
1735 // Load each ext_tables.php file of loaded extensions
1736 foreach ($GLOBALS['TYPO3_LOADED_EXT'] as $_EXTKEY => $extensionInformation) {
1737 if (is_array($extensionInformation) && $extensionInformation['ext_tables.php']) {
1738 // $_EXTKEY and $_EXTCONF are available in ext_tables.php
1739 // and are explicitly set in cached file as well
1740 $_EXTCONF = $GLOBALS['TYPO3_CONF_VARS']['EXT']['extConf'][$_EXTKEY];
1741 require $extensionInformation['ext_tables.php'];
1742 static::loadNewTcaColumnsConfigFiles();
1743 }
1744 }
1745 }
1746
1747 /**
1748 * Create concatenated ext_tables.php cache file
1749 *
1750 * @return void
1751 */
1752 static protected function createExtTablesCacheEntry() {
1753 $extensionInformation = $GLOBALS['TYPO3_LOADED_EXT'];
1754 $phpCodeToCache = array();
1755 // Set same globals as in loadSingleExtTablesFiles()
1756 $phpCodeToCache[] = '/**';
1757 $phpCodeToCache[] = ' * Compiled ext_tables.php cache file';
1758 $phpCodeToCache[] = ' */';
1759 $phpCodeToCache[] = '';
1760 $phpCodeToCache[] = 'global $T3_SERVICES, $T3_VAR, $TYPO3_CONF_VARS;';
1761 $phpCodeToCache[] = 'global $TBE_MODULES, $TBE_MODULES_EXT, $TCA;';
1762 $phpCodeToCache[] = 'global $PAGES_TYPES, $TBE_STYLES, $FILEICONS;';
1763 $phpCodeToCache[] = 'global $_EXTKEY;';
1764 $phpCodeToCache[] = '';
1765 // Iterate through loaded extensions and add ext_tables content
1766 foreach ($extensionInformation as $extensionKey => $extensionDetails) {
1767 if (isset($extensionDetails['ext_tables.php']) && $extensionDetails['ext_tables.php']) {
1768 // Include a header per extension to make the cache file more readable
1769 $phpCodeToCache[] = '/**';
1770 $phpCodeToCache[] = ' * Extension: ' . $extensionKey;
1771 $phpCodeToCache[] = ' * File: ' . $extensionDetails['ext_tables.php'];
1772 $phpCodeToCache[] = ' */';
1773 $phpCodeToCache[] = '';
1774 // Set $_EXTKEY and $_EXTCONF for this extension
1775 $phpCodeToCache[] = '$_EXTKEY = \'' . $extensionKey . '\';';
1776 $phpCodeToCache[] = '$_EXTCONF = $GLOBALS[\'TYPO3_CONF_VARS\'][\'EXT\'][\'extConf\'][$_EXTKEY];';
1777 $phpCodeToCache[] = '';
1778 // Add ext_tables.php content of extension
1779 $phpCodeToCache[] = trim(\TYPO3\CMS\Core\Utility\GeneralUtility::getUrl($extensionDetails['ext_tables.php']));
1780 $phpCodeToCache[] = '';
1781 $phpCodeToCache[] = '\TYPO3\CMS\Core\Utility\ExtensionManagementUtility::loadNewTcaColumnsConfigFiles();';
1782 $phpCodeToCache[] = '';
1783 }
1784 }
1785 $phpCodeToCache = implode(LF, $phpCodeToCache);
1786 // Remove all start and ending php tags from content
1787 $phpCodeToCache = preg_replace('/<\\?php|\\?>/is', '', $phpCodeToCache);
1788 $GLOBALS['typo3CacheManager']->getCache('cache_core')->set(self::getExtTablesCacheIdentifier(), $phpCodeToCache);
1789 }
1790
1791 /**
1792 * Loads "columns" of a $TCA table definition if extracted
1793 * to a "dynamicConfigFile". This method is called after each
1794 * single ext_tables.php files was included to immediately have
1795 * the full $TCA ready for the next extension.
1796 *
1797 * $TCA[$tableName]['ctrl']['dynamicConfigFile'] must be the
1798 * absolute path to a file.
1799 *
1800 * Be aware that 'dynamicConfigFile' is obsolete, and all TCA
1801 * table definitions should be moved to Configuration/TCA/tablename.php
1802 * to be fully loaded automatically.
1803 *
1804 * Example:
1805 * dynamicConfigFile = \TYPO3\CMS\Core\Utility\ExtensionManagementUtility::extPath($_EXTKEY) . 'SysNote.php',
1806 *
1807 * @return void
1808 * @throws \RuntimeException
1809 * @internal Internal use ONLY. It is called by cache files and can not be protected. Do not call yourself!
1810 */
1811 static public function loadNewTcaColumnsConfigFiles() {
1812 global $TCA;
1813
1814 foreach (array_keys($TCA) as $tableName) {
1815 if (!isset($TCA[$tableName]['columns'])) {
1816 $columnsConfigFile = $TCA[$tableName]['ctrl']['dynamicConfigFile'];
1817 if ($columnsConfigFile) {
1818 if (GeneralUtility::isAbsPath($columnsConfigFile)) {
1819 include($columnsConfigFile);
1820 } else {
1821 throw new \RuntimeException(
1822 'Columns configuration file not found',
1823 1341151261
1824 );
1825 }
1826 }
1827 }
1828 }
1829 }
1830
1831 /**
1832 * Cache identifier for concatenated ext_tables.php files
1833 *
1834 * @return string
1835 */
1836 static protected function getExtTablesCacheIdentifier() {
1837 return 'ext_tables_' . sha1((TYPO3_version . PATH_site . 'extTables'));
1838 }
1839
1840 /**
1841 * Returns TRUE if configuration files in typo3conf/ are writable
1842 *
1843 * @return boolean TRUE if at least one configuration file in typo3conf/ is writable
1844 * @internal
1845 * @deprecated since 6.1, will be removed in two versions
1846 */
1847 static public function isLocalconfWritable() {
1848 \TYPO3\CMS\Core\Utility\GeneralUtility::logDeprecatedFunction();
1849 return \TYPO3\CMS\Core\Utility\GeneralUtility::makeInstance('TYPO3\\CMS\\Core\\Configuration\\ConfigurationManager')
1850 ->canWriteConfiguration();
1851 }
1852
1853 /**
1854 * Remove cache files from php code cache, tagged with 'core'
1855 *
1856 * This removes the following cache entries:
1857 * - autoloader cache registry
1858 * - cache loaded extension array
1859 * - ext_localconf concatenation
1860 * - ext_tables concatenation
1861 *
1862 * This method is usually only used by extension that fiddle
1863 * with the loaded extensions. An example is the extension
1864 * manager and the install tool.
1865 *
1866 * @return void
1867 */
1868 static public function removeCacheFiles() {
1869 /** @var $codeCache \TYPO3\CMS\Core\Cache\Frontend\PhpFrontend */
1870 $codeCache = $GLOBALS['typo3CacheManager']->getCache('cache_core');
1871 $codeCache->flush();
1872 }
1873
1874 /**
1875 * Gets an array of loaded extension keys
1876 *
1877 * @return array Loaded extensions
1878 */
1879 static public function getLoadedExtensionListArray() {
1880 // Extensions in extListArray
1881 if (is_array($GLOBALS['TYPO3_CONF_VARS']['EXT']['extListArray'])) {
1882 $loadedExtensions = $GLOBALS['TYPO3_CONF_VARS']['EXT']['extListArray'];
1883 } else {
1884 // Fallback handling if extlist is still a string and not an array
1885 // @deprecated since 6.0, will be removed in 6.2 ... check upgrade process before removal!
1886 $loadedExtensions = \TYPO3\CMS\Core\Utility\GeneralUtility::trimExplode(',', $GLOBALS['TYPO3_CONF_VARS']['EXT']['extList']);
1887 }
1888 // Add required extensions
1889 $loadedExtensions = array_merge(static::getRequiredExtensionListArray(), $loadedExtensions);
1890 $loadedExtensions = array_unique($loadedExtensions);
1891 return $loadedExtensions;
1892 }
1893
1894 /**
1895 * Gets list of required extensions.
1896 * This is the list of extensions from constant REQUIRED_EXTENSIONS defined
1897 * in bootstrap, together with a possible additional list of extensions from
1898 * local configuration
1899 *
1900 * @return array List of required extensions
1901 */
1902 static public function getRequiredExtensionListArray() {
1903 if (is_array($GLOBALS['TYPO3_CONF_VARS']['EXT']['requiredExt'])) {
1904 $requiredExtensions = $GLOBALS['TYPO3_CONF_VARS']['EXT']['requiredExt'];
1905 } else {
1906 $requiredExtensions = \TYPO3\CMS\Core\Utility\GeneralUtility::trimExplode(',', $GLOBALS['TYPO3_CONF_VARS']['EXT']['requiredExt']);
1907 }
1908 $requiredExtensions = array_merge(\TYPO3\CMS\Core\Utility\GeneralUtility::trimExplode(',', REQUIRED_EXTENSIONS), $requiredExtensions);
1909 $requiredExtensions = array_unique($requiredExtensions);
1910 return $requiredExtensions;
1911 }
1912
1913 /**
1914 * Loads given extension
1915 *
1916 * Warning: This method only works if the ugrade wizard to transform
1917 * localconf.php to LocalConfiguration.php was already run
1918 *
1919 * @param string $extensionKey Extension key to load
1920 * @return void
1921 * @throws \RuntimeException
1922 */
1923 static public function loadExtension($extensionKey) {
1924 if (static::isLoaded($extensionKey)) {
1925 throw new \RuntimeException('Extension already loaded', 1342345486);
1926 }
1927 $extList = \TYPO3\CMS\Core\Utility\GeneralUtility::makeInstance('TYPO3\\CMS\\Core\\Configuration\\ConfigurationManager')->getLocalConfigurationValueByPath('EXT/extListArray');
1928 $extList[] = $extensionKey;
1929 static::writeNewExtensionList($extList);
1930 }
1931
1932 /**
1933 * Unloads given extension
1934 *
1935 * Warning: This method only works if the ugrade wizard to transform
1936 * localconf.php to LocalConfiguration.php was already run
1937 *
1938 * @param string $extensionKey Extension key to remove
1939 * @return void
1940 * @throws \RuntimeException
1941 */
1942 static public function unloadExtension($extensionKey) {
1943 if (!static::isLoaded($extensionKey)) {
1944 throw new \RuntimeException('Extension not loaded', 1342345487);
1945 }
1946 if (in_array($extensionKey, static::getRequiredExtensionListArray())) {
1947 throw new \RuntimeException('Can not unload required extension', 1342348167);
1948 }
1949 $extList = \TYPO3\CMS\Core\Utility\GeneralUtility::makeInstance('TYPO3\\CMS\\Core\\Configuration\\ConfigurationManager')->getLocalConfigurationValueByPath('EXT/extListArray');
1950 $extList = array_diff($extList, array($extensionKey));
1951 static::writeNewExtensionList($extList);
1952 }
1953
1954 /**
1955 * Writes extension list and clear cache files.
1956 *
1957 * @TODO : This method should be protected, but with current em it is hard to do so,
1958 * @param array Extension array to load, loader order is kept
1959 * @return void
1960 * @internal
1961 */
1962 static public function writeNewExtensionList(array $newExtensionList) {
1963 $extensionList = array_unique($newExtensionList);
1964 \TYPO3\CMS\Core\Utility\GeneralUtility::makeInstance('TYPO3\\CMS\\Core\\Configuration\\ConfigurationManager')->setLocalConfigurationValueByPath('EXT/extListArray', $extensionList);
1965 static::removeCacheFiles();
1966 }
1967
1968 /**
1969 * Makes a table categorizable by adding value into the category registry.
1970 *
1971 * @param string $extensionKey Extension key to be used
1972 * @param string $tableName Name of the table to be categorized
1973 * @param string $fieldName Name of the field to be used to store categories
1974 * @param array $options Additional configuration options
1975 * @see addTCAcolumns
1976 * @see addToAllTCAtypes
1977 */
1978 static public function makeCategorizable($extensionKey, $tableName, $fieldName = 'categories', array $options = array()) {
1979 // Update the category registry
1980 $result = \TYPO3\CMS\Core\Category\CategoryRegistry::getInstance()->add($extensionKey, $tableName, $fieldName, $options);
1981 if ($result === FALSE) {
1982 $message = '\TYPO3\CMS\Core\Category\CategoryRegistry: no category registered for table "%s". Key was already registered.';
1983 /** @var $logger \TYPO3\CMS\Core\Log\Logger */
1984 $logger = \TYPO3\CMS\Core\Utility\GeneralUtility::makeInstance('TYPO3\CMS\Core\Log\LogManager')->getLogger(__CLASS__);
1985 $logger->warning(
1986 sprintf($message, $tableName)
1987 );
1988 }
1989 }
1990
1991 }
1992 ?>