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