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