Reverted bug #9897 (rev. 4661) - will commit a new solution in a minute
[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 $fields = self::getFieldsOfFieldList($types[$type]['showitem']);
319 if (isset($fields[$field])) {
320 // If the field already has a palette, extend it:
321 if ($fields[$field]['details']['palette']) {
322 $palette = $fields[$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 $fields[$field]['details']['palette'] = $palette;
333 $types[$type]['showitem'] = self::generateFieldList($fields);
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 $fields = self::getFieldsOfFieldList($list);
398 $isInserted = false;
399 // Iterate through all fields an check whether it's possible to inserte there:
400 foreach ($fields as $field => &$fieldDetails) {
401 $needles = self::getInsertionNeedles($field, $fieldDetails['details']);
402 // Insert data before:
403 foreach ($needles['before'] as $needle) {
404 if (in_array($needle, $positions)) {
405 $fieldDetails['rawData'] = $insertionList . ', ' . $fieldDetails['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 $fieldDetails['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::generateFieldList($fields, 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 $field: The name of the field/item
475 * @param array $fieldDetails: Additional details of the field like e.g. palette information
476 * (this array gets created by the function getFieldsOfFieldList())
477 * @return array The needled to be used for inserting content before or after existing fields/items
478 */
479 protected static function getInsertionNeedles($field, array $fieldDetails) {
480 $needles = array(
481 'before' => array($field, 'before:' . $field),
482 'after' => array('after:' . $field),
483 );
484
485 if ($fieldDetails['palette']) {
486 $palette = $field . ';;' . $fieldDetails['palette'];
487 $needles['before'][] = $palette;
488 $needles['before'][] = 'before:' . $palette;
489 $needles['afer'][] = 'after:' . $palette;
490 }
491
492 return $needles;
493 }
494
495 /**
496 * Generates an array of fields with additional information such as e.g. the name of the palette.
497 *
498 * @param string $fieldList: List of fields/items to be splitted up
499 * (this mostly reflects the data in $TCA[<table>]['types'][<type>]['showitem'])
500 * @return array An array with the names of the fields as keys and additional information
501 */
502 protected static function getFieldsOfFieldList($fieldList) {
503 $fields = array();
504 $fieldParts = t3lib_div::trimExplode(',', $fieldList, true);
505
506 foreach ($fieldParts as $fieldPart) {
507 $fieldDetails = t3lib_div::trimExplode(';', $fieldPart, false, 5);
508 if (!isset($fields[$fieldDetails[0]])) {
509 $fields[$fieldDetails[0]] = array(
510 'rawData' => $fieldPart,
511 'details' => array(
512 'field' => $fieldDetails[0],
513 'label' => $fieldDetails[1],
514 'palette' => $fieldDetails[2],
515 'special' => $fieldDetails[3],
516 'styles' => $fieldDetails[4],
517 ),
518 );
519 }
520 }
521
522 return $fields;
523 }
524
525 /**
526 * Generates a list of fields/items out of an array provided by the function getFieldsOfFieldList().
527 *
528 * @see getFieldsOfFieldList
529 * @param array $fields: The array of fields with optional additional information
530 * @param boolean $useRawData: Use raw data instead of building by using the details (default: false)
531 * @return string The list of fields/items which gets used for $TCA[<table>]['types'][<type>]['showitem']
532 * or $TCA[<table>]['palettes'][<palette>]['showitem'] in most cases
533 */
534 protected static function generateFieldList(array $fields, $useRawData = false) {
535 $fieldParts = array();
536
537 foreach ($fields as $field => $fieldDetails) {
538 if ($useRawData) {
539 $fieldParts[] = $fieldDetails['rawData'];
540 } else {
541 $fieldParts[] = (count($fieldDetails['details']) > 1 ? implode(';', $fieldDetails['details']) : $field);
542 }
543 }
544
545 return implode(', ', $fieldParts);
546 }
547
548 /**
549 * Add tablename to default list of allowed tables on pages (in $PAGES_TYPES)
550 * Will add the $table to the list of tables allowed by default on pages as setup by $PAGES_TYPES['default']['allowedTables']
551 * FOR USE IN ext_tables.php FILES
552 * Usage: 11
553 *
554 * @param string Table name
555 * @return void
556 */
557 public static function allowTableOnStandardPages($table) {
558 global $PAGES_TYPES;
559
560 $PAGES_TYPES['default']['allowedTables'].=','.$table;
561 }
562
563 /**
564 * Adds a module (main or sub) to the backend interface
565 * FOR USE IN ext_tables.php FILES
566 * Usage: 18
567 *
568 * @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.
569 * @param string $sub is the submodule key. If $sub is not set a blank $main module is created.
570 * @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.
571 * @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.
572 * @return void
573 */
574 public static function addModule($main, $sub = '', $position = '', $path = '') {
575 global $TBE_MODULES;
576
577 if (isset($TBE_MODULES[$main]) && $sub) { // If there is already a main module by this name:
578
579 // Adding the submodule to the correct position:
580 list($place, $modRef) = t3lib_div::trimExplode(':', $position, 1);
581 $mods = t3lib_div::trimExplode(',', $TBE_MODULES[$main], 1);
582 if (!in_array($sub, $mods)) {
583 switch(strtolower($place)) {
584 case 'after':
585 case 'before':
586 $pointer = 0;
587 reset($mods);
588 while(list($k, $m) = each($mods)) {
589 if (!strcmp($m, $modRef)) {
590 $pointer = strtolower($place)=='after'?$k+1:$k;
591 }
592 }
593 array_splice(
594 $mods, // The modules array
595 $pointer, // To insert one position from the end of the list
596 0, // Don't remove any items, just insert
597 $sub // Module to insert
598 );
599 break;
600 default:
601 if (strtolower($place)=='top') {
602 array_unshift($mods, $sub);
603 } else {
604 array_push($mods, $sub);
605 }
606 break;
607 }
608 }
609 // Re-inserting the submodule list:
610 $TBE_MODULES[$main] = implode(',', $mods);
611 } else { // Create new main modules with only one submodule, $sub (or none if $sub is blank)
612 $TBE_MODULES[$main] = $sub;
613 }
614
615 // Adding path:
616 if ($path) {
617 $TBE_MODULES['_PATHS'][$main.($sub?'_'.$sub:'')] = $path;
618 }
619 }
620
621 /**
622 * Adds a module path to TBE_MODULES for used with the module dispatcher, mod.php
623 * Used only for modules that are not placed in the main/sub menu hierarchy by the traditional mechanism of addModule()
624 * Examples for this is context menu functionality (like import/export) which runs as an independent module through mod.php
625 * FOR USE IN ext_tables.php FILES
626 * Example: t3lib_extMgm::addModulePath('xMOD_tximpexp', t3lib_extMgm::extPath($_EXTKEY).'app/');
627 *
628 * @param string $name is the name of the module, refer to conf.php of the module.
629 * @param string $path is the absolute path to the module directory inside of which "index.php" and "conf.php" is found.
630 * @return void
631 */
632 public static function addModulePath($name, $path) {
633 global $TBE_MODULES;
634
635 $TBE_MODULES['_PATHS'][$name] = $path;
636 }
637
638 /**
639 * Adds a "Function menu module" ('third level module') to an existing function menu for some other backend module
640 * The arguments values are generally determined by which function menu this is supposed to interact with
641 * See Inside TYPO3 for information on how to use this function.
642 * FOR USE IN ext_tables.php FILES
643 * Usage: 26
644 *
645 * @param string Module name
646 * @param string Class name
647 * @param string Class path
648 * @param string Title of module
649 * @param string Menu array key - default is "function"
650 * @param string Workspace conditions. Blank means all workspaces, any other string can be a comma list of "online", "offline" and "custom"
651 * @return void
652 * @see t3lib_SCbase::mergeExternalItems()
653 */
654 public static function insertModuleFunction($modname, $className, $classPath, $title, $MM_key = 'function', $WS = '') {
655 global $TBE_MODULES_EXT;
656 $TBE_MODULES_EXT[$modname]['MOD_MENU'][$MM_key][$className] = array(
657 'name' => $className,
658 'path' => $classPath,
659 'title' => $title,
660 'ws' => $WS
661 );
662 }
663
664 /**
665 * Adds $content to the default Page TSconfig as set in $TYPO3_CONF_VARS[BE]['defaultPageTSconfig']
666 * Prefixed with a [GLOBAL] line
667 * FOR USE IN ext_tables.php/ext_localconf.php FILES
668 * Usage: 5
669 *
670 * @param string Page TSconfig content
671 * @return void
672 */
673 public static function addPageTSConfig($content) {
674 global $TYPO3_CONF_VARS;
675 $TYPO3_CONF_VARS['BE']['defaultPageTSconfig'].="\n[GLOBAL]\n".$content;
676 }
677
678 /**
679 * Adds $content to the default User TSconfig as set in $TYPO3_CONF_VARS[BE]['defaultUserTSconfig']
680 * Prefixed with a [GLOBAL] line
681 * FOR USE IN ext_tables.php/ext_localconf.php FILES
682 * Usage: 3
683 *
684 * @param string User TSconfig content
685 * @return void
686 */
687 public static function addUserTSConfig($content) {
688 global $TYPO3_CONF_VARS;
689 $TYPO3_CONF_VARS['BE']['defaultUserTSconfig'].="\n[GLOBAL]\n".$content;
690 }
691
692 /**
693 * Adds a reference to a locallang file with TCA_DESCR labels
694 * FOR USE IN ext_tables.php FILES
695 * 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.
696 * Usage: 31
697 *
698 * @param string Description key. Typically a database table (like "pages") but for applications can be other strings, but prefixed with "_MOD_")
699 * @param string File reference to locallang file, eg. "EXT:lang/locallang_csh_pages.php" (or ".xml")
700 * @return void
701 */
702 public static function addLLrefForTCAdescr($tca_descr_key, $file_ref) {
703 global $TCA_DESCR;
704 if ($tca_descr_key) {
705 if (!is_array($TCA_DESCR[$tca_descr_key])) {
706 $TCA_DESCR[$tca_descr_key] = array();
707 }
708 if (!is_array($TCA_DESCR[$tca_descr_key]['refs'])) {
709 $TCA_DESCR[$tca_descr_key]['refs'] = array();
710 }
711 $TCA_DESCR[$tca_descr_key]['refs'][] = $file_ref;
712 }
713 }
714
715
716
717
718
719
720
721
722
723
724
725
726 /**************************************
727 *
728 * Adding SERVICES features
729 *
730 * @author Ren? Fritz <r.fritz@colorcube.de>
731 *
732 ***************************************/
733
734 /**
735 * Adds a service to the global services array
736 *
737 * @param string Extension key
738 * @param string Service type, cannot be prefixed "tx_"
739 * @param string Service key, must be prefixed "tx_" or "user_"
740 * @param array Service description array
741 * @return void
742 * @author Ren? Fritz <r.fritz@colorcube.de>
743 */
744 public static function addService($extKey, $serviceType, $serviceKey, $info) {
745 global $T3_SERVICES, $TYPO3_CONF_VARS;
746
747 // even not available services will be included to make it possible to give the admin a feedback of non-available services.
748 // but maybe it's better to move non-available services to a different array??
749
750 if ($serviceType &&
751 !t3lib_div::isFirstPartOfStr($serviceType, 'tx_') &&
752 (t3lib_div::isFirstPartOfStr($serviceKey, 'tx_') || t3lib_div::isFirstPartOfStr($serviceKey, 'user_')) &&
753 is_array($info)) {
754
755 $info['priority'] = max(0, min(100, $info['priority']));
756
757 $T3_SERVICES[$serviceType][$serviceKey] = $info;
758
759 $T3_SERVICES[$serviceType][$serviceKey]['extKey'] = $extKey;
760 $T3_SERVICES[$serviceType][$serviceKey]['serviceKey'] = $serviceKey;
761 $T3_SERVICES[$serviceType][$serviceKey]['serviceType'] = $serviceType;
762
763
764 // mapping a service key to a service type
765 // all service keys begin with tx_ - service types don't
766 // this way a selection of a special service key as service type is easy
767 $T3_SERVICES[$serviceKey][$serviceKey] = &$T3_SERVICES[$serviceType][$serviceKey];
768
769
770 // change the priority (and other values) from TYPO3_CONF_VARS
771 // $TYPO3_CONF_VARS['T3_SERVICES'][$serviceType][$serviceKey]['priority']
772 // even the activation is possible (a unix service might be possible on windows for some reasons)
773 if (is_array($TYPO3_CONF_VARS['T3_SERVICES'][$serviceType][$serviceKey])) {
774
775 // no check is done here - there might be configuration values only the service type knows about, so we pass everything
776 $T3_SERVICES[$serviceType][$serviceKey] = array_merge ($T3_SERVICES[$serviceType][$serviceKey], $TYPO3_CONF_VARS['T3_SERVICES'][$serviceType][$serviceKey]);
777 }
778
779
780 // OS check
781 // empty $os means 'not limited to one OS', therefore a check is not needed
782 if ($T3_SERVICES[$serviceType][$serviceKey]['available'] && $T3_SERVICES[$serviceType][$serviceKey]['os']!='') {
783
784 // TYPO3_OS is not yet defined
785 $os_type = stristr(PHP_OS, 'win')&&!stristr(PHP_OS, 'darwin')?'WIN':'UNIX';
786
787 $os = t3lib_div::trimExplode(',', strtoupper($T3_SERVICES[$serviceType][$serviceKey]['os']));
788
789 if (!in_array($os_type, $os)) {
790 t3lib_extMgm::deactivateService($serviceType, $serviceKey);
791 }
792 }
793
794 // convert subtype list to array for quicker access
795 $T3_SERVICES[$serviceType][$serviceKey]['serviceSubTypes'] = array();
796 $serviceSubTypes = t3lib_div::trimExplode(',', $info['subtype']);
797 foreach ($serviceSubTypes as $subtype) {
798 $T3_SERVICES[$serviceType][$serviceKey]['serviceSubTypes'][$subtype] = $subtype;
799 }
800 }
801 }
802
803 /**
804 * Find the available service with highest priority
805 *
806 * @param string Service type
807 * @param string Service sub type
808 * @param mixed Service keys that should be excluded in the search for a service. Array or comma list.
809 * @return mixed Service info array if a service was found, FLASE otherwise
810 * @author Ren? Fritz <r.fritz@colorcube.de>
811 */
812 public static function findService($serviceType, $serviceSubType = '', $excludeServiceKeys = array()) {
813 global $T3_SERVICES, $TYPO3_CONF_VARS;
814
815 $serviceKey = FALSE;
816 $serviceInfo = FALSE;
817 $priority = 0;
818 $quality = 0;
819
820 if (!is_array($excludeServiceKeys) ) {
821 $excludeServiceKeys = t3lib_div::trimExplode(',', $excludeServiceKeys, 1);
822 }
823
824 if (is_array($T3_SERVICES[$serviceType])) {
825 foreach($T3_SERVICES[$serviceType] as $key => $info) {
826
827 if (in_array($key, $excludeServiceKeys)) {
828 continue;
829 }
830
831 // select a subtype randomly
832 // usefull to start a service by service key without knowing his subtypes - for testing purposes
833 if ($serviceSubType=='*') {
834 $serviceSubType = key($info['serviceSubTypes']);
835 }
836
837 // this matches empty subtype too
838 if ($info['available'] && ($info['subtype']==$serviceSubType || $info['serviceSubTypes'][$serviceSubType]) && $info['priority']>=$priority ) {
839
840 // has a lower quality than the already found, therefore we skip this service
841 if($info['priority']==$priority && $info['quality']<$quality) {
842 continue;
843 }
844
845 // service depends on external programs - check if they exists
846 if(trim($info['exec'])) {
847 $executables = t3lib_div::trimExplode(',', $info['exec'], 1);
848 foreach($executables as $executable) {
849 if(!t3lib_exec::checkCommand($executable)) {
850 t3lib_extMgm::deactivateService($serviceType, $key);
851 $info['available'] = FALSE;
852 break;
853 }
854 }
855 }
856
857 // still available after exec check?
858 if($info['available']) {
859 $serviceKey = $key;
860 $priority = $info['priority'];
861 $quality = $info['quality'];
862 }
863 }
864 }
865 }
866
867 if ($serviceKey) {
868 $serviceInfo = $T3_SERVICES[$serviceType][$serviceKey];
869 }
870 return $serviceInfo;
871 }
872
873 /**
874 * Deactivate a service
875 *
876 * @param string Service type
877 * @param string Service key
878 * @return void
879 * @author Ren? Fritz <r.fritz@colorcube.de>
880 */
881 public static function deactivateService($serviceType, $serviceKey) {
882 global $T3_SERVICES;
883
884 // ... maybe it's better to move non-available services to a different array??
885 $T3_SERVICES[$serviceType][$serviceKey]['available'] = FALSE;
886 }
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901 /**************************************
902 *
903 * Adding FRONTEND features
904 * (related specifically to "cms" extension)
905 *
906 ***************************************/
907
908 /**
909 * Adds an entry to the list of plugins in content elements of type "Insert plugin"
910 * 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)
911 * 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.
912 * 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
913 * FOR USE IN ext_tables.php FILES
914 * Usage: 13
915 *
916 * @param array Item Array
917 * @param string Type (eg. "list_type") - basically a field from "tt_content" table
918 * @return void
919 */
920 public static function addPlugin($itemArray, $type = 'list_type') {
921 global $TCA;
922
923 $_EXTKEY = $GLOBALS['_EXTKEY'];
924 if ($_EXTKEY && !$itemArray[2]) {
925 $itemArray[2] = t3lib_extMgm::extRelPath($_EXTKEY) . 'ext_icon.gif';
926 }
927
928 t3lib_div::loadTCA('tt_content');
929 if (is_array($TCA['tt_content']['columns']) && is_array($TCA['tt_content']['columns'][$type]['config']['items'])) {
930 reset($TCA['tt_content']['columns'][$type]['config']['items']);
931 while(list($k, $v) = each($TCA['tt_content']['columns'][$type]['config']['items'])) {
932 if (!strcmp($v[1], $itemArray[1])) {
933 $TCA['tt_content']['columns'][$type]['config']['items'][$k] = $itemArray;
934 return;
935 }
936 }
937 $TCA['tt_content']['columns'][$type]['config']['items'][] = $itemArray;
938 }
939 }
940
941 /**
942 * Adds an entry to the "ds" array of the tt_content field "pi_flexform".
943 * This is used by plugins to add a flexform XML reference / content for use when they are selected as plugin or content element.
944 * Usage: 0
945 *
946 * @param string Plugin key as used in the list_type field. Use the asterisk * to match all list_type values.
947 * @param string Either a reference to a flex-form XML file (eg. "FILE:EXT:newloginbox/flexform_ds.xml") or the XML directly.
948 * @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.
949 * @return void
950 * @see addPlugin()
951 */
952 public static function addPiFlexFormValue($piKeyToMatch, $value, $CTypeToMatch = 'list') {
953 global $TCA;
954 t3lib_div::loadTCA('tt_content');
955
956 if (is_array($TCA['tt_content']['columns']) && is_array($TCA['tt_content']['columns']['pi_flexform']['config']['ds'])) {
957 $TCA['tt_content']['columns']['pi_flexform']['config']['ds'][$piKeyToMatch.','.$CTypeToMatch] = $value;
958 }
959 }
960
961 /**
962 * Adds the $table tablename to the list of tables allowed to be includes by content element type "Insert records"
963 * By using $content_table and $content_field you can also use the function for other tables.
964 * FOR USE IN ext_tables.php FILES
965 * Usage: 9
966 *
967 * @param string Table name to allow for "insert record"
968 * @param string Table name TO WHICH the $table name is applied. See $content_field as well.
969 * @param string Field name in the database $content_table in which $table is allowed to be added as a reference ("Insert Record")
970 * @return void
971 */
972 public static function addToInsertRecords($table, $content_table = 'tt_content', $content_field = 'records') {
973 global $TCA;
974 t3lib_div::loadTCA($content_table);
975 if (is_array($TCA[$content_table]['columns']) && isset($TCA[$content_table]['columns'][$content_field]['config']['allowed'])) {
976 $TCA[$content_table]['columns'][$content_field]['config']['allowed'].=','.$table;
977 }
978 }
979
980 /**
981 * Add PlugIn to Static Template #43
982 *
983 * 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.
984 * 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"
985 * $type determines the type of frontend plugin:
986 * "list_type" (default) - the good old "Insert plugin" entry
987 * "menu_type" - a "Menu/Sitemap" entry
988 * "splash_layout" - a "Textbox" entry
989 * "CType" - a new content element type
990 * "header_layout" - an additional header type (added to the selection of layout1-5)
991 * "includeLib" - just includes the library for manual use somewhere in TypoScript.
992 * (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)
993 * FOR USE IN ext_localconf.php FILES
994 * Usage: 2
995 *
996 * @param string $key is the extension key
997 * @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.
998 * @param string $prefix is used as a - yes, suffix - of the class name (fx. "_pi1")
999 * @param string $type, see description above
1000 * @param boolean If $cached is set as USER content object (cObject) is created - otherwise a USER_INT object is created.
1001 * @return void
1002 */
1003 public static function addPItoST43($key, $classFile = '', $prefix = '', $type = 'list_type', $cached = 0) {
1004 global $TYPO3_LOADED_EXT;
1005 $classFile = $classFile ? $classFile : 'pi/class.tx_'.str_replace('_', '', $key).$prefix.'.php';
1006 $cN = t3lib_extMgm::getCN($key);
1007
1008 // General plugin:
1009 $pluginContent = trim('
1010 plugin.'.$cN.$prefix.' = USER' . ($cached ? '' : '_INT') . '
1011 plugin.'.$cN.$prefix.' {
1012 includeLibs = '.$TYPO3_LOADED_EXT[$key]['siteRelPath'].$classFile.'
1013 userFunc = '.$cN.$prefix.'->main
1014 }');
1015 t3lib_extMgm::addTypoScript($key, 'setup', '
1016 # Setting '.$key.' plugin TypoScript
1017 '.$pluginContent);
1018
1019 // After ST43:
1020 switch($type) {
1021 case 'list_type':
1022 $addLine = 'tt_content.list.20.'.$key.$prefix.' = < plugin.'.$cN.$prefix;
1023 break;
1024 case 'menu_type':
1025 $addLine = 'tt_content.menu.20.'.$key.$prefix.' = < plugin.'.$cN.$prefix;
1026 break;
1027 case 'splash_layout':
1028 $addLine = 'tt_content.splash.'.$key.$prefix.' = < plugin.'.$cN.$prefix;
1029 break;
1030 case 'CType':
1031 $addLine = trim('
1032 tt_content.'.$key.$prefix.' = COA
1033 tt_content.'.$key.$prefix.' {
1034 10 = < lib.stdheader
1035 20 = < plugin.'.$cN.$prefix.'
1036 }
1037 ');
1038 break;
1039 case 'header_layout':
1040 $addLine = 'lib.stdheader.10.'.$key.$prefix.' = < plugin.'.$cN.$prefix;
1041 break;
1042 case 'includeLib':
1043 $addLine = 'page.1000 = < plugin.'.$cN.$prefix;
1044 break;
1045 default:
1046 $addLine = '';
1047 break;
1048 }
1049 if ($addLine) {
1050 t3lib_extMgm::addTypoScript($key, 'setup', '
1051 # Setting '.$key.' plugin TypoScript
1052 '.$addLine.'
1053 ', 43);
1054 }
1055 }
1056
1057 /**
1058 * Call this method to add an entry in the static template list found in sys_templates
1059 * "static template files" are the modern equalent (provided from extensions) to the traditional records in "static_templates"
1060 * FOR USE IN ext_localconf.php FILES
1061 * Usage: 3
1062 *
1063 * @param string $extKey is of course the extension key
1064 * @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/
1065 * @param string $title is the title in the selector box.
1066 * @return void
1067 * @see addTypoScript()
1068 */
1069 public static function addStaticFile($extKey, $path, $title) {
1070 global $TCA;
1071 t3lib_div::loadTCA('sys_template');
1072 if ($extKey && $path && is_array($TCA['sys_template']['columns'])) {
1073 $value = str_replace(',', '', 'EXT:'.$extKey.'/'.$path);
1074 $itemArray = array(trim($title.' ('.$extKey.')'), $value);
1075 $TCA['sys_template']['columns']['include_static_file']['config']['items'][] = $itemArray;
1076 }
1077 }
1078
1079 /**
1080 * Adds $content to the default TypoScript setup code as set in $TYPO3_CONF_VARS[FE]['defaultTypoScript_setup']
1081 * Prefixed with a [GLOBAL] line
1082 * FOR USE IN ext_localconf.php FILES
1083 * Usage: 6
1084 *
1085 * @param string TypoScript Setup string
1086 * @return void
1087 */
1088 public static function addTypoScriptSetup($content) {
1089 global $TYPO3_CONF_VARS;
1090 $TYPO3_CONF_VARS['FE']['defaultTypoScript_setup'].="\n[GLOBAL]\n".$content;
1091 }
1092
1093 /**
1094 * Adds $content to the default TypoScript constants code as set in $TYPO3_CONF_VARS[FE]['defaultTypoScript_constants']
1095 * Prefixed with a [GLOBAL] line
1096 * FOR USE IN ext_localconf.php FILES
1097 * Usage: 0
1098 *
1099 * @param string TypoScript Constants string
1100 * @return void
1101 */
1102 public static function addTypoScriptConstants($content) {
1103 global $TYPO3_CONF_VARS;
1104 $TYPO3_CONF_VARS['FE']['defaultTypoScript_constants'].="\n[GLOBAL]\n".$content;
1105 }
1106
1107 /**
1108 * Adds $content to the default TypoScript code for either setup, constants or editorcfg as set in $TYPO3_CONF_VARS[FE]['defaultTypoScript_*']
1109 * (Basically this function can do the same as addTypoScriptSetup and addTypoScriptConstants - just with a little more hazzle, but also with some more options!)
1110 * FOR USE IN ext_localconf.php FILES
1111 * Usage: 7
1112 *
1113 * @param string $key is the extension key (informative only).
1114 * @param string $type is either "setup", "constants" or "editorcfg" and obviously determines which kind of TypoScript code we are adding.
1115 * @param string $content is the TS content, prefixed with a [GLOBAL] line and a comment-header.
1116 * @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.
1117 * @return void
1118 */
1119 public static function addTypoScript($key, $type, $content, $afterStaticUid = 0) {
1120 global $TYPO3_CONF_VARS;
1121
1122 if ($type=='setup' || $type=='editorcfg' || $type=='constants') {
1123 $content = '
1124
1125 [GLOBAL]
1126 #############################################
1127 ## TypoScript added by extension "'.$key.'"
1128 #############################################
1129
1130 '.$content;
1131 if ($afterStaticUid) {
1132 $TYPO3_CONF_VARS['FE']['defaultTypoScript_'.$type.'.'][$afterStaticUid].=$content;
1133 // TODO: find a dynamic way to add default TS to all versions of css_style_content
1134 if ($afterStaticUid==43) { // If 'content (default)' is targeted, also add to other 'content rendering templates', eg. css_styled_content
1135 $TYPO3_CONF_VARS['FE']['defaultTypoScript_'.$type.'.']['cssstyledcontent/static/'] .= $content;
1136 $TYPO3_CONF_VARS['FE']['defaultTypoScript_'.$type.'.']['cssstyledcontent/static/v4.2/'] .= $content;
1137 $TYPO3_CONF_VARS['FE']['defaultTypoScript_'.$type.'.']['cssstyledcontent/static/v3.9/'] .= $content;
1138 $TYPO3_CONF_VARS['FE']['defaultTypoScript_'.$type.'.']['cssstyledcontent/static/v3.8/'] .= $content;
1139 }
1140 } else {
1141 $TYPO3_CONF_VARS['FE']['defaultTypoScript_'.$type].=$content;
1142 }
1143 }
1144 }
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163 /**************************************
1164 *
1165 * INTERNAL EXTENSION MANAGEMENT:
1166 *
1167 ***************************************/
1168
1169 /**
1170 * Loading extensions configured in $TYPO3_CONF_VARS['EXT']['extList']
1171 *
1172 * CACHING ON: ($TYPO3_CONF_VARS['EXT']['extCache'] = 1 or 2)
1173 * 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.
1174 * If cachefiles are not found they will be generated
1175 * CACHING OFF: ($TYPO3_CONF_VARS['EXT']['extCache'] = 0)
1176 * 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.
1177 * This array will later be set in the global var $TYPO3_LOADED_EXT
1178 *
1179 * Usages of this function can be seen in config_default.php
1180 * Extensions are always detected in the order local - global - system.
1181 * Usage: 1
1182 *
1183 * @return array Extension Array
1184 * @internal
1185 */
1186 public static function typo3_loadExtensions() {
1187 global $TYPO3_CONF_VARS;
1188
1189 // Full list of extensions includes both required and extList:
1190 $rawExtList = $TYPO3_CONF_VARS['EXT']['requiredExt'].','.$TYPO3_CONF_VARS['EXT']['extList'];
1191
1192 // Empty array as a start.
1193 $extensions = array();
1194
1195 //
1196 if ($rawExtList) {
1197 // The cached File prefix.
1198 $cacheFilePrefix = 'temp_CACHED';
1199 // Setting the name for the cache files:
1200 if (intval($TYPO3_CONF_VARS['EXT']['extCache'])==1) $cacheFilePrefix.= '_ps'.substr(t3lib_div::shortMD5(PATH_site.'|'.$GLOBALS['TYPO_VERSION']), 0, 4);
1201 if (intval($TYPO3_CONF_VARS['EXT']['extCache'])==2) $cacheFilePrefix.= '_'.t3lib_div::shortMD5($rawExtList);
1202
1203 // If cache files available, set cache file prefix and return:
1204 if ($TYPO3_CONF_VARS['EXT']['extCache'] && t3lib_extMgm::isCacheFilesAvailable($cacheFilePrefix)) {
1205 // Return cache file prefix:
1206 $extensions['_CACHEFILE'] = $cacheFilePrefix;
1207 } else { // ... but if not, configure...
1208
1209 // Prepare reserved filenames:
1210 $files = t3lib_div::trimExplode(',', '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', 1);
1211
1212 // Traverse extensions and check their existence:
1213 clearstatcache(); // Clear file state cache to make sure we get good results from is_dir()
1214 $temp_extensions = array_unique(t3lib_div::trimExplode(',', $rawExtList, 1));
1215 foreach($temp_extensions as $temp_extKey) {
1216 // Check local, global and system locations:
1217 if (@is_dir(PATH_typo3conf.'ext/'.$temp_extKey.'/')) {
1218 $extensions[$temp_extKey] = array('type'=>'L', 'siteRelPath'=>'typo3conf/ext/'.$temp_extKey.'/', 'typo3RelPath'=>'../typo3conf/ext/'.$temp_extKey.'/');
1219 } elseif (@is_dir(PATH_typo3.'ext/'.$temp_extKey.'/')) {
1220 $extensions[$temp_extKey] = array('type'=>'G', 'siteRelPath'=>TYPO3_mainDir.'ext/'.$temp_extKey.'/', 'typo3RelPath'=>'ext/'.$temp_extKey.'/');
1221 } elseif (@is_dir(PATH_typo3.'sysext/'.$temp_extKey.'/')) {
1222 $extensions[$temp_extKey] = array('type'=>'S', 'siteRelPath'=>TYPO3_mainDir.'sysext/'.$temp_extKey.'/', 'typo3RelPath'=>'sysext/'.$temp_extKey.'/');
1223 }
1224
1225 // If extension was found, check for reserved filenames:
1226 if (isset($extensions[$temp_extKey])) {
1227 foreach($files as $fName) {
1228 $temp_filename = PATH_site.$extensions[$temp_extKey]['siteRelPath'].trim($fName);
1229 if (is_array($extensions[$temp_extKey]) && @is_file($temp_filename)) {
1230 $extensions[$temp_extKey][$fName] = $temp_filename;
1231 }
1232 }
1233 }
1234 }
1235 unset($extensions['_CACHEFILE']);
1236
1237 // write cache?
1238 if ($TYPO3_CONF_VARS['EXT']['extCache'] &&
1239 @is_dir(PATH_typo3.'sysext/') &&
1240 @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!
1241 $wrError = t3lib_extMgm::cannotCacheFilesWritable($cacheFilePrefix);
1242 if ($wrError) {
1243 $TYPO3_CONF_VARS['EXT']['extCache'] = 0;
1244 } else {
1245 // Write cache files:
1246 $extensions = t3lib_extMgm::writeCacheFiles($extensions, $cacheFilePrefix);
1247 }
1248 }
1249 }
1250 }
1251
1252 return $extensions;
1253 }
1254
1255 /**
1256 * Returns the section headers for the compiled cache-files.
1257 *
1258 * @param string $key is the extension key
1259 * @param string $file is the filename (only informative for comment)
1260 * @return string
1261 * @internal
1262 */
1263 public static function _makeIncludeHeader($key, $file) {
1264 return '<?php
1265 ###########################
1266 ## EXTENSION: '.$key.'
1267 ## FILE: '.$file.'
1268 ###########################
1269
1270 $_EXTKEY = \''.$key.'\';
1271 $_EXTCONF = $TYPO3_CONF_VARS[\'EXT\'][\'extConf\'][$_EXTKEY];
1272
1273 ?>';
1274 }
1275
1276 /**
1277 * Returns true if both the localconf and tables cache file exists (with $cacheFilePrefix)
1278 * Usage: 2
1279 *
1280 * @param string Prefix of the cache file to check
1281 * @return boolean
1282 * @internal
1283 */
1284 public static function isCacheFilesAvailable($cacheFilePrefix) {
1285 return
1286 @is_file(PATH_typo3conf.$cacheFilePrefix.'_ext_localconf.php') &&
1287 @is_file(PATH_typo3conf.$cacheFilePrefix.'_ext_tables.php');
1288 }
1289
1290 /**
1291 * Returns true if the "localconf.php" file in "typo3conf/" is writable
1292 * Usage: 1
1293 *
1294 * @return boolean
1295 * @internal
1296 */
1297 public static function isLocalconfWritable() {
1298 return @is_writable(PATH_typo3conf) && @is_writable(PATH_typo3conf.'localconf.php');
1299 }
1300
1301 /**
1302 * Returns an error string if typo3conf/ or cache-files with $cacheFilePrefix are NOT writable
1303 * Returns false if no problem.
1304 * Usage: 1
1305 *
1306 * @param string Prefix of the cache file to check
1307 * @return string
1308 * @internal
1309 */
1310 public static function cannotCacheFilesWritable($cacheFilePrefix) {
1311 $error = array();
1312 if (!@is_writable(PATH_typo3conf)) {
1313 $error[] = PATH_typo3conf;
1314 }
1315 if (@is_file(PATH_typo3conf.$cacheFilePrefix.'_ext_localconf.php') &&
1316 !@is_writable(PATH_typo3conf.$cacheFilePrefix.'_ext_localconf.php')) {
1317 $error[] = PATH_typo3conf.$cacheFilePrefix.'_ext_localconf.php';
1318 }
1319 if (@is_file(PATH_typo3conf.$cacheFilePrefix.'_ext_tables.php') &&
1320 !@is_writable(PATH_typo3conf.$cacheFilePrefix.'_ext_tables.php')) {
1321 $error[] = PATH_typo3conf.$cacheFilePrefix.'_ext_tables.php';
1322 }
1323 return implode(', ', $error);
1324 }
1325
1326 /**
1327 * Returns an array with the two cache-files (0=>localconf, 1=>tables) from typo3conf/ if they (both) exist. Otherwise false.
1328 * Evaluation relies on $TYPO3_LOADED_EXT['_CACHEFILE']
1329 * Usage: 2
1330 *
1331 * @return array
1332 * @internal
1333 */
1334 public static function currentCacheFiles() {
1335 global $TYPO3_LOADED_EXT;
1336
1337 if ($TYPO3_LOADED_EXT['_CACHEFILE']) {
1338 if (t3lib_extMgm::isCacheFilesAvailable($TYPO3_LOADED_EXT['_CACHEFILE'])) {
1339 return array(
1340 PATH_typo3conf.$TYPO3_LOADED_EXT['_CACHEFILE'].'_ext_localconf.php',
1341 PATH_typo3conf.$TYPO3_LOADED_EXT['_CACHEFILE'].'_ext_tables.php'
1342 );
1343 }
1344 }
1345 }
1346
1347 /**
1348 * Compiles/Creates the two cache-files in typo3conf/ based on $cacheFilePrefix
1349 * Returns a array with the key "_CACHEFILE" set to the $cacheFilePrefix value
1350 * Usage: 1
1351 *
1352 * @param array Extension information array
1353 * @param string Prefix for the cache files
1354 * @return array
1355 * @internal
1356 */
1357 public static function writeCacheFiles($extensions, $cacheFilePrefix) {
1358 // Making cache files:
1359 $extensions['_CACHEFILE'] = $cacheFilePrefix;
1360 $cFiles = array();
1361 $cFiles['ext_localconf'].='<?php
1362
1363 $TYPO3_LOADED_EXT = unserialize(stripslashes(\''.addslashes(serialize($extensions)).'\'));
1364
1365 ?>';
1366
1367 reset($extensions);
1368 while(list($key, $conf) = each($extensions)) {
1369 if (is_array($conf)) {
1370 if ($conf['ext_localconf.php']) {
1371 $cFiles['ext_localconf'].=t3lib_extMgm::_makeIncludeHeader($key, $conf['ext_localconf.php']);
1372 $cFiles['ext_localconf'].=trim(t3lib_div::getUrl($conf['ext_localconf.php']));
1373 }
1374 if ($conf['ext_tables.php']) {
1375 $cFiles['ext_tables'].=t3lib_extMgm::_makeIncludeHeader($key, $conf['ext_tables.php']);
1376 $cFiles['ext_tables'].=trim(t3lib_div::getUrl($conf['ext_tables.php']));
1377 }
1378 }
1379 }
1380
1381 $cFiles['ext_localconf'] = "<?php\n" . preg_replace('/<\?php|\?>/is', '', $cFiles['ext_localconf']) . "?>\n";
1382 $cFiles['ext_tables'] = "<?php\n" . preg_replace('/<\?php|\?>/is', '', $cFiles['ext_tables']) . "?>\n";
1383
1384 t3lib_div::writeFile(PATH_typo3conf.$cacheFilePrefix.'_ext_localconf.php', $cFiles['ext_localconf']);
1385 t3lib_div::writeFile(PATH_typo3conf.$cacheFilePrefix.'_ext_tables.php', $cFiles['ext_tables']);
1386
1387 $extensions = array();
1388 $extensions['_CACHEFILE'] = $cacheFilePrefix;
1389
1390 return $extensions;
1391 }
1392
1393 /**
1394 * Unlink (delete) cache files
1395 *
1396 * @return integer Number of deleted files.
1397 */
1398 public static function removeCacheFiles() {
1399 $cacheFiles = t3lib_extMgm::currentCacheFiles();
1400 $out = 0;
1401 if (is_array($cacheFiles)) {
1402 reset($cacheFiles);
1403 foreach($cacheFiles as $cfile) {
1404 @unlink($cfile);
1405 clearstatcache();
1406 $out++;
1407 }
1408 }
1409 return $out;
1410 }
1411 }
1412
1413 ?>