class.t3lib_extmgm.php

Go to the documentation of this file.

<?php
/***************************************************************
*  Copyright notice
*
*  (c) 1999-2008 Kasper Skaarhoj (kasperYYYY@typo3.com)
*  All rights reserved
*
*  This script is part of the TYPO3 project. The TYPO3 project is
*  free software; you can redistribute it and/or modify
*  it under the terms of the GNU General Public License as published by
*  the Free Software Foundation; either version 2 of the License, or
*  (at your option) any later version.
*
*  The GNU General Public License can be found at
*  http://www.gnu.org/copyleft/gpl.html.
*  A copy is found in the textfile GPL.txt and important notices to the license
*  from the author is found in LICENSE.txt distributed with these scripts.
*
*
*  This script is distributed in the hope that it will be useful,
*  but WITHOUT ANY WARRANTY; without even the implied warranty of
*  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
*  GNU General Public License for more details.
*
*  This copyright notice MUST APPEAR in all copies of the script!
***************************************************************/
/**
 * Contains a class with Extension Management functions
 *
 * $Id: class.t3lib_extmgm.php 4432 2008-11-07 03:52:22Z flyguide $
 * Revised for TYPO3 3.6 July/2003 by Kasper Skaarhoj
 *
 * @author  Kasper Skaarhoj <kasperYYYY@typo3.com>
 */
/**
 * [CLASS/FUNCTION INDEX of SCRIPT]
 *
 *
 *
 *  114: class t3lib_extMgm
 *
 *              SECTION: PATHS and other evaluation
 *  131:     function isLoaded($key,$exitOnError = 0)
 *  147:     function extPath($key,$script='')
 *  165:     function extRelPath($key)
 *  182:     function siteRelPath($key)
 *  194:     function getCN($key)
 *
 *              SECTION: Adding BACKEND features
 *  227:     function addTCAcolumns($table,$columnArray,$addTofeInterface=0)
 *  251:     function addToAllTCAtypes($table,$str,$specificTypesList='',$position='')
 *  309:     function allowTableOnStandardPages($table)
 *  326:     function addModule($main,$sub='',$position='',$path='')
 *  389:     function insertModuleFunction($modname,$className,$classPath,$title,$MM_key='function',$WS='')
 *  408:     function addPageTSConfig($content)
 *  422:     function addUserTSConfig($content)
 *  437:     function addLLrefForTCAdescr($tca_descr_key,$file_ref)
 *
 *              SECTION: Adding SERVICES features
 *  479:     function addService($extKey, $serviceType, $serviceKey, $info)
 *  547:     function findService($serviceType, $serviceSubType='', $excludeServiceKeys=array())
 *  618:     function deactivateService($serviceType, $serviceKey)
 *
 *              SECTION: Adding FRONTEND features
 *  657:     function addPlugin($itemArray,$type='list_type')
 *  682:     function addPiFlexFormValue($piKeyToMatch,$value)
 *  702:     function addToInsertRecords($table,$content_table='tt_content',$content_field='records')
 *  733:     function addPItoST43($key,$classFile='',$prefix='',$type='list_type',$cached=0)
 *  808:     function addStaticFile($extKey,$path,$title)
 *  827:     function addTypoScriptSetup($content)
 *  841:     function addTypoScriptConstants($content)
 *  858:     function addTypoScript($key,$type,$content,$afterStaticUid=0)
 *
 *              SECTION: INTERNAL EXTENSION MANAGEMENT:
 *  921:     function typo3_loadExtensions()
 *  998:     function _makeIncludeHeader($key,$file)
 * 1019:     function isCacheFilesAvailable($cacheFilePrefix)
 * 1032:     function isLocalconfWritable()
 * 1045:     function cannotCacheFilesWritable($cacheFilePrefix)
 * 1069:     function currentCacheFiles()
 * 1092:     function writeCacheFiles($extensions,$cacheFilePrefix)
 * 1130:     function removeCacheFiles()
 *
 * TOTAL FUNCTIONS: 32
 * (This index is automatically created/updated by the extension "extdeveval")
 *
 */
















/**
 * Extension Management functions
 *
 * This class is never instantiated, rather the methods inside is called as functions like
 *      t3lib_extMgm::isLoaded('my_extension');
 *
 * @author  Kasper Skaarhoj <kasperYYYY@typo3.com>
 * @package TYPO3
 * @subpackage t3lib
 */
final class t3lib_extMgm {


    /**************************************
     *
     * PATHS and other evaluation
     *
     ***************************************/

    /**
     * Returns true if the extension with extension key $key is loaded.
     * Usage: 109
     *
     * @param   string      Extension key to test
     * @param   boolean     If $exitOnError is true and the extension is not loaded the function will die with an error message
     * @return  boolean
     */
    public static function isLoaded($key, $exitOnError = 0) {
        global $TYPO3_LOADED_EXT;
        if ($exitOnError && !isset($TYPO3_LOADED_EXT[$key]))    die('Fatal Error: Extension "'.$key.'" was not loaded.');
        return isset($TYPO3_LOADED_EXT[$key]);
    }

    /**
     * Returns the absolute path to the extension with extension key $key
     * If the extension is not loaded the function will die with an error message
     * Useful for internal fileoperations
     * Usage: 136
     *
     * @param   string      Extension key
     * @param   string      $script is appended to the output if set.
     * @return  string
     */
    public static function extPath($key, $script = '') {
        global $TYPO3_LOADED_EXT;
        if (!isset($TYPO3_LOADED_EXT[$key])) {
            #debug(array(debug_backtrace()));
            die('TYPO3 Fatal Error: Extension key "'.$key.'" was NOT loaded! (t3lib_extMgm::extPath)');
        }
        return PATH_site.$TYPO3_LOADED_EXT[$key]['siteRelPath'].$script;
    }

