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