5998ab89e0009c9b18b3d2167c5ed60eb962997b
[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-2011 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 * t3lib_extMgm::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 \TYPO3\CMS\Core\Utility\GeneralUtility::loadTCA($table);
225 if (is_array($columnArray) && is_array($GLOBALS['TCA'][$table]) && is_array($GLOBALS['TCA'][$table]['columns'])) {
226 // Candidate for t3lib_div::array_merge() if integer-keys will some day make trouble...
227 $GLOBALS['TCA'][$table]['columns'] = array_merge($GLOBALS['TCA'][$table]['columns'], $columnArray);
228 if ($addTofeInterface) {
229 $GLOBALS['TCA'][$table]['feInterface']['fe_admin_fieldList'] .= ',' . implode(',', array_keys($columnArray));
230 }
231 }
232 }
233
234 /**
235 * Makes fields visible in the TCEforms, adding them to the end of (all) "types"-configurations
236 *
237 * Adds a string $str (comma list of field names) to all ["types"][xxx]["showitem"] entries for table $table (unless limited by $specificTypesList)
238 * This is needed to have new fields shown automatically in the TCEFORMS of a record from $table.
239 * Typically this function is called after having added new columns (database fields) with the addTCAcolumns function
240 * FOR USE IN ext_tables.php FILES
241 *
242 * @param string $table Table name
243 * @param string $str Field list to add.
244 * @param string $specificTypesList List of specific types to add the field list to. (If empty, all type entries are affected)
245 * @param string $position Insert fields before (default) or after one
246 * @return void
247 */
248 static public function addToAllTCAtypes($table, $str, $specificTypesList = '', $position = '') {
249 \TYPO3\CMS\Core\Utility\GeneralUtility::loadTCA($table);
250 $str = trim($str);
251 $palettesChanged = array();
252 if ($str && is_array($GLOBALS['TCA'][$table]) && is_array($GLOBALS['TCA'][$table]['types'])) {
253 foreach ($GLOBALS['TCA'][$table]['types'] as $type => &$typeDetails) {
254 if ($specificTypesList === '' || \TYPO3\CMS\Core\Utility\GeneralUtility::inList($specificTypesList, $type)) {
255 $fieldExists = FALSE;
256 if ($position != '' && is_array($GLOBALS['TCA'][$table]['palettes'])) {
257 $positionArray = \TYPO3\CMS\Core\Utility\GeneralUtility::trimExplode(':', $position);
258 if ($positionArray[0] == 'replace') {
259 foreach ($GLOBALS['TCA'][$table]['palettes'] as $palette => $paletteDetails) {
260 if (preg_match('/\\b' . $palette . '\\b/', $typeDetails['showitem']) > 0 && preg_match('/\\b' . $positionArray[1] . '\\b/', $paletteDetails['showitem']) > 0) {
261 self::addFieldsToPalette($table, $palette, $str, $position);
262 // Save that palette in case other types use it
263 $palettesChanged[] = $palette;
264 $fieldExists = TRUE;
265 } elseif (in_array($palette, $palettesChanged)) {
266 $fieldExists = TRUE;
267 }
268 }
269 } else {
270 if (strpos($typeDetails['showitem'], $str) !== FALSE) {
271 $fieldExists = TRUE;
272 } else {
273 foreach ($GLOBALS['TCA'][$table]['palettes'] as $palette => $paletteDetails) {
274 if (preg_match('/\\b' . $palette . '\\b/', $typeDetails['showitem']) > 0 && preg_match('/\\b' . $positionArray[1] . '\\b/', $paletteDetails['showitem']) > 0) {
275 $position = $positionArray[0] . ':--palette--;;' . $palette;
276 }
277 }
278 }
279 }
280 } else {
281 if (strpos($typeDetails['showitem'], $str) !== FALSE) {
282 $fieldExists = TRUE;
283 } elseif (is_array($GLOBALS['TCA'][$table]['palettes'])) {
284 foreach ($GLOBALS['TCA'][$table]['palettes'] as $palette => $paletteDetails) {
285 if (preg_match('/\\b' . $palette . '\\b/', $typeDetails['showitem']) > 0 && strpos($paletteDetails['showitem'], $str) !== FALSE) {
286 $fieldExists = TRUE;
287 }
288 }
289 }
290 }
291 if ($fieldExists === FALSE) {
292 $typeDetails['showitem'] = self::executePositionedStringInsertion($typeDetails['showitem'], $str, $position);
293 }
294 }
295 }
296 unset($typeDetails);
297 }
298 }
299
300 /**
301 * Adds new fields to all palettes of an existing field.
302 * If the field does not have a palette yet, it's created automatically and
303 * gets called "generatedFor-$field".
304 *
305 * @param string $table Name of the table
306 * @param string $field Name of the field that has the palette to be extended
307 * @param string $addFields List of fields to be added to the palette
308 * @param string $insertionPosition Insert fields before (default) or after one
309 * @return void
310 */
311 static public function addFieldsToAllPalettesOfField($table, $field, $addFields, $insertionPosition = '') {
312 $generatedPalette = '';
313 $processedPalettes = array();
314 \TYPO3\CMS\Core\Utility\GeneralUtility::loadTCA($table);
315 if (isset($GLOBALS['TCA'][$table]['columns'][$field])) {
316 $types = &$GLOBALS['TCA'][$table]['types'];
317 if (is_array($types)) {
318 // Iterate through all types and search for the field that defines the palette to be extended:
319 foreach (array_keys($types) as $type) {
320 $items = self::explodeItemList($types[$type]['showitem']);
321 if (isset($items[$field])) {
322 // If the field already has a palette, extend it:
323 if ($items[$field]['details']['palette']) {
324 $palette = $items[$field]['details']['palette'];
325 if (!isset($processedPalettes[$palette])) {
326 self::addFieldsToPalette($table, $palette, $addFields, $insertionPosition);
327 $processedPalettes[$palette] = TRUE;
328 }
329 } else {
330 if ($generatedPalette) {
331 $palette = $generatedPalette;
332 } else {
333 $palette = ($generatedPalette = 'generatedFor-' . $field);
334 self::addFieldsToPalette($table, $palette, $addFields, $insertionPosition);
335 }
336 $items[$field]['details']['palette'] = $palette;
337 $types[$type]['showitem'] = self::generateItemList($items);
338 }
339 }
340 }
341 }
342 }
343 }
344
345 /**
346 * Adds new fields to a palette.
347 * If the palette does not exist yet, it's created automatically.
348 *
349 * @param string $table Name of the table
350 * @param string $palette Name of the palette to be extended
351 * @param string $addFields List of fields to be added to the palette
352 * @param string $insertionPosition Insert fields before (default) or after one
353 * @return void
354 */
355 static public function addFieldsToPalette($table, $palette, $addFields, $insertionPosition = '') {
356 \TYPO3\CMS\Core\Utility\GeneralUtility::loadTCA($table);
357 if (isset($GLOBALS['TCA'][$table])) {
358 $paletteData = &$GLOBALS['TCA'][$table]['palettes'][$palette];
359 // If palette already exists, merge the data:
360 if (is_array($paletteData)) {
361 $paletteData['showitem'] = self::executePositionedStringInsertion($paletteData['showitem'], $addFields, $insertionPosition);
362 } else {
363 $paletteData['showitem'] = self::removeDuplicatesForInsertion($addFields);
364 }
365 }
366 }
367
368 /**
369 * Add an item to a select field item list.
370 *
371 * Warning: Do not use this method for radio or check types, especially not
372 * with $relativeToField and $relativePosition parameters. This would shift
373 * existing database data 'off by one'.
374 *
375 * As an example, this can be used to add an item to tt_content CType select
376 * drop-down after the existing 'mailform' field with these parameters:
377 * - $table = 'tt_content'
378 * - $field = 'CType'
379 * - $item = array(
380 * 'LLL:EXT:cms/locallang_ttc.xml:CType.I.10',
381 * 'login',
382 * 'i/tt_content_login.gif',
383 * ),
384 * - $relativeToField = mailform
385 * - $relativePosition = after
386 *
387 * @throws \InvalidArgumentException If given parameters are not of correct
388 * @throws \RuntimeException If reference to related position fields can not
389 * @param string $table Name of TCA table
390 * @param string $field Name of TCA field
391 * @param array $item New item to add
392 * @param string $relativeToField Add item relative to existing field
393 * @param string $relativePosition Valid keywords: 'before', 'after'
394 * @return void
395 */
396 static public function addTcaSelectItem($table, $field, array $item, $relativeToField = '', $relativePosition = '') {
397 if (!is_string($table)) {
398 throw new \InvalidArgumentException('Given table is of type "' . gettype($table) . '" but a string is expected.', 1303236963);
399 }
400 if (!is_string($field)) {
401 throw new \InvalidArgumentException('Given field is of type "' . gettype($field) . '" but a string is expected.', 1303236964);
402 }
403 if (!is_string($relativeToField)) {
404 throw new \InvalidArgumentException('Given relative field is of type "' . gettype($relativeToField) . '" but a string is expected.', 1303236965);
405 }
406 if (!is_string($relativePosition)) {
407 throw new \InvalidArgumentException('Given relative position is of type "' . gettype($relativePosition) . '" but a string is expected.', 1303236966);
408 }
409 if ($relativePosition !== '' && $relativePosition !== 'before' && $relativePosition !== 'after' && $relativePosition !== 'replace') {
410 throw new \InvalidArgumentException('Relative position must be either empty or one of "before", "after", "replace".', 1303236967);
411 }
412 \TYPO3\CMS\Core\Utility\GeneralUtility::loadTCA($table);
413 if (!is_array($GLOBALS['TCA'][$table]['columns'][$field]['config']['items'])) {
414 throw new \RuntimeException('Given select field item list was not found.', 1303237468);
415 }
416 // Make sure item keys are integers
417 $GLOBALS['TCA'][$table]['columns'][$field]['config']['items'] = array_values($GLOBALS['TCA'][$table]['columns'][$field]['config']['items']);
418 if (strlen($relativePosition) > 0) {
419 // Insert at specified position
420 $matchedPosition = \TYPO3\CMS\Core\Utility\ArrayUtility::filterByValueRecursive($relativeToField, $GLOBALS['TCA'][$table]['columns'][$field]['config']['items']);
421 if (count($matchedPosition) > 0) {
422 $relativeItemKey = key($matchedPosition);
423 if ($relativePosition === 'replace') {
424 $GLOBALS['TCA'][$table]['columns'][$field]['config']['items'][$relativeItemKey] = $item;
425 } else {
426 if ($relativePosition === 'before') {
427 $offset = $relativeItemKey;
428 } else {
429 $offset = $relativeItemKey + 1;
430 }
431 array_splice($GLOBALS['TCA'][$table]['columns'][$field]['config']['items'], $offset, 0, array(0 => $item));
432 }
433 } else {
434 // Insert at new item at the end of the array if relative position was not found
435 $GLOBALS['TCA'][$table]['columns'][$field]['config']['items'][] = $item;
436 }
437 } else {
438 // Insert at new item at the end of the array
439 $GLOBALS['TCA'][$table]['columns'][$field]['config']['items'][] = $item;
440 }
441 }
442
443 /**
444 * Gets the TCA configuration for a field handling (FAL) files.
445 *
446 * @param string $fieldName Name of the field to be used
447 * @param array $customSettingOverride Custom field settings overriding the basics
448 * @param string $allowedFileExtensions Comma list of allowed file extensions (e.g. "jpg,gif,pdf")
449 * @return array
450 */
451 static public function getFileFieldTCAConfig($fieldName, array $customSettingOverride = array(), $allowedFileExtensions = '', $disallowedFileExtensions = '') {
452 $fileFieldTCAConfig = array(
453 'type' => 'inline',
454 'foreign_table' => 'sys_file_reference',
455 'foreign_field' => 'uid_foreign',
456 'foreign_sortby' => 'sorting_foreign',
457 'foreign_table_field' => 'tablenames',
458 'foreign_match_fields' => array(
459 'fieldname' => $fieldName
460 ),
461 'foreign_label' => 'uid_local',
462 'foreign_selector' => 'uid_local',
463 'foreign_selector_fieldTcaOverride' => array(
464 'config' => array(
465 'appearance' => array(
466 'elementBrowserType' => 'file',
467 'elementBrowserAllowed' => $allowedFileExtensions
468 )
469 )
470 ),
471 'filter' => array(
472 array(
473 'userFunc' => 'TYPO3\\CMS\\Core\\Resource\\Filter\\FileExtensionFilter->filterInlineChildren',
474 'parameters' => array(
475 'allowedFileExtensions' => $allowedFileExtensions,
476 'disallowedFileExtensions' => $disallowedFileExtensions
477 )
478 )
479 ),
480 'appearance' => array(
481 'useSortable' => TRUE,
482 'headerThumbnail' => 'uid_local',
483 'showPossibleLocalizationRecords' => TRUE,
484 'showRemovedLocalizationRecords' => TRUE,
485 'showSynchronizationLink' => TRUE,
486
487 'enabledControls' => array(
488 'info' => FALSE,
489 'new' => FALSE,
490 'dragdrop' => TRUE,
491 'sort' => FALSE,
492 'hide' => TRUE,
493 'delete' => TRUE,
494 'localize' => TRUE,
495 ),
496 ),
497 'behaviour' => array(
498 'localizationMode' => 'select',
499 'localizeChildrenAtParentLocalization' => TRUE,
500 ),
501 );
502 return \TYPO3\CMS\Core\Utility\GeneralUtility::array_merge_recursive_overrule($fileFieldTCAConfig, $customSettingOverride);
503 }
504
505 /**
506 * Adds a list of new fields to the TYPO3 USER SETTINGS configuration "showitem" list, the array with
507 * the new fields itself needs to be added additionally to show up in the user setup, like
508 * $GLOBALS['TYPO3_USER_SETTINGS']['columns'] += $tempColumns
509 *
510 * @param string $addFields List of fields to be added to the user settings
511 * @param string $insertionPosition Insert fields before (default) or after one
512 * @return void
513 */
514 static public function addFieldsToUserSettings($addFields, $insertionPosition = '') {
515 $GLOBALS['TYPO3_USER_SETTINGS']['showitem'] = self::executePositionedStringInsertion($GLOBALS['TYPO3_USER_SETTINGS']['showitem'], $addFields, $insertionPosition);
516 }
517
518 /**
519 * Inserts as list of data into an existing list.
520 * The insertion position can be defined accordant before of after existing list items.
521 *
522 * @param string $list The list of items to be extended
523 * @param string $insertionList The list of items to inserted
524 * @param string $insertionPosition Insert fields before (default) or after one
525 * @return string The extended list
526 */
527 static protected function executePositionedStringInsertion($list, $insertionList, $insertionPosition = '') {
528 $list = trim($list);
529 $insertionList = self::removeDuplicatesForInsertion($insertionList, $list);
530 if ($insertionList) {
531 // Append data to the end (default):
532 if ($insertionPosition === '') {
533 $list .= ($list ? ', ' : '') . $insertionList;
534 } else {
535 $positions = \TYPO3\CMS\Core\Utility\GeneralUtility::trimExplode(',', $insertionPosition, TRUE);
536 $items = self::explodeItemList($list);
537 $isInserted = FALSE;
538 // Iterate through all fields an check whether it's possible to inserte there:
539 foreach ($items as $item => &$itemDetails) {
540 $needles = self::getInsertionNeedles($item, $itemDetails['details']);
541 // Insert data before:
542 foreach ($needles['before'] as $needle) {
543 if (in_array($needle, $positions)) {
544 $itemDetails['rawData'] = $insertionList . ', ' . $itemDetails['rawData'];
545 $isInserted = TRUE;
546 break;
547 }
548 }
549 // Insert data after:
550 foreach ($needles['after'] as $needle) {
551 if (in_array($needle, $positions)) {
552 $itemDetails['rawData'] .= ', ' . $insertionList;
553 $isInserted = TRUE;
554 break;
555 }
556 }
557 // Replace with data:
558 foreach ($needles['replace'] as $needle) {
559 if (in_array($needle, $positions)) {
560 $itemDetails['rawData'] = $insertionList;
561 $isInserted = TRUE;
562 break;
563 }
564 }
565 // Break if insertion was already done:
566 if ($isInserted) {
567 break;
568 }
569 }
570 // If insertion point could not be determined, append the data:
571 if (!$isInserted) {
572 $list .= ($list ? ', ' : '') . $insertionList;
573 } else {
574 $list = self::generateItemList($items, TRUE);
575 }
576 }
577 }
578 return $list;
579 }
580
581 /**
582 * Compares an existing list of items and a list of items to be inserted
583 * and returns a duplicate-free variant of that insertion list.
584 *
585 * Example:
586 * + list: 'field_a, field_b;;;;2-2-2, field_c;;;;3-3-3'
587 * + insertion: 'field_b, field_d, field_c;;;4-4-4'
588 * -> new insertion: 'field_d'
589 *
590 * @param string $insertionList The list of items to inserted
591 * @param string $list The list of items to be extended (default: '')
592 * @return string Duplicate-free list of items to be inserted
593 */
594 static protected function removeDuplicatesForInsertion($insertionList, $list = '') {
595 $pattern = '/(^|,)\\s*\\b([^;,]+)\\b[^,]*/';
596 $listItems = array();
597 if ($list && preg_match_all($pattern, $list, $listMatches)) {
598 $listItems = $listMatches[2];
599 }
600 if ($insertionList && preg_match_all($pattern, $insertionList, $insertionListMatches)) {
601 $insertionItems = array();
602 $insertionDuplicates = FALSE;
603 foreach ($insertionListMatches[2] as $insertionIndex => $insertionItem) {
604 if (!isset($insertionItems[$insertionItem]) && !in_array($insertionItem, $listItems)) {
605 $insertionItems[$insertionItem] = TRUE;
606 } else {
607 unset($insertionListMatches[0][$insertionIndex]);
608 $insertionDuplicates = TRUE;
609 }
610 }
611 if ($insertionDuplicates) {
612 $insertionList = implode('', $insertionListMatches[0]);
613 }
614 }
615 return $insertionList;
616 }
617
618 /**
619 * Generates search needles that are used for inserting fields/items into an existing list.
620 *
621 * @see executePositionedStringInsertion
622 * @param string $item The name of the field/item
623 * @param array $itemDetails Additional details of the field/item like e.g. palette information
624 * @return array The needled to be used for inserting content before or after existing fields/items
625 */
626 static protected function getInsertionNeedles($item, array $itemDetails) {
627 if (strstr($item, '--')) {
628 // 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.
629 $item = preg_replace('/[0-9]+$/', '', $item);
630 }
631 $needles = array(
632 'before' => array($item, 'before:' . $item),
633 'after' => array('after:' . $item),
634 'replace' => array('replace:' . $item)
635 );
636 if ($itemDetails['palette']) {
637 $palette = $item . ';;' . $itemDetails['palette'];
638 $needles['before'][] = $palette;
639 $needles['before'][] = 'before:' . $palette;
640 $needles['after'][] = 'after:' . $palette;
641 $needles['replace'][] = 'replace:' . $palette;
642 }
643 return $needles;
644 }
645
646 /**
647 * Generates an array of fields/items with additional information such as e.g. the name of the palette.
648 *
649 * @param string $itemList List of fields/items to be splitted up
650 * @return array An array with the names of the fields/items as keys and additional information
651 */
652 static protected function explodeItemList($itemList) {
653 $items = array();
654 $itemParts = \TYPO3\CMS\Core\Utility\GeneralUtility::trimExplode(',', $itemList, TRUE);
655 foreach ($itemParts as $itemPart) {
656 $itemDetails = \TYPO3\CMS\Core\Utility\GeneralUtility::trimExplode(';', $itemPart, FALSE, 5);
657 $key = $itemDetails[0];
658 if (strstr($key, '--')) {
659 // 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!
660 $key .= count($items);
661 }
662 if (!isset($items[$key])) {
663 $items[$key] = array(
664 'rawData' => $itemPart,
665 'details' => array(
666 'field' => $itemDetails[0],
667 'label' => $itemDetails[1],
668 'palette' => $itemDetails[2],
669 'special' => $itemDetails[3],
670 'styles' => $itemDetails[4]
671 )
672 );
673 }
674 }
675 return $items;
676 }
677
678 /**
679 * Generates a list of fields/items out of an array provided by the function getFieldsOfFieldList().
680 *
681 * @see explodeItemList
682 * @param array $items The array of fields/items with optional additional information
683 * @param boolean $useRawData Use raw data instead of building by using the details (default: FALSE)
684 * @return string The list of fields/items which gets used for $GLOBALS['TCA'][<table>]['types'][<type>]['showitem']
685 */
686 static protected function generateItemList(array $items, $useRawData = FALSE) {
687 $itemParts = array();
688 foreach ($items as $item => $itemDetails) {
689 if (strstr($item, '--')) {
690 // 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.
691 $item = preg_replace('/[0-9]+$/', '', $item);
692 }
693 if ($useRawData) {
694 $itemParts[] = $itemDetails['rawData'];
695 } else {
696 $itemParts[] = count($itemDetails['details']) > 1 ? implode(';', $itemDetails['details']) : $item;
697 }
698 }
699 return implode(', ', $itemParts);
700 }
701
702 /**
703 * Add tablename to default list of allowed tables on pages (in $PAGES_TYPES)
704 * Will add the $table to the list of tables allowed by default on pages as setup by $PAGES_TYPES['default']['allowedTables']
705 * FOR USE IN ext_tables.php FILES
706 *
707 * @param string $table Table name
708 * @return void
709 */
710 static public function allowTableOnStandardPages($table) {
711 $GLOBALS['PAGES_TYPES']['default']['allowedTables'] .= ',' . $table;
712 }
713
714 /**
715 * Adds a ExtJS module (main or sub) to the backend interface
716 * FOR USE IN ext_tables.php FILES
717 *
718 * @static
719 * @param string $extensionName
720 * @param string $mainModuleName Is the main module key
721 * @param string $subModuleName Is the submodule key, if blank a plain main module is generated
722 * @param string $position Passed to t3lib_extMgm::addModule, see reference there
723 * @param array $moduleConfiguration Icon with array keys: access, icon, labels to configure the module
724 * @throws \InvalidArgumentException
725 */
726 static public function addExtJSModule($extensionName, $mainModuleName, $subModuleName = '', $position = '', array $moduleConfiguration = array()) {
727 if (empty($extensionName)) {
728 throw new \InvalidArgumentException('The extension name must not be empty', 1325938973);
729 }
730 $extensionKey = \TYPO3\CMS\Core\Utility\GeneralUtility::camelCaseToLowerCaseUnderscored($extensionName);
731 $extensionName = str_replace(' ', '', ucwords(str_replace('_', ' ', $extensionName)));
732 $defaultModuleConfiguration = array(
733 'access' => 'admin',
734 'icon' => 'gfx/typo3.png',
735 'labels' => '',
736 'extRelPath' => self::extRelPath($extensionKey) . 'Classes/'
737 );
738 // Add mandatory parameter to use new pagetree
739 if ($mainModuleName === 'web') {
740 $defaultModuleConfiguration['navigationComponentId'] = 'typo3-pagetree';
741 }
742 $moduleConfiguration = \TYPO3\CMS\Core\Utility\GeneralUtility::array_merge_recursive_overrule($defaultModuleConfiguration, $moduleConfiguration);
743 if (strlen($subModuleName) > 0) {
744 $moduleSignature = $mainModuleName . '_' . $subModuleName;
745 } else {
746 $moduleSignature = $mainModuleName;
747 }
748 $moduleConfiguration['name'] = $moduleSignature;
749 $moduleConfiguration['script'] = 'extjspaneldummy.html';
750 $moduleConfiguration['extensionName'] = $extensionName;
751 $moduleConfiguration['configureModuleFunction'] = array('TYPO3\\CMS\\Core\\Utility\\ExtensionManagementUtility', 'configureModule');
752 $GLOBALS['TBE_MODULES']['_configuration'][$moduleSignature] = $moduleConfiguration;
753 self::addModule($mainModuleName, $subModuleName, $position);
754 }
755
756 /**
757 * This method is called from t3lib_loadModules::checkMod 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: t3lib_extMgm::addModulePath('xMOD_tximpexp', t3lib_extMgm::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 t3lib_SCbase::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. t3lib_extMgm::addLLrefForTCAdescr('pages', 'EXT:lang/locallang_csh_pages.xml'); for the pages table or t3lib_extMgm::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.php" (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 \TYPO3\CMS\Core\Utility\GeneralUtility::loadTCA('tt_content');
1179 if (is_array($GLOBALS['TCA']['tt_content']['columns']) && is_array($GLOBALS['TCA']['tt_content']['columns'][$type]['config']['items'])) {
1180 foreach ($GLOBALS['TCA']['tt_content']['columns'][$type]['config']['items'] as $k => $v) {
1181 if (!strcmp($v[1], $itemArray[1])) {
1182 $GLOBALS['TCA']['tt_content']['columns'][$type]['config']['items'][$k] = $itemArray;
1183 return;
1184 }
1185 }
1186 $GLOBALS['TCA']['tt_content']['columns'][$type]['config']['items'][] = $itemArray;
1187 }
1188 }
1189
1190 /**
1191 * Adds an entry to the "ds" array of the tt_content field "pi_flexform".
1192 * This is used by plugins to add a flexform XML reference / content for use when they are selected as plugin or content element.
1193 *
1194 * @param string $piKeyToMatch Plugin key as used in the list_type field. Use the asterisk * to match all list_type values.
1195 * @param string $value Either a reference to a flex-form XML file (eg. "FILE:EXT:newloginbox/flexform_ds.xml") or the XML directly.
1196 * @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.
1197 * @return void
1198 * @see addPlugin()
1199 */
1200 static public function addPiFlexFormValue($piKeyToMatch, $value, $CTypeToMatch = 'list') {
1201 \TYPO3\CMS\Core\Utility\GeneralUtility::loadTCA('tt_content');
1202 if (is_array($GLOBALS['TCA']['tt_content']['columns']) && is_array($GLOBALS['TCA']['tt_content']['columns']['pi_flexform']['config']['ds'])) {
1203 $GLOBALS['TCA']['tt_content']['columns']['pi_flexform']['config']['ds'][$piKeyToMatch . ',' . $CTypeToMatch] = $value;
1204 }
1205 }
1206
1207 /**
1208 * Adds the $table tablename to the list of tables allowed to be includes by content element type "Insert records"
1209 * By using $content_table and $content_field you can also use the function for other tables.
1210 * FOR USE IN ext_tables.php FILES
1211 *
1212 * @param string $table Table name to allow for "insert record
1213 * @param string $content_table Table name TO WHICH the $table name is applied. See $content_field as well.
1214 * @param string $content_field Field name in the database $content_table in which $table is allowed to be added as a reference ("Insert Record")
1215 * @return void
1216 */
1217 static public function addToInsertRecords($table, $content_table = 'tt_content', $content_field = 'records') {
1218 \TYPO3\CMS\Core\Utility\GeneralUtility::loadTCA($content_table);
1219 if (is_array($GLOBALS['TCA'][$content_table]['columns']) && isset($GLOBALS['TCA'][$content_table]['columns'][$content_field]['config']['allowed'])) {
1220 $GLOBALS['TCA'][$content_table]['columns'][$content_field]['config']['allowed'] .= ',' . $table;
1221 }
1222 }
1223
1224 /**
1225 * Add PlugIn to Static Template #43
1226 *
1227 * 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.
1228 * 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"
1229 * $type determines the type of frontend plugin:
1230 * "list_type" (default) - the good old "Insert plugin" entry
1231 * "menu_type" - a "Menu/Sitemap" entry
1232 * "CType" - a new content element type
1233 * "header_layout" - an additional header type (added to the selection of layout1-5)
1234 * "includeLib" - just includes the library for manual use somewhere in TypoScript.
1235 * (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)
1236 * FOR USE IN ext_localconf.php FILES
1237 *
1238 * @param string $key The extension key
1239 * @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.
1240 * @param string $prefix Is used as a - yes, suffix - of the class name (fx. "_pi1")
1241 * @param string $type See description above
1242 * @param boolean $cached If $cached is set as USER content object (cObject) is created - otherwise a USER_INT object is created.
1243 * @return void
1244 */
1245 static public function addPItoST43($key, $classFile = '', $prefix = '', $type = 'list_type', $cached = 0) {
1246 $classFile = $classFile ? $classFile : 'pi/class.tx_' . str_replace('_', '', $key) . $prefix . '.php';
1247 $cN = self::getCN($key);
1248 // General plugin
1249 $pluginContent = trim('
1250 plugin.' . $cN . $prefix . ' = USER' . ($cached ? '' : '_INT') . '
1251 plugin.' . $cN . $prefix . ' {
1252 includeLibs = ' . $GLOBALS['TYPO3_LOADED_EXT'][$key]['siteRelPath'] . $classFile . '
1253 userFunc = ' . $cN . $prefix . '->main
1254 }');
1255 self::addTypoScript($key, 'setup', '
1256 # Setting ' . $key . ' plugin TypoScript
1257 ' . $pluginContent);
1258 // After ST43
1259 switch ($type) {
1260 case 'list_type':
1261 $addLine = 'tt_content.list.20.' . $key . $prefix . ' = < plugin.' . $cN . $prefix;
1262 break;
1263 case 'menu_type':
1264 $addLine = 'tt_content.menu.20.' . $key . $prefix . ' = < plugin.' . $cN . $prefix;
1265 break;
1266 case 'CType':
1267 $addLine = trim('
1268 tt_content.' . $key . $prefix . ' = COA
1269 tt_content.' . $key . $prefix . ' {
1270 10 = < lib.stdheader
1271 20 = < plugin.' . $cN . $prefix . '
1272 }
1273 ');
1274 break;
1275 case 'header_layout':
1276 $addLine = 'lib.stdheader.10.' . $key . $prefix . ' = < plugin.' . $cN . $prefix;
1277 break;
1278 case 'includeLib':
1279 $addLine = 'page.1000 = < plugin.' . $cN . $prefix;
1280 break;
1281 default:
1282 $addLine = '';
1283 break;
1284 }
1285 if ($addLine) {
1286 self::addTypoScript($key, 'setup', '
1287 # Setting ' . $key . ' plugin TypoScript
1288 ' . $addLine . '
1289 ', 43);
1290 }
1291 }
1292
1293 /**
1294 * Call this method to add an entry in the static template list found in sys_templates
1295 * "static template files" are the modern equivalent (provided from extensions) to the traditional records in "static_templates"
1296 * FOR USE IN ext_localconf.php FILES
1297 *
1298 * @param string $extKey Is of course the extension key
1299 * @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/
1300 * @param string $title Is the title in the selector box.
1301 * @return void
1302 * @see addTypoScript()
1303 */
1304 static public function addStaticFile($extKey, $path, $title) {
1305 \TYPO3\CMS\Core\Utility\GeneralUtility::loadTCA('sys_template');
1306 if ($extKey && $path && is_array($GLOBALS['TCA']['sys_template']['columns'])) {
1307 $value = str_replace(',', '', 'EXT:' . $extKey . '/' . $path);
1308 $itemArray = array(trim($title . ' (' . $extKey . ')'), $value);
1309 $GLOBALS['TCA']['sys_template']['columns']['include_static_file']['config']['items'][] = $itemArray;
1310 }
1311 }
1312
1313 /**
1314 * Adds $content to the default TypoScript setup code as set in $GLOBALS['TYPO3_CONF_VARS'][FE]['defaultTypoScript_setup']
1315 * Prefixed with a [GLOBAL] line
1316 * FOR USE IN ext_localconf.php FILES
1317 *
1318 * @param string $content TypoScript Setup string
1319 * @return void
1320 */
1321 static public function addTypoScriptSetup($content) {
1322 self::appendToTypoConfVars('FE', 'defaultTypoScript_setup', '
1323 [GLOBAL]
1324 ' . $content);
1325 }
1326
1327 /**
1328 * Adds $content to the default TypoScript constants code as set in $GLOBALS['TYPO3_CONF_VARS'][FE]['defaultTypoScript_constants']
1329 * Prefixed with a [GLOBAL] line
1330 * FOR USE IN ext_localconf.php FILES
1331 *
1332 * @param string $content TypoScript Constants string
1333 * @return void
1334 */
1335 static public function addTypoScriptConstants($content) {
1336 self::appendToTypoConfVars('FE', 'defaultTypoScript_constants', '
1337 [GLOBAL]
1338 ' . $content);
1339 }
1340
1341 /**
1342 * Adds $content to the default TypoScript code for either setup or constants as set in $GLOBALS['TYPO3_CONF_VARS'][FE]['defaultTypoScript_*']
1343 * (Basically this function can do the same as addTypoScriptSetup and addTypoScriptConstants - just with a little more hazzle, but also with some more options!)
1344 * FOR USE IN ext_localconf.php FILES
1345 *
1346 * @param string $key Is the extension key (informative only).
1347 * @param string $type Is either "setup" or "constants" and obviously determines which kind of TypoScript code we are adding.
1348 * @param string $content Is the TS content, prefixed with a [GLOBAL] line and a comment-header.
1349 * @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.
1350 * @return void
1351 */
1352 static public function addTypoScript($key, $type, $content, $afterStaticUid = 0) {
1353 if ($type == 'setup' || $type == 'constants') {
1354 $content = '
1355
1356 [GLOBAL]
1357 #############################################
1358 ## TypoScript added by extension "' . $key . '"
1359 #############################################
1360
1361 ' . $content;
1362 if ($afterStaticUid) {
1363 $GLOBALS['TYPO3_CONF_VARS']['FE']['defaultTypoScript_' . $type . '.'][$afterStaticUid] .= $content;
1364 // If 'content (default)' is targeted, also add to other 'content rendering templates', eg. css_styled_content
1365 if ($afterStaticUid == 43 && is_array($GLOBALS['TYPO3_CONF_VARS']['FE']['contentRenderingTemplates'])) {
1366 foreach ($GLOBALS['TYPO3_CONF_VARS']['FE']['contentRenderingTemplates'] as $templateName) {
1367 $GLOBALS['TYPO3_CONF_VARS']['FE']['defaultTypoScript_' . $type . '.'][$templateName] .= $content;
1368 }
1369 }
1370 } else {
1371 $GLOBALS['TYPO3_CONF_VARS']['FE']['defaultTypoScript_' . $type] .= $content;
1372 }
1373 }
1374 }
1375
1376 /***************************************
1377 *
1378 * Internal extension management methods
1379 *
1380 ***************************************/
1381 /**
1382 * Load the extension information array. This array is set as
1383 * $GLOBALS['TYPO3_LOADED_EXT'] in bootstrap. It contains basic information
1384 * about every loaded extension.
1385 *
1386 * This is an internal method. It is only used during bootstrap and
1387 * extensions should not use it!
1388 *
1389 * @param boolean $allowCaching If FALSE, the array will not be read / created from cache
1390 * @return array Result array that will be set as $GLOBALS['TYPO3_LOADED_EXT']
1391 * @access private
1392 * @see createTypo3LoadedExtensionInformationArray
1393 */
1394 static public function loadTypo3LoadedExtensionInformation($allowCaching = TRUE) {
1395 if ($allowCaching) {
1396 $cacheIdentifier = self::getTypo3LoadedExtensionInformationCacheIdentifier();
1397 /** @var $codeCache \TYPO3\CMS\Core\Cache\Frontend\PhpFrontend */
1398 $codeCache = $GLOBALS['typo3CacheManager']->getCache('cache_core');
1399 if ($codeCache->has($cacheIdentifier)) {
1400 $typo3LoadedExtensionArray = $codeCache->requireOnce($cacheIdentifier);
1401 } else {
1402 $typo3LoadedExtensionArray = self::createTypo3LoadedExtensionInformationArray();
1403 $codeCache->set($cacheIdentifier, 'return ' . var_export($typo3LoadedExtensionArray, TRUE) . ';');
1404 }
1405 } else {
1406 $typo3LoadedExtensionArray = self::createTypo3LoadedExtensionInformationArray();
1407 }
1408 return $typo3LoadedExtensionArray;
1409 }
1410
1411 /**
1412 * Set up array with basic information about loaded extension:
1413 *
1414 * array(
1415 * 'extensionKey' => array(
1416 * 'type' => Either S, L or G, inidicating if the extension is a system, a local or a global extension
1417 * 'siteRelPath' => Relative path to the extension from document root
1418 * 'typo3RelPath' => Relative path to extension from typo3/ subdirectory
1419 * 'ext_localconf.php' => Absolute path to ext_localconf.php file of extension
1420 * 'ext_...' => Further absolute path of extension files, see $extensionFilesToCheckFor var for details
1421 * ),
1422 * );
1423 *
1424 * @return array Result array that will be set as $GLOBALS['TYPO3_LOADED_EXT']
1425 */
1426 static protected function createTypo3LoadedExtensionInformationArray() {
1427 $loadedExtensions = static::getLoadedExtensionListArray();
1428 $loadedExtensionInformation = array();
1429 $extensionFilesToCheckFor = array(
1430 'ext_localconf.php',
1431 'ext_tables.php',
1432 'ext_tables.sql',
1433 'ext_tables_static+adt.sql',
1434 'ext_typoscript_constants.txt',
1435 'ext_typoscript_setup.txt'
1436 );
1437 // Clear file status cache to make sure we get good results from is_dir()
1438 clearstatcache();
1439 foreach ($loadedExtensions as $extensionKey) {
1440 // Determine if extension is installed locally, globally or system (in this order)
1441 if (@is_dir((PATH_typo3conf . 'ext/' . $extensionKey . '/'))) {
1442 // local
1443 $loadedExtensionInformation[$extensionKey] = array(
1444 'type' => 'L',
1445 'siteRelPath' => 'typo3conf/ext/' . $extensionKey . '/',
1446 'typo3RelPath' => '../typo3conf/ext/' . $extensionKey . '/'
1447 );
1448 } elseif (@is_dir((PATH_typo3 . 'ext/' . $extensionKey . '/'))) {
1449 // global
1450 $loadedExtensionInformation[$extensionKey] = array(
1451 'type' => 'G',
1452 'siteRelPath' => TYPO3_mainDir . 'ext/' . $extensionKey . '/',
1453 'typo3RelPath' => 'ext/' . $extensionKey . '/'
1454 );
1455 } elseif (@is_dir((PATH_typo3 . 'sysext/' . $extensionKey . '/'))) {
1456 // system
1457 $loadedExtensionInformation[$extensionKey] = array(
1458 'type' => 'S',
1459 'siteRelPath' => TYPO3_mainDir . 'sysext/' . $extensionKey . '/',
1460 'typo3RelPath' => 'sysext/' . $extensionKey . '/'
1461 );
1462 }
1463 // Register found files in extension array if extension was found
1464 if (isset($loadedExtensionInformation[$extensionKey])) {
1465 foreach ($extensionFilesToCheckFor as $fileName) {
1466 $absolutePathToFile = PATH_site . $loadedExtensionInformation[$extensionKey]['siteRelPath'] . $fileName;
1467 if (@is_file($absolutePathToFile)) {
1468 $loadedExtensionInformation[$extensionKey][$fileName] = $absolutePathToFile;
1469 }
1470 }
1471 }
1472 // Register found extension icon
1473 $loadedExtensionInformation[$extensionKey]['ext_icon'] = self::getExtensionIcon(PATH_site . $loadedExtensionInformation[$extensionKey]['siteRelPath']);
1474 }
1475 return $loadedExtensionInformation;
1476 }
1477
1478 /**
1479 * Find extension icon
1480 *
1481 * @param string $extensionPath Path to extension directory.
1482 * @param string $returnFullPath Return full path of file.
1483 * @return string
1484 * @throws \BadFunctionCallException
1485 */
1486 static public function getExtensionIcon($extensionPath, $returnFullPath = FALSE) {
1487 $icon = '';
1488 $iconFileTypesToCheckFor = array('png', 'gif');
1489 foreach ($iconFileTypesToCheckFor as $fileType) {
1490 if (file_exists($extensionPath . 'ext_icon.' . $fileType)) {
1491 $icon = 'ext_icon.' . $fileType;
1492 break;
1493 }
1494 }
1495 return $returnFullPath ? $extensionPath . $icon : $icon;
1496 }
1497
1498 /**
1499 * Cache identifier of cached Typo3LoadedExtensionInformation array
1500 *
1501 * @return string
1502 */
1503 static protected function getTypo3LoadedExtensionInformationCacheIdentifier() {
1504 return 'loaded_extensions_' . sha1((TYPO3_version . PATH_site . 'loadedExtensions'));
1505 }
1506
1507 /**
1508 * Execute all ext_localconf.php files of loaded extensions.
1509 * The method implements an optionally used caching mechanism that concatenates all
1510 * ext_localconf.php files in one file.
1511 *
1512 * This is an internal method. It is only used during bootstrap and
1513 * extensions should not use it!
1514 *
1515 * @param boolean $allowCaching Whether or not to load / create concatenated cache file
1516 * @return void
1517 * @access private
1518 */
1519 static public function loadExtLocalconf($allowCaching = TRUE) {
1520 if ($allowCaching) {
1521 $cacheIdentifier = self::getExtLocalconfCacheIdentifier();
1522 /** @var $codeCache \TYPO3\CMS\Core\Cache\Frontend\PhpFrontend */
1523 $codeCache = $GLOBALS['typo3CacheManager']->getCache('cache_core');
1524 if ($codeCache->has($cacheIdentifier)) {
1525 $codeCache->requireOnce($cacheIdentifier);
1526 } else {
1527 self::loadSingleExtLocalconfFiles();
1528 self::createExtLocalconfCacheEntry();
1529 }
1530 } else {
1531 self::loadSingleExtLocalconfFiles();
1532 }
1533 }
1534
1535 /**
1536 * Execute ext_localconf.php files from extensions
1537 *
1538 * @return void
1539 */
1540 static protected function loadSingleExtLocalconfFiles() {
1541 // This is the main array meant to be manipulated in the ext_localconf.php files
1542 // In general it is recommended to not rely on it to be globally defined in that
1543 // scope but to use $GLOBALS['TYPO3_CONF_VARS'] instead.
1544 // Nevertheless we define it here as global for backwards compatibility.
1545 global $TYPO3_CONF_VARS;
1546 // These globals for internal use only. Manipulating them directly is highly discouraged!
1547 // We set them here as global for backwards compatibility, but this will change in
1548 // future versions.
1549 // @deprecated since 6.0 Will be removed in two versions.
1550 global $T3_SERVICES, $T3_VAR;
1551 foreach ($GLOBALS['TYPO3_LOADED_EXT'] as $_EXTKEY => $extensionInformation) {
1552 if (is_array($extensionInformation) && $extensionInformation['ext_localconf.php']) {
1553 // $_EXTKEY and $_EXTCONF are available in ext_localconf.php
1554 // and are explicitly set in cached file as well
1555 $_EXTCONF = $GLOBALS['TYPO3_CONF_VARS']['EXT']['extConf'][$_EXTKEY];
1556 require $extensionInformation['ext_localconf.php'];
1557 }
1558 }
1559 }
1560
1561 /**
1562 * Create cache entry for concatenated ext_localconf.php files
1563 *
1564 * @return void
1565 */
1566 static protected function createExtLocalconfCacheEntry() {
1567 $extensionInformation = $GLOBALS['TYPO3_LOADED_EXT'];
1568 $phpCodeToCache = array();
1569 // Set same globals as in loadSingleExtLocalconfFiles()
1570 $phpCodeToCache[] = '/**';
1571 $phpCodeToCache[] = ' * Compiled ext_localconf.php cache file';
1572 $phpCodeToCache[] = ' */';
1573 $phpCodeToCache[] = '';
1574 $phpCodeToCache[] = 'global $TYPO3_CONF_VARS, $T3_SERVICES, $T3_VAR;';
1575 $phpCodeToCache[] = '';
1576 // Iterate through loaded extensions and add ext_localconf content
1577 foreach ($extensionInformation as $extensionKey => $extensionDetails) {
1578 // Include a header per extension to make the cache file more readable
1579 $phpCodeToCache[] = '/**';
1580 $phpCodeToCache[] = ' * Extension: ' . $extensionKey;
1581 $phpCodeToCache[] = ' * File: ' . $extensionDetails['ext_localconf.php'];
1582 $phpCodeToCache[] = ' */';
1583 $phpCodeToCache[] = '';
1584 // Set $_EXTKEY and $_EXTCONF for this extension
1585 $phpCodeToCache[] = '$_EXTKEY = \'' . $extensionKey . '\';';
1586 $phpCodeToCache[] = '$_EXTCONF = $GLOBALS[\'TYPO3_CONF_VARS\'][\'EXT\'][\'extConf\'][$_EXTKEY];';
1587 $phpCodeToCache[] = '';
1588 // Add ext_localconf.php content of extension
1589 $phpCodeToCache[] = trim(\TYPO3\CMS\Core\Utility\GeneralUtility::getUrl($extensionDetails['ext_localconf.php']));
1590 $phpCodeToCache[] = '';
1591 $phpCodeToCache[] = '';
1592 }
1593 $phpCodeToCache = implode(LF, $phpCodeToCache);
1594 // Remove all start and ending php tags from content
1595 $phpCodeToCache = preg_replace('/<\\?php|\\?>/is', '', $phpCodeToCache);
1596 $GLOBALS['typo3CacheManager']->getCache('cache_core')->set(self::getExtLocalconfCacheIdentifier(), $phpCodeToCache);
1597 }
1598
1599 /**
1600 * Cache identifier of concatenated ext_localconf file
1601 *
1602 * @return string
1603 */
1604 static protected function getExtLocalconfCacheIdentifier() {
1605 return 'ext_localconf_' . sha1((TYPO3_version . PATH_site . 'extLocalconf'));
1606 }
1607
1608 /**
1609 * Execute all ext_tables.php files of loaded extensions.
1610 * The method implements an optionally used caching mechanism that concatenates all
1611 * ext_tables.php files in one file.
1612 *
1613 * This is an internal method. It is only used during bootstrap and
1614 * extensions should not use it!
1615 *
1616 * @param boolean $allowCaching Whether to load / create concatenated cache file
1617 * @return void
1618 * @access private
1619 */
1620 static public function loadExtTables($allowCaching = TRUE) {
1621 if ($allowCaching && !self::$extTablesWasReadFromCacheOnce) {
1622 self::$extTablesWasReadFromCacheOnce = TRUE;
1623 $cacheIdentifier = self::getExtTablesCacheIdentifier();
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::loadSingleExtTablesFiles();
1630 self::createExtTablesCacheEntry();
1631 }
1632 } else {
1633 self::loadSingleExtTablesFiles();
1634 }
1635 }
1636
1637 /**
1638 * Load ext_tables.php as single files
1639 *
1640 * @return void
1641 */
1642 static protected function loadSingleExtTablesFiles() {
1643 // In general it is recommended to not rely on it to be globally defined in that
1644 // scope, but we can not prohibit this without breaking backwards compatibility
1645 global $T3_SERVICES, $T3_VAR, $TYPO3_CONF_VARS;
1646 global $TBE_MODULES, $TBE_MODULES_EXT, $TCA;
1647 global $PAGES_TYPES, $TBE_STYLES, $FILEICONS;
1648 global $_EXTKEY;
1649 // Load each ext_tables.php file of loaded extensions
1650 foreach ($GLOBALS['TYPO3_LOADED_EXT'] as $_EXTKEY => $extensionInformation) {
1651 if (is_array($extensionInformation) && $extensionInformation['ext_tables.php']) {
1652 // $_EXTKEY and $_EXTCONF are available in ext_tables.php
1653 // and are explicitly set in cached file as well
1654 $_EXTCONF = $GLOBALS['TYPO3_CONF_VARS']['EXT']['extConf'][$_EXTKEY];
1655 require $extensionInformation['ext_tables.php'];
1656 }
1657 }
1658 }
1659
1660 /**
1661 * Create concatenated ext_tables.php cache file
1662 *
1663 * @return void
1664 */
1665 static protected function createExtTablesCacheEntry() {
1666 $extensionInformation = $GLOBALS['TYPO3_LOADED_EXT'];
1667 $phpCodeToCache = array();
1668 // Set same globals as in loadSingleExtTablesFiles()
1669 $phpCodeToCache[] = '/**';
1670 $phpCodeToCache[] = ' * Compiled ext_tables.php cache file';
1671 $phpCodeToCache[] = ' */';
1672 $phpCodeToCache[] = '';
1673 $phpCodeToCache[] = 'global $T3_SERVICES, $T3_VAR, $TYPO3_CONF_VARS;';
1674 $phpCodeToCache[] = 'global $TBE_MODULES, $TBE_MODULES_EXT, $TCA;';
1675 $phpCodeToCache[] = 'global $PAGES_TYPES, $TBE_STYLES, $FILEICONS;';
1676 $phpCodeToCache[] = 'global $_EXTKEY;';
1677 $phpCodeToCache[] = '';
1678 // Iterate through loaded extensions and add ext_tables content
1679 foreach ($extensionInformation as $extensionKey => $extensionDetails) {
1680 // Include a header per extension to make the cache file more readable
1681 $phpCodeToCache[] = '/**';
1682 $phpCodeToCache[] = ' * Extension: ' . $extensionKey;
1683 $phpCodeToCache[] = ' * File: ' . $extensionDetails['ext_tables.php'];
1684 $phpCodeToCache[] = ' */';
1685 $phpCodeToCache[] = '';
1686 // Set $_EXTKEY and $_EXTCONF for this extension
1687 $phpCodeToCache[] = '$_EXTKEY = \'' . $extensionKey . '\';';
1688 $phpCodeToCache[] = '$_EXTCONF = $GLOBALS[\'TYPO3_CONF_VARS\'][\'EXT\'][\'extConf\'][$_EXTKEY];';
1689 $phpCodeToCache[] = '';
1690 // Add ext_tables.php content of extension
1691 $phpCodeToCache[] = trim(\TYPO3\CMS\Core\Utility\GeneralUtility::getUrl($extensionDetails['ext_tables.php']));
1692 $phpCodeToCache[] = '';
1693 $phpCodeToCache[] = '';
1694 }
1695 $phpCodeToCache = implode(LF, $phpCodeToCache);
1696 // Remove all start and ending php tags from content
1697 $phpCodeToCache = preg_replace('/<\\?php|\\?>/is', '', $phpCodeToCache);
1698 $GLOBALS['typo3CacheManager']->getCache('cache_core')->set(self::getExtTablesCacheIdentifier(), $phpCodeToCache);
1699 }
1700
1701 /**
1702 * Cache identifier for concatenated ext_tables.php files
1703 *
1704 * @return string
1705 */
1706 static protected function getExtTablesCacheIdentifier() {
1707 return 'ext_tables_' . sha1((TYPO3_version . PATH_site . 'extTables'));
1708 }
1709
1710 /**
1711 * Loading extensions configured in $GLOBALS['TYPO3_CONF_VARS']['EXT']['extListArray']
1712 *
1713 * Usages of this function can be seen in bootstrap
1714 * Extensions are always detected in the order local - global - system.
1715 *
1716 * @return array Extension Array
1717 * @internal
1718 * @deprecated since 6.0, will be removed in two versions
1719 */
1720 static public function typo3_loadExtensions() {
1721 \TYPO3\CMS\Core\Utility\GeneralUtility::logDeprecatedFunction();
1722 return self::loadTypo3LoadedExtensionInformation(TRUE);
1723 }
1724
1725 /**
1726 * Returns the section headers for the compiled cache-files.
1727 *
1728 * @param string $key Is the extension key
1729 * @param string $file Is the filename (only informative for comment)
1730 * @return string
1731 * @internal
1732 * @deprecated since 6.0, will be removed in two versions
1733 */
1734 static public function _makeIncludeHeader($key, $file) {
1735 \TYPO3\CMS\Core\Utility\GeneralUtility::logDeprecatedFunction();
1736 return '';
1737 }
1738
1739 /**
1740 * Returns TRUE if both the localconf and tables cache file exists
1741 * (with $cacheFilePrefix) and if they are not empty
1742 *
1743 * @param $cacheFilePrefix string Prefix of the cache file to check
1744 * @return boolean
1745 * @deprecated since 6.0, will be removed in two versions
1746 */
1747 static public function isCacheFilesAvailable($cacheFilePrefix) {
1748 \TYPO3\CMS\Core\Utility\GeneralUtility::logDeprecatedFunction();
1749 return FALSE;
1750 }
1751
1752 /**
1753 * Returns TRUE if configuration files in typo3conf/ are writable
1754 *
1755 * @return boolean TRUE if at least one configuration file in typo3conf/ is writable
1756 * @internal
1757 */
1758 static public function isLocalconfWritable() {
1759 return \TYPO3\CMS\Core\Utility\GeneralUtility::makeInstance('TYPO3\\CMS\\Core\\Configuration\\ConfigurationManager')->canWriteConfiguration();
1760 }
1761
1762 /**
1763 * Returns an error string if typo3conf/ or cache-files with $cacheFilePrefix are NOT writable
1764 * Returns FALSE if no problem.
1765 *
1766 * @param string $cacheFilePrefix Prefix of the cache file to check
1767 * @return string
1768 * @internal
1769 * @deprecated since 6.0, will be removed in two versions
1770 */
1771 static public function cannotCacheFilesWritable($cacheFilePrefix) {
1772 \TYPO3\CMS\Core\Utility\GeneralUtility::logDeprecatedFunction();
1773 return '';
1774 }
1775
1776 /**
1777 * Returns an array with the two cache-files (0=>localconf, 1=>tables)
1778 * from typo3conf/ if they (both) exist. Otherwise FALSE.
1779 * Evaluation relies on $GLOBALS['TYPO3_LOADED_EXT']['_CACHEFILE']
1780 *
1781 * @param string $cacheFilePrefix Cache file prefix to be used (optional)
1782 * @return array
1783 * @internal
1784 * @deprecated since 6.0, will be removed in versions
1785 */
1786 static public function currentCacheFiles($cacheFilePrefix = NULL) {
1787 \TYPO3\CMS\Core\Utility\GeneralUtility::logDeprecatedFunction();
1788 return array();
1789 }
1790
1791 /**
1792 * Compiles/Creates the two cache-files in typo3conf/ based on $cacheFilePrefix
1793 * Returns a array with the key "_CACHEFILE" set to the $cacheFilePrefix value
1794 *
1795 * @param array $extensions Extension information array
1796 * @param string $cacheFilePrefix Prefix for the cache files
1797 * @return array
1798 * @internal
1799 * @deprecated since 6.0, will be removed in two versions
1800 */
1801 static public function writeCacheFiles($extensions, $cacheFilePrefix) {
1802 \TYPO3\CMS\Core\Utility\GeneralUtility::logDeprecatedFunction();
1803 return array();
1804 }
1805
1806 /**
1807 * Remove cache files from php code cache, tagged with 'core'
1808 *
1809 * This removes the following cache entries:
1810 * - autoloader cache registry
1811 * - cache loaded extension array
1812 * - ext_localconf concatenation
1813 * - ext_tables concatenation
1814 *
1815 * This method is usually only used by extension that fiddle
1816 * with the loaded extensions. An example is the extension
1817 * manager and the install tool.
1818 *
1819 * @return void
1820 */
1821 static public function removeCacheFiles() {
1822 /** @var $codeCache \TYPO3\CMS\Core\Cache\Frontend\PhpFrontend */
1823 $codeCache = $GLOBALS['typo3CacheManager']->getCache('cache_core');
1824 $codeCache->flush();
1825 }
1826
1827 /**
1828 * Gets the behaviour for caching ext_tables.php and ext_localconf.php files
1829 * (see $GLOBALS['TYPO3_CONF_VARS']['EXT']['extCache'] setting in the install tool).
1830 *
1831 * @param boolean $usePlainValue Whether to use the value as it is without modifications
1832 * @return integer
1833 * @deprecated since 6.0, will be removed two versions later
1834 */
1835 static public function getExtensionCacheBehaviour($usePlainValue = FALSE) {
1836 \TYPO3\CMS\Core\Utility\GeneralUtility::logDeprecatedFunction();
1837 return 1;
1838 }
1839
1840 /**
1841 * Gets the prefix used for the ext_tables.php and ext_localconf.php cached files.
1842 *
1843 * @return string
1844 * @deprecated since 6.0, will be removed two versions later
1845 */
1846 static public function getCacheFilePrefix() {
1847 \TYPO3\CMS\Core\Utility\GeneralUtility::logDeprecatedFunction();
1848 }
1849
1850 /**
1851 * Gets the list of enabled extensions
1852 *
1853 * @return string
1854 * @deprecated since 6.0, will be removed two versions later
1855 */
1856 static public function getEnabledExtensionList() {
1857 \TYPO3\CMS\Core\Utility\GeneralUtility::logDeprecatedFunction();
1858 return implode(',', self::getLoadedExtensionListArray());
1859 }
1860
1861 /**
1862 * Gets the list of required extensions.
1863 *
1864 * @return string
1865 * @deprecated since 6.0, will be removed two versions later
1866 */
1867 static public function getRequiredExtensionList() {
1868 \TYPO3\CMS\Core\Utility\GeneralUtility::logDeprecatedFunction();
1869 return implode(',', self::getRequiredExtensionListArray());
1870 }
1871
1872 /**
1873 * Get list of extensions to be ignored (not to be loaded).
1874 *
1875 * @return string
1876 * @deprecated since 6.0, will be removed two versions later
1877 */
1878 static public function getIgnoredExtensionList() {
1879 \TYPO3\CMS\Core\Utility\GeneralUtility::logDeprecatedFunction();
1880 return '';
1881 }
1882
1883 /**
1884 * Gets an array of loaded extension keys
1885 *
1886 * @return array Loaded extensions
1887 */
1888 static public function getLoadedExtensionListArray() {
1889 // Extensions in extListArray
1890 if (is_array($GLOBALS['TYPO3_CONF_VARS']['EXT']['extListArray'])) {
1891 $loadedExtensions = $GLOBALS['TYPO3_CONF_VARS']['EXT']['extListArray'];
1892 } else {
1893 // Fallback handling if extlist is still a string and not an array
1894 $loadedExtensions = \TYPO3\CMS\Core\Utility\GeneralUtility::trimExplode(',', $GLOBALS['TYPO3_CONF_VARS']['EXT']['extList']);
1895 }
1896 // Add required extensions
1897 $loadedExtensions = array_merge(static::getRequiredExtensionListArray(), $loadedExtensions);
1898 $loadedExtensions = array_unique($loadedExtensions);
1899 return $loadedExtensions;
1900 }
1901
1902 /**
1903 * Gets list of required extensions.
1904 * This is the list of extensions from constant REQUIRED_EXTENSIONS defined
1905 * in bootstrap, together with a possible additional list of extensions from
1906 * local configuration
1907 *
1908 * @return array List of required extensions
1909 */
1910 static public function getRequiredExtensionListArray() {
1911 if (is_array($GLOBALS['TYPO3_CONF_VARS']['EXT']['requiredExt'])) {
1912 $requiredExtensions = $GLOBALS['TYPO3_CONF_VARS']['EXT']['requiredExt'];
1913 } else {
1914 $requiredExtensions = \TYPO3\CMS\Core\Utility\GeneralUtility::trimExplode(',', $GLOBALS['TYPO3_CONF_VARS']['EXT']['requiredExt']);
1915 }
1916 $requiredExtensions = array_merge(\TYPO3\CMS\Core\Utility\GeneralUtility::trimExplode(',', REQUIRED_EXTENSIONS), $requiredExtensions);
1917 $requiredExtensions = array_unique($requiredExtensions);
1918 return $requiredExtensions;
1919 }
1920
1921 /**
1922 * Loads given extension
1923 *
1924 * Warning: This method only works if the ugrade wizard to transform
1925 * localconf.php to LocalConfiguration.php was already run
1926 *
1927 * @param string $extensionKey Extension key to load
1928 * @return void
1929 * @throws \RuntimeException
1930 */
1931 static public function loadExtension($extensionKey) {
1932 if (static::isLoaded($extensionKey)) {
1933 throw new \RuntimeException('Extension already loaded', 1342345486);
1934 }
1935 $extList = \TYPO3\CMS\Core\Utility\GeneralUtility::makeInstance('TYPO3\\CMS\\Core\\Configuration\\ConfigurationManager')->getLocalConfigurationValueByPath('EXT/extListArray');
1936 $extList[] = $extensionKey;
1937 static::writeNewExtensionList($extList);
1938 }
1939
1940 /**
1941 * Unloads given extension
1942 *
1943 * Warning: This method only works if the ugrade wizard to transform
1944 * localconf.php to LocalConfiguration.php was already run
1945 *
1946 * @param string $extensionKey Extension key to remove
1947 * @return void
1948 * @throws \RuntimeException
1949 */
1950 static public function unloadExtension($extensionKey) {
1951 if (!static::isLoaded($extensionKey)) {
1952 throw new \RuntimeException('Extension not loaded', 1342345487);
1953 }
1954 if (in_array($extensionKey, static::getRequiredExtensionListArray())) {
1955 throw new \RuntimeException('Can not unload required extension', 1342348167);
1956 }
1957 $extList = \TYPO3\CMS\Core\Utility\GeneralUtility::makeInstance('TYPO3\\CMS\\Core\\Configuration\\ConfigurationManager')->getLocalConfigurationValueByPath('EXT/extListArray');
1958 $extList = array_diff($extList, array($extensionKey));
1959 static::writeNewExtensionList($extList);
1960 }
1961
1962 /**
1963 * Writes extension list and clear cache files.
1964 *
1965 * @TODO : This method should be protected, but with current em it is hard to do so,
1966 * @param array Extension array to load, loader order is kept
1967 * @return void
1968 * @internal
1969 */
1970 static public function writeNewExtensionList(array $newExtensionList) {
1971 $extensionList = array_unique($newExtensionList);
1972 \TYPO3\CMS\Core\Utility\GeneralUtility::makeInstance('TYPO3\\CMS\\Core\\Configuration\\ConfigurationManager')->setLocalConfigurationValueByPath('EXT/extListArray', $extensionList);
1973 // @deprecated: extList as string is deprecated, the handling will be removed with 6.2
1974 // For now, this value is still set for better backwards compatibility
1975 \TYPO3\CMS\Core\Utility\GeneralUtility::makeInstance('TYPO3\\CMS\\Core\\Configuration\\ConfigurationManager')->setLocalConfigurationValueByPath('EXT/extList', implode(',', $extensionList));
1976 static::removeCacheFiles();
1977 }
1978
1979 /**
1980 * Makes a table categorizable by extending its TCA.
1981 *
1982 * @param string $extensionKey Extension key to be used
1983 * @param string $tableName Name of the table to be categoriezed
1984 * @param string $fieldName Name of the field to be used to store categories
1985 * @param array $options Additional configuration options
1986 * @see addTCAcolumns
1987 * @see addToAllTCAtypes
1988 */
1989 static public function makeCategorizable($extensionKey, $tableName, $fieldName = 'categories', array $options = array()) {
1990 // Load TCA first
1991 \TYPO3\CMS\Core\Utility\GeneralUtility::loadTCA($tableName);
1992 // Update the category registry
1993 $result = \TYPO3\CMS\Core\Category\CategoryRegistry::getInstance()->add($extensionKey, $tableName, $fieldName);
1994 if ($result === FALSE) {
1995 $message = 't3lib_categoryRegistry: no category registered for table "%s". Double check if there is a TCA configured';
1996 \TYPO3\CMS\Core\Utility\GeneralUtility::devLog(sprintf($message, $tableName), 'Core', 2);
1997 }
1998 // Makes sure to add more TCA to an existing structure
1999 if (isset($GLOBALS['TCA'][$tableName]['columns'])) {
2000 // Forges a new field, default name is "categories"
2001 $fieldConfiguration = array(
2002 'type' => 'select',
2003 'foreign_table' => 'sys_category',
2004 'foreign_table_where' => ' ORDER BY sys_category.title ASC',
2005 'MM' => 'sys_category_record_mm',
2006 'MM_opposite_field' => 'items',
2007 'MM_match_fields' => array('tablenames' => $tableName),
2008 'size' => 10,
2009 'autoSizeMax' => 50,
2010 'maxitems' => 9999,
2011 'renderMode' => 'tree',
2012 'treeConfig' => array(
2013 'parentField' => 'parent',
2014 'appearance' => array(
2015 'expandAll' => TRUE,
2016 'showHeader' => TRUE
2017 )
2018 ),
2019 'wizards' => array(
2020 '_PADDING' => 1,
2021 '_VERTICAL' => 1,
2022 'edit' => array(
2023 'type' => 'popup',
2024 'title' => 'Edit',
2025 'script' => 'wizard_edit.php',
2026 'icon' => 'edit2.gif',
2027 'popup_onlyOpenIfSelected' => 1,
2028 'JSopenParams' => 'height=350,width=580,status=0,menubar=0,scrollbars=1'
2029 ),
2030 'add' => array(
2031 'type' => 'script',
2032 'title' => 'Create new',
2033 'icon' => 'add.gif',
2034 'params' => array(
2035 'table' => 'sys_category',
2036 'pid' => '###CURRENT_PID###',
2037 'setValue' => 'prepend'
2038 ),
2039 'script' => 'wizard_add.php'
2040 )
2041 )
2042 );
2043 if (!empty($options['fieldConfiguration'])) {
2044 $fieldConfiguration = \TYPO3\CMS\Core\Utility\GeneralUtility::array_merge_recursive_overrule($fieldConfiguration, $options['fieldConfiguration']);
2045 }
2046 $columns = array(
2047 $fieldName => array(
2048 'exclude' => 0,
2049 'label' => 'LLL:EXT:lang/locallang_tca.xlf:sys_category.categories',
2050 'config' => $fieldConfiguration
2051 )
2052 );
2053 // Adding fields to an existing table definition
2054 self::addTCAcolumns($tableName, $columns);
2055 $fieldList = '--div--;LLL:EXT:lang/locallang_tca.xlf:sys_category.tabs.category, ' . $fieldName;
2056 if (!empty($options['fieldList'])) {
2057 $fieldList = $options['fieldList'];
2058 }
2059 $typesList = '';
2060 if (!empty($options['typesList'])) {
2061 $typesList = $options['typesList'];
2062 }
2063 $position = '';
2064 if (!empty($options['position'])) {
2065 $position = $options['position'];
2066 }
2067 // Makes the new "categories" field to be visible in TSFE.
2068 self::addToAllTCAtypes($tableName, $fieldList, $typesList, $position);
2069 }
2070 }
2071
2072 }
2073 ?>