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