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