Cleanup: Updated copyright comments
[Packages/TYPO3.CMS.git] / t3lib / class.t3lib_extmgm.php
1 <?php
2 /***************************************************************
3 * Copyright notice
4 *
5 * (c) 1999-2010 Kasper Skaarhoj (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 Skaarhoj
32 *
33 * @author Kasper Skaarhoj <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 Skaarhoj <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
802
803
804
805
806
807
808
809
810
811 /**************************************
812 *
813 * Adding SERVICES features
814 *
815 * @author Rene Fritz <r.fritz@colorcube.de>
816 *
817 ***************************************/
818
819 /**
820 * Adds a service to the global services array
821 *
822 * @param string Extension key
823 * @param string Service type, cannot be prefixed "tx_"
824 * @param string Service key, must be prefixed "tx_" or "user_"
825 * @param array Service description array
826 * @return void
827 * @author Rene Fritz <r.fritz@colorcube.de>
828 */
829 public static function addService($extKey, $serviceType, $serviceKey, $info) {
830 global $T3_SERVICES, $TYPO3_CONF_VARS;
831
832 // even not available services will be included to make it possible to give the admin a feedback of non-available services.
833 // but maybe it's better to move non-available services to a different array??
834
835 if ($serviceType &&
836 !t3lib_div::isFirstPartOfStr($serviceType, 'tx_') &&
837 (t3lib_div::isFirstPartOfStr($serviceKey, 'tx_') || t3lib_div::isFirstPartOfStr($serviceKey, 'user_')) &&
838 is_array($info)) {
839
840 $info['priority'] = max(0, min(100, $info['priority']));
841
842 $T3_SERVICES[$serviceType][$serviceKey] = $info;
843
844 $T3_SERVICES[$serviceType][$serviceKey]['extKey'] = $extKey;
845 $T3_SERVICES[$serviceType][$serviceKey]['serviceKey'] = $serviceKey;
846 $T3_SERVICES[$serviceType][$serviceKey]['serviceType'] = $serviceType;
847
848
849 // mapping a service key to a service type
850 // all service keys begin with tx_ - service types don't
851 // this way a selection of a special service key as service type is easy
852 $T3_SERVICES[$serviceKey][$serviceKey] = &$T3_SERVICES[$serviceType][$serviceKey];
853
854
855 // change the priority (and other values) from TYPO3_CONF_VARS
856 // $TYPO3_CONF_VARS['T3_SERVICES'][$serviceType][$serviceKey]['priority']
857 // even the activation is possible (a unix service might be possible on windows for some reasons)
858 if (is_array($TYPO3_CONF_VARS['T3_SERVICES'][$serviceType][$serviceKey])) {
859
860 // no check is done here - there might be configuration values only the service type knows about, so we pass everything
861 $T3_SERVICES[$serviceType][$serviceKey] = array_merge ($T3_SERVICES[$serviceType][$serviceKey], $TYPO3_CONF_VARS['T3_SERVICES'][$serviceType][$serviceKey]);
862 }
863
864
865 // OS check
866 // empty $os means 'not limited to one OS', therefore a check is not needed
867 if ($T3_SERVICES[$serviceType][$serviceKey]['available'] && $T3_SERVICES[$serviceType][$serviceKey]['os']!='') {
868
869 // TYPO3_OS is not yet defined
870 $os_type = stristr(PHP_OS, 'win')&&!stristr(PHP_OS, 'darwin')?'WIN':'UNIX';
871
872 $os = t3lib_div::trimExplode(',', strtoupper($T3_SERVICES[$serviceType][$serviceKey]['os']));
873
874 if (!in_array($os_type, $os)) {
875 self::deactivateService($serviceType, $serviceKey);
876 }
877 }
878
879 // convert subtype list to array for quicker access
880 $T3_SERVICES[$serviceType][$serviceKey]['serviceSubTypes'] = array();
881 $serviceSubTypes = t3lib_div::trimExplode(',', $info['subtype']);
882 foreach ($serviceSubTypes as $subtype) {
883 $T3_SERVICES[$serviceType][$serviceKey]['serviceSubTypes'][$subtype] = $subtype;
884 }
885 }
886 }
887
888 /**
889 * Find the available service with highest priority
890 *
891 * @param string Service type
892 * @param string Service sub type
893 * @param mixed Service keys that should be excluded in the search for a service. Array or comma list.
894 * @return mixed Service info array if a service was found, FLASE otherwise
895 * @author Rene Fritz <r.fritz@colorcube.de>
896 */
897 public static function findService($serviceType, $serviceSubType = '', $excludeServiceKeys = array()) {
898 global $T3_SERVICES, $TYPO3_CONF_VARS;
899
900 $serviceKey = FALSE;
901 $serviceInfo = FALSE;
902 $priority = 0;
903 $quality = 0;
904
905 if (!is_array($excludeServiceKeys) ) {
906 $excludeServiceKeys = t3lib_div::trimExplode(',', $excludeServiceKeys, 1);
907 }
908
909 if (is_array($T3_SERVICES[$serviceType])) {
910 foreach($T3_SERVICES[$serviceType] as $key => $info) {
911
912 if (in_array($key, $excludeServiceKeys)) {
913 continue;
914 }
915
916 // select a subtype randomly
917 // usefull to start a service by service key without knowing his subtypes - for testing purposes
918 if ($serviceSubType=='*') {
919 $serviceSubType = key($info['serviceSubTypes']);
920 }
921
922 // this matches empty subtype too
923 if ($info['available'] && ($info['subtype']==$serviceSubType || $info['serviceSubTypes'][$serviceSubType]) && $info['priority']>=$priority ) {
924
925 // has a lower quality than the already found, therefore we skip this service
926 if($info['priority']==$priority && $info['quality']<$quality) {
927 continue;
928 }
929
930 // service depends on external programs - check if they exists
931 if(trim($info['exec'])) {
932 $executables = t3lib_div::trimExplode(',', $info['exec'], 1);
933 foreach($executables as $executable) {
934 if(!t3lib_exec::checkCommand($executable)) {
935 self::deactivateService($serviceType, $key);
936 $info['available'] = FALSE;
937 break;
938 }
939 }
940 }
941
942 // still available after exec check?
943 if($info['available']) {
944 $serviceKey = $key;
945 $priority = $info['priority'];
946 $quality = $info['quality'];
947 }
948 }
949 }
950 }
951
952 if ($serviceKey) {
953 $serviceInfo = $T3_SERVICES[$serviceType][$serviceKey];
954 }
955 return $serviceInfo;
956 }
957
958 /**
959 * Deactivate a service
960 *
961 * @param string Service type
962 * @param string Service key
963 * @return void
964 * @author Rene Fritz <r.fritz@colorcube.de>
965 */
966 public static function deactivateService($serviceType, $serviceKey) {
967 global $T3_SERVICES;
968
969 // ... maybe it's better to move non-available services to a different array??
970 $T3_SERVICES[$serviceType][$serviceKey]['available'] = FALSE;
971 }
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986 /**************************************
987 *
988 * Adding FRONTEND features
989 * (related specifically to "cms" extension)
990 *
991 ***************************************/
992
993 /**
994 * Adds an entry to the list of plugins in content elements of type "Insert plugin"
995 * 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)
996 * 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.
997 * 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
998 * FOR USE IN ext_tables.php FILES
999 * Usage: 13
1000 *
1001 * @param array Item Array
1002 * @param string Type (eg. "list_type") - basically a field from "tt_content" table
1003 * @return void
1004 */
1005 public static function addPlugin($itemArray, $type = 'list_type') {
1006 global $TCA;
1007
1008 $_EXTKEY = $GLOBALS['_EXTKEY'];
1009 if ($_EXTKEY && !$itemArray[2]) {
1010 $itemArray[2] = self::extRelPath($_EXTKEY) . 'ext_icon.gif';
1011 }
1012
1013 t3lib_div::loadTCA('tt_content');
1014 if (is_array($TCA['tt_content']['columns']) && is_array($TCA['tt_content']['columns'][$type]['config']['items'])) {
1015 foreach ($TCA['tt_content']['columns'][$type]['config']['items'] as $k => $v) {
1016 if (!strcmp($v[1], $itemArray[1])) {
1017 $TCA['tt_content']['columns'][$type]['config']['items'][$k] = $itemArray;
1018 return;
1019 }
1020 }
1021 $TCA['tt_content']['columns'][$type]['config']['items'][] = $itemArray;
1022 }
1023 }
1024
1025 /**
1026 * Adds an entry to the "ds" array of the tt_content field "pi_flexform".
1027 * This is used by plugins to add a flexform XML reference / content for use when they are selected as plugin or content element.
1028 * Usage: 0
1029 *
1030 * @param string Plugin key as used in the list_type field. Use the asterisk * to match all list_type values.
1031 * @param string Either a reference to a flex-form XML file (eg. "FILE:EXT:newloginbox/flexform_ds.xml") or the XML directly.
1032 * @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.
1033 * @return void
1034 * @see addPlugin()
1035 */
1036 public static function addPiFlexFormValue($piKeyToMatch, $value, $CTypeToMatch = 'list') {
1037 global $TCA;
1038 t3lib_div::loadTCA('tt_content');
1039
1040 if (is_array($TCA['tt_content']['columns']) && is_array($TCA['tt_content']['columns']['pi_flexform']['config']['ds'])) {
1041 $TCA['tt_content']['columns']['pi_flexform']['config']['ds'][$piKeyToMatch.','.$CTypeToMatch] = $value;
1042 }
1043 }
1044
1045 /**
1046 * Adds the $table tablename to the list of tables allowed to be includes by content element type "Insert records"
1047 * By using $content_table and $content_field you can also use the function for other tables.
1048 * FOR USE IN ext_tables.php FILES
1049 * Usage: 9
1050 *
1051 * @param string Table name to allow for "insert record"
1052 * @param string Table name TO WHICH the $table name is applied. See $content_field as well.
1053 * @param string Field name in the database $content_table in which $table is allowed to be added as a reference ("Insert Record")
1054 * @return void
1055 */
1056 public static function addToInsertRecords($table, $content_table = 'tt_content', $content_field = 'records') {
1057 global $TCA;
1058 t3lib_div::loadTCA($content_table);
1059 if (is_array($TCA[$content_table]['columns']) && isset($TCA[$content_table]['columns'][$content_field]['config']['allowed'])) {
1060 $TCA[$content_table]['columns'][$content_field]['config']['allowed'].=','.$table;
1061 }
1062 }
1063
1064 /**
1065 * Add PlugIn to Static Template #43
1066 *
1067 * 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.
1068 * 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"
1069 * $type determines the type of frontend plugin:
1070 * "list_type" (default) - the good old "Insert plugin" entry
1071 * "menu_type" - a "Menu/Sitemap" entry
1072 * "splash_layout" - a "Textbox" entry
1073 * "CType" - a new content element type
1074 * "header_layout" - an additional header type (added to the selection of layout1-5)
1075 * "includeLib" - just includes the library for manual use somewhere in TypoScript.
1076 * (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)
1077 * FOR USE IN ext_localconf.php FILES
1078 * Usage: 2
1079 *
1080 * @param string $key is the extension key
1081 * @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.
1082 * @param string $prefix is used as a - yes, suffix - of the class name (fx. "_pi1")
1083 * @param string $type, see description above
1084 * @param boolean If $cached is set as USER content object (cObject) is created - otherwise a USER_INT object is created.
1085 * @return void
1086 */
1087 public static function addPItoST43($key, $classFile = '', $prefix = '', $type = 'list_type', $cached = 0) {
1088 global $TYPO3_LOADED_EXT;
1089 $classFile = $classFile ? $classFile : 'pi/class.tx_'.str_replace('_', '', $key).$prefix.'.php';
1090 $cN = self::getCN($key);
1091
1092 // General plugin:
1093 $pluginContent = trim('
1094 plugin.'.$cN.$prefix.' = USER' . ($cached ? '' : '_INT') . '
1095 plugin.'.$cN.$prefix.' {
1096 includeLibs = '.$TYPO3_LOADED_EXT[$key]['siteRelPath'].$classFile.'
1097 userFunc = '.$cN.$prefix.'->main
1098 }');
1099 self::addTypoScript($key, 'setup', '
1100 # Setting '.$key.' plugin TypoScript
1101 '.$pluginContent);
1102
1103 // After ST43:
1104 switch($type) {
1105 case 'list_type':
1106 $addLine = 'tt_content.list.20.'.$key.$prefix.' = < plugin.'.$cN.$prefix;
1107 break;
1108 case 'menu_type':
1109 $addLine = 'tt_content.menu.20.'.$key.$prefix.' = < plugin.'.$cN.$prefix;
1110 break;
1111 case 'splash_layout':
1112 $addLine = 'tt_content.splash.'.$key.$prefix.' = < plugin.'.$cN.$prefix;
1113 break;
1114 case 'CType':
1115 $addLine = trim('
1116 tt_content.'.$key.$prefix.' = COA
1117 tt_content.'.$key.$prefix.' {
1118 10 = < lib.stdheader
1119 20 = < plugin.'.$cN.$prefix.'
1120 }
1121 ');
1122 break;
1123 case 'header_layout':
1124 $addLine = 'lib.stdheader.10.'.$key.$prefix.' = < plugin.'.$cN.$prefix;
1125 break;
1126 case 'includeLib':
1127 $addLine = 'page.1000 = < plugin.'.$cN.$prefix;
1128 break;
1129 default:
1130 $addLine = '';
1131 break;
1132 }
1133 if ($addLine) {
1134 self::addTypoScript($key, 'setup', '
1135 # Setting '.$key.' plugin TypoScript
1136 '.$addLine.'
1137 ', 43);
1138 }
1139 }
1140
1141 /**
1142 * Call this method to add an entry in the static template list found in sys_templates
1143 * "static template files" are the modern equalent (provided from extensions) to the traditional records in "static_templates"
1144 * FOR USE IN ext_localconf.php FILES
1145 * Usage: 3
1146 *
1147 * @param string $extKey is of course the extension key
1148 * @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/
1149 * @param string $title is the title in the selector box.
1150 * @return void
1151 * @see addTypoScript()
1152 */
1153 public static function addStaticFile($extKey, $path, $title) {
1154 global $TCA;
1155 t3lib_div::loadTCA('sys_template');
1156 if ($extKey && $path && is_array($TCA['sys_template']['columns'])) {
1157 $value = str_replace(',', '', 'EXT:'.$extKey.'/'.$path);
1158 $itemArray = array(trim($title.' ('.$extKey.')'), $value);
1159 $TCA['sys_template']['columns']['include_static_file']['config']['items'][] = $itemArray;
1160 }
1161 }
1162
1163 /**
1164 * Adds $content to the default TypoScript setup code as set in $TYPO3_CONF_VARS[FE]['defaultTypoScript_setup']
1165 * Prefixed with a [GLOBAL] line
1166 * FOR USE IN ext_localconf.php FILES
1167 * Usage: 6
1168 *
1169 * @param string TypoScript Setup string
1170 * @return void
1171 */
1172 public static function addTypoScriptSetup($content) {
1173 global $TYPO3_CONF_VARS;
1174 $TYPO3_CONF_VARS['FE']['defaultTypoScript_setup'].="\n[GLOBAL]\n".$content;
1175 }
1176
1177 /**
1178 * Adds $content to the default TypoScript constants code as set in $TYPO3_CONF_VARS[FE]['defaultTypoScript_constants']
1179 * Prefixed with a [GLOBAL] line
1180 * FOR USE IN ext_localconf.php FILES
1181 * Usage: 0
1182 *
1183 * @param string TypoScript Constants string
1184 * @return void
1185 */
1186 public static function addTypoScriptConstants($content) {
1187 global $TYPO3_CONF_VARS;
1188 $TYPO3_CONF_VARS['FE']['defaultTypoScript_constants'].="\n[GLOBAL]\n".$content;
1189 }
1190
1191 /**
1192 * Adds $content to the default TypoScript code for either setup, constants or editorcfg as set in $TYPO3_CONF_VARS[FE]['defaultTypoScript_*']
1193 * (Basically this function can do the same as addTypoScriptSetup and addTypoScriptConstants - just with a little more hazzle, but also with some more options!)
1194 * FOR USE IN ext_localconf.php FILES
1195 * Usage: 7
1196 *
1197 * @param string $key is the extension key (informative only).
1198 * @param string $type is either "setup", "constants" or "editorcfg" and obviously determines which kind of TypoScript code we are adding.
1199 * @param string $content is the TS content, prefixed with a [GLOBAL] line and a comment-header.
1200 * @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.
1201 * @return void
1202 */
1203 public static function addTypoScript($key, $type, $content, $afterStaticUid = 0) {
1204 global $TYPO3_CONF_VARS;
1205
1206 if ($type=='setup' || $type=='editorcfg' || $type=='constants') {
1207 $content = '
1208
1209 [GLOBAL]
1210 #############################################
1211 ## TypoScript added by extension "'.$key.'"
1212 #############################################
1213
1214 '.$content;
1215 if ($afterStaticUid) {
1216 $TYPO3_CONF_VARS['FE']['defaultTypoScript_'.$type.'.'][$afterStaticUid].=$content;
1217 // If 'content (default)' is targeted, also add to other 'content rendering templates', eg. css_styled_content
1218 if ($afterStaticUid==43 && is_array($TYPO3_CONF_VARS['FE']['contentRenderingTemplates'])) {
1219 foreach ($TYPO3_CONF_VARS['FE']['contentRenderingTemplates'] as $templateName) {
1220 $TYPO3_CONF_VARS['FE']['defaultTypoScript_'.$type.'.'][$templateName] .= $content;
1221 }
1222 }
1223 } else {
1224 $TYPO3_CONF_VARS['FE']['defaultTypoScript_'.$type].=$content;
1225 }
1226 }
1227 }
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246 /**************************************
1247 *
1248 * INTERNAL EXTENSION MANAGEMENT:
1249 *
1250 ***************************************/
1251
1252 /**
1253 * Loading extensions configured in $TYPO3_CONF_VARS['EXT']['extList']
1254 *
1255 * CACHING ON: ($TYPO3_CONF_VARS['EXT']['extCache'] = 1 or 2)
1256 * 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.
1257 * If cachefiles are not found they will be generated
1258 * CACHING OFF: ($TYPO3_CONF_VARS['EXT']['extCache'] = 0)
1259 * 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.
1260 * This array will later be set in the global var $TYPO3_LOADED_EXT
1261 *
1262 * Usages of this function can be seen in config_default.php
1263 * Extensions are always detected in the order local - global - system.
1264 * Usage: 1
1265 *
1266 * @return array Extension Array
1267 * @internal
1268 */
1269 public static function typo3_loadExtensions() {
1270 global $TYPO3_CONF_VARS;
1271
1272 // Select mode how to load extensions in order to speed up the FE
1273 if (TYPO3_MODE == 'FE') {
1274 if (!($extLoadInContext = $TYPO3_CONF_VARS['EXT']['extList_FE'])) {
1275 // fall back to standard 'extList' if 'extList_FE' is not (yet) set
1276 $extLoadInContext = $TYPO3_CONF_VARS['EXT']['extList'];
1277 }
1278 $cacheFileSuffix = '_FE';
1279 } else {
1280 $extLoadInContext = $TYPO3_CONF_VARS['EXT']['extList'];
1281 // Works as before
1282 $cacheFileSuffix = '';
1283 }
1284 // Full list of extensions includes both required and extList:
1285 $rawExtList = $TYPO3_CONF_VARS['EXT']['requiredExt'] . ',' . $extLoadInContext;
1286
1287 // Empty array as a start.
1288 $extensions = array();
1289
1290 //
1291 if ($rawExtList) {
1292 // The cached File prefix.
1293 $cacheFilePrefix = 'temp_CACHED' . $cacheFileSuffix;
1294 // Setting the name for the cache files:
1295 if (intval($TYPO3_CONF_VARS['EXT']['extCache'])==1) $cacheFilePrefix.= '_ps'.substr(t3lib_div::shortMD5(PATH_site.'|'.$GLOBALS['TYPO_VERSION']), 0, 4);
1296 if (intval($TYPO3_CONF_VARS['EXT']['extCache'])==2) $cacheFilePrefix.= '_'.t3lib_div::shortMD5($rawExtList);
1297
1298 // If cache files available, set cache file prefix and return:
1299 if ($TYPO3_CONF_VARS['EXT']['extCache'] && self::isCacheFilesAvailable($cacheFilePrefix)) {
1300 // Return cache file prefix:
1301 $extensions['_CACHEFILE'] = $cacheFilePrefix;
1302 } else { // ... but if not, configure...
1303
1304 // Prepare reserved filenames:
1305 $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');
1306 // Traverse extensions and check their existence:
1307 clearstatcache(); // Clear file state cache to make sure we get good results from is_dir()
1308 $temp_extensions = array_unique(t3lib_div::trimExplode(',', $rawExtList, 1));
1309 foreach($temp_extensions as $temp_extKey) {
1310 // Check local, global and system locations:
1311 if (@is_dir(PATH_typo3conf.'ext/'.$temp_extKey.'/')) {
1312 $extensions[$temp_extKey] = array('type'=>'L', 'siteRelPath'=>'typo3conf/ext/'.$temp_extKey.'/', 'typo3RelPath'=>'../typo3conf/ext/'.$temp_extKey.'/');
1313 } elseif (@is_dir(PATH_typo3.'ext/'.$temp_extKey.'/')) {
1314 $extensions[$temp_extKey] = array('type'=>'G', 'siteRelPath'=>TYPO3_mainDir.'ext/'.$temp_extKey.'/', 'typo3RelPath'=>'ext/'.$temp_extKey.'/');
1315 } elseif (@is_dir(PATH_typo3.'sysext/'.$temp_extKey.'/')) {
1316 $extensions[$temp_extKey] = array('type'=>'S', 'siteRelPath'=>TYPO3_mainDir.'sysext/'.$temp_extKey.'/', 'typo3RelPath'=>'sysext/'.$temp_extKey.'/');
1317 }
1318
1319 // If extension was found, check for reserved filenames:
1320 if (isset($extensions[$temp_extKey])) {
1321 foreach($files as $fName) {
1322 $temp_filename = PATH_site.$extensions[$temp_extKey]['siteRelPath'].trim($fName);
1323 if (is_array($extensions[$temp_extKey]) && @is_file($temp_filename)) {
1324 $extensions[$temp_extKey][$fName] = $temp_filename;
1325 }
1326 }
1327 }
1328 }
1329 unset($extensions['_CACHEFILE']);
1330
1331 // write cache?
1332 if ($TYPO3_CONF_VARS['EXT']['extCache'] &&
1333 @is_dir(PATH_typo3.'sysext/') &&
1334 @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!
1335 $wrError = self::cannotCacheFilesWritable($cacheFilePrefix);
1336 if ($wrError) {
1337 $TYPO3_CONF_VARS['EXT']['extCache'] = 0;
1338 } else {
1339 // Write cache files:
1340 $extensions = self::writeCacheFiles($extensions, $cacheFilePrefix);
1341 }
1342 }
1343 }
1344 }
1345
1346 return $extensions;
1347 }
1348
1349 /**
1350 * Returns the section headers for the compiled cache-files.
1351 *
1352 * @param string $key is the extension key
1353 * @param string $file is the filename (only informative for comment)
1354 * @return string
1355 * @internal
1356 */
1357 public static function _makeIncludeHeader($key, $file) {
1358 return '<?php
1359 ###########################
1360 ## EXTENSION: '.$key.'
1361 ## FILE: '.$file.'
1362 ###########################
1363
1364 $_EXTKEY = \''.$key.'\';
1365 $_EXTCONF = $TYPO3_CONF_VARS[\'EXT\'][\'extConf\'][$_EXTKEY];
1366
1367 ?>';
1368 }
1369
1370 /**
1371 * Returns true if both the localconf and tables cache file exists (with $cacheFilePrefix)
1372 * Usage: 2
1373 *
1374 * @param string Prefix of the cache file to check
1375 * @return boolean
1376 * @internal
1377 */
1378 public static function isCacheFilesAvailable($cacheFilePrefix) {
1379 return
1380 @is_file(PATH_typo3conf.$cacheFilePrefix.'_ext_localconf.php') &&
1381 @is_file(PATH_typo3conf.$cacheFilePrefix.'_ext_tables.php');
1382 }
1383
1384 /**
1385 * Returns true if the "localconf.php" file in "typo3conf/" is writable
1386 * Usage: 1
1387 *
1388 * @return boolean
1389 * @internal
1390 */
1391 public static function isLocalconfWritable() {
1392 return @is_writable(PATH_typo3conf) && @is_writable(PATH_typo3conf.'localconf.php');
1393 }
1394
1395 /**
1396 * Returns an error string if typo3conf/ or cache-files with $cacheFilePrefix are NOT writable
1397 * Returns false if no problem.
1398 * Usage: 1
1399 *
1400 * @param string Prefix of the cache file to check
1401 * @return string
1402 * @internal
1403 */
1404 public static function cannotCacheFilesWritable($cacheFilePrefix) {
1405 $error = array();
1406 if (!@is_writable(PATH_typo3conf)) {
1407 $error[] = PATH_typo3conf;
1408 }
1409 if (@is_file(PATH_typo3conf.$cacheFilePrefix.'_ext_localconf.php') &&
1410 !@is_writable(PATH_typo3conf.$cacheFilePrefix.'_ext_localconf.php')) {
1411 $error[] = PATH_typo3conf.$cacheFilePrefix.'_ext_localconf.php';
1412 }
1413 if (@is_file(PATH_typo3conf.$cacheFilePrefix.'_ext_tables.php') &&
1414 !@is_writable(PATH_typo3conf.$cacheFilePrefix.'_ext_tables.php')) {
1415 $error[] = PATH_typo3conf.$cacheFilePrefix.'_ext_tables.php';
1416 }
1417 return implode(', ', $error);
1418 }
1419
1420 /**
1421 * Returns an array with the two cache-files (0=>localconf, 1=>tables) from typo3conf/ if they (both) exist. Otherwise false.
1422 * Evaluation relies on $TYPO3_LOADED_EXT['_CACHEFILE']
1423 * Usage: 2
1424 *
1425 * @return array
1426 * @internal
1427 */
1428 public static function currentCacheFiles() {
1429 if (($cacheFilePrefix = $GLOBALS['TYPO3_LOADED_EXT']['_CACHEFILE'])) {
1430 $cacheFilePrefixFE = str_replace('temp_CACHED','temp_CACHED_FE',$cacheFilePrefix);
1431 $files = array();
1432 if (self::isCacheFilesAvailable($cacheFilePrefix)) {
1433 $files[] = PATH_typo3conf.$cacheFilePrefix.'_ext_localconf.php';
1434 $files[] = PATH_typo3conf.$cacheFilePrefix.'_ext_tables.php';
1435 }
1436 if (self::isCacheFilesAvailable($cacheFilePrefixFE)) {
1437 $files[] = PATH_typo3conf.$cacheFilePrefixFE.'_ext_localconf.php';
1438 $files[] = PATH_typo3conf.$cacheFilePrefixFE.'_ext_tables.php';
1439 }
1440 if (!empty($files)) {
1441 return $files;
1442 }
1443 }
1444 }
1445
1446 /**
1447 * Compiles/Creates the two cache-files in typo3conf/ based on $cacheFilePrefix
1448 * Returns a array with the key "_CACHEFILE" set to the $cacheFilePrefix value
1449 * Usage: 1
1450 *
1451 * @param array Extension information array
1452 * @param string Prefix for the cache files
1453 * @return array
1454 * @internal
1455 */
1456 public static function writeCacheFiles($extensions, $cacheFilePrefix) {
1457 // Making cache files:
1458 $extensions['_CACHEFILE'] = $cacheFilePrefix;
1459 $cFiles = array();
1460 $cFiles['ext_localconf'].='<?php
1461
1462 $TYPO3_LOADED_EXT = unserialize(stripslashes(\''.addslashes(serialize($extensions)).'\'));
1463
1464 ?>';
1465
1466 foreach ($extensions as $key => $conf) {
1467 if (is_array($conf)) {
1468 if ($conf['ext_localconf.php']) {
1469 $cFiles['ext_localconf'] .= self::_makeIncludeHeader($key, $conf['ext_localconf.php']);
1470 $cFiles['ext_localconf'] .= trim(t3lib_div::getUrl($conf['ext_localconf.php']));
1471 }
1472 if ($conf['ext_tables.php']) {
1473 $cFiles['ext_tables'] .= self::_makeIncludeHeader($key, $conf['ext_tables.php']);
1474 $cFiles['ext_tables'] .= trim(t3lib_div::getUrl($conf['ext_tables.php']));
1475 }
1476 }
1477 }
1478
1479 $cFiles['ext_localconf'] = "<?php\n" . preg_replace('/<\?php|\?>/is', '', $cFiles['ext_localconf']) . "?>\n";
1480 $cFiles['ext_tables'] = "<?php\n" . preg_replace('/<\?php|\?>/is', '', $cFiles['ext_tables']) . "?>\n";
1481
1482 t3lib_div::writeFile(PATH_typo3conf.$cacheFilePrefix.'_ext_localconf.php', $cFiles['ext_localconf']);
1483 t3lib_div::writeFile(PATH_typo3conf.$cacheFilePrefix.'_ext_tables.php', $cFiles['ext_tables']);
1484
1485 $extensions = array();
1486 $extensions['_CACHEFILE'] = $cacheFilePrefix;
1487
1488 return $extensions;
1489 }
1490
1491 /**
1492 * Unlink (delete) cache files
1493 *
1494 * @return integer Number of deleted files.
1495 */
1496 public static function removeCacheFiles() {
1497 $cacheFiles = self::currentCacheFiles();
1498 $out = 0;
1499 if (is_array($cacheFiles)) {
1500 reset($cacheFiles);
1501 foreach($cacheFiles as $cfile) {
1502 @unlink($cfile);
1503 clearstatcache();
1504 $out++;
1505 }
1506 }
1507 return $out;
1508 }
1509 }
1510
1511 ?>