    /**
     * Returns the relative path to the extension as measured from from the TYPO3_mainDir
     * If the extension is not loaded the function will die with an error message
     * Useful for images and links from backend
     * Usage: 54
     *
     * @param   string      Extension key
     * @return  string
     */
    public static function extRelPath($key) {
        global $TYPO3_LOADED_EXT;
        if (!isset($TYPO3_LOADED_EXT[$key])) {
            die('TYPO3 Fatal Error: Extension key "'.$key.'" was NOT loaded! (t3lib_extMgm::extRelPath)');
        }
        return $TYPO3_LOADED_EXT[$key]['typo3RelPath'];
    }

    /**
     * Returns the relative path to the extension as measured from the PATH_site (frontend)
     * If the extension is not loaded the function will die with an error message
     * Useful for images and links from the frontend
     * Usage: 6
     *
     * @param   string      Extension key
     * @return  string
     */
    public static function siteRelPath($key) {
        return substr(t3lib_extMgm::extPath($key), strlen(PATH_site));
    }

    /**
     * Returns the correct class name prefix for the extension key $key
     * Usage: 3
     *
     * @param   string      Extension key
     * @return  string
     * @internal
     */
    public static function getCN($key) {
        return substr($key, 0, 5)=='user_' ? 'user_'.str_replace('_', '', substr($key, 5)) : 'tx_'.str_replace('_', '', $key);
    }










    /**************************************
     *
     *   Adding BACKEND features
     *   (related to core features)
     *
     ***************************************/

    /**
     * Adding fields to an existing table definition in $TCA
     * Adds an array with $TCA column-configuration to the $TCA-entry for that table.
     * 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!
     * So to have the fields displayed you must also call fx. addToAllTCAtypes or manually add the fields to the types list.
     * FOR USE IN ext_tables.php FILES
     * Usage: 4
     *
     * @param   string      $table is the table name of a table already present in $TCA with a columns section
     * @param   array       $columnArray is the array with the additional columns (typical some fields an extension wants to add)
     * @param   boolean     If $addTofeInterface is true the list of fields are also added to the fe_admin_fieldList.
     * @return  void
     */
    public static function addTCAcolumns($table, $columnArray, $addTofeInterface = 0) {
        global $TCA;
        t3lib_div::loadTCA($table);
        if (is_array($columnArray) && is_array($TCA[$table]) && is_array($TCA[$table]['columns'])) {
            $TCA[$table]['columns'] = array_merge($TCA[$table]['columns'], $columnArray);   // Candidate for t3lib_div::array_merge() if integer-keys will some day make trouble...
            if ($addTofeInterface)  $TCA[$table]['feInterface']['fe_admin_fieldList'].=','.implode(',', array_keys($columnArray));
        }
    }

    /**
     * Makes fields visible in the TCEforms, adding them to the end of (all) "types"-configurations
     *
     * Adds a string $str (comma list of field names) to all ["types"][xxx]["showitem"] entries for table $table (unless limited by $specificTypesList)
     * This is needed to have new fields shown automatically in the TCEFORMS of a record from $table.
     * Typically this function is called after having added new columns (database fields) with the addTCAcolumns function
     * FOR USE IN ext_tables.php FILES
     * Usage: 1
     *
     * @param   string      Table name
     * @param   string      Field list to add.
     * @param   string      List of specific types to add the field list to. (If empty, all type entries are affected)
     * @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.
     * @return  void
     */
    public static function addToAllTCAtypes($table, $str, $specificTypesList = '', $position = '') {
        t3lib_div::loadTCA($table);
        $str = trim($str);

        if ($str && is_array($GLOBALS['TCA'][$table]) && is_array($GLOBALS['TCA'][$table]['types'])) {
            foreach($GLOBALS['TCA'][$table]['types'] as $type => &$typeDetails) {
                if ($specificTypesList === '' || t3lib_div::inList($specificTypesList, $type)) {
                    $typeDetails['showitem'] = self::executePositionedStringInsertion(
                        $typeDetails['showitem'],
                        $str,
                        $position
                    );
                }
            }
        }
    }

    /**
     * Adds new fields to all palettes of an existing field.
     * If the field does not have a palette yet, it's created automatically and
     * gets called "generatedFor-$field".
     *
     * @param   string      $table: Name of the table
     * @param   string      $field: Name of the field that has the palette to be extended
     * @param   string      $addFields: List of fields to be added to the palette
     * @param   string      $insertionPosition: 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.
     * @return  void
     */
    public static function addFieldsToAllPalettesOfField($table, $field, $addFields, $insertionPosition = '') {
        $generatedPalette = '';
        t3lib_div::loadTCA($table);

        if (isset($GLOBALS['TCA'][$table]['columns'][$field])) {
            $types =& $GLOBALS['TCA'][$table]['types'];
            if (is_array($types)) {
                    // Iterate through all types and search for the field that defines the palette to be extended:
                foreach (array_keys($types) as $type) {
                    $fields = self::getFieldsOfFieldList($types[$type]['showitem']);
                    if (isset($fields[$field])) {
                            // If the field already has a palette, extend it:
                        if ($fields[$field]['details']['palette']) {
                            $palette = $fields[$field]['details']['palette'];
                            self::addFieldsToPalette($table, $palette, $addFields, $insertionPosition);
                            // If there's not palette yet, create one:
                        } else {
                            if ($generatedPalette) {
                                $palette = $generatedPalette;
                            } else {
                                $palette = $generatedPalette = 'generatedFor-' . $field;
                                self::addFieldsToPalette($table, $palette, $addFields, $insertionPosition);
                            }
                            $fields[$field]['details']['palette'] = $palette;
                            $types[$type]['showitem'] =  self::generateFieldList($fields);
                        }
                    }
                }
            }
        }
    }

