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