[TASK] Clean up uses of fe_adminLib properties
[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 use TYPO3\CMS\Core\Utility\GeneralUtility;
31
32 /**
33 * Extension Management functions
34 *
35 * This class is never instantiated, rather the methods inside is called as functions like
36 * \TYPO3\CMS\Core\Utility\ExtensionManagementUtility::isLoaded('my_extension');
37 *
38 * @author Kasper Skårhøj <kasperYYYY@typo3.com>
39 */
40 class ExtensionManagementUtility {
41
42 static protected $extensionKeyMap;
43
44 /**
45 * TRUE, if ext_tables file was read from cache for this script run.
46 * The frontend tends to do that multiple times, but the caching framework does
47 * not allow this (via a require_once call). This variable is used to track
48 * the access to the cache file to read the single ext_tables.php if it was
49 * already read from cache
50 *
51 * @TODO : See if we can get rid of the 'load multiple times' scenario in fe
52 * @var boolean
53 */
54 static protected $extTablesWasReadFromCacheOnce = FALSE;
55
56 /**
57 * @var \TYPO3\CMS\Core\Package\PackageManager
58 */
59 static protected $packageManager;
60
61 /**
62 * Sets the package manager for all that backwards compatibility stuff,
63 * so it doesn't have to be fetched through the bootstap
64 *
65 * @param \TYPO3\CMS\Core\Package\PackageManager $packageManager
66 */
67 static public function setPackageManager(\TYPO3\CMS\Core\Package\PackageManager $packageManager) {
68 static::$packageManager = $packageManager;
69 }
70
71 /**************************************
72 *
73 * PATHS and other evaluation
74 *
75 ***************************************/
76 /**
77 * Returns TRUE if the extension with extension key $key is loaded.
78 *
79 * @param string $key Extension key to test
80 * @param boolean $exitOnError If $exitOnError is TRUE and the extension is not loaded the function will die with an error message
81 * @return boolean
82 * @throws \BadFunctionCallException
83 */
84 static public function isLoaded($key, $exitOnError = FALSE) {
85 $isLoaded = static::$packageManager->isPackageActive($key);
86 if ($exitOnError && !$isLoaded) {
87 throw new \BadFunctionCallException('TYPO3 Fatal Error: Extension "' . $key . '" is not loaded!', 1270853910);
88 }
89 return $isLoaded;
90 }
91
92 /**
93 * Returns the absolute path to the extension with extension key $key
94 * If the extension is not loaded the function will die with an error message
95 * Useful for internal fileoperations
96 *
97 * @param $key string Extension key
98 * @param $script string $script is appended to the output if set.
99 * @throws \BadFunctionCallException
100 * @return string
101 */
102 static public function extPath($key, $script = '') {
103 if (!static::$packageManager->isPackageActive($key)) {
104 throw new \BadFunctionCallException('TYPO3 Fatal Error: Extension key "' . $key . '" is NOT loaded!', 1365429656);
105 }
106 return static::$packageManager->getPackage($key)->getPackagePath() . $script;
107 }
108
109 /**
110 * Returns the relative path to the extension as measured from from the TYPO3_mainDir
111 * If the extension is not loaded the function will die with an error message
112 * Useful for images and links from backend
113 *
114 * @param string $key Extension key
115 * @return string
116 */
117 static public function extRelPath($key) {
118 if (!static::$packageManager->isPackageActive($key)) {
119 throw new \BadFunctionCallException('TYPO3 Fatal Error: Extension key "' . $key . '" is NOT loaded!', 1365429673);
120 }
121 $relativePathToSiteRoot = self::siteRelPath($key);
122 if (substr($relativePathToSiteRoot, 0, $typo3MainDirLength = strlen(TYPO3_mainDir)) === TYPO3_mainDir) {
123 $relativePathToSiteRoot = substr($relativePathToSiteRoot, $typo3MainDirLength);
124 } else {
125 $relativePathToSiteRoot = '../' . $relativePathToSiteRoot;
126 }
127 return $relativePathToSiteRoot;
128 }
129
130 /**
131 * Returns the relative path to the extension as measured from the PATH_site (frontend)
132 * If the extension is not loaded the function will die with an error message
133 * Useful for images and links from the frontend
134 *
135 * @param string $key Extension key
136 * @return string
137 */
138 static public function siteRelPath($key) {
139 return \TYPO3\CMS\Core\Utility\PathUtility::stripPathSitePrefix(self::extPath($key));
140 }
141
142 /**
143 * Returns the correct class name prefix for the extension key $key
144 *
145 * @param string $key Extension key
146 * @return string
147 * @internal
148 */
149 static public function getCN($key) {
150 return substr($key, 0, 5) == 'user_' ? 'user_' . str_replace('_', '', substr($key, 5)) : 'tx_' . str_replace('_', '', $key);
151 }
152
153 /**
154 * Returns the real extension key like 'tt_news' from an extension prefix like 'tx_ttnews'.
155 *
156 * @param string $prefix The extension prefix (e.g. 'tx_ttnews')
157 * @return mixed Real extension key (string) or FALSE (boolean) if something went wrong
158 */
159 static public function getExtensionKeyByPrefix($prefix) {
160 $result = FALSE;
161 // Build map of short keys referencing to real keys:
162 if (!isset(self::$extensionKeyMap)) {
163 self::$extensionKeyMap = array();
164 foreach (static::$packageManager->getActivePackages() as $package) {
165 $shortKey = str_replace('_', '', $package->getPackageKey());
166 self::$extensionKeyMap[$shortKey] = $package->getPackageKey();
167 }
168 }
169 // Lookup by the given short key:
170 $parts = explode('_', $prefix);
171 if (isset(self::$extensionKeyMap[$parts[1]])) {
172 $result = self::$extensionKeyMap[$parts[1]];
173 }
174 return $result;
175 }
176
177 /**
178 * Clears the extension key map.
179 *
180 * @return void
181 */
182 static public function clearExtensionKeyMap() {
183 self::$extensionKeyMap = NULL;
184 }
185
186 /**
187 * Retrieves the version of an installed extension.
188 * If the extension is not installed, this function returns an empty string.
189 *
190 * @param string $key The key of the extension to look up, must not be empty
191 * @return string The extension version as a string in the format "x.y.z",
192 */
193 static public function getExtensionVersion($key) {
194 if (!is_string($key) || empty($key)) {
195 throw new \InvalidArgumentException('Extension key must be a non-empty string.', 1294586096);
196 }
197 if (!static::isLoaded($key)) {
198 return '';
199 }
200 return static::$packageManager->getPackage($key)->getPackageMetaData()->getVersion();
201 }
202
203 /**************************************
204 *
205 * Adding BACKEND features
206 * (related to core features)
207 *
208 ***************************************/
209 /**
210 * Adding fields to an existing table definition in $GLOBALS['TCA']
211 * Adds an array with $GLOBALS['TCA'] column-configuration to the $GLOBALS['TCA']-entry for that table.
212 * 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!
213 * So to have the fields displayed you must also call fx. addToAllTCAtypes or manually add the fields to the types list.
214 * FOR USE IN ext_tables.php FILES
215 *
216 * @param string $table The table name of a table already present in $GLOBALS['TCA'] with a columns section
217 * @param array $columnArray The array with the additional columns (typical some fields an extension wants to add)
218 * @param boolean $addTofeInterface DEPRECATED: Usage of feInterface is no longer part of the TYPO3 CMS Core. Please check EXT:statictemplates.
219 * @return void
220 */
221 static public function addTCAcolumns($table, $columnArray, $addTofeInterface = FALSE) {
222 if (is_array($columnArray) && is_array($GLOBALS['TCA'][$table]) && is_array($GLOBALS['TCA'][$table]['columns'])) {
223 // Candidate for array_merge() if integer-keys will some day make trouble...
224 $GLOBALS['TCA'][$table]['columns'] = array_merge($GLOBALS['TCA'][$table]['columns'], $columnArray);
225 if ($addTofeInterface) {
226 GeneralUtility::deprecationLog(
227 'Usage of feInterface is no longer part of the TYPO3 CMS Core. Please check EXT:statictemplates.'
228 );
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 === '' || GeneralUtility::inList($specificTypesList, $type)) {
253 $fieldExists = FALSE;
254 if ($position != '' && is_array($GLOBALS['TCA'][$table]['palettes'])) {
255 $positionArray = 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.xlf: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' => FALSE,
483 'showRemovedLocalizationRecords' => FALSE,
484 'showSynchronizationLink' => FALSE,
485 'showAllLocalizationLink' => FALSE,
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 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 = 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 = GeneralUtility::trimExplode(',', $itemList, TRUE);
655 foreach ($itemParts as $itemPart) {
656 $itemDetails = 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 \TYPO3\CMS\Core\Utility\ExtensionManagementUtility::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 = 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 = 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 \TYPO3\CMS\Backend\Module\ModuleLoader::checkMod
758 * and it replaces old conf.php.
759 *
760 * The original function for is called
761 * Tx_Extbase_Utility_Extension::configureModule, the refered function can
762 * be deprecated now
763 *
764 * @param string $moduleSignature The module name
765 * @param string $modulePath Absolute path to module (not used by Extbase currently)
766 * @return array Configuration of the module
767 */
768 static public function configureModule($moduleSignature, $modulePath) {
769 $moduleConfiguration = $GLOBALS['TBE_MODULES']['_configuration'][$moduleSignature];
770 $iconPathAndFilename = $moduleConfiguration['icon'];
771 if (substr($iconPathAndFilename, 0, 4) === 'EXT:') {
772 list($extensionKey, $relativePath) = explode('/', substr($iconPathAndFilename, 4), 2);
773 $iconPathAndFilename = self::extPath($extensionKey) . $relativePath;
774 }
775 // TODO: skin support
776 $moduleLabels = array(
777 'tabs_images' => array(
778 'tab' => $iconPathAndFilename
779 ),
780 'labels' => array(
781 'tablabel' => $GLOBALS['LANG']->sL($moduleConfiguration['labels'] . ':mlang_labels_tablabel'),
782 'tabdescr' => $GLOBALS['LANG']->sL($moduleConfiguration['labels'] . ':mlang_labels_tabdescr')
783 ),
784 'tabs' => array(
785 'tab' => $GLOBALS['LANG']->sL($moduleConfiguration['labels'] . ':mlang_tabs_tab')
786 )
787 );
788 $GLOBALS['LANG']->addModuleLabels($moduleLabels, $moduleSignature . '_');
789 return $moduleConfiguration;
790 }
791
792 /**
793 * Adds a module (main or sub) to the backend interface
794 * FOR USE IN ext_tables.php FILES
795 *
796 * @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.
797 * @param string $sub The submodule key. If $sub is not set a blank $main module is created.
798 * @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.
799 * @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.
800 * @param array $moduleConfiguration additional configuration, previously put in "conf.php" of the module directory
801 * @return void
802 */
803 static public function addModule($main, $sub = '', $position = '', $path = '', $moduleConfiguration = array()) {
804 if (isset($GLOBALS['TBE_MODULES'][$main]) && $sub) {
805 // If there is already a main module by this name:
806 // Adding the submodule to the correct position:
807 list($place, $modRef) = GeneralUtility::trimExplode(':', $position, TRUE);
808 $mods = GeneralUtility::trimExplode(',', $GLOBALS['TBE_MODULES'][$main], TRUE);
809 if (!in_array($sub, $mods)) {
810 switch (strtolower($place)) {
811 case 'after':
812
813 case 'before':
814 $pointer = 0;
815 $found = FALSE;
816 foreach ($mods as $k => $m) {
817 if (!strcmp($m, $modRef)) {
818 $pointer = strtolower($place) == 'after' ? $k + 1 : $k;
819 $found = TRUE;
820 }
821 }
822 if ($found) {
823 array_splice($mods, $pointer, 0, $sub);
824 } else {
825 // If requested module is not found: Add at the end
826 array_push($mods, $sub);
827 }
828 break;
829 default:
830 if (strtolower($place) == 'top') {
831 array_unshift($mods, $sub);
832 } else {
833 array_push($mods, $sub);
834 }
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 = 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 = 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 = GeneralUtility::trimExplode(',', $excludeServiceKeys, TRUE);
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 = GeneralUtility::trimExplode(',', $serviceDetails['exec'], TRUE);
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 }
1288 if ($addLine) {
1289 self::addTypoScript($key, 'setup', '
1290 # Setting ' . $key . ' plugin TypoScript
1291 ' . $addLine . '
1292 ', 43);
1293 }
1294 }
1295
1296 /**
1297 * Call this method to add an entry in the static template list found in sys_templates
1298 * FOR USE IN ext_tables.php FILES
1299 *
1300 * @param string $extKey Is of course the extension key
1301 * @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/
1302 * @param string $title Is the title in the selector box.
1303 * @return void
1304 * @see addTypoScript()
1305 */
1306 static public function addStaticFile($extKey, $path, $title) {
1307 if ($extKey && $path && is_array($GLOBALS['TCA']['sys_template']['columns'])) {
1308 $value = str_replace(',', '', 'EXT:' . $extKey . '/' . $path);
1309 $itemArray = array(trim($title . ' (' . $extKey . ')'), $value);
1310 $GLOBALS['TCA']['sys_template']['columns']['include_static_file']['config']['items'][] = $itemArray;
1311 }
1312 }
1313
1314 /**
1315 * Adds $content to the default TypoScript setup code as set in $GLOBALS['TYPO3_CONF_VARS'][FE]['defaultTypoScript_setup']
1316 * Prefixed with a [GLOBAL] line
1317 * FOR USE IN ext_localconf.php FILES
1318 *
1319 * @param string $content TypoScript Setup string
1320 * @return void
1321 */
1322 static public function addTypoScriptSetup($content) {
1323 self::appendToTypoConfVars('FE', 'defaultTypoScript_setup', '
1324 [GLOBAL]
1325 ' . $content);
1326 }
1327
1328 /**
1329 * Adds $content to the default TypoScript constants code as set in $GLOBALS['TYPO3_CONF_VARS'][FE]['defaultTypoScript_constants']
1330 * Prefixed with a [GLOBAL] line
1331 * FOR USE IN ext_localconf.php FILES
1332 *
1333 * @param string $content TypoScript Constants string
1334 * @return void
1335 */
1336 static public function addTypoScriptConstants($content) {
1337 self::appendToTypoConfVars('FE', 'defaultTypoScript_constants', '
1338 [GLOBAL]
1339 ' . $content);
1340 }
1341
1342 /**
1343 * Adds $content to the default TypoScript code for either setup or constants as set in $GLOBALS['TYPO3_CONF_VARS'][FE]['defaultTypoScript_*']
1344 * (Basically this function can do the same as addTypoScriptSetup and addTypoScriptConstants - just with a little more hazzle, but also with some more options!)
1345 * FOR USE IN ext_localconf.php FILES
1346 *
1347 * @param string $key Is the extension key (informative only).
1348 * @param string $type Is either "setup" or "constants" and obviously determines which kind of TypoScript code we are adding.
1349 * @param string $content Is the TS content, prefixed with a [GLOBAL] line and a comment-header.
1350 * @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.
1351 * @return void
1352 */
1353 static public function addTypoScript($key, $type, $content, $afterStaticUid = 0) {
1354 if ($type == 'setup' || $type == 'constants') {
1355 $content = '
1356
1357 [GLOBAL]
1358 #############################################
1359 ## TypoScript added by extension "' . $key . '"
1360 #############################################
1361
1362 ' . $content;
1363 if ($afterStaticUid) {
1364 $GLOBALS['TYPO3_CONF_VARS']['FE']['defaultTypoScript_' . $type . '.'][$afterStaticUid] .= $content;
1365 // If 'content (default)' is targeted, also add to other 'content rendering templates', eg. css_styled_content
1366 if ($afterStaticUid == 43 && is_array($GLOBALS['TYPO3_CONF_VARS']['FE']['contentRenderingTemplates'])) {
1367 foreach ($GLOBALS['TYPO3_CONF_VARS']['FE']['contentRenderingTemplates'] as $templateName) {
1368 $GLOBALS['TYPO3_CONF_VARS']['FE']['defaultTypoScript_' . $type . '.'][$templateName] .= $content;
1369 }
1370 }
1371 } else {
1372 $GLOBALS['TYPO3_CONF_VARS']['FE']['defaultTypoScript_' . $type] .= $content;
1373 }
1374 }
1375 }
1376
1377 /***************************************
1378 *
1379 * Internal extension management methods
1380 *
1381 ***************************************/
1382 /**
1383 * Find extension icon
1384 *
1385 * @param string $extensionPath Path to extension directory.
1386 * @param string $returnFullPath Return full path of file.
1387 * @return string
1388 * @throws \BadFunctionCallException
1389 */
1390 static public function getExtensionIcon($extensionPath, $returnFullPath = FALSE) {
1391 $icon = '';
1392 $iconFileTypesToCheckFor = array('png', 'gif');
1393 foreach ($iconFileTypesToCheckFor as $fileType) {
1394 if (file_exists($extensionPath . 'ext_icon.' . $fileType)) {
1395 $icon = 'ext_icon.' . $fileType;
1396 break;
1397 }
1398 }
1399 return $returnFullPath ? $extensionPath . $icon : $icon;
1400 }
1401
1402 /**
1403 * Execute all ext_localconf.php files of loaded extensions.
1404 * The method implements an optionally used caching mechanism that concatenates all
1405 * ext_localconf.php files in one file.
1406 *
1407 * This is an internal method. It is only used during bootstrap and
1408 * extensions should not use it!
1409 *
1410 * @param boolean $allowCaching Whether or not to load / create concatenated cache file
1411 * @return void
1412 * @access private
1413 */
1414 static public function loadExtLocalconf($allowCaching = TRUE) {
1415 if ($allowCaching) {
1416 $cacheIdentifier = self::getExtLocalconfCacheIdentifier();
1417 /** @var $codeCache \TYPO3\CMS\Core\Cache\Frontend\PhpFrontend */
1418 $codeCache = $GLOBALS['typo3CacheManager']->getCache('cache_core');
1419 if ($codeCache->has($cacheIdentifier)) {
1420 $codeCache->requireOnce($cacheIdentifier);
1421 } else {
1422 self::loadSingleExtLocalconfFiles();
1423 self::createExtLocalconfCacheEntry();
1424 }
1425 } else {
1426 self::loadSingleExtLocalconfFiles();
1427 }
1428 }
1429
1430 /**
1431 * Execute ext_localconf.php files from extensions
1432 *
1433 * @return void
1434 */
1435 static protected function loadSingleExtLocalconfFiles() {
1436 // This is the main array meant to be manipulated in the ext_localconf.php files
1437 // In general it is recommended to not rely on it to be globally defined in that
1438 // scope but to use $GLOBALS['TYPO3_CONF_VARS'] instead.
1439 // Nevertheless we define it here as global for backwards compatibility.
1440 global $TYPO3_CONF_VARS;
1441 foreach ($GLOBALS['TYPO3_LOADED_EXT'] as $_EXTKEY => $extensionInformation) {
1442 if ((is_array($extensionInformation) || $extensionInformation instanceof \ArrayAccess) && isset($extensionInformation['ext_localconf.php'])) {
1443 // $_EXTKEY and $_EXTCONF are available in ext_localconf.php
1444 // and are explicitly set in cached file as well
1445 $_EXTCONF = isset($GLOBALS['TYPO3_CONF_VARS']['EXT']['extConf'][$_EXTKEY]) ? $GLOBALS['TYPO3_CONF_VARS']['EXT']['extConf'][$_EXTKEY] : NULL;
1446 require $extensionInformation['ext_localconf.php'];
1447 }
1448 }
1449 }
1450
1451 /**
1452 * Create cache entry for concatenated ext_localconf.php files
1453 *
1454 * @return void
1455 */
1456 static protected function createExtLocalconfCacheEntry() {
1457 $extensionInformation = $GLOBALS['TYPO3_LOADED_EXT'];
1458 $phpCodeToCache = array();
1459 // Set same globals as in loadSingleExtLocalconfFiles()
1460 $phpCodeToCache[] = '/**';
1461 $phpCodeToCache[] = ' * Compiled ext_localconf.php cache file';
1462 $phpCodeToCache[] = ' */';
1463 $phpCodeToCache[] = '';
1464 $phpCodeToCache[] = 'global $TYPO3_CONF_VARS, $T3_SERVICES, $T3_VAR;';
1465 $phpCodeToCache[] = '';
1466 // Iterate through loaded extensions and add ext_localconf content
1467 foreach ($extensionInformation as $extensionKey => $extensionDetails) {
1468 if (isset($extensionDetails['ext_localconf.php']) && $extensionDetails['ext_localconf.php']) {
1469 // Include a header per extension to make the cache file more readable
1470 $phpCodeToCache[] = '/**';
1471 $phpCodeToCache[] = ' * Extension: ' . $extensionKey;
1472 $phpCodeToCache[] = ' * File: ' . $extensionDetails['ext_localconf.php'];
1473 $phpCodeToCache[] = ' */';
1474 $phpCodeToCache[] = '';
1475 // Set $_EXTKEY and $_EXTCONF for this extension
1476 $phpCodeToCache[] = '$_EXTKEY = \'' . $extensionKey . '\';';
1477 $phpCodeToCache[] = '$_EXTCONF = $GLOBALS[\'TYPO3_CONF_VARS\'][\'EXT\'][\'extConf\'][$_EXTKEY];';
1478 $phpCodeToCache[] = '';
1479 // Add ext_localconf.php content of extension
1480 $phpCodeToCache[] = trim(GeneralUtility::getUrl($extensionDetails['ext_localconf.php']));
1481 $phpCodeToCache[] = '';
1482 $phpCodeToCache[] = '';
1483 }
1484 }
1485 $phpCodeToCache = implode(LF, $phpCodeToCache);
1486 // Remove all start and ending php tags from content
1487 $phpCodeToCache = preg_replace('/<\\?php|\\?>/is', '', $phpCodeToCache);
1488 $GLOBALS['typo3CacheManager']->getCache('cache_core')->set(self::getExtLocalconfCacheIdentifier(), $phpCodeToCache);
1489 }
1490
1491 /**
1492 * Cache identifier of concatenated ext_localconf file
1493 *
1494 * @return string
1495 */
1496 static protected function getExtLocalconfCacheIdentifier() {
1497 return 'ext_localconf_' . sha1((TYPO3_version . PATH_site . 'extLocalconf'));
1498 }
1499
1500 /**
1501 * Wrapper for buildBaseTcaFromSingleFiles handling caching.
1502 *
1503 * This builds 'base' TCA that is later overloaded by ext_tables.php.
1504 *
1505 * Use a cache file if exists and caching is allowed.
1506 *
1507 * This is an internal method. It is only used during bootstrap and
1508 * extensions should not use it!
1509 *
1510 * @param boolean $allowCaching Whether or not to load / create concatenated cache file
1511 * @return void
1512 * @access private
1513 */
1514 static public function loadBaseTca($allowCaching = TRUE) {
1515 if ($allowCaching) {
1516 $cacheIdentifier = static::getBaseTcaCacheIdentifier();
1517 /** @var $codeCache \TYPO3\CMS\Core\Cache\Frontend\PhpFrontend */
1518 $codeCache = $GLOBALS['typo3CacheManager']->getCache('cache_core');
1519 if ($codeCache->has($cacheIdentifier)) {
1520 // substr is necessary, because the php frontend wraps php code around the cache value
1521 $GLOBALS['TCA'] = unserialize(substr($codeCache->get($cacheIdentifier), 6, -2));
1522 } else {
1523 self::buildBaseTcaFromSingleFiles();
1524 self::createBaseTcaCacheFile();
1525 }
1526 } else {
1527 self::buildBaseTcaFromSingleFiles();
1528 }
1529 }
1530
1531 /**
1532 * Find all Configuration/TCA/* files of extensions and create base TCA from it.
1533 * The filename must be the table name in $GLOBALS['TCA'], and the content of
1534 * the file should return an array with content of a specific table.
1535 *
1536 * @return void
1537 * @see Extension core, cms, extensionmanager and others for examples.
1538 */
1539 static protected function buildBaseTcaFromSingleFiles() {
1540 $GLOBALS['TCA'] = array();
1541 foreach (self::getLoadedExtensionListArray() as $extensionName) {
1542 $tcaConfigurationDirectory = self::extPath($extensionName) . 'Configuration/TCA';
1543 if (is_dir($tcaConfigurationDirectory)) {
1544 $files = scandir($tcaConfigurationDirectory);
1545 foreach ($files as $file) {
1546 if (
1547 is_file($tcaConfigurationDirectory . '/' . $file)
1548 && ($file !== '.')
1549 && ($file !== '..')
1550 && (substr($file, -4, 4) === '.php')
1551 ) {
1552 $tcaOfTable = require($tcaConfigurationDirectory . '/' . $file);
1553 if (is_array($tcaOfTable)) {
1554 // TCA table name is filename without .php suffix, eg 'sys_notes', not 'sys_notes.php'
1555 $tcaTableName = substr($file, 0, -4);
1556 $GLOBALS['TCA'][$tcaTableName] = $tcaOfTable;
1557 }
1558 }
1559 }
1560 }
1561 }
1562 }
1563
1564 /**
1565 * Cache base $GLOBALS['TCA'] to cache file to require the whole thing in one
1566 * file for next access instead of cycling through all extensions again.
1567 *
1568 * @return void
1569 */
1570 static protected function createBaseTcaCacheFile() {
1571 /** @var $codeCache \TYPO3\CMS\Core\Cache\Frontend\PhpFrontend */
1572 $codeCache = $GLOBALS['typo3CacheManager']->getCache('cache_core');
1573 $codeCache->set(static::getBaseTcaCacheIdentifier(), serialize($GLOBALS['TCA']));
1574 }
1575
1576 /**
1577 * Cache identifier of base TCA cache entry.
1578 *
1579 * @return string
1580 */
1581 static protected function getBaseTcaCacheIdentifier() {
1582 return 'tca_base_' . sha1((TYPO3_version . PATH_site . 'tca'));
1583 }
1584
1585 /**
1586 * Execute all ext_tables.php files of loaded extensions.
1587 * The method implements an optionally used caching mechanism that concatenates all
1588 * ext_tables.php files in one file.
1589 *
1590 * This is an internal method. It is only used during bootstrap and
1591 * extensions should not use it!
1592 *
1593 * @param boolean $allowCaching Whether to load / create concatenated cache file
1594 * @return void
1595 * @access private
1596 */
1597 static public function loadExtTables($allowCaching = TRUE) {
1598 if ($allowCaching && !self::$extTablesWasReadFromCacheOnce) {
1599 self::$extTablesWasReadFromCacheOnce = TRUE;
1600 $cacheIdentifier = self::getExtTablesCacheIdentifier();
1601 /** @var $codeCache \TYPO3\CMS\Core\Cache\Frontend\PhpFrontend */
1602 $codeCache = $GLOBALS['typo3CacheManager']->getCache('cache_core');
1603 if ($codeCache->has($cacheIdentifier)) {
1604 $codeCache->requireOnce($cacheIdentifier);
1605 } else {
1606 self::loadSingleExtTablesFiles();
1607 self::createExtTablesCacheEntry();
1608 }
1609 } else {
1610 self::loadSingleExtTablesFiles();
1611 }
1612 }
1613
1614 /**
1615 * Load ext_tables.php as single files
1616 *
1617 * @return void
1618 */
1619 static protected function loadSingleExtTablesFiles() {
1620 // In general it is recommended to not rely on it to be globally defined in that
1621 // scope, but we can not prohibit this without breaking backwards compatibility
1622 global $T3_SERVICES, $T3_VAR, $TYPO3_CONF_VARS;
1623 global $TBE_MODULES, $TBE_MODULES_EXT, $TCA;
1624 global $PAGES_TYPES, $TBE_STYLES, $FILEICONS;
1625 global $_EXTKEY;
1626 // Load each ext_tables.php file of loaded extensions
1627 foreach ($GLOBALS['TYPO3_LOADED_EXT'] as $_EXTKEY => $extensionInformation) {
1628 if ((is_array($extensionInformation) || $extensionInformation instanceof \ArrayAccess) && $extensionInformation['ext_tables.php']) {
1629 // $_EXTKEY and $_EXTCONF are available in ext_tables.php
1630 // and are explicitly set in cached file as well
1631 $_EXTCONF = $GLOBALS['TYPO3_CONF_VARS']['EXT']['extConf'][$_EXTKEY];
1632 require $extensionInformation['ext_tables.php'];
1633 static::loadNewTcaColumnsConfigFiles();
1634 }
1635 }
1636 }
1637
1638 /**
1639 * Create concatenated ext_tables.php cache file
1640 *
1641 * @return void
1642 */
1643 static protected function createExtTablesCacheEntry() {
1644 $extensionInformation = $GLOBALS['TYPO3_LOADED_EXT'];
1645 $phpCodeToCache = array();
1646 // Set same globals as in loadSingleExtTablesFiles()
1647 $phpCodeToCache[] = '/**';
1648 $phpCodeToCache[] = ' * Compiled ext_tables.php cache file';
1649 $phpCodeToCache[] = ' */';
1650 $phpCodeToCache[] = '';
1651 $phpCodeToCache[] = 'global $T3_SERVICES, $T3_VAR, $TYPO3_CONF_VARS;';
1652 $phpCodeToCache[] = 'global $TBE_MODULES, $TBE_MODULES_EXT, $TCA;';
1653 $phpCodeToCache[] = 'global $PAGES_TYPES, $TBE_STYLES, $FILEICONS;';
1654 $phpCodeToCache[] = 'global $_EXTKEY;';
1655 $phpCodeToCache[] = '';
1656 // Iterate through loaded extensions and add ext_tables content
1657 foreach ($extensionInformation as $extensionKey => $extensionDetails) {
1658 if (isset($extensionDetails['ext_tables.php']) && $extensionDetails['ext_tables.php']) {
1659 // Include a header per extension to make the cache file more readable
1660 $phpCodeToCache[] = '/**';
1661 $phpCodeToCache[] = ' * Extension: ' . $extensionKey;
1662 $phpCodeToCache[] = ' * File: ' . $extensionDetails['ext_tables.php'];
1663 $phpCodeToCache[] = ' */';
1664 $phpCodeToCache[] = '';
1665 // Set $_EXTKEY and $_EXTCONF for this extension
1666 $phpCodeToCache[] = '$_EXTKEY = \'' . $extensionKey . '\';';
1667 $phpCodeToCache[] = '$_EXTCONF = $GLOBALS[\'TYPO3_CONF_VARS\'][\'EXT\'][\'extConf\'][$_EXTKEY];';
1668 $phpCodeToCache[] = '';
1669 // Add ext_tables.php content of extension
1670 $phpCodeToCache[] = trim(GeneralUtility::getUrl($extensionDetails['ext_tables.php']));
1671 $phpCodeToCache[] = '';
1672 $phpCodeToCache[] = '\TYPO3\CMS\Core\Utility\ExtensionManagementUtility::loadNewTcaColumnsConfigFiles();';
1673 $phpCodeToCache[] = '';
1674 }
1675 }
1676 $phpCodeToCache = implode(LF, $phpCodeToCache);
1677 // Remove all start and ending php tags from content
1678 $phpCodeToCache = preg_replace('/<\\?php|\\?>/is', '', $phpCodeToCache);
1679 $GLOBALS['typo3CacheManager']->getCache('cache_core')->set(self::getExtTablesCacheIdentifier(), $phpCodeToCache);
1680 }
1681
1682 /**
1683 * Loads "columns" of a $TCA table definition if extracted
1684 * to a "dynamicConfigFile". This method is called after each
1685 * single ext_tables.php files was included to immediately have
1686 * the full $TCA ready for the next extension.
1687 *
1688 * $TCA[$tableName]['ctrl']['dynamicConfigFile'] must be the
1689 * absolute path to a file.
1690 *
1691 * Be aware that 'dynamicConfigFile' is obsolete, and all TCA
1692 * table definitions should be moved to Configuration/TCA/tablename.php
1693 * to be fully loaded automatically.
1694 *
1695 * Example:
1696 * dynamicConfigFile = \TYPO3\CMS\Core\Utility\ExtensionManagementUtility::extPath($_EXTKEY) . 'SysNote.php',
1697 *
1698 * @return void
1699 * @throws \RuntimeException
1700 * @internal Internal use ONLY. It is called by cache files and can not be protected. Do not call yourself!
1701 */
1702 static public function loadNewTcaColumnsConfigFiles() {
1703 global $TCA;
1704
1705 foreach (array_keys($TCA) as $tableName) {
1706 if (!isset($TCA[$tableName]['columns'])) {
1707 $columnsConfigFile = $TCA[$tableName]['ctrl']['dynamicConfigFile'];
1708 if ($columnsConfigFile) {
1709 if (GeneralUtility::isAbsPath($columnsConfigFile)) {
1710 include($columnsConfigFile);
1711 } else {
1712 throw new \RuntimeException(
1713 'Columns configuration file not found',
1714 1341151261
1715 );
1716 }
1717 }
1718 }
1719 }
1720 }
1721
1722 /**
1723 * Cache identifier for concatenated ext_tables.php files
1724 *
1725 * @return string
1726 */
1727 static protected function getExtTablesCacheIdentifier() {
1728 return 'ext_tables_' . sha1((TYPO3_version . PATH_site . 'extTables'));
1729 }
1730
1731 /**
1732 * Returns TRUE if configuration files in typo3conf/ are writable
1733 *
1734 * @return boolean TRUE if at least one configuration file in typo3conf/ is writable
1735 * @internal
1736 * @deprecated since 6.1, will be removed in two versions
1737 */
1738 static public function isLocalconfWritable() {
1739 GeneralUtility::logDeprecatedFunction();
1740 return GeneralUtility::makeInstance('TYPO3\\CMS\\Core\\Configuration\\ConfigurationManager')
1741 ->canWriteConfiguration();
1742 }
1743
1744 /**
1745 * Remove cache files from php code cache, tagged with 'core'
1746 *
1747 * This removes the following cache entries:
1748 * - autoloader cache registry
1749 * - cache loaded extension array
1750 * - ext_localconf concatenation
1751 * - ext_tables concatenation
1752 *
1753 * This method is usually only used by extension that fiddle
1754 * with the loaded extensions. An example is the extension
1755 * manager and the install tool.
1756 *
1757 * @return void
1758 */
1759 static public function removeCacheFiles() {
1760 /** @var $codeCache \TYPO3\CMS\Core\Cache\Frontend\PhpFrontend */
1761 $codeCache = $GLOBALS['typo3CacheManager']->getCache('cache_core');
1762 $codeCache->flush();
1763 }
1764
1765 /**
1766 * Gets an array of loaded extension keys
1767 *
1768 * @return array Loaded extensions
1769 */
1770 static public function getLoadedExtensionListArray() {
1771 return array_keys(static::$packageManager->getActivePackages());
1772 }
1773
1774 /**
1775 * Gets list of required extensions.
1776 * This is the list of extensions from constant REQUIRED_EXTENSIONS defined
1777 * in bootstrap, together with a possible additional list of extensions from
1778 * local configuration
1779 *
1780 * @return array List of required extensions
1781 */
1782 static public function getRequiredExtensionListArray() {
1783 if (is_array($GLOBALS['TYPO3_CONF_VARS']['EXT']['requiredExt'])) {
1784 $requiredExtensions = $GLOBALS['TYPO3_CONF_VARS']['EXT']['requiredExt'];
1785 } else {
1786 $requiredExtensions = GeneralUtility::trimExplode(',', $GLOBALS['TYPO3_CONF_VARS']['EXT']['requiredExt']);
1787 }
1788 $requiredExtensions = array_merge(GeneralUtility::trimExplode(',', REQUIRED_EXTENSIONS), $requiredExtensions);
1789 $requiredExtensions = array_unique($requiredExtensions);
1790 return $requiredExtensions;
1791 }
1792
1793 /**
1794 * Loads given extension
1795 *
1796 * Warning: This method only works if the ugrade wizard to transform
1797 * localconf.php to LocalConfiguration.php was already run
1798 *
1799 * @param string $extensionKey Extension key to load
1800 * @return void
1801 * @throws \RuntimeException
1802 */
1803 static public function loadExtension($extensionKey) {
1804 if (static::$packageManager->isPackageActive($extensionKey)) {
1805 throw new \RuntimeException('Extension already loaded', 1342345486);
1806 }
1807 static::$packageManager->activatePackage($extensionKey);
1808 }
1809
1810 /**
1811 * Unloads given extension
1812 *
1813 * Warning: This method only works if the ugrade wizard to transform
1814 * localconf.php to LocalConfiguration.php was already run
1815 *
1816 * @param string $extensionKey Extension key to remove
1817 * @return void
1818 * @throws \RuntimeException
1819 */
1820 static public function unloadExtension($extensionKey) {
1821 if (!static::$packageManager->isPackageActive($extensionKey)) {
1822 throw new \RuntimeException('Extension not loaded', 1342345487);
1823 }
1824 static::$packageManager->deactivatePackage($extensionKey);
1825 }
1826
1827 /**
1828 * Writes extension list and clear cache files.
1829 *
1830 * @TODO: This method should be protected, but with current em it is hard to do so,
1831 * @TODO: Find out if we may remove this already
1832 * @param array Extension array to load, loader order is kept
1833 * @return void
1834 * @internal
1835 * @deprecated since 6.2, will be removed two versions later
1836 */
1837 static public function writeNewExtensionList(array $newExtensionList) {
1838 GeneralUtility::logDeprecatedFunction();
1839 }
1840
1841 /**
1842 * Makes a table categorizable by adding value into the category registry.
1843 *
1844 * @param string $extensionKey Extension key to be used
1845 * @param string $tableName Name of the table to be categorized
1846 * @param string $fieldName Name of the field to be used to store categories
1847 * @param array $options Additional configuration options
1848 * @see addTCAcolumns
1849 * @see addToAllTCAtypes
1850 */
1851 static public function makeCategorizable($extensionKey, $tableName, $fieldName = 'categories', array $options = array()) {
1852 // Update the category registry
1853 $result = \TYPO3\CMS\Core\Category\CategoryRegistry::getInstance()->add($extensionKey, $tableName, $fieldName, $options);
1854 if ($result === FALSE) {
1855 $message = '\TYPO3\CMS\Core\Category\CategoryRegistry: no category registered for table "%s". Key was already registered.';
1856 /** @var $logger \TYPO3\CMS\Core\Log\Logger */
1857 $logger = GeneralUtility::makeInstance('TYPO3\CMS\Core\Log\LogManager')->getLogger(__CLASS__);
1858 $logger->warning(
1859 sprintf($message, $tableName)
1860 );
1861 }
1862 }
1863
1864 }