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