[BUGFIX] fix t3lib_extMgm::addToAllTCAtypes(..... , 'replace:xxx')
[Packages/TYPO3.CMS.git] / t3lib / class.t3lib_extmgm.php
1 <?php
2 /***************************************************************
3 * Copyright notice
4 *
5 * (c) 1999-2011 Kasper Skårhøj (kasperYYYY@typo3.com)
6 * All rights reserved
7 *
8 * This script is part of the TYPO3 project. The TYPO3 project is
9 * free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
13 *
14 * The GNU General Public License can be found at
15 * http://www.gnu.org/copyleft/gpl.html.
16 * A copy is found in the textfile GPL.txt and important notices to the license
17 * from the author is found in LICENSE.txt distributed with these scripts.
18 *
19 *
20 * This script is distributed in the hope that it will be useful,
21 * but WITHOUT ANY WARRANTY; without even the implied warranty of
22 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
23 * GNU General Public License for more details.
24 *
25 * This copyright notice MUST APPEAR in all copies of the script!
26 ***************************************************************/
27 /**
28 * Contains a class with Extension Management functions
29 *
30 * $Id$
31 * Revised for TYPO3 3.6 July/2003 by Kasper Skårhøj
32 *
33 * @author Kasper Skårhøj <kasperYYYY@typo3.com>
34 */
35 /**
36 * [CLASS/FUNCTION INDEX of SCRIPT]
37 *
38 *
39 *
40 * 114: class t3lib_extMgm
41 *
42 * SECTION: PATHS and other evaluation
43 * 131: function isLoaded($key,$exitOnError = 0)
44 * 147: function extPath($key,$script='')
45 * 165: function extRelPath($key)
46 * 182: function siteRelPath($key)
47 * 194: function getCN($key)
48 *
49 * SECTION: Adding BACKEND features
50 * 227: function addTCAcolumns($table,$columnArray,$addTofeInterface=0)
51 * 251: function addToAllTCAtypes($table,$str,$specificTypesList='',$position='')
52 * 309: function allowTableOnStandardPages($table)
53 * 326: function addModule($main,$sub='',$position='',$path='')
54 * 389: function insertModuleFunction($modname,$className,$classPath,$title,$MM_key='function',$WS='')
55 * 408: function addPageTSConfig($content)
56 * 422: function addUserTSConfig($content)
57 * 437: function addLLrefForTCAdescr($tca_descr_key,$file_ref)
58 *
59 * SECTION: Adding SERVICES features
60 * 479: function addService($extKey, $serviceType, $serviceKey, $info)
61 * 547: function findService($serviceType, $serviceSubType='', $excludeServiceKeys=array())
62 * 618: function deactivateService($serviceType, $serviceKey)
63 *
64 * SECTION: Adding FRONTEND features
65 * 657: function addPlugin($itemArray,$type='list_type')
66 * 682: function addPiFlexFormValue($piKeyToMatch,$value)
67 * 702: function addToInsertRecords($table,$content_table='tt_content',$content_field='records')
68 * 733: function addPItoST43($key,$classFile='',$prefix='',$type='list_type',$cached=0)
69 * 808: function addStaticFile($extKey,$path,$title)
70 * 827: function addTypoScriptSetup($content)
71 * 841: function addTypoScriptConstants($content)
72 * 858: function addTypoScript($key,$type,$content,$afterStaticUid=0)
73 *
74 * SECTION: INTERNAL EXTENSION MANAGEMENT:
75 * 921: function typo3_loadExtensions()
76 * 998: function _makeIncludeHeader($key,$file)
77 * 1019: function isCacheFilesAvailable($cacheFilePrefix)
78 * 1032: function isLocalconfWritable()
79 * 1045: function cannotCacheFilesWritable($cacheFilePrefix)
80 * 1069: function currentCacheFiles()
81 * 1092: function writeCacheFiles($extensions,$cacheFilePrefix)
82 * 1130: function removeCacheFiles()
83 *
84 * TOTAL FUNCTIONS: 32
85 * (This index is automatically created/updated by the extension "extdeveval")
86 *
87 */
88
89
90 /**
91 * Extension Management functions
92 *
93 * This class is never instantiated, rather the methods inside is called as functions like
94 * t3lib_extMgm::isLoaded('my_extension');
95 *
96 * @author Kasper Skårhøj <kasperYYYY@typo3.com>
97 * @package TYPO3
98 * @subpackage t3lib
99 */
100 final class t3lib_extMgm {
101 protected static $extensionKeyMap;
102
103
104 /**************************************
105 *
106 * PATHS and other evaluation
107 *
108 ***************************************/
109
110 /**
111 * Returns true if the extension with extension key $key is loaded.
112 * Usage: 109
113 *
114 * @param string Extension key to test
115 * @param boolean If $exitOnError is true and the extension is not loaded the function will die with an error message
116 * @return boolean
117 */
118 public static function isLoaded($key, $exitOnError = 0) {
119 global $TYPO3_LOADED_EXT;
120 if ($exitOnError && !isset($TYPO3_LOADED_EXT[$key])) {
121 throw new BadFunctionCallException(
122 'TYPO3 Fatal Error: Extension "' . $key . '" was not loaded!',
123 1270853910
124 );
125 }
126 return isset($TYPO3_LOADED_EXT[$key]);
127 }
128
129 /**
130 * Returns the absolute path to the extension with extension key $key
131 * If the extension is not loaded the function will die with an error message
132 * Useful for internal fileoperations
133 * Usage: 136
134 *
135 * @param string Extension key
136 * @param string $script is appended to the output if set.
137 * @return string
138 */
139 public static function extPath($key, $script = '') {
140 global $TYPO3_LOADED_EXT;
141 if (!isset($TYPO3_LOADED_EXT[$key])) {
142 throw new BadFunctionCallException(
143 'TYPO3 Fatal Error: Extension key "' . $key . '" was NOT loaded!',
144 1270853878
145 );
146 }
147 return PATH_site . $TYPO3_LOADED_EXT[$key]['siteRelPath'] . $script;
148 }
149
150 /**
151 * Returns the relative path to the extension as measured from from the TYPO3_mainDir
152 * If the extension is not loaded the function will die with an error message
153 * Useful for images and links from backend
154 * Usage: 54
155 *
156 * @param string Extension key
157 * @return string
158 */
159 public static function extRelPath($key) {
160 global $TYPO3_LOADED_EXT;
161 if (!isset($TYPO3_LOADED_EXT[$key])) {
162 throw new BadFunctionCallException(
163 'TYPO3 Fatal Error: Extension key "' . $key . '" was NOT loaded!',
164 1270853879
165 );
166 }
167 return $TYPO3_LOADED_EXT[$key]['typo3RelPath'];
168 }
169
170 /**
171 * Returns the relative path to the extension as measured from the PATH_site (frontend)
172 * If the extension is not loaded the function will die with an error message
173 * Useful for images and links from the frontend
174 * Usage: 6
175 *
176 * @param string Extension key
177 * @return string
178 */
179 public static function siteRelPath($key) {
180 return substr(self::extPath($key), strlen(PATH_site));
181 }
182
183 /**
184 * Returns the correct class name prefix for the extension key $key
185 * Usage: 3
186 *
187 * @param string Extension key
188 * @return string
189 * @internal
190 */
191 public static function getCN($key) {
192 return substr($key, 0, 5) == 'user_' ? 'user_' . str_replace('_', '', substr($key, 5)) : 'tx_' . str_replace('_', '', $key);
193 }
194
195 /**
196 * Returns the real extension key like 'tt_news' from an extension prefix like 'tx_ttnews'.
197 *
198 * @param string $prefix: The extension prefix (e.g. 'tx_ttnews')
199 * @return mixed Real extension key (string) or false (boolean) if something went wrong
200 */
201 public static function getExtensionKeyByPrefix($prefix) {
202 $result = FALSE;
203 // Build map of short keys referencing to real keys:
204 if (!isset(self::$extensionKeyMap)) {
205 self::$extensionKeyMap = array();
206 foreach (array_keys($GLOBALS['TYPO3_LOADED_EXT']) as $extensionKey) {
207 $shortKey = str_replace('_', '', $extensionKey);
208 self::$extensionKeyMap[$shortKey] = $extensionKey;
209 }
210 }
211 // Lookup by the given short key:
212 $parts = explode('_', $prefix);
213 if (isset(self::$extensionKeyMap[$parts[1]])) {
214 $result = self::$extensionKeyMap[$parts[1]];
215 }
216 return $result;
217 }
218
219 /**
220 * Clears the extension key map.
221 *
222 * @return void
223 */
224 public static function clearExtensionKeyMap() {
225 self::$extensionKeyMap = NULL;
226 }
227
228 /**
229 * Retrieves the version of an installed extension.
230 * If the extension is not installed, this function returns an empty string.
231 *
232 * @param string $key the key of the extension to look up, must not be empty
233 * @return string the extension version as a string in the format "x.y.z",
234 * will be an empty string if the extension is not loaded
235 */
236 public static function getExtensionVersion($key) {
237 if (!is_string($key) || empty($key)) {
238 throw new InvalidArgumentException('Extension key must be a non-empty string.');
239 }
240 if (!self::isLoaded($key)) {
241 return '';
242 }
243
244 $EM_CONF = array();
245 $_EXTKEY = $key;
246 include(self::extPath($key) . 'ext_emconf.php');
247
248 return $EM_CONF[$key]['version'];
249 }
250
251
252 /**************************************
253 *
254 * Adding BACKEND features
255 * (related to core features)
256 *
257 ***************************************/
258
259 /**
260 * Adding fields to an existing table definition in $TCA
261 * Adds an array with $TCA column-configuration to the $TCA-entry for that table.
262 * 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!
263 * So to have the fields displayed you must also call fx. addToAllTCAtypes or manually add the fields to the types list.
264 * FOR USE IN ext_tables.php FILES
265 * Usage: 4
266 *
267 * @param string $table is the table name of a table already present in $TCA with a columns section
268 * @param array $columnArray is the array with the additional columns (typical some fields an extension wants to add)
269 * @param boolean If $addTofeInterface is true the list of fields are also added to the fe_admin_fieldList.
270 * @return void
271 */
272 public static function addTCAcolumns($table, $columnArray, $addTofeInterface = 0) {
273 global $TCA;
274 t3lib_div::loadTCA($table);
275 if (is_array($columnArray) && is_array($TCA[$table]) && is_array($TCA[$table]['columns'])) {
276 $TCA[$table]['columns'] = array_merge($TCA[$table]['columns'], $columnArray); // Candidate for t3lib_div::array_merge() if integer-keys will some day make trouble...
277 if ($addTofeInterface) {
278 $TCA[$table]['feInterface']['fe_admin_fieldList'] .= ',' . implode(',', array_keys($columnArray));
279 }
280 }
281 }
282
283 /**
284 * Makes fields visible in the TCEforms, adding them to the end of (all) "types"-configurations
285 *
286 * Adds a string $str (comma list of field names) to all ["types"][xxx]["showitem"] entries for table $table (unless limited by $specificTypesList)
287 * This is needed to have new fields shown automatically in the TCEFORMS of a record from $table.
288 * Typically this function is called after having added new columns (database fields) with the addTCAcolumns function
289 * FOR USE IN ext_tables.php FILES
290 * Usage: 1
291 *
292 * @param string Table name
293 * @param string Field list to add.
294 * @param string List of specific types to add the field list to. (If empty, all type entries are affected)
295 * @param string Insert fields before (default) or after one
296 * of this fields (commalist with "before:", "after:" or "replace:" commands).
297 * Example: "before:keywords,--palette--;;4,after:description".
298 * Palettes must be passed like in the example no matter how the palette definition looks like in TCA.
299 * It will add the list of new fields before or after a palette or replace the field inside the palette,
300 * when the field given in $position is found inside a palette used by the type.
301 * @return void
302 */
303 public static function addToAllTCAtypes($table, $str, $specificTypesList = '', $position = '') {
304 t3lib_div::loadTCA($table);
305 $str = trim($str);
306 $palettesChanged = array();
307 if ($str && is_array($GLOBALS['TCA'][$table]) && is_array($GLOBALS['TCA'][$table]['types'])) {
308 foreach ($GLOBALS['TCA'][$table]['types'] as $type => &$typeDetails) {
309 if ($specificTypesList === '' || t3lib_div::inList($specificTypesList, $type)) {
310 $fieldExists = FALSE;
311 if ($position != '' && is_array($GLOBALS['TCA'][$table]['palettes'])) {
312 $positionArray = t3lib_div::trimExplode(':', $position);
313 if ($positionArray[0] == 'replace') {
314 foreach ($GLOBALS['TCA'][$table]['palettes'] as $palette => $paletteDetails) {
315 if (preg_match('/\b' . $palette . '\b/', $typeDetails['showitem']) > 0
316 && preg_match('/\b' . $positionArray[1] . '\b/', $paletteDetails['showitem']) > 0) {
317 self::addFieldsToPalette($table, $palette, $str, $position);
318 // save that palette in case other types use it
319 $palettesChanged[] = $palette;
320 $fieldExists = TRUE;
321 } elseif (in_array($palette, $palettesChanged)) {
322 $fieldExists = TRUE;
323 }
324 }
325 } else {
326 if (strpos($typeDetails['showitem'], $str) !== FALSE) {
327 $fieldExists = TRUE;
328 } else {
329 foreach ($GLOBALS['TCA'][$table]['palettes'] as $palette => $paletteDetails) {
330 if (preg_match('/\b' . $palette . '\b/', $typeDetails['showitem']) > 0
331 && preg_match('/\b' . $positionArray[1] . '\b/', $paletteDetails['showitem']) > 0) {
332 $position = $positionArray[0] . ':--palette--;;' . $palette;
333 }
334 }
335 }
336 }
337 } else {
338 if (strpos($typeDetails['showitem'], $str) !== FALSE) {
339 $fieldExists = TRUE;
340 } else if(is_array($GLOBALS['TCA'][$table]['palettes'])) {
341 foreach ($GLOBALS['TCA'][$table]['palettes'] as $palette => $paletteDetails) {
342 if (preg_match('/\b' . $palette . '\b/', $typeDetails['showitem']) > 0
343 && strpos($paletteDetails['showitem'], $str) !== FALSE) {
344 $fieldExists = TRUE;
345 }
346 }
347 }
348 }
349 if ($fieldExists === FALSE) {
350 $typeDetails['showitem'] = self::executePositionedStringInsertion(
351 $typeDetails['showitem'],
352 $str,
353 $position
354 );
355 }
356 }
357 }
358 }
359 }
360
361 /**
362 * Adds new fields to all palettes of an existing field.
363 * If the field does not have a palette yet, it's created automatically and
364 * gets called "generatedFor-$field".
365 *
366 * @param string $table: Name of the table
367 * @param string $field: Name of the field that has the palette to be extended
368 * @param string $addFields: List of fields to be added to the palette
369 * @param string $insertionPosition: Insert fields before (default) or after one
370 * of this fields (commalist with "before:", "after:" or "replace:" commands).
371 * Example: "before:keywords,--palette--;;4,after:description".
372 * Palettes must be passed like in the example no matter how the
373 * palette definition looks like in TCA.
374 * @return void
375 */
376 public static function addFieldsToAllPalettesOfField($table, $field, $addFields, $insertionPosition = '') {
377 $generatedPalette = '';
378 $processedPalettes = array();
379 t3lib_div::loadTCA($table);
380
381 if (isset($GLOBALS['TCA'][$table]['columns'][$field])) {
382 $types =& $GLOBALS['TCA'][$table]['types'];
383 if (is_array($types)) {
384 // Iterate through all types and search for the field that defines the palette to be extended:
385 foreach (array_keys($types) as $type) {
386 $items = self::explodeItemList($types[$type]['showitem']);
387 if (isset($items[$field])) {
388 // If the field already has a palette, extend it:
389 if ($items[$field]['details']['palette']) {
390 $palette = $items[$field]['details']['palette'];
391 if (!isset($processedPalettes[$palette])) {
392 self::addFieldsToPalette($table, $palette, $addFields, $insertionPosition);
393 $processedPalettes[$palette] = TRUE;
394 }
395 // If there's not palette yet, create one:
396 } else {
397 if ($generatedPalette) {
398 $palette = $generatedPalette;
399 } else {
400 $palette = $generatedPalette = 'generatedFor-' . $field;
401 self::addFieldsToPalette($table, $palette, $addFields, $insertionPosition);
402 }
403 $items[$field]['details']['palette'] = $palette;
404 $types[$type]['showitem'] = self::generateItemList($items);
405 }
406 }
407 }
408 }
409 }
410 }
411
412 /**
413 * Adds new fields to a palette.
414 * If the palette does not exist yet, it's created automatically.
415 *
416 * @param string $table: Name of the table
417 * @param string $palette: Name of the palette to be extended
418 * @param string $addFields: List of fields to be added to the palette
419 * @param string $insertionPosition: Insert fields before (default) or after one
420 * of this fields (commalist with "before:", "after:" or "replace:" commands).
421 * Example: "before:keywords,--palette--;;4,after:description".
422 * Palettes must be passed like in the example no matter how the
423 * palette definition looks like in TCA.
424 * @return void
425 */
426 public static function addFieldsToPalette($table, $palette, $addFields, $insertionPosition = '') {
427 t3lib_div::loadTCA($table);
428
429 if (isset($GLOBALS['TCA'][$table])) {
430 $paletteData =& $GLOBALS['TCA'][$table]['palettes'][$palette];
431 // If palette already exists, merge the data:
432 if (is_array($paletteData)) {
433 $paletteData['showitem'] = self::executePositionedStringInsertion(
434 $paletteData['showitem'],
435 $addFields,
436 $insertionPosition
437 );
438 // If it's a new palette, just set the data:
439 } else {
440 $paletteData['showitem'] = self::removeDuplicatesForInsertion($addFields);
441 }
442 }
443 }
444
445 /**
446 * Adds a list of new fields to the TYPO3 USER SETTINGS configuration "showitem" list, the array with
447 * the new fields itself needs to be added additionally to show up in the user setup, like
448 * $GLOBALS['TYPO3_USER_SETTINGS']['columns'] += $tempColumns
449 *
450 * @param string $addFields: List of fields to be added to the user settings
451 * @param string $insertionPosition: Insert fields before (default) or after one
452 * of this fields (commalist with "before:", "after:" or "replace:" commands).
453 * Example: "before:password,after:email".
454 * @return void
455 */
456 public function addFieldsToUserSettings($addFields, $insertionPosition = '') {
457 $GLOBALS['TYPO3_USER_SETTINGS']['showitem'] = self::executePositionedStringInsertion(
458 $GLOBALS['TYPO3_USER_SETTINGS']['showitem'],
459 $addFields,
460 $insertionPosition
461 );
462 }
463
464 /**
465 * Inserts as list of data into an existing list.
466 * The insertion position can be defined accordant before of after existing list items.
467 *
468 * @param string $list: The list of items to be extended
469 * @param string $insertionList: The list of items to inserted
470 * @param string $insertionPosition: Insert fields before (default) or after one
471 * of this fields (commalist with "before:" or "after:" commands).
472 * Example: "before:keywords,--palette--;;4,after:description".
473 * Palettes must be passed like in the example no matter how the
474 * palette definition looks like in TCA.
475 * @return string The extended list
476 */
477 protected static function executePositionedStringInsertion($list, $insertionList, $insertionPosition = '') {
478 $list = trim($list);
479 $insertionList = self::removeDuplicatesForInsertion($insertionList, $list);
480
481 if ($insertionList) {
482 // Append data to the end (default):
483 if ($insertionPosition === '') {
484 $list .= ($list ? ', ' : '') . $insertionList;
485 // Insert data before or after insertion points:
486 } else {
487 $positions = t3lib_div::trimExplode(',', $insertionPosition, TRUE);
488 $items = self::explodeItemList($list);
489 $isInserted = FALSE;
490 // Iterate through all fields an check whether it's possible to inserte there:
491 foreach ($items as $item => &$itemDetails) {
492 $needles = self::getInsertionNeedles($item, $itemDetails['details']);
493 // Insert data before:
494 foreach ($needles['before'] as $needle) {
495 if (in_array($needle, $positions)) {
496 $itemDetails['rawData'] = $insertionList . ', ' . $itemDetails['rawData'];
497 $isInserted = TRUE;
498 break;
499 }
500 }
501 // Insert data after:
502 foreach ($needles['after'] as $needle) {
503 if (in_array($needle, $positions)) {
504 $itemDetails['rawData'] .= ', ' . $insertionList;
505 $isInserted = TRUE;
506 break;
507 }
508 }
509 // Replace with data:
510 foreach ($needles['replace'] as $needle) {
511 if (in_array($needle, $positions)) {
512 $itemDetails['rawData'] = $insertionList;
513 $isInserted = TRUE;
514 break;
515 }
516 }
517 // Break if insertion was already done:
518 if ($isInserted) {
519 break;
520 }
521 }
522 // If insertion point could not be determined, append the data:
523 if (!$isInserted) {
524 $list .= ($list ? ', ' : '') . $insertionList;
525 // If data was correctly inserted before or after existing items, recreate the list:
526 } else {
527 $list = self::generateItemList($items, TRUE);
528 }
529 }
530 }
531
532 return $list;
533 }
534
535 /**
536 * Compares an existing list of items and a list of items to be inserted
537 * and returns a duplicate-free variant of that insertion list.
538 *
539 * Example:
540 * + list: 'field_a, field_b;;;;2-2-2, field_c;;;;3-3-3'
541 * + insertion: 'field_b, field_d, field_c;;;4-4-4'
542 * -> new insertion: 'field_d'
543 *
544 * @param string $insertionList: The list of items to inserted
545 * @param string $list: The list of items to be extended (default: '')
546 * @return string Duplicate-free list of items to be inserted
547 */
548 protected static function removeDuplicatesForInsertion($insertionList, $list = '') {
549 $pattern = '/(^|,)\s*\b([^;,]+)\b[^,]*/';
550 $listItems = array();
551
552 if ($list && preg_match_all($pattern, $list, $listMatches)) {
553 $listItems = $listMatches[2];
554 }
555
556 if ($insertionList && preg_match_all($pattern, $insertionList, $insertionListMatches)) {
557 $insertionItems = array();
558 $insertionDuplicates = FALSE;
559
560 foreach ($insertionListMatches[2] as $insertionIndex => $insertionItem) {
561 if (!isset($insertionItems[$insertionItem]) && !in_array($insertionItem, $listItems)) {
562 $insertionItems[$insertionItem] = TRUE;
563 } else {
564 unset($insertionListMatches[0][$insertionIndex]);
565 $insertionDuplicates = TRUE;
566 }
567 }
568
569 if ($insertionDuplicates) {
570 $insertionList = implode('', $insertionListMatches[0]);
571 }
572 }
573
574 return $insertionList;
575 }
576
577 /**
578 * Generates search needles that are used for inserting fields/items into an existing list.
579 *
580 * @see executePositionedStringInsertion
581 * @param string $item: The name of the field/item
582 * @param array $itemDetails: Additional details of the field/item like e.g. palette information
583 * (this array gets created by the function explodeItemList())
584 * @return array The needled to be used for inserting content before or after existing fields/items
585 */
586 protected static function getInsertionNeedles($item, array $itemDetails) {
587 if (strstr($item, '--')) {
588 // 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.
589 $item = preg_replace('/[0-9]+$/', '', $item);
590 }
591
592 $needles = array(
593 'before' => array($item, 'before:' . $item),
594 'after' => array('after:' . $item),
595 'replace' => array('replace:' . $item),
596 );
597
598 if ($itemDetails['palette']) {
599 $palette = $item . ';;' . $itemDetails['palette'];
600 $needles['before'][] = $palette;
601 $needles['before'][] = 'before:' . $palette;
602 $needles['after'][] = 'after:' . $palette;
603 $needles['replace'][] = 'replace:' . $palette;
604 }
605
606 return $needles;
607 }
608
609 /**
610 * Generates an array of fields/items with additional information such as e.g. the name of the palette.
611 *
612 * @param string $itemList: List of fields/items to be splitted up
613 * (this mostly reflects the data in $TCA[<table>]['types'][<type>]['showitem'])
614 * @return array An array with the names of the fields/items as keys and additional information
615 */
616 protected static function explodeItemList($itemList) {
617 $items = array();
618 $itemParts = t3lib_div::trimExplode(',', $itemList, TRUE);
619
620 foreach ($itemParts as $itemPart) {
621 $itemDetails = t3lib_div::trimExplode(';', $itemPart, FALSE, 5);
622 $key = $itemDetails[0];
623 if (strstr($key, '--')) {
624 // 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!
625 $key .= count($items);
626 }
627
628 if (!isset($items[$key])) {
629 $items[$key] = array(
630 'rawData' => $itemPart,
631 'details' => array(
632 'field' => $itemDetails[0],
633 'label' => $itemDetails[1],
634 'palette' => $itemDetails[2],
635 'special' => $itemDetails[3],
636 'styles' => $itemDetails[4],
637 ),
638 );
639 }
640 }
641
642 return $items;
643 }
644
645 /**
646 * Generates a list of fields/items out of an array provided by the function getFieldsOfFieldList().
647 *
648 * @see explodeItemList
649 * @param array $items: The array of fields/items with optional additional information
650 * @param boolean $useRawData: Use raw data instead of building by using the details (default: false)
651 * @return string The list of fields/items which gets used for $TCA[<table>]['types'][<type>]['showitem']
652 * or $TCA[<table>]['palettes'][<palette>]['showitem'] in most cases
653 */
654 protected static function generateItemList(array $items, $useRawData = FALSE) {
655 $itemParts = array();
656
657 foreach ($items as $item => $itemDetails) {
658 if (strstr($item, '--')) {
659 // 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.
660 $item = preg_replace('/[0-9]+$/', '', $item);
661 }
662
663 if ($useRawData) {
664 $itemParts[] = $itemDetails['rawData'];
665 } else {
666 $itemParts[] = (count($itemDetails['details']) > 1 ? implode(';', $itemDetails['details']) : $item);
667 }
668 }
669
670 return implode(', ', $itemParts);
671 }
672
673 /**
674 * Add tablename to default list of allowed tables on pages (in $PAGES_TYPES)
675 * Will add the $table to the list of tables allowed by default on pages as setup by $PAGES_TYPES['default']['allowedTables']
676 * FOR USE IN ext_tables.php FILES
677 * Usage: 11
678 *
679 * @param string Table name
680 * @return void
681 */
682 public static function allowTableOnStandardPages($table) {
683 global $PAGES_TYPES;
684
685 $PAGES_TYPES['default']['allowedTables'] .= ',' . $table;
686 }
687
688 /**
689 * Adds a module (main or sub) to the backend interface
690 * FOR USE IN ext_tables.php FILES
691 * Usage: 18
692 *
693 * @param string $main is 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.
694 * @param string $sub is the submodule key. If $sub is not set a blank $main module is created.
695 * @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.
696 * @param string $path is 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.
697 * @return void
698 */
699 public static function addModule($main, $sub = '', $position = '', $path = '') {
700 global $TBE_MODULES;
701
702 if (isset($TBE_MODULES[$main]) && $sub) { // If there is already a main module by this name:
703
704 // Adding the submodule to the correct position:
705 list($place, $modRef) = t3lib_div::trimExplode(':', $position, 1);
706 $mods = t3lib_div::trimExplode(',', $TBE_MODULES[$main], 1);
707 if (!in_array($sub, $mods)) {
708 switch (strtolower($place)) {
709 case 'after':
710 case 'before':
711 $pointer = 0;
712 $found = FALSE;
713 foreach ($mods as $k => $m) {
714 if (!strcmp($m, $modRef)) {
715 $pointer = strtolower($place) == 'after' ? $k + 1 : $k;
716 $found = TRUE;
717 }
718 }
719 if ($found) {
720 array_splice(
721 $mods, // The modules array
722 $pointer, // To insert one position from the end of the list
723 0, // Don't remove any items, just insert
724 $sub // Module to insert
725 );
726 } else {
727 // If requested module is not found: Add at the end
728 array_push($mods, $sub);
729 }
730 break;
731 default:
732 if (strtolower($place) == 'top') {
733 array_unshift($mods, $sub);
734 } else {
735 array_push($mods, $sub);
736 }
737 break;
738 }
739 }
740 // Re-inserting the submodule list:
741 $TBE_MODULES[$main] = implode(',', $mods);
742 } else { // Create new main modules with only one submodule, $sub (or none if $sub is blank)
743 $TBE_MODULES[$main] = $sub;
744 }
745
746 // Adding path:
747 if ($path) {
748 $TBE_MODULES['_PATHS'][$main . ($sub ? '_' . $sub : '')] = $path;
749 }
750 }
751
752 /**
753 * Adds a module path to TBE_MODULES for used with the module dispatcher, mod.php
754 * Used only for modules that are not placed in the main/sub menu hierarchy by the traditional mechanism of addModule()
755 * Examples for this is context menu functionality (like import/export) which runs as an independent module through mod.php
756 * FOR USE IN ext_tables.php FILES
757 * Example: t3lib_extMgm::addModulePath('xMOD_tximpexp', t3lib_extMgm::extPath($_EXTKEY).'app/');
758 *
759 * @param string $name is the name of the module, refer to conf.php of the module.
760 * @param string $path is the absolute path to the module directory inside of which "index.php" and "conf.php" is found.
761 * @return void
762 */
763 public static function addModulePath($name, $path) {
764 global $TBE_MODULES;
765
766 $TBE_MODULES['_PATHS'][$name] = $path;
767 }
768
769 /**
770 * Adds a "Function menu module" ('third level module') to an existing function menu for some other backend module
771 * The arguments values are generally determined by which function menu this is supposed to interact with
772 * See Inside TYPO3 for information on how to use this function.
773 * FOR USE IN ext_tables.php FILES
774 * Usage: 26
775 *
776 * @param string Module name
777 * @param string Class name
778 * @param string Class path
779 * @param string Title of module
780 * @param string Menu array key - default is "function"
781 * @param string Workspace conditions. Blank means all workspaces, any other string can be a comma list of "online", "offline" and "custom"
782 * @return void
783 * @see t3lib_SCbase::mergeExternalItems()
784 */
785 public static function insertModuleFunction($modname, $className, $classPath, $title, $MM_key = 'function', $WS = '') {
786 global $TBE_MODULES_EXT;
787 $TBE_MODULES_EXT[$modname]['MOD_MENU'][$MM_key][$className] = array(
788 'name' => $className,
789 'path' => $classPath,
790 'title' => $title,
791 'ws' => $WS
792 );
793 }
794
795 /**
796 * Adds $content to the default Page TSconfig as set in $TYPO3_CONF_VARS[BE]['defaultPageTSconfig']
797 * Prefixed with a [GLOBAL] line
798 * FOR USE IN ext_tables.php/ext_localconf.php FILES
799 * Usage: 5
800 *
801 * @param string Page TSconfig content
802 * @return void
803 */
804 public static function addPageTSConfig($content) {
805 global $TYPO3_CONF_VARS;
806 $TYPO3_CONF_VARS['BE']['defaultPageTSconfig'] .= "\n[GLOBAL]\n" . $content;
807 }
808
809 /**
810 * Adds $content to the default User TSconfig as set in $TYPO3_CONF_VARS[BE]['defaultUserTSconfig']
811 * Prefixed with a [GLOBAL] line
812 * FOR USE IN ext_tables.php/ext_localconf.php FILES
813 * Usage: 3
814 *
815 * @param string User TSconfig content
816 * @return void
817 */
818 public static function addUserTSConfig($content) {
819 global $TYPO3_CONF_VARS;
820 $TYPO3_CONF_VARS['BE']['defaultUserTSconfig'] .= "\n[GLOBAL]\n" . $content;
821 }
822
823 /**
824 * Adds a reference to a locallang file with TCA_DESCR labels
825 * FOR USE IN ext_tables.php FILES
826 * eg. t3lib_extMgm::addLLrefForTCAdescr('pages', 'EXT:lang/locallang_csh_pages.xml'); for the pages table or t3lib_extMgm::addLLrefForTCAdescr('_MOD_web_layout', 'EXT:cms/locallang_csh_weblayout.php'); for the Web > Page module.
827 * Usage: 31
828 *
829 * @param string Description key. Typically a database table (like "pages") but for applications can be other strings, but prefixed with "_MOD_")
830 * @param string File reference to locallang file, eg. "EXT:lang/locallang_csh_pages.php" (or ".xml")
831 * @return void
832 */
833 public static function addLLrefForTCAdescr($tca_descr_key, $file_ref) {
834 global $TCA_DESCR;
835 if ($tca_descr_key) {
836 if (!is_array($TCA_DESCR[$tca_descr_key])) {
837 $TCA_DESCR[$tca_descr_key] = array();
838 }
839 if (!is_array($TCA_DESCR[$tca_descr_key]['refs'])) {
840 $TCA_DESCR[$tca_descr_key]['refs'] = array();
841 }
842 $TCA_DESCR[$tca_descr_key]['refs'][] = $file_ref;
843 }
844 }
845
846 /**
847 * Registers a navigation component
848 *
849 * @param string $module
850 * @param string $componentId
851 * @return void
852 */
853 public static function addNavigationComponent($module, $componentId) {
854 $GLOBALS['TBE_MODULES']['_navigationComponents'][$module] = array(
855 'componentId' => $componentId,
856 'extKey' => $GLOBALS['_EXTKEY'],
857 'isCoreComponent' => FALSE,
858 );
859 }
860
861 /**
862 * Registers a core navigation component
863 *
864 * @param string $module
865 * @param string $componentId
866 * @return void
867 */
868 public static function addCoreNavigationComponent($module, $componentId) {
869 self::addNavigationComponent($module, $componentId);
870 $GLOBALS['TBE_MODULES']['_navigationComponents'][$module]['isCoreComponent'] = TRUE;
871 }
872
873
874 /**************************************
875 *
876 * Adding SERVICES features
877 *
878 * @author René Fritz <r.fritz@colorcube.de>
879 *
880 ***************************************/
881
882 /**
883 * Adds a service to the global services array
884 *
885 * @param string Extension key
886 * @param string Service type, cannot be prefixed "tx_"
887 * @param string Service key, must be prefixed "tx_" or "user_"
888 * @param array Service description array
889 * @return void
890 * @author René Fritz <r.fritz@colorcube.de>
891 */
892 public static function addService($extKey, $serviceType, $serviceKey, $info) {
893 global $T3_SERVICES, $TYPO3_CONF_VARS;
894
895 // even not available services will be included to make it possible to give the admin a feedback of non-available services.
896 // but maybe it's better to move non-available services to a different array??
897
898 if ($serviceType &&
899 !t3lib_div::isFirstPartOfStr($serviceType, 'tx_') &&
900 (t3lib_div::isFirstPartOfStr($serviceKey, 'tx_') || t3lib_div::isFirstPartOfStr($serviceKey, 'user_')) &&
901 is_array($info)) {
902
903 $info['priority'] = max(0, min(100, $info['priority']));
904
905 $T3_SERVICES[$serviceType][$serviceKey] = $info;
906
907 $T3_SERVICES[$serviceType][$serviceKey]['extKey'] = $extKey;
908 $T3_SERVICES[$serviceType][$serviceKey]['serviceKey'] = $serviceKey;
909 $T3_SERVICES[$serviceType][$serviceKey]['serviceType'] = $serviceType;
910
911
912 // mapping a service key to a service type
913 // all service keys begin with tx_ - service types don't
914 // this way a selection of a special service key as service type is easy
915 $T3_SERVICES[$serviceKey][$serviceKey] = &$T3_SERVICES[$serviceType][$serviceKey];
916
917
918 // change the priority (and other values) from TYPO3_CONF_VARS
919 // $TYPO3_CONF_VARS['T3_SERVICES'][$serviceType][$serviceKey]['priority']
920 // even the activation is possible (a unix service might be possible on windows for some reasons)
921 if (is_array($TYPO3_CONF_VARS['T3_SERVICES'][$serviceType][$serviceKey])) {
922
923 // no check is done here - there might be configuration values only the service type knows about, so we pass everything
924 $T3_SERVICES[$serviceType][$serviceKey] = array_merge($T3_SERVICES[$serviceType][$serviceKey], $TYPO3_CONF_VARS['T3_SERVICES'][$serviceType][$serviceKey]);
925 }
926
927
928 // OS check
929 // empty $os means 'not limited to one OS', therefore a check is not needed
930 if ($T3_SERVICES[$serviceType][$serviceKey]['available'] && $T3_SERVICES[$serviceType][$serviceKey]['os'] != '') {
931
932 // TYPO3_OS is not yet defined
933 $os_type = stristr(PHP_OS, 'win') && !stristr(PHP_OS, 'darwin') ? 'WIN' : 'UNIX';
934
935 $os = t3lib_div::trimExplode(',', strtoupper($T3_SERVICES[$serviceType][$serviceKey]['os']));
936
937 if (!in_array($os_type, $os)) {
938 self::deactivateService($serviceType, $serviceKey);
939 }
940 }
941
942 // convert subtype list to array for quicker access
943 $T3_SERVICES[$serviceType][$serviceKey]['serviceSubTypes'] = array();
944 $serviceSubTypes = t3lib_div::trimExplode(',', $info['subtype']);
945 foreach ($serviceSubTypes as $subtype) {
946 $T3_SERVICES[$serviceType][$serviceKey]['serviceSubTypes'][$subtype] = $subtype;
947 }
948 }
949 }
950
951 /**
952 * Find the available service with highest priority
953 *
954 * @param string Service type
955 * @param string Service sub type
956 * @param mixed Service keys that should be excluded in the search for a service. Array or comma list.
957 * @return mixed Service info array if a service was found, FLASE otherwise
958 * @author René Fritz <r.fritz@colorcube.de>
959 */
960 public static function findService($serviceType, $serviceSubType = '', $excludeServiceKeys = array()) {
961 global $T3_SERVICES, $TYPO3_CONF_VARS;
962
963 $serviceKey = FALSE;
964 $serviceInfo = FALSE;
965 $priority = 0;
966 $quality = 0;
967
968 if (!is_array($excludeServiceKeys)) {
969 $excludeServiceKeys = t3lib_div::trimExplode(',', $excludeServiceKeys, 1);
970 }
971
972 if (is_array($T3_SERVICES[$serviceType])) {
973 foreach ($T3_SERVICES[$serviceType] as $key => $info) {
974
975 if (in_array($key, $excludeServiceKeys)) {
976 continue;
977 }
978
979 // select a subtype randomly
980 // usefull to start a service by service key without knowing his subtypes - for testing purposes
981 if ($serviceSubType == '*') {
982 $serviceSubType = key($info['serviceSubTypes']);
983 }
984
985 // this matches empty subtype too
986 if ($info['available'] && ($info['subtype'] == $serviceSubType || $info['serviceSubTypes'][$serviceSubType]) && $info['priority'] >= $priority) {
987
988 // has a lower quality than the already found, therefore we skip this service
989 if ($info['priority'] == $priority && $info['quality'] < $quality) {
990 continue;
991 }
992
993 // service depends on external programs - check if they exists
994 if (trim($info['exec'])) {
995 $executables = t3lib_div::trimExplode(',', $info['exec'], 1);
996 foreach ($executables as $executable) {
997 if (!t3lib_exec::checkCommand($executable)) {
998 self::deactivateService($serviceType, $key);
999 $info['available'] = FALSE;
1000 break;
1001 }
1002 }
1003 }
1004
1005 // still available after exec check?
1006 if ($info['available']) {
1007 $serviceKey = $key;
1008 $priority = $info['priority'];
1009 $quality = $info['quality'];
1010 }
1011 }
1012 }
1013 }
1014
1015 if ($serviceKey) {
1016 $serviceInfo = $T3_SERVICES[$serviceType][$serviceKey];
1017 }
1018 return $serviceInfo;
1019 }
1020
1021 /**
1022 * Deactivate a service
1023 *
1024 * @param string Service type
1025 * @param string Service key
1026 * @return void
1027 * @author René Fritz <r.fritz@colorcube.de>
1028 */
1029 public static function deactivateService($serviceType, $serviceKey) {
1030 global $T3_SERVICES;
1031
1032 // ... maybe it's better to move non-available services to a different array??
1033 $T3_SERVICES[$serviceType][$serviceKey]['available'] = FALSE;
1034 }
1035
1036
1037 /**************************************
1038 *
1039 * Adding FRONTEND features
1040 * (related specifically to "cms" extension)
1041 *
1042 ***************************************/
1043
1044 /**
1045 * Adds an entry to the list of plugins in content elements of type "Insert plugin"
1046 * Takes the $itemArray (label, value[,icon]) and adds to the items-array of $TCA[tt_content] elements with CType "listtype" (or another field if $type points to another fieldname)
1047 * 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.
1048 * 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
1049 * FOR USE IN ext_tables.php FILES
1050 * Usage: 13
1051 *
1052 * @param array Item Array
1053 * @param string Type (eg. "list_type") - basically a field from "tt_content" table
1054 * @return void
1055 */
1056 public static function addPlugin($itemArray, $type = 'list_type') {
1057 global $TCA;
1058
1059 $_EXTKEY = $GLOBALS['_EXTKEY'];
1060 if ($_EXTKEY && !$itemArray[2]) {
1061 $itemArray[2] = self::extRelPath($_EXTKEY) . 'ext_icon.gif';
1062 }
1063
1064 t3lib_div::loadTCA('tt_content');
1065 if (is_array($TCA['tt_content']['columns']) && is_array($TCA['tt_content']['columns'][$type]['config']['items'])) {
1066 foreach ($TCA['tt_content']['columns'][$type]['config']['items'] as $k => $v) {
1067 if (!strcmp($v[1], $itemArray[1])) {
1068 $TCA['tt_content']['columns'][$type]['config']['items'][$k] = $itemArray;
1069 return;
1070 }
1071 }
1072 $TCA['tt_content']['columns'][$type]['config']['items'][] = $itemArray;
1073 }
1074 }
1075
1076 /**
1077 * Adds an entry to the "ds" array of the tt_content field "pi_flexform".
1078 * This is used by plugins to add a flexform XML reference / content for use when they are selected as plugin or content element.
1079 * Usage: 0
1080 *
1081 * @param string Plugin key as used in the list_type field. Use the asterisk * to match all list_type values.
1082 * @param string Either a reference to a flex-form XML file (eg. "FILE:EXT:newloginbox/flexform_ds.xml") or the XML directly.
1083 * @param string 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.
1084 * @return void
1085 * @see addPlugin()
1086 */
1087 public static function addPiFlexFormValue($piKeyToMatch, $value, $CTypeToMatch = 'list') {
1088 global $TCA;
1089 t3lib_div::loadTCA('tt_content');
1090
1091 if (is_array($TCA['tt_content']['columns']) && is_array($TCA['tt_content']['columns']['pi_flexform']['config']['ds'])) {
1092 $TCA['tt_content']['columns']['pi_flexform']['config']['ds'][$piKeyToMatch . ',' . $CTypeToMatch] = $value;
1093 }
1094 }
1095
1096 /**
1097 * Adds the $table tablename to the list of tables allowed to be includes by content element type "Insert records"
1098 * By using $content_table and $content_field you can also use the function for other tables.
1099 * FOR USE IN ext_tables.php FILES
1100 * Usage: 9
1101 *
1102 * @param string Table name to allow for "insert record"
1103 * @param string Table name TO WHICH the $table name is applied. See $content_field as well.
1104 * @param string Field name in the database $content_table in which $table is allowed to be added as a reference ("Insert Record")
1105 * @return void
1106 */
1107 public static function addToInsertRecords($table, $content_table = 'tt_content', $content_field = 'records') {
1108 global $TCA;
1109 t3lib_div::loadTCA($content_table);
1110 if (is_array($TCA[$content_table]['columns']) && isset($TCA[$content_table]['columns'][$content_field]['config']['allowed'])) {
1111 $TCA[$content_table]['columns'][$content_field]['config']['allowed'] .= ',' . $table;
1112 }
1113 }
1114
1115 /**
1116 * Add PlugIn to Static Template #43
1117 *
1118 * 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.
1119 * 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"
1120 * $type determines the type of frontend plugin:
1121 * "list_type" (default) - the good old "Insert plugin" entry
1122 * "menu_type" - a "Menu/Sitemap" entry
1123 * "splash_layout" - a "Textbox" entry
1124 * "CType" - a new content element type
1125 * "header_layout" - an additional header type (added to the selection of layout1-5)
1126 * "includeLib" - just includes the library for manual use somewhere in TypoScript.
1127 * (Remember that your $type definition should correspond to the column/items array in $TCA[tt_content] where you added the selector item for the element! See addPlugin() function)
1128 * FOR USE IN ext_localconf.php FILES
1129 * Usage: 2
1130 *
1131 * @param string $key is the extension key
1132 * @param string $classFile is the PHP-class filename relative to the extension root directory. If set to blank a default value is chosen according to convensions.
1133 * @param string $prefix is used as a - yes, suffix - of the class name (fx. "_pi1")
1134 * @param string $type, see description above
1135 * @param boolean If $cached is set as USER content object (cObject) is created - otherwise a USER_INT object is created.
1136 * @return void
1137 */
1138 public static function addPItoST43($key, $classFile = '', $prefix = '', $type = 'list_type', $cached = 0) {
1139 global $TYPO3_LOADED_EXT;
1140 $classFile = $classFile ? $classFile : 'pi/class.tx_' . str_replace('_', '', $key) . $prefix . '.php';
1141 $cN = self::getCN($key);
1142
1143 // General plugin:
1144 $pluginContent = trim('
1145 plugin.' . $cN . $prefix . ' = USER' . ($cached ? '' : '_INT') . '
1146 plugin.' . $cN . $prefix . ' {
1147 includeLibs = ' . $TYPO3_LOADED_EXT[$key]['siteRelPath'] . $classFile . '
1148 userFunc = ' . $cN . $prefix . '->main
1149 }');
1150 self::addTypoScript($key, 'setup', '
1151 # Setting ' . $key . ' plugin TypoScript
1152 ' . $pluginContent);
1153
1154 // After ST43:
1155 switch ($type) {
1156 case 'list_type':
1157 $addLine = 'tt_content.list.20.' . $key . $prefix . ' = < plugin.' . $cN . $prefix;
1158 break;
1159 case 'menu_type':
1160 $addLine = 'tt_content.menu.20.' . $key . $prefix . ' = < plugin.' . $cN . $prefix;
1161 break;
1162 case 'splash_layout':
1163 $addLine = 'tt_content.splash.' . $key . $prefix . ' = < plugin.' . $cN . $prefix;
1164 break;
1165 case 'CType':
1166 $addLine = trim('
1167 tt_content.' . $key . $prefix . ' = COA
1168 tt_content.' . $key . $prefix . ' {
1169 10 = < lib.stdheader
1170 20 = < plugin.' . $cN . $prefix . '
1171 }
1172 ');
1173 break;
1174 case 'header_layout':
1175 $addLine = 'lib.stdheader.10.' . $key . $prefix . ' = < plugin.' . $cN . $prefix;
1176 break;
1177 case 'includeLib':
1178 $addLine = 'page.1000 = < plugin.' . $cN . $prefix;
1179 break;
1180 default:
1181 $addLine = '';
1182 break;
1183 }
1184 if ($addLine) {
1185 self::addTypoScript($key, 'setup', '
1186 # Setting ' . $key . ' plugin TypoScript
1187 ' . $addLine . '
1188 ', 43);
1189 }
1190 }
1191
1192 /**
1193 * Call this method to add an entry in the static template list found in sys_templates
1194 * "static template files" are the modern equalent (provided from extensions) to the traditional records in "static_templates"
1195 * FOR USE IN ext_localconf.php FILES
1196 * Usage: 3
1197 *
1198 * @param string $extKey is of course the extension key
1199 * @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, editorcfg.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/
1200 * @param string $title is the title in the selector box.
1201 * @return void
1202 * @see addTypoScript()
1203 */
1204 public static function addStaticFile($extKey, $path, $title) {
1205 global $TCA;
1206 t3lib_div::loadTCA('sys_template');
1207 if ($extKey && $path && is_array($TCA['sys_template']['columns'])) {
1208 $value = str_replace(',', '', 'EXT:' . $extKey . '/' . $path);
1209 $itemArray = array(trim($title . ' (' . $extKey . ')'), $value);
1210 $TCA['sys_template']['columns']['include_static_file']['config']['items'][] = $itemArray;
1211 }
1212 }
1213
1214 /**
1215 * Adds $content to the default TypoScript setup code as set in $TYPO3_CONF_VARS[FE]['defaultTypoScript_setup']
1216 * Prefixed with a [GLOBAL] line
1217 * FOR USE IN ext_localconf.php FILES
1218 * Usage: 6
1219 *
1220 * @param string TypoScript Setup string
1221 * @return void
1222 */
1223 public static function addTypoScriptSetup($content) {
1224 global $TYPO3_CONF_VARS;
1225 $TYPO3_CONF_VARS['FE']['defaultTypoScript_setup'] .= "\n[GLOBAL]\n" . $content;
1226 }
1227
1228 /**
1229 * Adds $content to the default TypoScript constants code as set in $TYPO3_CONF_VARS[FE]['defaultTypoScript_constants']
1230 * Prefixed with a [GLOBAL] line
1231 * FOR USE IN ext_localconf.php FILES
1232 * Usage: 0
1233 *
1234 * @param string TypoScript Constants string
1235 * @return void
1236 */
1237 public static function addTypoScriptConstants($content) {
1238 global $TYPO3_CONF_VARS;
1239 $TYPO3_CONF_VARS['FE']['defaultTypoScript_constants'] .= "\n[GLOBAL]\n" . $content;
1240 }
1241
1242 /**
1243 * Adds $content to the default TypoScript code for either setup, constants or editorcfg as set in $TYPO3_CONF_VARS[FE]['defaultTypoScript_*']
1244 * (Basically this function can do the same as addTypoScriptSetup and addTypoScriptConstants - just with a little more hazzle, but also with some more options!)
1245 * FOR USE IN ext_localconf.php FILES
1246 * Usage: 7
1247 *
1248 * @param string $key is the extension key (informative only).
1249 * @param string $type is either "setup", "constants" or "editorcfg" and obviously determines which kind of TypoScript code we are adding.
1250 * @param string $content is the TS content, prefixed with a [GLOBAL] line and a comment-header.
1251 * @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.
1252 * @return void
1253 */
1254 public static function addTypoScript($key, $type, $content, $afterStaticUid = 0) {
1255 global $TYPO3_CONF_VARS;
1256
1257 if ($type == 'setup' || $type == 'editorcfg' || $type == 'constants') {
1258 $content = '
1259
1260 [GLOBAL]
1261 #############################################
1262 ## TypoScript added by extension "' . $key . '"
1263 #############################################
1264
1265 ' . $content;
1266 if ($afterStaticUid) {
1267 $TYPO3_CONF_VARS['FE']['defaultTypoScript_' . $type . '.'][$afterStaticUid] .= $content;
1268 // If 'content (default)' is targeted, also add to other 'content rendering templates', eg. css_styled_content
1269 if ($afterStaticUid == 43 && is_array($TYPO3_CONF_VARS['FE']['contentRenderingTemplates'])) {
1270 foreach ($TYPO3_CONF_VARS['FE']['contentRenderingTemplates'] as $templateName) {
1271 $TYPO3_CONF_VARS['FE']['defaultTypoScript_' . $type . '.'][$templateName] .= $content;
1272 }
1273 }
1274 } else {
1275 $TYPO3_CONF_VARS['FE']['defaultTypoScript_' . $type] .= $content;
1276 }
1277 }
1278 }
1279
1280
1281 /**************************************
1282 *
1283 * INTERNAL EXTENSION MANAGEMENT:
1284 *
1285 ***************************************/
1286
1287 /**
1288 * Loading extensions configured in $TYPO3_CONF_VARS['EXT']['extList']
1289 *
1290 * CACHING ON: ($TYPO3_CONF_VARS['EXT']['extCache'] = 1 or 2)
1291 * If caching is enabled (and possible), the output will be $extensions['_CACHEFILE'] set to the cacheFilePrefix. Subsequently the cache files must be included then since those will eventually set up the extensions.
1292 * If cachefiles are not found they will be generated
1293 * CACHING OFF: ($TYPO3_CONF_VARS['EXT']['extCache'] = 0)
1294 * The returned value will be an array where each key is an extension key and the value is an array with filepaths for the extension.
1295 * This array will later be set in the global var $TYPO3_LOADED_EXT
1296 *
1297 * Usages of this function can be seen in config_default.php
1298 * Extensions are always detected in the order local - global - system.
1299 * Usage: 1
1300 *
1301 * @return array Extension Array
1302 * @internal
1303 */
1304 public static function typo3_loadExtensions() {
1305 global $TYPO3_CONF_VARS;
1306
1307 // Caching behaviour of ext_tables.php and ext_localconf.php files:
1308 $extensionCacheBehaviour = self::getExtensionCacheBehaviour();
1309 // Full list of extensions includes both required and extList:
1310 $rawExtList = self::getEnabledExtensionList();
1311
1312 // Empty array as a start.
1313 $extensions = array();
1314
1315 //
1316 if ($rawExtList) {
1317 // The cached File prefix.
1318 $cacheFilePrefix = self::getCacheFilePrefix();
1319
1320 // If cache files available, set cache file prefix and return:
1321 if ($extensionCacheBehaviour && self::isCacheFilesAvailable($cacheFilePrefix)) {
1322 // Return cache file prefix:
1323 $extensions['_CACHEFILE'] = $cacheFilePrefix;
1324 } else { // ... but if not, configure...
1325
1326 // Prepare reserved filenames:
1327 $files = array('ext_localconf.php', 'ext_tables.php', 'ext_tables.sql', 'ext_tables_static+adt.sql', 'ext_typoscript_constants.txt', 'ext_typoscript_editorcfg.txt', 'ext_typoscript_setup.txt');
1328 // Traverse extensions and check their existence:
1329 clearstatcache(); // Clear file state cache to make sure we get good results from is_dir()
1330 $temp_extensions = array_unique(t3lib_div::trimExplode(',', $rawExtList, 1));
1331 foreach ($temp_extensions as $temp_extKey) {
1332 // Check local, global and system locations:
1333 if (@is_dir(PATH_typo3conf . 'ext/' . $temp_extKey . '/')) {
1334 $extensions[$temp_extKey] = array('type' => 'L', 'siteRelPath' => 'typo3conf/ext/' . $temp_extKey . '/', 'typo3RelPath' => '../typo3conf/ext/' . $temp_extKey . '/');
1335 } elseif (@is_dir(PATH_typo3 . 'ext/' . $temp_extKey . '/')) {
1336 $extensions[$temp_extKey] = array('type' => 'G', 'siteRelPath' => TYPO3_mainDir . 'ext/' . $temp_extKey . '/', 'typo3RelPath' => 'ext/' . $temp_extKey . '/');
1337 } elseif (@is_dir(PATH_typo3 . 'sysext/' . $temp_extKey . '/')) {
1338 $extensions[$temp_extKey] = array('type' => 'S', 'siteRelPath' => TYPO3_mainDir . 'sysext/' . $temp_extKey . '/', 'typo3RelPath' => 'sysext/' . $temp_extKey . '/');
1339 }
1340
1341 // If extension was found, check for reserved filenames:
1342 if (isset($extensions[$temp_extKey])) {
1343 foreach ($files as $fName) {
1344 $temp_filename = PATH_site . $extensions[$temp_extKey]['siteRelPath'] . trim($fName);
1345 if (is_array($extensions[$temp_extKey]) && @is_file($temp_filename)) {
1346 $extensions[$temp_extKey][$fName] = $temp_filename;
1347 }
1348 }
1349 }
1350 }
1351 unset($extensions['_CACHEFILE']);
1352
1353 // write cache?
1354 if ($extensionCacheBehaviour &&
1355 @is_dir(PATH_typo3 . 'sysext/') &&
1356 @is_dir(PATH_typo3 . 'ext/')) { // Must also find global and system extension directories to exist, otherwise caching cannot be allowed (since it is most likely a temporary server problem). This might fix a rare, unrepeatable bug where global/system extensions are not loaded resulting in fatal errors if that is cached!
1357 $wrError = self::cannotCacheFilesWritable($cacheFilePrefix);
1358 if ($wrError) {
1359 $TYPO3_CONF_VARS['EXT']['extCache'] = 0;
1360 } else {
1361 // Write cache files:
1362 $extensions = self::writeCacheFiles($extensions, $cacheFilePrefix);
1363 }
1364 }
1365 }
1366 }
1367
1368 return $extensions;
1369 }
1370
1371 /**
1372 * Returns the section headers for the compiled cache-files.
1373 *
1374 * @param string $key is the extension key
1375 * @param string $file is the filename (only informative for comment)
1376 * @return string
1377 * @internal
1378 */
1379 public static function _makeIncludeHeader($key, $file) {
1380 return '<?php
1381 ###########################
1382 ## EXTENSION: ' . $key . '
1383 ## FILE: ' . $file . '
1384 ###########################
1385
1386 $_EXTKEY = \'' . $key . '\';
1387 $_EXTCONF = $TYPO3_CONF_VARS[\'EXT\'][\'extConf\'][$_EXTKEY];
1388
1389 ?>';
1390 }
1391
1392 /**
1393 * Returns true if both the localconf and tables cache file exists (with $cacheFilePrefix)
1394 * Usage: 2
1395 *
1396 * @param string Prefix of the cache file to check
1397 * @return boolean
1398 * @internal
1399 */
1400 public static function isCacheFilesAvailable($cacheFilePrefix) {
1401 return
1402 @is_file(PATH_typo3conf . $cacheFilePrefix . '_ext_localconf.php') &&
1403 @is_file(PATH_typo3conf . $cacheFilePrefix . '_ext_tables.php');
1404 }
1405
1406 /**
1407 * Returns true if the "localconf.php" file in "typo3conf/" is writable
1408 * Usage: 1
1409 *
1410 * @return boolean
1411 * @internal
1412 */
1413 public static function isLocalconfWritable() {
1414 return @is_writable(PATH_typo3conf) && @is_writable(PATH_typo3conf . 'localconf.php');
1415 }
1416
1417 /**
1418 * Returns an error string if typo3conf/ or cache-files with $cacheFilePrefix are NOT writable
1419 * Returns false if no problem.
1420 * Usage: 1
1421 *
1422 * @param string Prefix of the cache file to check
1423 * @return string
1424 * @internal
1425 */
1426 public static function cannotCacheFilesWritable($cacheFilePrefix) {
1427 $error = array();
1428 if (!@is_writable(PATH_typo3conf)) {
1429 $error[] = PATH_typo3conf;
1430 }
1431 if (@is_file(PATH_typo3conf . $cacheFilePrefix . '_ext_localconf.php') &&
1432 !@is_writable(PATH_typo3conf . $cacheFilePrefix . '_ext_localconf.php')) {
1433 $error[] = PATH_typo3conf . $cacheFilePrefix . '_ext_localconf.php';
1434 }
1435 if (@is_file(PATH_typo3conf . $cacheFilePrefix . '_ext_tables.php') &&
1436 !@is_writable(PATH_typo3conf . $cacheFilePrefix . '_ext_tables.php')) {
1437 $error[] = PATH_typo3conf . $cacheFilePrefix . '_ext_tables.php';
1438 }
1439 return implode(', ', $error);
1440 }
1441
1442 /**
1443 * Returns an array with the two cache-files (0=>localconf, 1=>tables) from typo3conf/ if they (both) exist. Otherwise false.
1444 * Evaluation relies on $TYPO3_LOADED_EXT['_CACHEFILE']
1445 * Usage: 2
1446 *
1447 * @param string $cacheFilePrefix Cache file prefix to be used (optional)
1448 * @return array
1449 * @internal
1450 */
1451 public static function currentCacheFiles($cacheFilePrefix = NULL) {
1452 if (is_null($cacheFilePrefix)) {
1453 $cacheFilePrefix = $GLOBALS['TYPO3_LOADED_EXT']['_CACHEFILE'];
1454 }
1455
1456 if ($cacheFilePrefix) {
1457 $cacheFilePrefixFE = str_replace('temp_CACHED', 'temp_CACHED_FE', $cacheFilePrefix);
1458 $files = array();
1459 if (self::isCacheFilesAvailable($cacheFilePrefix)) {
1460 $files[] = PATH_typo3conf . $cacheFilePrefix . '_ext_localconf.php';
1461 $files[] = PATH_typo3conf . $cacheFilePrefix . '_ext_tables.php';
1462 }
1463 if (self::isCacheFilesAvailable($cacheFilePrefixFE)) {
1464 $files[] = PATH_typo3conf . $cacheFilePrefixFE . '_ext_localconf.php';
1465 $files[] = PATH_typo3conf . $cacheFilePrefixFE . '_ext_tables.php';
1466 }
1467 if (!empty($files)) {
1468 return $files;
1469 }
1470 }
1471 }
1472
1473 /**
1474 * Compiles/Creates the two cache-files in typo3conf/ based on $cacheFilePrefix
1475 * Returns a array with the key "_CACHEFILE" set to the $cacheFilePrefix value
1476 * Usage: 1
1477 *
1478 * @param array Extension information array
1479 * @param string Prefix for the cache files
1480 * @return array
1481 * @internal
1482 */
1483 public static function writeCacheFiles($extensions, $cacheFilePrefix) {
1484 // Making cache files:
1485 $extensions['_CACHEFILE'] = $cacheFilePrefix;
1486 $cFiles = array();
1487 $cFiles['ext_localconf'] .= '<?php
1488
1489 $TYPO3_LOADED_EXT = unserialize(stripslashes(\'' . addslashes(serialize($extensions)) . '\'));
1490
1491 ?>';
1492
1493 foreach ($extensions as $key => $conf) {
1494 if (is_array($conf)) {
1495 if ($conf['ext_localconf.php']) {
1496 $cFiles['ext_localconf'] .= self::_makeIncludeHeader($key, $conf['ext_localconf.php']);
1497 $cFiles['ext_localconf'] .= trim(t3lib_div::getUrl($conf['ext_localconf.php']));
1498 }
1499 if ($conf['ext_tables.php']) {
1500 $cFiles['ext_tables'] .= self::_makeIncludeHeader($key, $conf['ext_tables.php']);
1501 $cFiles['ext_tables'] .= trim(t3lib_div::getUrl($conf['ext_tables.php']));
1502 }
1503 }
1504 }
1505
1506 $cFiles['ext_localconf'] = "<?php\n" . preg_replace('/<\?php|\?>/is', '', $cFiles['ext_localconf']) . "?>\n";
1507 $cFiles['ext_tables'] = "<?php\n" . preg_replace('/<\?php|\?>/is', '', $cFiles['ext_tables']) . "?>\n";
1508
1509 t3lib_div::writeFile(PATH_typo3conf . $cacheFilePrefix . '_ext_localconf.php', $cFiles['ext_localconf']);
1510 t3lib_div::writeFile(PATH_typo3conf . $cacheFilePrefix . '_ext_tables.php', $cFiles['ext_tables']);
1511
1512 $extensions = array();
1513 $extensions['_CACHEFILE'] = $cacheFilePrefix;
1514
1515 return $extensions;
1516 }
1517
1518 /**
1519 * Unlink (delete) cache files
1520 *
1521 * @param string $cacheFilePrefix Cache file prefix to be used (optional)
1522 * @return integer Number of deleted files.
1523 */
1524 public static function removeCacheFiles($cacheFilePrefix = NULL) {
1525 $cacheFiles = self::currentCacheFiles($cacheFilePrefix);
1526
1527 $out = 0;
1528 if (is_array($cacheFiles)) {
1529 reset($cacheFiles);
1530 foreach ($cacheFiles as $cfile) {
1531 @unlink($cfile);
1532 clearstatcache();
1533 $out++;
1534 }
1535 }
1536 return $out;
1537 }
1538
1539 /**
1540 * Gets the behaviour for caching ext_tables.php and ext_localconf.php files
1541 * (see $TYPO3_CONF_VARS['EXT']['extCache'] setting in the install tool).
1542 *
1543 * @param boolean $usePlainValue Whether to use the value as it is without modifications
1544 * @return integer
1545 */
1546 public static function getExtensionCacheBehaviour($usePlainValue = FALSE) {
1547 $extensionCacheBehaviour = intval($GLOBALS['TYPO3_CONF_VARS']['EXT']['extCache']);
1548
1549 // Caching of extensions is disabled when install tool is used:
1550 if (!$usePlainValue && defined('TYPO3_enterInstallScript') && TYPO3_enterInstallScript) {
1551 $extensionCacheBehaviour = 0;
1552 }
1553
1554 return $extensionCacheBehaviour;
1555 }
1556
1557 /**
1558 * Gets the prefix used for the ext_tables.php and ext_localconf.php cached files.
1559 *
1560 * @return string
1561 */
1562 public static function getCacheFilePrefix() {
1563 $extensionCacheBehaviour = self::getExtensionCacheBehaviour(TRUE);
1564
1565 $cacheFileSuffix = (TYPO3_MODE == 'FE' ? '_FE' : '');
1566 $cacheFilePrefix = 'temp_CACHED' . $cacheFileSuffix;
1567
1568 if ($extensionCacheBehaviour == 1) {
1569 $cacheFilePrefix .= '_ps' . substr(t3lib_div::shortMD5(PATH_site . '|' . $GLOBALS['TYPO_VERSION']), 0, 4);
1570 } elseif ($extensionCacheBehaviour == 2) {
1571 $cacheFilePrefix .= '_' . t3lib_div::shortMD5(self::getEnabledExtensionList());
1572 }
1573
1574 return $cacheFilePrefix;
1575 }
1576
1577 /**
1578 * Gets the list of enabled extensions for the accordant context (frontend or backend).
1579 *
1580 * @return string
1581 */
1582 public static function getEnabledExtensionList() {
1583 // Select mode how to load extensions in order to speed up the FE
1584 if (TYPO3_MODE == 'FE') {
1585 if (!($extLoadInContext = $GLOBALS['TYPO3_CONF_VARS']['EXT']['extList_FE'])) {
1586 // fall back to standard 'extList' if 'extList_FE' is not (yet) set
1587 $extLoadInContext = $GLOBALS['TYPO3_CONF_VARS']['EXT']['extList'];
1588 }
1589 } else {
1590 $extLoadInContext = $GLOBALS['TYPO3_CONF_VARS']['EXT']['extList'];
1591 }
1592
1593 $extensionList = self::getRequiredExtensionList() . ',' . $extLoadInContext;
1594 $ignoredExtensionList = self::getIgnoredExtensionList();
1595
1596 // Remove the extensions to be ignored:
1597 if ($ignoredExtensionList && (defined('TYPO3_enterInstallScript') && TYPO3_enterInstallScript) === FALSE) {
1598 $extensions = array_diff(
1599 explode(',', $extensionList),
1600 explode(',', $ignoredExtensionList)
1601 );
1602 $extensionList = implode(',', $extensions);
1603 }
1604
1605 return $extensionList;
1606 }
1607
1608 /**
1609 * Gets the list of required extensions.
1610 *
1611 * @return string
1612 */
1613 public static function getRequiredExtensionList() {
1614 $requiredExtensionList = t3lib_div::uniqueList(
1615 REQUIRED_EXTENSIONS . ',' . $GLOBALS['TYPO3_CONF_VARS']['EXT']['requiredExt']
1616 );
1617
1618 return $requiredExtensionList;
1619 }
1620
1621 /**
1622 * Gets the list of extensions to be ignored (not to be loaded).
1623 *
1624 * @return string
1625 */
1626 public static function getIgnoredExtensionList() {
1627 $ignoredExtensionList = t3lib_div::uniqueList(
1628 $GLOBALS['TYPO3_CONF_VARS']['EXT']['ignoredExt']
1629 );
1630
1631 return $ignoredExtensionList;
1632 }
1633 }
1634
1635 ?>