    /**
     * Adds new fields to a palette.
     * If the palette does not exist yet, it's created automatically.
     *
     * @param   string      $table: Name of the table
     * @param   string      $palette: Name of the palette to be extended
     * @param   string      $addFields: List of fields to be added to the palette
     * @param   string      $insertionPosition: 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.
     * @return  void
     */
    public static function addFieldsToPalette($table, $palette, $addFields, $insertionPosition = '') {
        t3lib_div::loadTCA($table);

        if (isset($GLOBALS['TCA'][$table])) {
            $paletteData =& $GLOBALS['TCA'][$table]['palettes'][$palette];
                // If palette already exists, merge the data:
            if (is_array($paletteData)) {
                $paletteData['showitem'] = self::executePositionedStringInsertion(
                    $paletteData['showitem'],
                    $addFields,
                    $insertionPosition
                );
                // If it's a new palette, just set the data:
            } else {
                $paletteData['showitem'] = $addFields;
            }
        }
    }

    /**
     * Inserts as list of data into an existing list.
     * The insertion position can be defined accordant before of after existing list items.
     *
     * @param   string      $list: The list of items to be extended
     * @param   string      $insertionList: The list of items to inserted
     * @param   string      $insertionPosition: 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.
     * @return  string      The extended list
     */
    protected static function executePositionedStringInsertion($list, $insertionList, $insertionPosition = '') {
        $list = trim($list);
        $insertionList = self::removeDuplicatesForInsertion($list, $insertionList);

            // Append data to the end (default):
        if ($insertionPosition === '') {
            $list.= ($list ? ', ' : '') . $insertionList;
            // Insert data before or after insertion points:
        } else {
            $positions = t3lib_div::trimExplode(',', $insertionPosition, true);
            $fields = self::getFieldsOfFieldList($list);
            $isInserted = false;
                // Iterate through all fields an check whether it's possible to inserte there:
            foreach ($fields as $field => &$fieldDetails) {
                $needles = self::getInsertionNeedles($field, $fieldDetails['details']);
                    // Insert data before:
                foreach ($needles['before'] as $needle) {
                    if (in_array($needle, $positions)) {
                        $fieldDetails['rawData'] = $insertionList . ', '  . $fieldDetails['rawData'];
                        $isInserted = true;
                        break;
                    }
                }
                    // Insert data after:
                foreach ($needles['after'] as $needle) {
                    if (in_array($needle, $positions)) {
                        $fieldDetails['rawData'] .= ', ' . $insertionList;
                        $isInserted = true;
                        break;
                    }
                }
                    // Break if insertion was already done:
                if ($isInserted) {
                    break;
                }
            }
                // If insertion point could not be determined, append the data:
            if (!$isInserted) {
                $list.= ($list ? ', ' : '') . $insertionList;
                // If data was correctly inserted before or after existing items, recreate the list:
            } else {
                $list = self::generateFieldList($fields, true);
            }
        }

        return $list;
    }

    /**
     * Compares an existing list of items and a list of items to be inserted
     * and returns a duplicate-free variant of that insertion list.
     *
     * Example:
     *  + list: 'field_a, field_b;;;;2-2-2, field_c;;;;3-3-3'
     *  + insertion: 'field_b, field_d, field_c;;;4-4-4'
     * -> new insertion: 'field_d'
     *
     * @param   string      $list: The list of items to be extended
     * @param   string      $insertionList: The list of items to inserted
     * @return  string      Duplicate-free list of items to be inserted
     */
    protected static function removeDuplicatesForInsertion($list, $insertionList) {
        $pattern = '/(^|,)\s*\b([^;,]+)\b[^,]*/';

        if ($list && preg_match_all($pattern, $list, $listMatches)) {
            if ($insertionList && preg_match_all($pattern, $insertionList, $insertionListMatches)) {
                $duplicates = array_intersect($listMatches[2], $insertionListMatches[2]);
                if ($duplicates) {
                    foreach ($duplicates as &$duplicate) {
                        $duplicate = preg_quote($duplicate, '/');
                    }
                    $insertionList = preg_replace(
                        array('/(^|,)\s*\b(' . implode('|', $duplicates) . ')\b[^,]*(,|$)/', '/,$/'),
                        array('\3', ''),
                        $insertionList
                    );
                }
            }
        }

        return $insertionList;
    }

    /**
     * Generates search needles that are used for inserting fields/items into an existing list.
     *
     * @see     executePositionedStringInsertion
     * @param   string      $field: The name of the field/item
     * @param   array       $fieldDetails: Additional details of the field like e.g. palette information
     *                      (this array gets created by the function getFieldsOfFieldList())
     * @return  array       The needled to be used for inserting content before or after existing fields/items
     */
    protected static function getInsertionNeedles($field, array $fieldDetails) {
        $needles = array(
            'before' => array($field, 'before:' . $field),
            'after' => array('after:' . $field),
        );

        if ($fieldDetails['palette']) {
            $palette = $field . ';;' . $fieldDetails['palette'];
            $needles['before'][] = $palette;
            $needles['before'][] = 'before:' . $palette;
            $needles['afer'][] = 'after:' . $palette;
        }

        return $needles;
    }

    /**
     * Generates an array of fields with additional information such as e.g. the name of the palette.
     *
     * @param   string      $fieldList: List of fields/items to be splitted up
     *                      (this mostly reflects the data in $TCA[<table>]['types'][<type>]['showitem'])
     * @return  array       An array with the names of the fields as keys and additional information
     */
    protected static function getFieldsOfFieldList($fieldList) {
        $fields = array();
        $fieldParts = t3lib_div::trimExplode(',', $fieldList, true);

        foreach ($fieldParts as $fieldPart) {
            $fieldDetails = t3lib_div::trimExplode(';', $fieldPart, false, 5);
            if (!isset($fields[$fieldDetails[0]])) {
                $fields[$fieldDetails[0]] = array(
                    'rawData' => $fieldPart,
                    'details' => array(
                        'field' => $fieldDetails[0],
                        'label' => $fieldDetails[1],
                        'palette' => $fieldDetails[2],
                        'special' => $fieldDetails[3],
                        'styles' => $fieldDetails[4],
                    ),
                );
            }
        }

        return $fields;
    }

    /**
     * Generates a list of fields/items out of an array provided by the function getFieldsOfFieldList().
     *
     * @see     getFieldsOfFieldList
     * @param   array       $fields: The array of fields with optional additional information
     * @param   boolean     $useRawData: Use raw data instead of building by using the details (default: false)
     * @return  string      The list of fields/items which gets used for $TCA[<table>]['types'][<type>]['showitem']
     *                      or $TCA[<table>]['palettes'][<palette>]['showitem'] in most cases
     */
    protected static function generateFieldList(array $fields, $useRawData = false) {
        $fieldParts = array();

        foreach ($fields as $field => $fieldDetails) {
            if ($useRawData) {
                $fieldParts[] = $fieldDetails['rawData'];
            } else {
                $fieldParts[] = (count($fieldDetails['details']) > 1 ? implode(';', $fieldDetails['details']) : $field);
            }
        }

        return implode(', ', $fieldParts);
    }

    /**
     * Add tablename to default list of allowed tables on pages (in $PAGES_TYPES)
     * Will add the $table to the list of tables allowed by default on pages as setup by $PAGES_TYPES['default']['allowedTables']
     * FOR USE IN ext_tables.php FILES
     * Usage: 11
     *
     * @param   string      Table name
     * @return  void
     */
    public static function allowTableOnStandardPages($table) {
        global $PAGES_TYPES;

        $PAGES_TYPES['default']['allowedTables'].=','.$table;
    }

    /**
     * Adds a module (main or sub) to the backend interface
     * FOR USE IN ext_tables.php FILES
     * Usage: 18
     *
     * @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.
     * @param   string      $sub is the submodule key. If $sub is not set a blank $main module is created.
     * @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.
     * @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.
     * @return  void
     */
    public static function addModule($main, $sub = '', $position = '', $path = '') {
        global $TBE_MODULES;

        if (isset($TBE_MODULES[$main]) && $sub) {   // If there is already a main module by this name:

                // Adding the submodule to the correct position:
            list($place, $modRef) = t3lib_div::trimExplode(':', $position, 1);
            $mods = t3lib_div::trimExplode(',', $TBE_MODULES[$main], 1);
            if (!in_array($sub, $mods)) {
                switch(strtolower($place)) {
                    case 'after':
                    case 'before':
                        $pointer = 0;
                        reset($mods);
                        while(list($k, $m) = each($mods)) {
                            if (!strcmp($m, $modRef)) {
                                $pointer = strtolower($place)=='after'?$k+1:$k;
                            }
                        }
                        array_splice(
                            $mods,  // The modules array
                            $pointer,       // To insert one position from the end of the list
                            0,      // Don't remove any items, just insert
                            $sub    // Module to insert
                        );
                    break;
                    default:
                        if (strtolower($place)=='top') {
                            array_unshift($mods, $sub);
                        } else {
                            array_push($mods, $sub);
                        }
                    break;
                }
            }
                // Re-inserting the submodule list:
            $TBE_MODULES[$main] = implode(',', $mods);
        } else {    // Create new main modules with only one submodule, $sub (or none if $sub is blank)
            $TBE_MODULES[$main] = $sub;
        }

            // Adding path:
        if ($path) {
            $TBE_MODULES['_PATHS'][$main.($sub?'_'.$sub:'')] = $path;
        }
    }

    /**
     * Adds a module path to TBE_MODULES for used with the module dispatcher, mod.php
     * Used only for modules that are not placed in the main/sub menu hierarchy by the traditional mechanism of addModule()
     * Examples for this is context menu functionality (like import/export) which runs as an independent module through mod.php
     * FOR USE IN ext_tables.php FILES
     * Example:  t3lib_extMgm::addModulePath('xMOD_tximpexp', t3lib_extMgm::extPath($_EXTKEY).'app/');
     *
     * @param   string      $name is the name of the module, refer to conf.php of the module.
     * @param   string      $path is the absolute path to the module directory inside of which "index.php" and "conf.php" is found.
     * @return  void
     */
    public static function addModulePath($name, $path) {
        global $TBE_MODULES;

        $TBE_MODULES['_PATHS'][$name] = $path;
    }

    /**
     * Adds a "Function menu module" ('third level module') to an existing function menu for some other backend module
     * The arguments values are generally determined by which function menu this is supposed to interact with
     * See Inside TYPO3 for information on how to use this function.
     * FOR USE IN ext_tables.php FILES
     * Usage: 26
     *
     * @param   string      Module name
     * @param   string      Class name
     * @param   string      Class path
     * @param   string      Title of module
     * @param   string      Menu array key - default is "function"
     * @param   string      Workspace conditions. Blank means all workspaces, any other string can be a comma list of "online", "offline" and "custom"
     * @return  void
     * @see t3lib_SCbase::mergeExternalItems()
     */
    public static function insertModuleFunction($modname, $className, $classPath, $title, $MM_key = 'function', $WS = '') {
        global $TBE_MODULES_EXT;
        $TBE_MODULES_EXT[$modname]['MOD_MENU'][$MM_key][$className] = array(
            'name' => $className,
            'path' => $classPath,
            'title' => $title,
            'ws' => $WS
        );
    }

    /**
     * Adds $content to the default Page TSconfig as set in $TYPO3_CONF_VARS[BE]['defaultPageTSconfig']
     * Prefixed with a [GLOBAL] line
     * FOR USE IN ext_tables.php/ext_locallang.php FILES
     * Usage: 5
     *
     * @param   string      Page TSconfig content
     * @return  void
     */
    public static function addPageTSConfig($content) {
        global $TYPO3_CONF_VARS;
        $TYPO3_CONF_VARS['BE']['defaultPageTSconfig'].="\n[GLOBAL]\n".$content;
    }

    /**
     * Adds $content to the default User TSconfig as set in $TYPO3_CONF_VARS[BE]['defaultUserTSconfig']
     * Prefixed with a [GLOBAL] line
     * FOR USE IN ext_tables.php/ext_locallang.php FILES
     * Usage: 3
     *
     * @param   string      User TSconfig content
     * @return  void
     */
    public static function addUserTSConfig($content) {
        global $TYPO3_CONF_VARS;
        $TYPO3_CONF_VARS['BE']['defaultUserTSconfig'].="\n[GLOBAL]\n".$content;
    }

    /**
     * Adds a reference to a locallang file with TCA_DESCR labels
     * FOR USE IN ext_tables.php FILES
     * 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.
     * Usage: 31
     *
     * @param   string      Description key. Typically a database table (like "pages") but for applications can be other strings, but prefixed with "_MOD_")
     * @param   string      File reference to locallang file, eg. "EXT:lang/locallang_csh_pages.php" (or ".xml")
     * @return  void
     */
    public static function addLLrefForTCAdescr($tca_descr_key, $file_ref) {
        global $TCA_DESCR;
        if ($tca_descr_key) {
            if (!is_array($TCA_DESCR[$tca_descr_key])) {
                $TCA_DESCR[$tca_descr_key] = array();
            }
            if (!is_array($TCA_DESCR[$tca_descr_key]['refs'])) {
                $TCA_DESCR[$tca_descr_key]['refs'] = array();
            }
            $TCA_DESCR[$tca_descr_key]['refs'][] = $file_ref;
        }
    }












    /**************************************
     *
     *   Adding SERVICES features
     *
     *   @author    Ren� Fritz <r.fritz@colorcube.de>
     *
     ***************************************/

    /**
     * Adds a service to the global services array
     *
     * @param   string      Extension key
     * @param   string      Service type, cannot be prefixed "tx_"
     * @param   string      Service key, must be prefixed "tx_" or "user_"
     * @param   array       Service description array
     * @return  void
     * @author  Ren� Fritz <r.fritz@colorcube.de>
     */
    public static function addService($extKey, $serviceType, $serviceKey, $info) {
        global $T3_SERVICES, $TYPO3_CONF_VARS;

        // even not available services will be included to make it possible to give the admin a feedback of non-available services.
        // but maybe it's better to move non-available services to a different array??

        if ($serviceType &&
            !t3lib_div::isFirstPartOfStr($serviceType, 'tx_') &&
            (t3lib_div::isFirstPartOfStr($serviceKey, 'tx_') || t3lib_div::isFirstPartOfStr($serviceKey, 'user_')) &&
            is_array($info))    {

            $info['priority'] = max(0, min(100, $info['priority']));

            $T3_SERVICES[$serviceType][$serviceKey] = $info;

            $T3_SERVICES[$serviceType][$serviceKey]['extKey'] = $extKey;
            $T3_SERVICES[$serviceType][$serviceKey]['serviceKey'] = $serviceKey;
            $T3_SERVICES[$serviceType][$serviceKey]['serviceType'] = $serviceType;


                // mapping a service key to a service type
                // all service keys begin with tx_ - service types don't
                // this way a selection of a special service key as service type is easy
            $T3_SERVICES[$serviceKey][$serviceKey] = &$T3_SERVICES[$serviceType][$serviceKey];


                // change the priority (and other values) from TYPO3_CONF_VARS
                // $TYPO3_CONF_VARS['T3_SERVICES'][$serviceType][$serviceKey]['priority']
                // even the activation is possible (a unix service might be possible on windows for some reasons)
            if (is_array($TYPO3_CONF_VARS['T3_SERVICES'][$serviceType][$serviceKey])) {

                    // no check is done here - there might be configuration values only the service type knows about, so we pass everything
                $T3_SERVICES[$serviceType][$serviceKey] = array_merge ($T3_SERVICES[$serviceType][$serviceKey], $TYPO3_CONF_VARS['T3_SERVICES'][$serviceType][$serviceKey]);
            }


                // OS check
                // empty $os means 'not limited to one OS', therefore a check is not needed
            if ($T3_SERVICES[$serviceType][$serviceKey]['available'] && $T3_SERVICES[$serviceType][$serviceKey]['os']!='') {

                    // TYPO3_OS is not yet defined
                $os_type = stristr(PHP_OS, 'win')&&!stristr(PHP_OS, 'darwin')?'WIN':'UNIX';

                $os = t3lib_div::trimExplode(',', strtoupper($T3_SERVICES[$serviceType][$serviceKey]['os']));

                if (!in_array($os_type, $os)) {
                    t3lib_extMgm::deactivateService($serviceType, $serviceKey);
                }
            }

                // convert subtype list to array for quicker access
            $T3_SERVICES[$serviceType][$serviceKey]['serviceSubTypes'] = array();
            $serviceSubTypes = t3lib_div::trimExplode(',', $info['subtype']);
            foreach ($serviceSubTypes as $subtype) {
                $T3_SERVICES[$serviceType][$serviceKey]['serviceSubTypes'][$subtype] = $subtype;
            }
        }
    }

    /**
     * Find the available service with highest priority
     *
     * @param   string      Service type
     * @param   string      Service sub type
     * @param   mixed       Service keys that should be excluded in the search for a service. Array or comma list.
     * @return  mixed       Service info array if a service was found, FLASE otherwise
     * @author  Ren� Fritz <r.fritz@colorcube.de>
     */
    public static function findService($serviceType, $serviceSubType = '', $excludeServiceKeys = array()) {
        global $T3_SERVICES, $TYPO3_CONF_VARS;

        $serviceKey = FALSE;
        $serviceInfo = FALSE;
        $priority = 0;
        $quality = 0;

        if (!is_array($excludeServiceKeys) ) {
            $excludeServiceKeys = t3lib_div::trimExplode(',', $excludeServiceKeys, 1);
        }

        if (is_array($T3_SERVICES[$serviceType])) {
            foreach($T3_SERVICES[$serviceType] as $key => $info)    {

                if (in_array($key, $excludeServiceKeys)) {
                    continue;
                }

                    // select a subtype randomly
                    // usefull to start a service by service key without knowing his subtypes - for testing purposes
                if ($serviceSubType=='*') {
                    $serviceSubType = key($info['serviceSubTypes']);
                }

                    // this matches empty subtype too
                if ($info['available'] && ($info['subtype']==$serviceSubType || $info['serviceSubTypes'][$serviceSubType]) && $info['priority']>=$priority )    {

                        // has a lower quality than the already found, therefore we skip this service
                    if($info['priority']==$priority && $info['quality']<$quality) {
                        continue;
                    }

                        // service depends on external programs - check if they exists
                    if(trim($info['exec'])) {
                        require_once(PATH_t3lib.'class.t3lib_exec.php');

                        $executables = t3lib_div::trimExplode(',', $info['exec'], 1);
                        foreach($executables as $executable) {
                            if(!t3lib_exec::checkCommand($executable)) {
                                t3lib_extMgm::deactivateService($serviceType, $key);
                                $info['available'] = FALSE;
                                break;
                            }
                        }
                    }

                        // still available after exec check?
                    if($info['available']) {
                        $serviceKey = $key;
                        $priority = $info['priority'];
                        $quality = $info['quality'];
                    }
                }
            }
        }

        if ($serviceKey) {
            $serviceInfo = $T3_SERVICES[$serviceType][$serviceKey];
        }
        return $serviceInfo;
    }

    /**
     * Deactivate a service
     *
     * @param   string      Service type
     * @param   string      Service key
     * @return  void
     * @author  Ren� Fritz <r.fritz@colorcube.de>
     */
    public static function deactivateService($serviceType, $serviceKey) {
        global $T3_SERVICES;

            // ... maybe it's better to move non-available services to a different array??
        $T3_SERVICES[$serviceType][$serviceKey]['available'] = FALSE;
    }














    /**************************************
     *
     *   Adding FRONTEND features
     *   (related specifically to "cms" extension)
     *
     ***************************************/

    /**
     * Adds an entry to the list of plugins in content elements of type "Insert plugin"
     * 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)
     * 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.
     * 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
     * FOR USE IN ext_tables.php FILES
     * Usage: 13
     *
     * @param   array       Item Array
     * @param   string      Type (eg. "list_type") - basically a field from "tt_content" table
     * @return  void
     */
    public static function addPlugin($itemArray, $type = 'list_type') {
        global $TCA;

        $_EXTKEY = $GLOBALS['_EXTKEY'];
        if ($_EXTKEY && !$itemArray[2]) {
            $itemArray[2] = t3lib_extMgm::extRelPath($_EXTKEY) . 'ext_icon.gif';
        }

        t3lib_div::loadTCA('tt_content');
        if (is_array($TCA['tt_content']['columns']) && is_array($TCA['tt_content']['columns'][$type]['config']['items'])) {
            reset($TCA['tt_content']['columns'][$type]['config']['items']);
            while(list($k, $v) = each($TCA['tt_content']['columns'][$type]['config']['items'])) {
                if (!strcmp($v[1], $itemArray[1])) {
                    $TCA['tt_content']['columns'][$type]['config']['items'][$k] = $itemArray;
                    return;
                }
            }
            $TCA['tt_content']['columns'][$type]['config']['items'][] = $itemArray;
        }
    }

    /**
     * Adds an entry to the "ds" array of the tt_content field "pi_flexform".
     * This is used by plugins to add a flexform XML reference / content for use when they are selected as plugin or content element.
     * Usage: 0
     *
     * @param   string      Plugin key as used in the list_type field. Use the asterisk * to match all list_type values.
     * @param   string      Either a reference to a flex-form XML file (eg. "FILE:EXT:newloginbox/flexform_ds.xml") or the XML directly.
     * @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.
     * @return  void
     * @see addPlugin()
     */
    public static function addPiFlexFormValue($piKeyToMatch, $value, $CTypeToMatch = 'list') {
        global $TCA;
        t3lib_div::loadTCA('tt_content');

        if (is_array($TCA['tt_content']['columns']) && is_array($TCA['tt_content']['columns']['pi_flexform']['config']['ds'])) {
            $TCA['tt_content']['columns']['pi_flexform']['config']['ds'][$piKeyToMatch.','.$CTypeToMatch] = $value;
        }
    }

    /**
     * Adds the $table tablename to the list of tables allowed to be includes by content element type "Insert records"
     * By using $content_table and $content_field you can also use the function for other tables.
     * FOR USE IN ext_tables.php FILES
     * Usage: 9
     *
     * @param   string      Table name to allow for "insert record"
     * @param   string      Table name TO WHICH the $table name is applied. See $content_field as well.
     * @param   string      Field name in the database $content_table in which $table is allowed to be added as a reference ("Insert Record")
     * @return  void
     */
    public static function addToInsertRecords($table, $content_table = 'tt_content', $content_field = 'records') {
        global $TCA;
        t3lib_div::loadTCA($content_table);
        if (is_array($TCA[$content_table]['columns']) && isset($TCA[$content_table]['columns'][$content_field]['config']['allowed'])) {
            $TCA[$content_table]['columns'][$content_field]['config']['allowed'].=','.$table;
        }
    }

    /**
     * Add PlugIn to Static Template #43
     *
     * 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.
     * 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"
     * $type determines the type of frontend plugin:
     *      "list_type" (default)   - the good old "Insert plugin" entry
     *      "menu_type" - a "Menu/Sitemap" entry
     *      "splash_layout" - a "Textbox" entry
     *      "CType" - a new content element type
     *      "header_layout" - an additional header type (added to the selection of layout1-5)
     *      "includeLib" - just includes the library for manual use somewhere in TypoScript.
     *  (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)
     * FOR USE IN ext_locallang.php FILES
     * Usage: 2
     *
     * @param   string      $key is the extension key
     * @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.
     * @param   string      $prefix is used as a - yes, suffix - of the class name (fx. "_pi1")
     * @param   string      $type, see description above
     * @param   boolean     If $cached is set as USER content object (cObject) is created - otherwise a USER_INT object is created.
     * @return  void
     */
    public static function addPItoST43($key, $classFile = '', $prefix = '', $type = 'list_type', $cached = 0) {
        global $TYPO3_LOADED_EXT;
        $classFile = $classFile ? $classFile : 'pi/class.tx_'.str_replace('_', '', $key).$prefix.'.php';
        $cN = t3lib_extMgm::getCN($key);

            // General plugin:
        $pluginContent = trim('
plugin.'.$cN.$prefix.' = USER' . ($cached ? '' : '_INT') . '
plugin.'.$cN.$prefix.' {
  includeLibs = '.$TYPO3_LOADED_EXT[$key]['siteRelPath'].$classFile.'
  userFunc = '.$cN.$prefix.'->main
}');
        t3lib_extMgm::addTypoScript($key, 'setup', '
# Setting '.$key.' plugin TypoScript
'.$pluginContent);

            // After ST43:
        switch($type) {
            case 'list_type':
                $addLine = 'tt_content.list.20.'.$key.$prefix.' = < plugin.'.$cN.$prefix;
            break;
            case 'menu_type':
                $addLine = 'tt_content.menu.20.'.$key.$prefix.' = < plugin.'.$cN.$prefix;
            break;
            case 'splash_layout':
                $addLine = 'tt_content.splash.'.$key.$prefix.' = < plugin.'.$cN.$prefix;
            break;
            case 'CType':
                $addLine = trim('
tt_content.'.$key.$prefix.' = COA
tt_content.'.$key.$prefix.' {
    10 = < lib.stdheader
    20 = < plugin.'.$cN.$prefix.'
}
                ');
            break;
            case 'header_layout':
                $addLine = 'lib.stdheader.10.'.$key.$prefix.' = < plugin.'.$cN.$prefix;
            break;
            case 'includeLib':
                $addLine = 'page.1000 = < plugin.'.$cN.$prefix;
            break;
            default:
                $addLine = '';
            break;
        }
        if ($addLine) {
            t3lib_extMgm::addTypoScript($key, 'setup', '
# Setting '.$key.' plugin TypoScript
'.$addLine.'
', 43);
        }
    }

    /**
     * Call this method to add an entry in the static template list found in sys_templates
     * "static template files" are the modern equalent (provided from extensions) to the traditional records in "static_templates"
     * FOR USE IN ext_locallang.php FILES
     * Usage: 3
     *
     * @param   string      $extKey is of course the extension key
     * @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/
     * @param   string      $title is the title in the selector box.
     * @return  void
     * @see addTypoScript()
     */
    public static function addStaticFile($extKey, $path, $title) {
        global $TCA;
        t3lib_div::loadTCA('sys_template');
        if ($extKey && $path && is_array($TCA['sys_template']['columns'])) {
            $value = str_replace(',', '', 'EXT:'.$extKey.'/'.$path);
            $itemArray = array(trim($title.' ('.$extKey.')'), $value);
            $TCA['sys_template']['columns']['include_static_file']['config']['items'][] = $itemArray;
        }
    }

    /**
     * Adds $content to the default TypoScript setup code as set in $TYPO3_CONF_VARS[FE]['defaultTypoScript_setup']
     * Prefixed with a [GLOBAL] line
     * FOR USE IN ext_locallang.php FILES
     * Usage: 6
     *
     * @param   string      TypoScript Setup string
     * @return  void
     */
    public static function addTypoScriptSetup($content) {
        global $TYPO3_CONF_VARS;
        $TYPO3_CONF_VARS['FE']['defaultTypoScript_setup'].="\n[GLOBAL]\n".$content;
    }

    /**
     * Adds $content to the default TypoScript constants code as set in $TYPO3_CONF_VARS[FE]['defaultTypoScript_constants']
     * Prefixed with a [GLOBAL] line
     * FOR USE IN ext_locallang.php FILES
     * Usage: 0
     *
     * @param   string      TypoScript Constants string
     * @return  void
     */
    public static function addTypoScriptConstants($content) {
        global $TYPO3_CONF_VARS;
        $TYPO3_CONF_VARS['FE']['defaultTypoScript_constants'].="\n[GLOBAL]\n".$content;
    }

    /**
     * Adds $content to the default TypoScript code for either setup, constants or editorcfg as set in $TYPO3_CONF_VARS[FE]['defaultTypoScript_*']
     * (Basically this function can do the same as addTypoScriptSetup and addTypoScriptConstants - just with a little more hazzle, but also with some more options!)
     * FOR USE IN ext_locallang.php FILES
     * Usage: 7
     *
     * @param   string      $key is the extension key (informative only).
     * @param   string      $type is either "setup", "constants" or "editorcfg" and obviously determines which kind of TypoScript code we are adding.
     * @param   string      $content is the TS content, prefixed with a [GLOBAL] line and a comment-header.
     * @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.
     * @return  void
     */
    public static function addTypoScript($key, $type, $content, $afterStaticUid = 0) {
        global $TYPO3_CONF_VARS;

        if ($type=='setup' || $type=='editorcfg' || $type=='constants')     {
            $content = '

[GLOBAL]
#############################################
## TypoScript added by extension "'.$key.'"
#############################################

'.$content;
            if ($afterStaticUid) {
                $TYPO3_CONF_VARS['FE']['defaultTypoScript_'.$type.'.'][$afterStaticUid].=$content;
                if ($afterStaticUid==43)    {   // If 'content (default)' is targeted, also add to other 'content rendering templates', eg. css_styled_content
                    $TYPO3_CONF_VARS['FE']['defaultTypoScript_'.$type.'.']['cssstyledcontent/static/'].=$content;
                }
            } else {
                $TYPO3_CONF_VARS['FE']['defaultTypoScript_'.$type].=$content;
            }
        }
    }


















    /**************************************
     *
     *   INTERNAL EXTENSION MANAGEMENT:
     *
     ***************************************/

    /**
     * Loading extensions configured in $TYPO3_CONF_VARS['EXT']['extList']
     *
     * CACHING ON: ($TYPO3_CONF_VARS['EXT']['extCache'] = 1 or 2)
     *      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.
     *      If cachefiles are not found they will be generated
     * CACHING OFF: ($TYPO3_CONF_VARS['EXT']['extCache'] = 0)
     *      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.
     *      This array will later be set in the global var $TYPO3_LOADED_EXT
     *
     * Usages of this function can be seen in config_default.php
     * Extensions are always detected in the order local - global - system.
     * Usage: 1
     *
     * @return  array       Extension Array
     * @internal
     */
    public static function typo3_loadExtensions() {
        global $TYPO3_CONF_VARS;

            // Full list of extensions includes both required and extList:
        $rawExtList = $TYPO3_CONF_VARS['EXT']['requiredExt'].','.$TYPO3_CONF_VARS['EXT']['extList'];

            // Empty array as a start.
        $extensions = array();

            //
        if ($rawExtList) {
                // The cached File prefix.
            $cacheFilePrefix = 'temp_CACHED';
                // Setting the name for the cache files:
            if (intval($TYPO3_CONF_VARS['EXT']['extCache'])==1) $cacheFilePrefix.= '_ps'.substr(t3lib_div::shortMD5(PATH_site.'|'.$GLOBALS['TYPO_VERSION']), 0, 4);
            if (intval($TYPO3_CONF_VARS['EXT']['extCache'])==2) $cacheFilePrefix.= '_'.t3lib_div::shortMD5($rawExtList);

                // If cache files available, set cache file prefix and return:
            if ($TYPO3_CONF_VARS['EXT']['extCache'] && t3lib_extMgm::isCacheFilesAvailable($cacheFilePrefix)) {
                    // Return cache file prefix:
                $extensions['_CACHEFILE'] = $cacheFilePrefix;
            } else {    // ... but if not, configure...

                    // Prepare reserved filenames:
                $files = t3lib_div::trimExplode(',', 'ext_localconf.php,ext_tables.php,ext_tables.sql,ext_tables_static+adt.sql,ext_typoscript_constants.txt,ext_typoscript_editorcfg.txt,ext_typoscript_setup.txt', 1);

                    // Traverse extensions and check their existence:
                clearstatcache();   // Clear file state cache to make sure we get good results from is_dir()
                $temp_extensions = array_unique(t3lib_div::trimExplode(',', $rawExtList, 1));
                foreach($temp_extensions as $temp_extKey) {
                        // Check local, global and system locations:
                    if (@is_dir(PATH_typo3conf.'ext/'.$temp_extKey.'/')) {
                        $extensions[$temp_extKey] = array('type'=>'L', 'siteRelPath'=>'typo3conf/ext/'.$temp_extKey.'/', 'typo3RelPath'=>'../typo3conf/ext/'.$temp_extKey.'/');
                    } elseif (@is_dir(PATH_typo3.'ext/'.$temp_extKey.'/')) {
                        $extensions[$temp_extKey] = array('type'=>'G', 'siteRelPath'=>TYPO3_mainDir.'ext/'.$temp_extKey.'/', 'typo3RelPath'=>'ext/'.$temp_extKey.'/');
                    } elseif (@is_dir(PATH_typo3.'sysext/'.$temp_extKey.'/'