Changed t3lib_div::get_tag_attributes/split_tag_attributes so that they always return...

[Packages/TYPO3.CMS.git] / t3lib / class.t3lib_div.php

<?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 the reknown class "t3lib_div" with general purpose functions
 *
 * $Id$
 * Revised for TYPO3 3.6 July/2003 by Kasper Skaarhoj
 * XHTML compliant
 * Usage counts are based on search 22/2 2003 through whole source including tslib/
 *
 * @author      Kasper Skaarhoj <kasperYYYY@typo3.com>
 */
/**
 * [CLASS/FUNCTION INDEX of SCRIPT]
 *
 *
 *
 *  232: class t3lib_div
 *
 *              SECTION: GET/POST Variables
 *  262:     function _GP($var)
 *  280:     function _GET($var=NULL)
 *  297:     function _POST($var=NULL)
 *  313:     function _GETset($inputGet,$key='')
 *  336:     function GPvar($var,$strip=0)
 *  353:     function GParrayMerged($var)
 *
 *              SECTION: IMAGE FUNCTIONS
 *  397:     function gif_compress($theFile, $type)
 *  425:     function png_to_gif_by_imagemagick($theFile)
 *  450:     function read_png_gif($theFile,$output_png=0)
 *
 *              SECTION: STRING FUNCTIONS
 *  499:     function fixed_lgd($string,$origChars,$preStr='...')
 *  524:     function fixed_lgd_pre($string,$chars)
 *  538:     function fixed_lgd_cs($string,$chars)
 *  555:     function breakTextForEmail($str,$implChar="\n",$charWidth=76)
 *  574:     function breakLinesForEmail($str,$implChar="\n",$charWidth=76)
 *  610:     function cmpIP($baseIP, $list)
 *  626:     function cmpIPv4($baseIP, $list)
 *  668:     function cmpIPv6($baseIP, $list)
 *  711:     function IPv6Hex2Bin ($hex)
 *  726:     function normalizeIPv6($address)
 *  782:     function validIPv6($ip)
 *  805:     function cmpFQDN($baseIP, $list)
 *  835:     function inList($list,$item)
 *  847:     function rmFromList($element,$list)
 *  863:     function expandList($list)
 *  894:     function intInRange($theInt,$min,$max=2000000000,$zeroValue=0)
 *  910:     function intval_positive($theInt)
 *  923:     function int_from_ver($verNumberStr)
 *  934:     function compat_version($verNumberStr)
 *  952:     function md5int($str)
 *  965:     function shortMD5($input, $len=10)
 *  978:     function uniqueList($in_list, $secondParameter=NULL)
 *  992:     function split_fileref($fileref)
 * 1030:     function dirname($path)
 * 1046:     function modifyHTMLColor($color,$R,$G,$B)
 * 1066:     function modifyHTMLColorAll($color,$all)
 * 1077:     function rm_endcomma($string)
 * 1090:     function danish_strtoupper($string)
 * 1105:     function convUmlauts($str)
 * 1118:     function testInt($var)
 * 1130:     function isFirstPartOfStr($str,$partStr)
 * 1146:     function formatSize($sizeInBytes,$labels='')
 * 1181:     function convertMicrotime($microtime)
 * 1195:     function splitCalc($string,$operators)
 * 1217:     function calcPriority($string)
 * 1258:     function calcParenthesis($string)
 * 1284:     function htmlspecialchars_decode($value)
 * 1299:     function deHSCentities($str)
 * 1312:     function slashJS($string,$extended=0,$char="'")
 * 1325:     function rawUrlEncodeJS($str)
 * 1337:     function rawUrlEncodeFP($str)
 * 1348:     function validEmail($email)
 * 1363:     function formatForTextarea($content)
 *
 *              SECTION: ARRAY FUNCTIONS
 * 1394:     function inArray($in_array,$item)
 * 1411:     function intExplode($delim, $string)
 * 1430:     function revExplode($delim, $string, $count=0)
 * 1450:     function trimExplode($delim, $string, $onlyNonEmptyValues=0)
 * 1472:     function uniqueArray($valueArray)
 * 1484:     function removeArrayEntryByValue($array,$cmpValue)
 * 1513:     function implodeArrayForUrl($name,$theArray,$str='',$skipBlank=0,$rawurlencodeParamName=0)
 * 1538:     function explodeUrl2Array($string,$multidim=FALSE)
 * 1564:     function compileSelectedGetVarsFromArray($varList,$getArray,$GPvarAlt=1)
 * 1587:     function addSlashesOnArray(&$theArray)
 * 1611:     function stripSlashesOnArray(&$theArray)
 * 1633:     function slashArray($arr,$cmd)
 * 1650:     function array_merge_recursive_overrule($arr0,$arr1,$notAddKeys=0,$includeEmtpyValues=true)
 * 1683:     function array_merge($arr1,$arr2)
 * 1696:     function csvValues($row,$delim=',',$quote='"')
 *
 *              SECTION: HTML/XML PROCESSING
 * 1738:     function get_tag_attributes($tag)
 * 1775:     function split_tag_attributes($tag)
 * 1809:     function implodeAttributes($arr,$xhtmlSafe=FALSE,$dontOmitBlankAttribs=FALSE)
 * 1836:     function implodeParams($arr,$xhtmlSafe=FALSE,$dontOmitBlankAttribs=FALSE)
 * 1851:     function wrapJS($string, $linebreak=TRUE)
 * 1882:     function xml2tree($string,$depth=999)
 * 1969:     function array2xml($array,$NSprefix='',$level=0,$docTag='phparray',$spaceInd=0, $options=array(),$stackData=array())
 * 2088:     function xml2array($string,$NSprefix='',$reportDocTag=FALSE)
 * 2198:     function xmlRecompileFromStructValArray($vals)
 * 2242:     function xmlGetHeaderAttribs($xmlData)
 *
 *              SECTION: FILES FUNCTIONS
 * 2275:     function getURL($url, $includeHeader=0)
 * 2342:     function writeFile($file,$content)
 * 2367:     function fixPermissions($file)
 * 2384:     function writeFileToTypo3tempDir($filepath,$content)
 * 2427:     function mkdir($theNewFolder)
 * 2446:     function mkdir_deep($destination,$deepDir)
 * 2468:     function get_dirs($path)
 * 2493:     function getFilesInDir($path,$extensionList='',$prependPath=0,$order='')
 * 2547:     function getAllFilesAndFoldersInPath($fileArr,$path,$extList='',$regDirs=0,$recursivityLevels=99)
 * 2570:     function removePrefixPathFromList($fileArr,$prefixToRemove)
 * 2586:     function fixWindowsFilePath($theFile)
 * 2598:     function resolveBackPath($pathStr)
 * 2626:     function locationHeaderUrl($path)
 *
 *              SECTION: DEBUG helper FUNCTIONS
 * 2666:     function debug_ordvalue($string,$characters=100)
 * 2683:     function view_array($array_in)
 * 2711:     function print_array($array_in)
 * 2726:     function debug($var="",$brOrHeader=0)
 * 2757:     function debug_trail()
 * 2779:     function debugRows($rows,$header='')
 *
 *              SECTION: SYSTEM INFORMATION
 * 2857:     function getThisUrl()
 * 2873:     function linkThisScript($getParams=array())
 * 2897:     function linkThisUrl($url,$getParams=array())
 * 2920:     function getIndpEnv($getEnvName)
 * 3113:     function milliseconds()
 * 3125:     function clientInfo($useragent='')
 *
 *              SECTION: TYPO3 SPECIFIC FUNCTIONS
 * 3212:     function getFileAbsFileName($filename,$onlyRelative=1,$relToTYPO3_mainDir=0)
 * 3248:     function validPathStr($theFile)
 * 3259:     function isAbsPath($path)
 * 3270:     function isAllowedAbsPath($path)
 * 3287:     function verifyFilenameAgainstDenyPattern($filename)
 * 3305:     function upload_copy_move($source,$destination)
 * 3331:     function upload_to_tempfile($uploadedFileName)
 * 3349:     function unlink_tempfile($uploadedTempFileName)
 * 3365:     function tempnam($filePrefix)
 * 3379:     function stdAuthCode($uid_or_record,$fields='',$codeLength=8)
 * 3410:     function cHashParams($addQueryParams)
 * 3433:     function hideIfNotTranslated($l18n_cfg_fieldValue)
 * 3448:     function readLLfile($fileRef,$langKey)
 * 3472:     function readLLXMLfile($fileRef,$langKey)
 * 3589:     function llXmlAutoFileName($fileRef,$language)
 * 3633:     function loadTCA($table)
 * 3653:     function resolveSheetDefInDS($dataStructArray,$sheet='sDEF')
 * 3686:     function resolveAllSheetsInDS($dataStructArray)
 * 3715:     function callUserFunction($funcName,&$params,&$ref,$checkPrefix='user_',$silent=0)
 * 3813:     function &getUserObj($classRef,$checkPrefix='user_',$silent=0)
 * 3871:     function &makeInstance($className)
 * 3883:     function makeInstanceClassName($className)
 * 3897:     function &makeInstanceService($serviceType, $serviceSubType='', $excludeServiceKeys=array())
 * 3961:     function plainMailEncoded($email,$subject,$message,$headers='',$enc='',$charset='',$dontEncodeHeader=false)
 * 4031:     function quoted_printable($string,$maxlen=76)
 * 4078:     function encodeHeader($line,$enc='',$charset='ISO-8859-1')
 * 4121:     function substUrlsInPlainText($message,$urlmode='76',$index_script_url='')
 * 4155:     function makeRedirectUrl($inUrl,$l=0,$index_script_url='')
 * 4182:     function freetypeDpiComp($font_size)
 * 4194:     function initSysLog()
 * 4251:     function sysLog($msg, $extKey, $severity=0)
 * 4334:     function devLog($msg, $extKey, $severity=0, $dataVar=FALSE)
 * 4355:     function arrayToLogString($arr, $valueList=array(), $valueLength=20)
 * 4378:     function imageMagickCommand($command, $parameters, $path='')
 * 4425:     function unQuoteFilenames($parameters,$unQuote=FALSE)
 * 4459:     function quoteJSvalue($value, $inScriptTags = false)
 *
 * TOTAL FUNCTIONS: 138
 * (This index is automatically created/updated by the extension "extdeveval")
 *
 */












/**
 * The legendary "t3lib_div" class - Miscellaneous functions for general purpose.
 * Most of the functions does not relate specifically to TYPO3
 * However a section of functions requires certain TYPO3 features available
 * See comments in the source.
 * You are encouraged to use this library in your own scripts!
 *
 * USE:
 * The class is intended to be used without creating an instance of it.
 * So: Don't instantiate - call functions with "t3lib_div::" prefixed the function name.
 * So use t3lib_div::[method-name] to refer to the functions, eg. 't3lib_div::milliseconds()'
 *
 * @author      Kasper Skaarhoj <kasperYYYY@typo3.com>
 * @package TYPO3
 * @subpackage t3lib
 */
class t3lib_div {





        /*************************
         *
         * GET/POST Variables
         *
         * Background:
         * Input GET/POST variables in PHP may have their quotes escaped with "\" or not depending on configuration.
         * TYPO3 has always converted quotes to BE escaped if the configuration told that they would not be so.
         * But the clean solution is that quotes are never escaped and that is what the functions below offers.
         * Eventually TYPO3 should provide this in the global space as well.
         * In the transitional phase (or forever..?) we need to encourage EVERY to read and write GET/POST vars through the API functions below.
         *
         *************************/

        /**
         * Returns the 'GLOBAL' value of incoming data from POST or GET, with priority to POST (that is equalent to 'GP' order)
         * Strips slashes from all output, both strings and arrays.
         * This function substitutes t3lib_div::GPvar()
         * To enhancement security in your scripts, please consider using t3lib_div::_GET or t3lib_div::_POST if you already know by which method your data is arriving to the scripts!
         * Usage: 537
         *
         * @param       string          GET/POST var to return
         * @return      mixed           POST var named $var and if not set, the GET var of the same name.
         * @see GPvar()
         */
        public static function _GP($var)        {
                if(empty($var)) return;
                $value = isset($_POST[$var]) ? $_POST[$var] : $_GET[$var];
                if (isset($value))      {
                        if (is_array($value))   { t3lib_div::stripSlashesOnArray($value); } else { $value = stripslashes($value); }
                }
                return $value;
        }

        /**
         * Returns the global GET array (or value from) normalized to contain un-escaped values.
         * ALWAYS use this API function to acquire the GET variables!
         * Usage: 27
         *
         * @param       string          Optional pointer to value in GET array (basically name of GET var)
         * @return      mixed           If $var is set it returns the value of $_GET[$var]. If $var is NULL (default), returns $_GET itself. In any case *slashes are stipped from the output!*
         * @see _POST(), _GP(), _GETset()
         */
        public static function _GET($var=NULL)  {
                $value = ($var === NULL) ? $_GET : (empty($var) ? NULL : $_GET[$var]);
                if (isset($value))      {       // Removes slashes since TYPO3 has added them regardless of magic_quotes setting.
                        if (is_array($value))   { t3lib_div::stripSlashesOnArray($value); } else { $value = stripslashes($value); }
                }
                return $value;
        }

        /**
         * Returns the global POST array (or value from) normalized to contain un-escaped values.
         * ALWAYS use this API function to acquire the POST variables!
         * Usage: 41
         *
         * @param       string          Optional pointer to value in POST array (basically name of POST var)
         * @return      mixed           If $var is set it returns the value of $_POST[$var]. If $var is NULL (default), returns $_POST itself. In any case *slashes are stipped from the output!*
         * @see _GET(), _GP()
         */
        public static function _POST($var=NULL) {
                $value = ($var === NULL) ? $_POST : (empty($var) ? NULL : $_POST[$var]);
                if (isset($value))      {       // Removes slashes since TYPO3 has added them regardless of magic_quotes setting.
                        if (is_array($value))   { t3lib_div::stripSlashesOnArray($value); } else { $value = stripslashes($value); }
                }
                return $value;
        }

        /**
         * Writes input value to $_GET
         * Usage: 2
         *
         * @param       array           Array to write to $_GET. Values should NOT be escaped at input time (but will be escaped before writing according to TYPO3 standards).
         * @param       string          Alternative key; If set, this will not set the WHOLE GET array, but only the key in it specified by this value!
         * @return      void
         */
        public static function _GETset(array $inputGet,$key='') {
                        // ADDS slashes since TYPO3 standard currently is that slashes MUST be applied (regardless of magic_quotes setting).
                if (strcmp($key,''))    {
                        if (is_array($inputGet))        { t3lib_div::addSlashesOnArray($inputGet); } else { $inputGet = addslashes($inputGet); }
                        $GLOBALS['HTTP_GET_VARS'][$key] = $_GET[$key] = $inputGet;
                } elseif (is_array($inputGet)){
                        t3lib_div::addSlashesOnArray($inputGet);
                        $GLOBALS['HTTP_GET_VARS'] = $_GET = $inputGet;
                }
        }

        /**
         * GET/POST variable
         * Returns the 'GLOBAL' value of incoming data from POST or GET, with priority to POST (that is equalent to 'GP' order)
         * Strips slashes of string-outputs, but not arrays UNLESS $strip is set. If $strip is set all output will have escaped characters unescaped.
         * Usage: 2
         *
         * @param       string          GET/POST var to return
         * @param       boolean         If set, values are stripped of return values that are *arrays!* - string/integer values returned are always strip-slashed()
         * @return      mixed           POST var named $var and if not set, the GET var of the same name.
         * @deprecated          Use t3lib_div::_GP instead (ALWAYS delivers a value with un-escaped values!)
         * @see _GP()
         */
        public static function GPvar($var,$strip=0)     {
                if(empty($var)) return;
                $value = isset($_POST[$var]) ? $_POST[$var] : $_GET[$var];
                if (isset($value) && is_string($value)) { $value = stripslashes($value); }      // Originally check '&& get_magic_quotes_gpc() ' but the values of $_GET are always slashed regardless of get_magic_quotes_gpc() because HTTP_POST/GET_VARS are run through addSlashesOnArray in the very beginning of index_ts.php eg.
                if ($strip && isset($value) && is_array($value)) { t3lib_div::stripSlashesOnArray($value); }
                return $value;
        }

        /**
         * Returns the GET/POST global arrays merged with POST taking precedence.
         * Usage: 1
         *
         * @param       string          Key (variable name) from GET or POST vars
         * @return      array           Returns the GET vars merged recursively onto the POST vars.
         * @ignore
         * @deprecated
         */
        public static function GParrayMerged($var)      {
                $postA = is_array($_POST[$var]) ? $_POST[$var] : array();
                $getA = is_array($_GET[$var]) ? $_GET[$var] : array();
                $mergedA = t3lib_div::array_merge_recursive_overrule($getA,$postA);
                t3lib_div::stripSlashesOnArray($mergedA);
                return $mergedA;
        }

        /**
         * Wrapper for the RemoveXSS function.
         * Removes potential XSS code from an input string.
         *
         * Using an external class by Travis Puderbaugh <kallahar@quickwired.com>
         *
         * @param       string          Input string
         * @return      string          Input string with potential XSS code removed
         */
        public function removeXSS($string)      {
                require_once(PATH_typo3.'contrib/RemoveXSS/RemoveXSS.php');
                $string = RemoveXSS::RemoveXSS($string);
                return $string;
        }










        /*************************
         *
         * IMAGE FUNCTIONS
         *
         *************************/


        /**
         * Compressing a GIF file if not already LZW compressed
         * This function is a workaround for the fact that ImageMagick and/or GD does not compress GIF-files to their minimun size (that is RLE or no compression used)
         *
         *              The function takes a file-reference, $theFile, and saves it again through GD or ImageMagick in order to compress the file
         *              GIF:
         *              If $type is not set, the compression is done with ImageMagick (provided that $GLOBALS['TYPO3_CONF_VARS']['GFX']['im_path_lzw'] is pointing to the path of a lzw-enabled version of 'convert') else with GD (should be RLE-enabled!)
         *              If $type is set to either 'IM' or 'GD' the compression is done with ImageMagick and GD respectively
         *              PNG:
         *              No changes.
         *
         *              $theFile is expected to be a valid GIF-file!
         *              The function returns a code for the operation.
         * Usage: 9
         *
         * @param       string          Filepath
         * @param       string          See description of function
         * @return      string          Returns "GD" if GD was used, otherwise "IM" if ImageMagick was used. If nothing done at all, it returns empty string.
         * @internal
         */
        public static function gif_compress($theFile, $type)    {
                $gfxConf = $GLOBALS['TYPO3_CONF_VARS']['GFX'];
                $returnCode='';
                if ($gfxConf['gif_compress'] && strtolower(substr($theFile,-4,4))=='.gif')      {       // GIF...
                        if (($type=='IM' || !$type) && $gfxConf['im'] && $gfxConf['im_path_lzw'])       {       // IM
                                $cmd = t3lib_div::imageMagickCommand('convert', '"'.$theFile.'" "'.$theFile.'"', $gfxConf['im_path_lzw']);
                                exec($cmd);

                                $returnCode='IM';
                        } elseif (($type=='GD' || !$type) && $gfxConf['gdlib'] && !$gfxConf['gdlib_png'])       {       // GD
                                $tempImage = imageCreateFromGif($theFile);
                                imageGif($tempImage, $theFile);
                                imageDestroy($tempImage);
                                $returnCode='GD';
                        }
                }
                return $returnCode;
        }

        /**
         * Converts a png file to gif
         * This converts a png file to gif IF the FLAG $GLOBALS['TYPO3_CONF_VARS']['FE']['png_to_gif'] is set true.
         * Usage: 5
         *
         * @param       string          $theFile        the filename with path
         * @return      string          new filename
         * @internal
         */
        public static function png_to_gif_by_imagemagick($theFile)      {
                if ($GLOBALS['TYPO3_CONF_VARS']['FE']['png_to_gif']
                        && $GLOBALS['TYPO3_CONF_VARS']['GFX']['im']
                        && $GLOBALS['TYPO3_CONF_VARS']['GFX']['im_path_lzw']
                        && strtolower(substr($theFile,-4,4))=='.png'
                        && @is_file($theFile))  {       // IM
                                $newFile = substr($theFile,0,-4).'.gif';
                                $cmd = t3lib_div::imageMagickCommand('convert', '"'.$theFile.'" "'.$newFile.'"', $GLOBALS['TYPO3_CONF_VARS']['GFX']['im_path_lzw']);
                                exec($cmd);
                                $theFile = $newFile;
                                        // unlink old file?? May be bad idea bacause TYPO3 would then recreate the file every time as TYPO3 thinks the file is not generated because it's missing!! So do not unlink $theFile here!!
                }
                return $theFile;
        }

        /**
         * Returns filename of the png/gif version of the input file (which can be png or gif).
         * If input file type does not match the wanted output type a conversion is made and temp-filename returned.
         * Usage: 2
         *
         * @param       string          Filepath of image file
         * @param       boolean         If set, then input file is converted to PNG, otherwise to GIF
         * @return      string          If the new image file exists, it's filepath is returned
         * @internal
         */
        public static function read_png_gif($theFile,$output_png=0)     {
                if ($GLOBALS['TYPO3_CONF_VARS']['GFX']['im'] && @is_file($theFile))     {
                        $ext = strtolower(substr($theFile,-4,4));
                        if (
                                        ((string)$ext=='.png' && $output_png)   ||
                                        ((string)$ext=='.gif' && !$output_png)
                                )       {
                                return $theFile;
                        } else {
                                $newFile = PATH_site.'typo3temp/readPG_'.md5($theFile.'|'.filemtime($theFile)).($output_png?'.png':'.gif');
                                $cmd = t3lib_div::imageMagickCommand('convert', '"'.$theFile.'" "'.$newFile.'"', $GLOBALS['TYPO3_CONF_VARS']['GFX']['im_path']);
                                exec($cmd);
                                if (@is_file($newFile)) return $newFile;
                        }
                }
        }















        /*************************
         *
         * STRING FUNCTIONS
         *
         *************************/

        /**
         * Truncate string
         * Returns a new string of max. $chars length.
         * If the string is longer, it will be truncated and appended with '...'.
         * Usage: 39
         *
         * @param       string          string to truncate
         * @param       integer         must be an integer with an absolute value of at least 4. if negative the string is cropped from the right end.
         * @param       string          String to append to the output if it is truncated, default is '...'
         * @return      string          new string
         * @deprecated          Works ONLY for single-byte charsets! USE t3lib_div::fixed_lgd_cs() instead
         * @see fixed_lgd_pre()
         */
        public static function fixed_lgd($string,$origChars,$preStr='...')      {
                $chars = abs($origChars);
                if ($chars >= 4)        {
                        if(strlen($string)>$chars)  {
                                return $origChars < 0 ?
                                        $preStr.trim(substr($string, -($chars-3))) :
                                        trim(substr($string, 0, $chars-3)).$preStr;
                        }
                }
                return $string;
        }

        /**
         * Truncate string
         * Returns a new string of max. $chars length.
         * If the string is longer, it will be truncated and prepended with '...'.
         * This works like fixed_lgd, but is truncated in the start of the string instead of the end
         * Usage: 6
         *
         * @param       string          string to truncate
         * @param       integer         must be an integer of at least 4
         * @return      string          new string
         * @deprecated          Use either fixed_lgd() or fixed_lgd_cs() (with negative input value for $chars)
         * @see fixed_lgd()
         */
        public static function fixed_lgd_pre($string,$chars)    {
                return strrev(t3lib_div::fixed_lgd(strrev($string),$chars));
        }

        /**
         * Truncates a string with appended/prepended "..." and takes backend character set into consideration
         * Use only from backend!
         * Usage: 75
         *
         * @param       string          string to truncate
         * @param       integer         must be an integer with an absolute value of at least 4. if negative the string is cropped from the right end.
         * @return      string          New string
         * @see fixed_lgd()
         */
        public static function fixed_lgd_cs($string,$chars)     {
                if (is_object($GLOBALS['LANG']))        {
                        return $GLOBALS['LANG']->csConvObj->crop($GLOBALS['LANG']->charSet,$string,$chars,'...');
                } else {
                        return t3lib_div::fixed_lgd($string, $chars);
                }
        }

        /**
         * Breaks up the text for emails
         * Usage: 1
         *
         * @param       string          The string to break up
         * @param       string          The string to implode the broken lines with (default/typically \n)
         * @param       integer         The line length
         * @deprecated          Use PHP function wordwrap()
         * @return      string
         */
        public static function breakTextForEmail($str,$implChar="\n",$charWidth=76)     {
                $lines = explode(chr(10),$str);
                $outArr=array();
                while(list(,$lStr)=each($lines))        {
                        $outArr[] = t3lib_div::breakLinesForEmail($lStr,$implChar,$charWidth);
                }
                return implode(chr(10),$outArr);
        }

        /**
         * Breaks up a single line of text for emails
         * Usage: 5
         *
         * @param       string          The string to break up
         * @param       string          The string to implode the broken lines with (default/typically \n)
         * @param       integer         The line length
         * @return      string
         * @see breakTextForEmail()
         */
        public static function breakLinesForEmail($str,$implChar="\n",$charWidth=76)    {
                $lines=array();
                $l=$charWidth;
                $p=0;
                while(strlen($str)>$p)  {
                        $substr=substr($str,$p,$l);
                        if (strlen($substr)==$l)        {
                                $count = count(explode(' ',trim(strrev($substr))));
                                if ($count>1)   {       // OK...
                                        $parts = explode(' ',strrev($substr),2);
                                        $theLine = strrev($parts[1]);
                                } else {
                                        $afterParts = explode(' ',substr($str,$l+$p),2);
                                        $theLine = $substr.$afterParts[0];
                                }
                                if (!strlen($theLine))  {break; }       // Error, because this would keep us in an endless loop.
                        } else {
                                $theLine=$substr;
                        }

                        $lines[]=trim($theLine);
                        $p+=strlen($theLine);
                        if (!trim(substr($str,$p,$l)))  break;  // added...
                }
                return implode($implChar,$lines);
        }

        /**
         * Match IP number with list of numbers with wildcard
         * Dispatcher method for switching into specialised IPv4 and IPv6 methods.
         * Usage: 10
         *
         * @param       string          $baseIP is the current remote IP address for instance, typ. REMOTE_ADDR
         * @param       string          $list is a comma-list of IP-addresses to match with. *-wildcard allowed instead of number, plus leaving out parts in the IP number is accepted as wildcard (eg. 192.168.*.* equals 192.168). If list is "*" no check is done and the function returns TRUE immediately.
         * @return      boolean         True if an IP-mask from $list matches $baseIP
         */
        public static function cmpIP($baseIP, $list)    {
                if ($list==='*')        return TRUE;
                if (strstr($baseIP, ':') && t3lib_div::validIPv6($baseIP))      {
                        return t3lib_div::cmpIPv6($baseIP, $list);
                } else {
                        return t3lib_div::cmpIPv4($baseIP, $list);
                }
        }

        /**
         * Match IPv4 number with list of numbers with wildcard
         *
         * @param       string          $baseIP is the current remote IP address for instance, typ. REMOTE_ADDR
         * @param       string          $list is a comma-list of IP-addresses to match with. *-wildcard allowed instead of number, plus leaving out parts in the IP number is accepted as wildcard (eg. 192.168.*.* equals 192.168)
         * @return      boolean         True if an IP-mask from $list matches $baseIP
         */
        public static function cmpIPv4($baseIP, $list)  {
                $IPpartsReq = explode('.',$baseIP);
                if (count($IPpartsReq)==4)      {
                        $values = t3lib_div::trimExplode(',',$list,1);

                        foreach($values as $test)       {
                                list($test,$mask) = explode('/',$test);

                                if(intval($mask)) {
                                                // "192.168.3.0/24"
                                        $lnet = ip2long($test);
                                        $lip = ip2long($baseIP);
                                        $binnet = str_pad( decbin($lnet),32,'0','STR_PAD_LEFT');
                                        $firstpart = substr($binnet,0,$mask);
                                        $binip = str_pad( decbin($lip),32,'0','STR_PAD_LEFT');
                                        $firstip = substr($binip,0,$mask);
                                        $yes = (strcmp($firstpart,$firstip)==0);
                                } else {
                                                // "192.168.*.*"
                                        $IPparts = explode('.',$test);
                                        $yes = 1;
                                        reset($IPparts);
                                        while(list($index,$val)=each($IPparts)) {
                                                $val = trim($val);
                                                if (strcmp($val,'*') && strcmp($IPpartsReq[$index],$val))       {
                                                        $yes=0;
                                                }
                                        }
                                }
                                if ($yes) return true;
                        }
                }
                return false;
        }

        /**
         * Match IPv6 address with a list of IPv6 prefixes
         *
         * @param       string          $baseIP is the current remote IP address for instance
         * @param       string          $list is a comma-list of IPv6 prefixes, could also contain IPv4 addresses
         * @return      boolean         True if an baseIP matches any prefix
         */
        public static function cmpIPv6($baseIP, $list)  {
                $success = false;       // Policy default: Deny connection
                $baseIP = t3lib_div::normalizeIPv6($baseIP);

                $values = t3lib_div::trimExplode(',',$list,1);
                foreach ($values as $test)      {
                        list($test,$mask) = explode('/',$test);
                        if (t3lib_div::validIPv6($test))        {
                                $test = t3lib_div::normalizeIPv6($test);
                                if (intval($mask))      {
                                        switch ($mask) {        // test on /48 /64
                                                case '48':
                                                        $testBin = substr(t3lib_div::IPv6Hex2Bin($test), 0, 48);
                                                        $baseIPBin = substr(t3lib_div::IPv6Hex2Bin($baseIP), 0, 48);
                                                        $success = strcmp($testBin, $baseIPBin)==0 ? true : false;
                                                break;
                                                case '64':
                                                        $testBin = substr(t3lib_div::IPv6Hex2Bin($test), 0, 64);
                                                        $baseIPBin = substr(t3lib_div::IPv6Hex2Bin($baseIP), 0, 64);
                                                        $success = strcmp($testBin, $baseIPBin)==0 ? true : false;
                                                break;
                                                default:
                                                        $success = false;
                                        }
                                } else {
                                        if (t3lib_div::validIPv6($test))        {       // test on full ip address 128 bits
                                                $testBin = t3lib_div::IPv6Hex2Bin($test);
                                                $baseIPBin = t3lib_div::IPv6Hex2Bin($baseIP);
                                                $success = strcmp($testBin, $baseIPBin)==0 ? true : false;
                                        }
                                }
                        }
                        if ($success) return true;
                }
                return false;
        }

        /**
         * [Describe function...]
         *
         * @param       [type]          $hex: ...
         * @return      [type]          ...
         */
        public static function IPv6Hex2Bin ($hex)       {
                $bin = '';
                $hex = str_replace(':', '', $hex);      // Replace colon to nothing
                for ($i=0; $i<strlen($hex); $i=$i+2)    {
                        $bin.= chr(hexdec(substr($hex, $i, 2)));
                }
                return $bin;
        }

        /**
         * Normalize an IPv6 address to full length
         *
         * @param       string          Given IPv6 address
         * @return      string          Normalized address
         */
        public static function normalizeIPv6($address)  {
                $normalizedAddress = '';
                $stageOneAddress = '';

                $chunks = explode('::', $address);      // Count 2 if if address has hidden zero blocks
                if (count($chunks)==2)  {
                        $chunksLeft = explode(':', $chunks[0]);
                        $chunksRight = explode(':', $chunks[1]);
                        $left = count($chunksLeft);
                        $right = count($chunksRight);

                                // Special case: leading zero-only blocks count to 1, should be 0
                        if ($left==1 && strlen($chunksLeft[0])==0)      $left=0;

                        $hiddenBlocks = 8 - ($left + $right);
                        $hiddenPart = '';
                        while ($h<$hiddenBlocks)        {
                                $hiddenPart .= '0000:';
                                $h++;
                        }

                        if ($left == 0) {
                                $stageOneAddress = $hiddenPart . $chunks[1];
                        } else {
                                $stageOneAddress = $chunks[0] . ':' . $hiddenPart . $chunks[1];
                        }
                } else $stageOneAddress = $address;

                        // normalize the blocks:
                $blocks = explode(':', $stageOneAddress);
                $divCounter = 0;
                foreach ($blocks as $block)     {
                        $tmpBlock = '';
                        $i = 0;
                        $hiddenZeros = 4 - strlen($block);
                        while ($i < $hiddenZeros)       {
                                $tmpBlock .= '0';
                                $i++;
                        }
                        $normalizedAddress .= $tmpBlock . $block;
                        if ($divCounter < 7)    {
                                $normalizedAddress .= ':';
                                $divCounter++;
                        }
                }
                return $normalizedAddress;
        }

        /**
         * Validate a given IP address to the IPv6 address format.
         *
         * Example for possible format:  43FB::BB3F:A0A0:0 | ::1
         *
         * @param       string          IP address to be tested
         * @return      boolean         True if $ip is of IPv6 format.
         */
        public static function validIPv6($ip)   {
                $uppercaseIP = strtoupper($ip);

                $regex = '/^(';
                $regex.= '(([\dA-F]{1,4}:){7}[\dA-F]{1,4})|';
                $regex.= '(([\dA-F]{1,4}){1}::([\dA-F]{1,4}:){1,5}[\dA-F]{1,4})|';
                $regex.= '(([\dA-F]{1,4}:){2}:([\dA-F]{1,4}:){1,4}[\dA-F]{1,4})|';
                $regex.= '(([\dA-F]{1,4}:){3}:([\dA-F]{1,4}:){1,3}[\dA-F]{1,4})|';
                $regex.= '(([\dA-F]{1,4}:){4}:([\dA-F]{1,4}:){1,2}[\dA-F]{1,4})|';
                $regex.= '(([\dA-F]{1,4}:){5}:([\dA-F]{1,4}:){0,1}[\dA-F]{1,4})|';
                $regex.= '(::([\dA-F]{1,4}:){0,6}[\dA-F]{1,4})';
                $regex.= ')$/';

                return preg_match($regex, $uppercaseIP) ? true : false;
        }

        /**
         * Match fully qualified domain name with list of strings with wildcard
         *
         * @param       string          The current remote IP address for instance, typ. REMOTE_ADDR
         * @param       string          A comma-list of domain names to match with. *-wildcard allowed but cannot be part of a string, so it must match the full host name (eg. myhost.*.com => correct, myhost.*domain.com => wrong)
         * @return      boolean         True if a domain name mask from $list matches $baseIP
         */
        public static function cmpFQDN($baseIP, $list)        {
                if (count(explode('.',$baseIP))==4)     {
                        $resolvedHostName = explode('.', gethostbyaddr($baseIP));
                        $values = t3lib_div::trimExplode(',',$list,1);

                        foreach($values as $test)       {
                                $hostNameParts = explode('.',$test);
                                $yes = 1;

                                foreach($hostNameParts as $index => $val)       {
                                        $val = trim($val);
                                        if (strcmp($val,'*') && strcmp($resolvedHostName[$index],$val)) {
                                                $yes=0;
                                        }
                                }
                                if ($yes) return true;
                        }
                }
                return false;
        }

        /**
         * Check for item in list
         * Check if an item exists in a comma-separated list of items.
         * Usage: 163
         *
         * @param       string          comma-separated list of items (string)
         * @param       string          item to check for
         * @return      boolean         true if $item is in $list
         */
        public static function inList($list,$item)      {
                return strstr(','.$list.',', ','.$item.',') ? true : false;
        }

        /**
         * Removes an item from a comma-separated list of items.
         * Usage: 1
         *
         * @param       string          element to remove
         * @param       string          comma-separated list of items (string)
         * @return      string          new comma-separated list of items
         */
        public static function rmFromList($element,$list)       {
                $items = explode(',',$list);
                while(list($k,$v)=each($items)) {
                        if ($v==$element)       {unset($items[$k]);}
                }
                return implode(',',$items);
        }

        /**
         * Expand a comma-separated list of integers with ranges (eg 1,3-5,7 becomes 1,3,4,5,7).
         * Ranges are limited to 1000 values per range.
         *
         * @param       string          comma-separated list of integers with ranges (string)
         * @return      string          new comma-separated list of items
         * @author      Martin Kutschker <martin.kutschker@activesolution.at>
         */
        public static function expandList($list)      {
                $items = explode(',',$list);
                $list = array();
                while(list(,$item)=each($items))        {
                        $range = explode('-',$item);
                        if (isset($range[1]))   {
                                $runAwayBrake = 1000;
                                for ($n=$range[0]; $n<=$range[1]; $n++) {
                                        $list[] = $n;

                                        $runAwayBrake--;
                                        if ($runAwayBrake<=0)   break;
                                }
                        } else {
                                $list[] = $item;
                        }
                }

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

        /**
         * Forces the integer $theInt into the boundaries of $min and $max. If the $theInt is 'false' then the $zeroValue is applied.
         * Usage: 224
         *
         * @param       integer         Input value
         * @param       integer         Lower limit
         * @param       integer         Higher limit
         * @param       integer         Default value if input is false.
         * @return      integer         The input value forced into the boundaries of $min and $max
         */
        public static function intInRange($theInt,$min,$max=2000000000,$zeroValue=0)    {
                // Returns $theInt as an integer in the integerspace from $min to $max
                $theInt = intval($theInt);
                if ($zeroValue && !$theInt)     {$theInt=$zeroValue;}   // If the input value is zero after being converted to integer, zeroValue may set another default value for it.
                if ($theInt<$min){$theInt=$min;}
                if ($theInt>$max){$theInt=$max;}
                return $theInt;
        }

        /**
         * Returns the $integer if greater than zero, otherwise returns zero.
         * Usage: 1
         *
         * @param       integer         Integer string to process
         * @return      integer
         */
        public static function intval_positive($theInt) {
                $theInt = intval($theInt);
                if ($theInt<0){$theInt=0;}
                return $theInt;
        }

        /**
         * Returns an integer from a three part version number, eg '4.12.3' -> 4012003
         * Usage: 2
         *
         * @param       string          Version number on format x.x.x
         * @return      integer         Integer version of version number (where each part can count to 999)
         */
        public static function int_from_ver($verNumberStr)      {
                $verParts = explode('.',$verNumberStr);
                return intval((int)$verParts[0].str_pad((int)$verParts[1],3,'0',STR_PAD_LEFT).str_pad((int)$verParts[2],3,'0',STR_PAD_LEFT));
        }

        /**
         * Returns true if the current TYPO3 version (or compatibility version) is compatible to the input version
         * Notice that this function compares branches, not versions (4.0.1 would be > 4.0.0 although they use the same compat_version)
         *
         * @param       string          Minimum branch number required (format x.y / e.g. "4.0" NOT "4.0.0"!)
         * @return      boolean         Returns true if this setup is compatible with the provided version number
         * @todo        Still needs a function to convert versions to branches
         */
        public static function compat_version($verNumberStr)    {
                global $TYPO3_CONF_VARS;
                $currVersionStr = $TYPO3_CONF_VARS['SYS']['compat_version'] ? $TYPO3_CONF_VARS['SYS']['compat_version'] : TYPO3_branch;

                if (t3lib_div::int_from_ver($currVersionStr) < t3lib_div::int_from_ver($verNumberStr))  {
                        return FALSE;
                } else {
                        return TRUE;
                }
        }

        /**
         * Makes a positive integer hash out of the first 7 chars from the md5 hash of the input
         * Usage: 5
         *
         * @param       string          String to md5-hash
         * @return      integer         Returns 28bit integer-hash
         */
        public static function md5int($str)     {
                return hexdec(substr(md5($str),0,7));
        }

        /**
         * Returns the first 10 positions of the MD5-hash               (changed from 6 to 10 recently)
         *
         * Usage: 37
         *
         * @param       string          Input string to be md5-hashed
         * @param       integer         The string-length of the output
         * @return      string          Substring of the resulting md5-hash, being $len chars long (from beginning)
         */
        public static function shortMD5($input, $len=10)        {
                return substr(md5($input),0,$len);
        }

        /**
         * Takes comma-separated lists and arrays and removes all duplicates
         * If a value in the list is trim(empty), the value is ignored.
         * Usage: 16
         *
         * @param       string          Accept multiple parameters wich can be comma-separated lists of values and arrays.
         * @param       mixed           $secondParameter: Dummy field, which if set will show a warning!
         * @return      string          Returns the list without any duplicates of values, space around values are trimmed
         */
        public static function uniqueList($in_list, $secondParameter=NULL)      {
                if (is_array($in_list)) die('t3lib_div::uniqueList() does NOT support array arguments anymore! Only string comma lists!');
                if (isset($secondParameter))    die('t3lib_div::uniqueList() does NOT support more than a single argument value anymore. You have specified more than one.');

                return implode(',',array_unique(t3lib_div::trimExplode(',',$in_list,1)));
        }

        /**
         * Splits a reference to a file in 5 parts
         * Usage: 43
         *
         * @param       string          Filename/filepath to be analysed
         * @return      array           Contains keys [path], [file], [filebody], [fileext], [realFileext]
         */
        public static function split_fileref($fileref)  {
                $reg = array();
                if (    ereg('(.*/)(.*)$',$fileref,$reg)        )       {
                        $info['path'] = $reg[1];
                        $info['file'] = $reg[2];
                } else {
                        $info['path'] = '';
                        $info['file'] = $fileref;
                }
                $reg='';
                if (    ereg('(.*)\.([^\.]*$)',$info['file'],$reg)      )       {
                        $info['filebody'] = $reg[1];
                        $info['fileext'] = strtolower($reg[2]);
                        $info['realFileext'] = $reg[2];
                } else {
                        $info['filebody'] = $info['file'];
                        $info['fileext'] = '';
                }
                reset($info);
                return $info;
        }

        /**
         * Returns the directory part of a path without trailing slash
         * If there is no dir-part, then an empty string is returned.
         * Behaviour:
         *
         * '/dir1/dir2/script.php' => '/dir1/dir2'
         * '/dir1/' => '/dir1'
         * 'dir1/script.php' => 'dir1'
         * 'd/script.php' => 'd'
         * '/script.php' => ''
         * '' => ''
         * Usage: 5
         *
         * @param       string          Directory name / path
         * @return      string          Processed input value. See function description.
         */
        public static function dirname($path)   {
                $p=t3lib_div::revExplode('/',$path,2);
                return count($p)==2?$p[0]:'';
        }

        /**
         * Modifies a HTML Hex color by adding/subtracting $R,$G and $B integers
         * Usage: 11
         *
         * @param       string          A hexadecimal color code, #xxxxxx
         * @param       integer         Offset value 0-255
         * @param       integer         Offset value 0-255
         * @param       integer         Offset value 0-255
         * @return      string          A hexadecimal color code, #xxxxxx, modified according to input vars
         * @see modifyHTMLColorAll()
         */
        public static function modifyHTMLColor($color,$R,$G,$B) {
                // This takes a hex-color (# included!) and adds $R, $G and $B to the HTML-color (format: #xxxxxx) and returns the new color
                $nR = t3lib_div::intInRange(hexdec(substr($color,1,2))+$R,0,255);
                $nG = t3lib_div::intInRange(hexdec(substr($color,3,2))+$G,0,255);
                $nB = t3lib_div::intInRange(hexdec(substr($color,5,2))+$B,0,255);
                return '#'.
                        substr('0'.dechex($nR),-2).
                        substr('0'.dechex($nG),-2).
                        substr('0'.dechex($nB),-2);
        }

        /**
         * Modifies a HTML Hex color by adding/subtracting $all integer from all R/G/B channels
         * Usage: 6
         *
         * @param       string          A hexadecimal color code, #xxxxxx
         * @param       integer         Offset value 0-255 for all three channels.
         * @return      string          A hexadecimal color code, #xxxxxx, modified according to input vars
         * @see modifyHTMLColor()
         */
        public static function modifyHTMLColorAll($color,$all)  {
                return t3lib_div::modifyHTMLColor($color,$all,$all,$all);
        }

        /**
         * Removes comma (if present) in the end of string
         * Usage: 2
         *
         * @param       string          String from which the comma in the end (if any) will be removed.
         * @return      string
         */
        public static function rm_endcomma($string)     {
                return ereg_replace(',$','',$string);
        }

        /**
         * strtoupper which converts danish (and other characters) characters as well
         * Usage: 0
         *
         * @param       string          String to process
         * @return      string
         * @deprecated          Use t3lib_cs::conv_case() instead or for HTML output, wrap your content in <span class="uppercase">...</span>)
         * @ignore
         */
        public static function danish_strtoupper($string)       {
                $value = strtoupper($string);
                return strtr($value, 'áéúíâêûôîæøåäöü', 'ÁÉÚÍÄËÜÖÏÆØÅÄÖÜ');
        }

        /**
         * Change umlaut characters to plain ASCII with normally two character target
         * Only known characters will be converted, so don't expect a result for any character.
         *
         * ä => ae, Ö => Oe
         *
         * @param       string          String to convert.
         * @deprecated          Works only for western europe single-byte charsets! Use t3lib_cs::specCharsToASCII() instead!
         * @return      string
         */
        public static function convUmlauts($str)        {
                $pat  = array ( '/ä/', '/Ä/', '/ö/', '/Ö/', '/ü/', '/Ü/', '/ß/', '/å/', '/Å/', '/ø/', '/Ø/', '/æ/', '/Æ/'  );
                $repl = array ( 'ae',   'Ae',   'oe',   'Oe',   'ue',   'Ue',   'ss',   'aa',   'AA',   'oe',   'OE',   'ae',   'AE'    );
                return preg_replace($pat,$repl,$str);
        }

        /**
         * Tests if the input is an integer.
         * Usage: 77
         *
         * @param       mixed           Any input variable to test.
         * @return      boolean         Returns true if string is an integer
         */
        public static function testInt($var)    {
                return !strcmp($var,intval($var));
        }

        /**
         * Returns true if the first part of $str matches the string $partStr
         * Usage: 59
         *
         * @param       string          Full string to check
         * @param       string          Reference string which must be found as the "first part" of the full string
         * @return      boolean         True if $partStr was found to be equal to the first part of $str
         */
        public static function isFirstPartOfStr($str,$partStr)  {
                // Returns true, if the first part of a $str equals $partStr and $partStr is not ''
                $psLen = strlen($partStr);
                if ($psLen)     {
                        return substr($str,0,$psLen)==(string)$partStr;
                } else return false;
        }

        /**
         * Formats the input integer $sizeInBytes as bytes/kilobytes/megabytes (-/K/M)
         * Usage: 53
         *
         * @param       integer         Number of bytes to format.
         * @param       string          Labels for bytes, kilo, mega and giga separated by vertical bar (|) and possibly encapsulated in "". Eg: " | K| M| G" (which is the default value)
         * @return      string          Formatted representation of the byte number, for output.
         */
        public static function formatSize($sizeInBytes,$labels='')      {

                        // Set labels:
                if (strlen($labels) == 0) {
                    $labels = ' | K| M| G';
                } else {
                    $labels = str_replace('"','',$labels);
                }
                $labelArr = explode('|',$labels);

                        // Find size:
                if ($sizeInBytes>900)   {
                        if ($sizeInBytes>900000000)     {       // GB
                                $val = $sizeInBytes/(1024*1024*1024);
                                return number_format($val, (($val<20)?1:0), '.', '').$labelArr[3];
                        }
                        elseif ($sizeInBytes>900000)    {       // MB
                                $val = $sizeInBytes/(1024*1024);
                                return number_format($val, (($val<20)?1:0), '.', '').$labelArr[2];
                        } else {        // KB
                                $val = $sizeInBytes/(1024);
                                return number_format($val, (($val<20)?1:0), '.', '').$labelArr[1];
                        }
                } else {        // Bytes
                        return $sizeInBytes.$labelArr[0];
                }
        }

        /**
         * Returns microtime input to milliseconds
         * Usage: 2
         *
         * @param       string          Microtime
         * @return      integer         Microtime input string converted to an integer (milliseconds)
         */
        public static function convertMicrotime($microtime)     {
                $parts = explode(' ',$microtime);
                return round(($parts[0]+$parts[1])*1000);
        }

        /**
         * This splits a string by the chars in $operators (typical /+-*) and returns an array with them in
         * Usage: 2
         *
         * @param       string          Input string, eg "123 + 456 / 789 - 4"
         * @param       string          Operators to split by, typically "/+-*"
         * @return      array           Array with operators and operands separated.
         * @see tslib_cObj::calc(), tslib_gifBuilder::calcOffset()
         */
        public static function splitCalc($string,$operators)    {
                $res = Array();
                $sign='+';
                while($string)  {
                        $valueLen=strcspn($string,$operators);
                        $value=substr($string,0,$valueLen);
                        $res[] = Array($sign,trim($value));
                        $sign=substr($string,$valueLen,1);
                        $string=substr($string,$valueLen+1);
                }
                reset($res);
                return $res;
        }

        /**
         * Calculates the input by +,-,*,/,%,^ with priority to + and -
         * Usage: 1
         *
         * @param       string          Input string, eg "123 + 456 / 789 - 4"
         * @return      integer         Calculated value. Or error string.
         * @see calcParenthesis()
         */
        public static function calcPriority($string)    {
                $string=ereg_replace('[[:space:]]*','',$string);        // removing all whitespace
                $string='+'.$string;    // Ensuring an operator for the first entrance
                $qm='\*\/\+-^%';
                $regex = '(['.$qm.'])(['.$qm.']?[0-9\.]*)';
                        // split the expression here:
                $reg = array();
                preg_match_all('/'.$regex.'/',$string,$reg);

                reset($reg[2]);
                $number=0;
                $Msign='+';
                $err='';
                $buffer=doubleval(current($reg[2]));
                next($reg[2]);  // Advance pointer
                while(list($k,$v)=each($reg[2]))        {
                        $v=doubleval($v);
                        $sign = $reg[1][$k];
                        if ($sign=='+' || $sign=='-')   {
                                $number = $Msign=='-' ? $number-=$buffer : $number+=$buffer;
                                $Msign = $sign;
                                $buffer=$v;
                        } else {
                                if ($sign=='/') {if ($v) $buffer/=$v; else $err='dividing by zero';}
                                if ($sign=='%') {if ($v) $buffer%=$v; else $err='dividing by zero';}
                                if ($sign=='*') {$buffer*=$v;}
                                if ($sign=='^') {$buffer=pow($buffer,$v);}
                        }
                }
                $number = $Msign=='-' ? $number-=$buffer : $number+=$buffer;
                return $err ? 'ERROR: '.$err : $number;
        }

        /**
         * Calculates the input with parenthesis levels
         * Usage: 2
         *
         * @param       string          Input string, eg "(123 + 456) / 789 - 4"
         * @return      integer         Calculated value. Or error string.
         * @see calcPriority(), tslib_cObj::stdWrap()
         */
        public static function calcParenthesis($string) {
                $securC=100;
                do {
                        $valueLenO=strcspn($string,'(');
                        $valueLenC=strcspn($string,')');
                        if ($valueLenC==strlen($string) || $valueLenC < $valueLenO)     {
                                $value = t3lib_div::calcPriority(substr($string,0,$valueLenC));
                                $string = $value.substr($string,$valueLenC+1);
                                return $string;
                        } else {
                                $string = substr($string,0,$valueLenO).t3lib_div::calcParenthesis(substr($string,$valueLenO+1));
                        }
                                // Security:
                        $securC--;
                        if ($securC<=0) break;
                } while($valueLenO<strlen($string));
                return $string;
        }

        /**
         * Inverse version of htmlspecialchars()
         * Usage: 4
         *
         * @param       string          Value where &gt;, &lt;, &quot; and &amp; should be converted to regular chars.
         * @return      string          Converted result.
         */
        public static function htmlspecialchars_decode($value)  {
                $value = str_replace('&gt;','>',$value);
                $value = str_replace('&lt;','<',$value);
                $value = str_replace('&quot;','"',$value);
                $value = str_replace('&amp;','&',$value);
                return $value;
        }

        /**
         * Re-converts HTML entities if they have been converted by htmlspecialchars()
         * Usage: 10
         *
         * @param       string          String which contains eg. "&amp;amp;" which should stay "&amp;". Or "&amp;#1234;" to "&#1234;". Or "&amp;#x1b;" to "&#x1b;"
         * @return      string          Converted result.
         */
        public static function deHSCentities($str)      {
                return ereg_replace('&amp;([#[:alnum:]]*;)','&\1',$str);
        }

        /**
         * This function is used to escape any ' -characters when transferring text to JavaScript!
         * Usage: 3
         *
         * @param       string          String to escape
         * @param       boolean         If set, also backslashes are escaped.
         * @param       string          The character to escape, default is ' (single-quote)
         * @return      string          Processed input string
         */
        public static function slashJS($string,$extended=0,$char="'")   {
                if ($extended)  {$string = str_replace ("\\", "\\\\", $string);}
                return str_replace ($char, "\\".$char, $string);
        }

        /**
         * Version of rawurlencode() where all spaces (%20) are re-converted to space-characters.
         * Usefull when passing text to JavaScript where you simply url-encode it to get around problems with syntax-errors, linebreaks etc.
         * Usage: 4
         *
         * @param       string          String to raw-url-encode with spaces preserved
         * @return      string          Rawurlencoded result of input string, but with all %20 (space chars) converted to real spaces.
         */
        public static function rawUrlEncodeJS($str)     {
                return str_replace('%20',' ',rawurlencode($str));
        }

        /**
         * rawurlencode which preserves "/" chars
         * Usefull when filepaths should keep the "/" chars, but have all other special chars encoded.
         * Usage: 5
         *
         * @param       string          Input string
         * @return      string          Output string
         */
        public static function rawUrlEncodeFP($str)     {
                return str_replace('%2F','/',rawurlencode($str));
        }

        /**
         * Checking syntax of input email address
         * Usage: 5
         *
         * @param       string          Input string to evaluate
         * @return      boolean         Returns true if the $email address (input string) is valid; Has a "@", domain name with at least one period and only allowed a-z characters.
         */
        public static function validEmail($email)       {
                $email = trim ($email);
                if (strstr($email,' '))  return FALSE;
                return ereg('^[A-Za-z0-9\._-]+[@][A-Za-z0-9\._-]+[\.].[A-Za-z0-9]+$',$email) ? TRUE : FALSE;
        }

        /**
         * Formats a string for output between <textarea>-tags
         * All content outputted in a textarea form should be passed through this function
         * Not only is the content htmlspecialchar'ed on output but there is also a single newline added in the top. The newline is necessary because browsers will ignore the first newline after <textarea> if that is the first character. Therefore better set it!
         * Usage: 23
         *
         * @param       string          Input string to be formatted.
         * @return      string          Formatted for <textarea>-tags
         */
        public static function formatForTextarea($content)      {
                return chr(10).htmlspecialchars($content);
        }












        /*************************
         *
         * ARRAY FUNCTIONS
         *
         *************************/

        /**
         * Check if an item exists in an array
         * Please note that the order of parameters is reverse compared to the php4-function in_array()!!!
         * Usage: 3
         *
         * @param       array           one-dimensional array of items
         * @param       string          item to check for
         * @return      boolean         true if $item is in the one-dimensional array $in_array
         * @internal
         */
        public static function inArray(array $in_array,$item)   {
                while (list(,$val)=each($in_array))     {
                        if (!is_array($val) && !strcmp($val,$item)) return true;
                }
        }

        /**
         * Explodes a $string delimited by $delim and passes each item in the array through intval().
         * Corresponds to explode(), but with conversion to integers for all values.
         * Usage: 76
         *
         * @param       string          Delimiter string to explode with
         * @param       string          The string to explode
         * @return      array           Exploded values, all converted to integers
         */
        public static function intExplode($delim, $string)      {
                $temp = explode($delim,$string);
                while(list($key,$val)=each($temp))      {
                        $temp[$key]=intval($val);
                }
                reset($temp);
                return $temp;
        }

        /**
         * Reverse explode which explodes the string counting from behind.
         * Thus t3lib_div::revExplode(':','my:words:here',2) will return array('my:words','here')
         * Usage: 8
         *
         * @param       string          Delimiter string to explode with
         * @param       string          The string to explode
         * @param       integer         Number of array entries
         * @return      array           Exploded values
         */
        public static function revExplode($delim, $string, $count=0)    {
                $temp = explode($delim,strrev($string),$count);
                while(list($key,$val)=each($temp))      {
                        $temp[$key]=strrev($val);
                }
                $temp = array_reverse($temp);
                reset($temp);
                return $temp;
        }

        /**
         * Explodes a string and trims all values for whitespace in the ends.
         * If $onlyNonEmptyValues is set, then all blank ('') values are removed.
         * Usage: 256
         *
         * @param       string          Delimiter string to explode with
         * @param       string          The string to explode
         * @param       boolean         If set, all empty values (='') will NOT be set in output
         * @return      array           Exploded values
         */
        public static function trimExplode($delim, $string, $onlyNonEmptyValues=0)      {
                $array = explode($delim, $string);
                        // for two perfomance reasons the loop is duplicated
                        //  a) avoid check for $onlyNonEmptyValues in foreach loop
                        //  b) avoid unnecessary code when $onlyNonEmptyValues is not set
                if ($onlyNonEmptyValues) {
                        $new_array = array();
                        foreach($array as $value) {
                                $value = trim($value);
                                if ($value != '') {
                                        $new_array[] = $value;
                                }
                        }
                                // direct return for perfomance reasons
                        return $new_array;
                }

                foreach($array as &$value) {
                        $value = trim($value);
                }

                return $array;
        }

        /**
         * Remove duplicate values from an array
         * Usage: 0
         *
         * @param       array           Array of values to make unique
         * @return      array
         * @ignore
         * @deprecated          Use the PHP function array_unique instead
         */
        public static function uniqueArray(array $valueArray)   {
                return array_unique($valueArray);
        }

        /**
         * Removes the value $cmpValue from the $array if found there. Returns the modified array
         * Usage: 3
         *
         * @param       array           Array containing the values
         * @param       string          Value to search for and if found remove array entry where found.
         * @return      array           Output array with entries removed if search string is found
         */
        public static function removeArrayEntryByValue(array $array, $cmpValue) {
                reset($array);
                while(list($k,$v)=each($array)) {
                        if (is_array($v))       {
                                $array[$k] = t3lib_div::removeArrayEntryByValue($v,$cmpValue);
                        } else {
                                if (!strcmp($v,$cmpValue))      {
                                        unset($array[$k]);
                                }
                        }
                }
                reset($array);
                return $array;
        }

        /**
         * Implodes a multidim-array into GET-parameters (eg. &param[key][key2]=value2&param[key][key3]=value3)
         * Usage: 24
         *
         * @param       string          Name prefix for entries. Set to blank if you wish none.
         * @param       array           The (multidim) array to implode
         * @param       string          (keep blank)
         * @param       boolean         If set, parameters which were blank strings would be removed.
         * @param       boolean         If set, the param name itself (for example "param[key][key2]") would be rawurlencoded as well.
         * @return      string          Imploded result, fx. &param[key][key2]=value2&param[key][key3]=value3
         * @see explodeUrl2Array()
         */
        public static function implodeArrayForUrl($name,array $theArray,$str='',$skipBlank=0,$rawurlencodeParamName=0)  {
                foreach($theArray as $Akey => $AVal)    {
                        $thisKeyName = $name ? $name.'['.$Akey.']' : $Akey;
                        if (is_array($AVal))    {
                                $str = t3lib_div::implodeArrayForUrl($thisKeyName,$AVal,$str,$skipBlank,$rawurlencodeParamName);
                        } else {
                                if (!$skipBlank || strcmp($AVal,''))    {
                                        $str.='&'.($rawurlencodeParamName ? rawurlencode($thisKeyName) : $thisKeyName).
                                                '='.rawurlencode($AVal);
                                }
                        }
                }
                return $str;
        }

        /**
         * Explodes a string with GETvars (eg. "&id=1&type=2&ext[mykey]=3") into an array
         *
         * @param       string          GETvars string
         * @param       boolean         If set, the string will be parsed into a multidimensional array if square brackets are used in variable names (using PHP function parse_str())
         * @return      array           Array of values. All values AND keys are rawurldecoded() as they properly should be. But this means that any implosion of the array again must rawurlencode it!
         * @see implodeArrayForUrl()
         */
        public static function explodeUrl2Array($string,$multidim=FALSE)        {
                $output = array();
                if ($multidim)  {
                        parse_str($string,$output);
                } else {
                        $p = explode('&',$string);
                        foreach($p as $v)       {
                                if (strlen($v)) {
                                        list($pK,$pV) = explode('=',$v,2);
                                        $output[rawurldecode($pK)] = rawurldecode($pV);
                                }
                        }
                }
                return $output;
        }

        /**
         * Returns an array with selected keys from incoming data.
         * (Better read source code if you want to find out...)
         * Usage: 3
         *
         * @param       string          List of variable/key names
         * @param       array           Array from where to get values based on the keys in $varList
         * @param       boolean         If set, then t3lib_div::_GP() is used to fetch the value if not found (isset) in the $getArray
         * @return      array           Output array with selected variables.
         */
        public static function compileSelectedGetVarsFromArray($varList,array $getArray,$GPvarAlt=1)    {
                $keys = t3lib_div::trimExplode(',',$varList,1);
                $outArr = array();
                foreach($keys as $v)    {
                        if (isset($getArray[$v]))       {
                                $outArr[$v] = $getArray[$v];
                        } elseif ($GPvarAlt) {
                                $outArr[$v] = t3lib_div::_GP($v);
                        }
                }
                return $outArr;
        }

        /**
         * AddSlash array
         * This function traverses a multidimentional array and adds slashes to the values.
         * NOTE that the input array is and argument by reference.!!
         * Twin-function to stripSlashesOnArray
         * Usage: 8
         *
         * @param       array           Multidimensional input array, (REFERENCE!)
         * @return      array
         */
        public static function addSlashesOnArray(array &$theArray)      {
                reset($theArray);
                while(list($Akey,$AVal)=each($theArray))        {
                        if (is_array($AVal))    {
                                t3lib_div::addSlashesOnArray($theArray[$Akey]);
                        } else {
                                $theArray[$Akey] = addslashes($AVal);
                        }
                }
                reset($theArray);
        }

        /**
         * StripSlash array
         * This function traverses a multidimentional array and strips slashes to the values.
         * NOTE that the input array is and argument by reference.!!
         * Twin-function to addSlashesOnArray
         * Usage: 10
         *
         * @param       array           Multidimensional input array, (REFERENCE!)
         * @return      array
         */
        public static function stripSlashesOnArray(array &$theArray)    {
                reset($theArray);
                while(list($Akey,$AVal)=each($theArray))        {
                        if (is_array($AVal))    {
                                t3lib_div::stripSlashesOnArray($theArray[$Akey]);
                        } else {
                                $theArray[$Akey] = stripslashes($AVal);
                        }
                }
                reset($theArray);
        }

        /**
         * Either slashes ($cmd=add) or strips ($cmd=strip) array $arr depending on $cmd
         * Usage: 0
         *
         * @param       array           Multidimensional input array
         * @param       string          "add" or "strip", depending on usage you wish.
         * @return      array
         */
        public static function slashArray(array $arr,$cmd)      {
                if ($cmd=='strip')      t3lib_div::stripSlashesOnArray($arr);
                if ($cmd=='add')        t3lib_div::addSlashesOnArray($arr);
                return $arr;
        }

        /**
         * Merges two arrays recursively and "binary safe" (integer keys are overridden as well), overruling similar values in the first array ($arr0) with the values of the second array ($arr1)
         * In case of identical keys, ie. keeping the values of the second.
         * Usage: 0
         *
         * @param       array           First array
         * @param       array           Second array, overruling the first array
         * @param       boolean         If set, keys that are NOT found in $arr0 (first array) will not be set. Thus only existing value can/will be overruled from second array.
         * @param       boolean         If set, values from $arr1 will overrule if they are empty or zero. Default: true
         * @return      array           Resulting array where $arr1 values has overruled $arr0 values
         */
        public static function array_merge_recursive_overrule(array $arr0,array $arr1,$notAddKeys=0,$includeEmtpyValues=true) {
                reset($arr1);
                while(list($key,$val) = each($arr1)) {
                        if(is_array($arr0[$key])) {
                                if (is_array($arr1[$key]))      {
                                        $arr0[$key] = t3lib_div::array_merge_recursive_overrule($arr0[$key],$arr1[$key],$notAddKeys,$includeEmtpyValues);
                                }
                        } else {
                                if ($notAddKeys) {
                                        if (isset($arr0[$key])) {
                                                if ($includeEmtpyValues || $val) {
                                                        $arr0[$key] = $val;
                                                }
                                        }
                                } else {
                                        if ($includeEmtpyValues || $val) {
                                                $arr0[$key] = $val;
                                        }
                                }
                        }
                }
                reset($arr0);
                return $arr0;
        }

        /**
         * An array_merge function where the keys are NOT renumbered as they happen to be with the real php-array_merge function. It is "binary safe" in the sense that integer keys are overridden as well.
         * Usage: 16
         *
         * @param       array           First array
         * @param       array           Second array
         * @return      array           Merged result.
         */
        public static function array_merge(array $arr1,array $arr2)     {
                return $arr2+$arr1;
        }

        /**
         * Takes a row and returns a CSV string of the values with $delim (default is ,) and $quote (default is ") as separator chars.
         * Usage: 5
         *
         * @param       array           Input array of values
         * @param       string          Delimited, default is comman
         * @param       string          Quote-character to wrap around the values.
         * @return      string          A single line of CSV
         */
        public static function csvValues(array $row,$delim=',',$quote='"')      {
                reset($row);
                $out=array();
                foreach ($row as $value) {
                        $out[] = str_replace($quote, $quote.$quote, $value);
                }
                $str = $quote.implode($quote.$delim.$quote,$out).$quote;
                return $str;
        }

        /**
         * Creates recursively a JSON literal from a mulidimensional associative array.
         * Uses Services_JSON (http://mike.teczno.com/JSON/doc/)
         *
         * @param       array           $jsonArray: The array to be transformed to JSON
         * @return      string          JSON string
         */
        public static function array2json(array $jsonArray) {
                if (!$GLOBALS['JSON']) {
                        require_once(PATH_typo3.'contrib/json/json.php');
                        $GLOBALS['JSON'] = t3lib_div::makeInstance('Services_JSON');
                }
                return $GLOBALS['JSON']->encode($jsonArray);
        }

        /**
         * Removes dots "." from end of a key identifier of TypoScript styled array.
         * array('key.' => array('property.' => 'value')) --> array('key' => array('property' => 'value'))
         *
         * @param       array   $ts: TypoScript configuration array
         * @return      array   TypoScript configuration array without dots at the end of all keys
         */
        public static function removeDotsFromTS(array $ts) {
                $out = array();
                if (is_array($ts)) {
                        foreach ($ts as $key => $value) {
                                if (is_array($value)) {
                                        $key = rtrim($key, '.');
                                        $out[$key] = t3lib_div::removeDotsFromTS($value);
                                } else {
                                        $out[$key] = $value;
                                }
                        }
                }
                return $out;
        }
















        /*************************
         *
         * HTML/XML PROCESSING
         *
         *************************/

        /**
         * Returns an array with all attributes of the input HTML tag as key/value pairs. Attributes are only lowercase a-z
         * $tag is either a whole tag (eg '<TAG OPTION ATTRIB=VALUE>') or the parameterlist (ex ' OPTION ATTRIB=VALUE>')
         * If an attribute is empty, then the value for the key is empty. You can check if it existed with isset()
         * Usage: 8
         *
         * @param       string          HTML-tag string (or attributes only)
         * @return      array           Array with the attribute values.
         */
        public static function get_tag_attributes($tag) {
                $components = t3lib_div::split_tag_attributes($tag);
                $name = '';      // attribute name is stored here
                $valuemode = false;
                $attributes = array();
                foreach ($components as $key => $val)   {
                        if ($val != '=')        {       // Only if $name is set (if there is an attribute, that waits for a value), that valuemode is enabled. This ensures that the attribute is assigned it's value
                                if ($valuemode) {
                                        if ($name)      {
                                                $attributes[$name] = $val;
                                                $name = '';
                                        }
                                } else {
                                        if ($key = strtolower(ereg_replace('[^a-zA-Z0-9]','',$val)))    {
                                                $attributes[$key] = '';
                                                $name = $key;
                                        }
                                }
                                $valuemode = false;
                        } else {
                                $valuemode = true;
                        }
                }
                return $attributes;
        }

        /**
         * Returns an array with the 'components' from an attribute list from an HTML tag. The result is normally analyzed by get_tag_attributes
         * Removes tag-name if found
         * Usage: 2
         *
         * @param       string          HTML-tag string (or attributes only)
         * @return      array           Array with the attribute values.
         * @internal
         */
        public static function split_tag_attributes($tag)       {
                $tag_tmp = trim(eregi_replace ('^<[^[:space:]]*','',trim($tag)));
                        // Removes any > in the end of the string
                $tag_tmp = trim(eregi_replace ('>$','',$tag_tmp));

                $value = array();
                while (strcmp($tag_tmp,''))     {       // Compared with empty string instead , 030102
                        $firstChar=substr($tag_tmp,0,1);
                        if (!strcmp($firstChar,'"') || !strcmp($firstChar,"'")) {
                                $reg=explode($firstChar,$tag_tmp,3);
                                $value[]=$reg[1];
                                $tag_tmp=trim($reg[2]);
                        } elseif (!strcmp($firstChar,'=')) {
                                $value[] = '=';
                                $tag_tmp = trim(substr($tag_tmp,1));            // Removes = chars.
                        } else {
                                        // There are '' around the value. We look for the next ' ' or '>'
                                $reg = split('[[:space:]=]',$tag_tmp,2);
                                $value[] = trim($reg[0]);
                                $tag_tmp = trim(substr($tag_tmp,strlen($reg[0]),1).$reg[1]);
                        }
                }
                reset($value);
                return $value;
        }

        /**
         * Implodes attributes in the array $arr for an attribute list in eg. and HTML tag (with quotes)
         * Usage: 14
         *
         * @param       array           Array with attribute key/value pairs, eg. "bgcolor"=>"red", "border"=>0
         * @param       boolean         If set the resulting attribute list will have a) all attributes in lowercase (and duplicates weeded out, first entry taking precedence) and b) all values htmlspecialchar()'ed. It is recommended to use this switch!
         * @param       boolean         If true, don't check if values are blank. Default is to omit attributes with blank values.
         * @return      string          Imploded attributes, eg. 'bgcolor="red" border="0"'
         */
        public static function implodeAttributes(array $arr,$xhtmlSafe=FALSE,$dontOmitBlankAttribs=FALSE)       {
                if ($xhtmlSafe) {
                        $newArr=array();
                        foreach($arr as $p => $v)       {
                                if (!isset($newArr[strtolower($p)])) $newArr[strtolower($p)] = htmlspecialchars($v);
                        }
                        $arr = $newArr;
                }
                $list = array();
                foreach($arr as $p => $v)       {
                        if (strcmp($v,'') || $dontOmitBlankAttribs)     {$list[]=$p.'="'.$v.'"';}
                }
                return implode(' ',$list);
        }

        /**
         * Implodes attributes in the array $arr for an attribute list in eg. and HTML tag (with quotes)
         *
         * @param       array           See implodeAttributes()
         * @param       boolean         See implodeAttributes()
         * @param       boolean         See implodeAttributes()
         * @return      string          See implodeAttributes()
         * @deprecated  Name was changed into implodeAttributes
         * @see implodeAttributes()
         */
        public static function implodeParams(array $arr,$xhtmlSafe=FALSE,$dontOmitBlankAttribs=FALSE)   {
                return t3lib_div::implodeAttributes($arr,$xhtmlSafe,$dontOmitBlankAttribs);
        }

        /**
         * Wraps JavaScript code XHTML ready with <script>-tags
         * Automatic re-identing of the JS code is done by using the first line as ident reference.
         * This is nice for identing JS code with PHP code on the same level.
         *
         * @param       string          JavaScript code
         * @param       boolean         Wrap script element in linebreaks? Default is TRUE.
         * @return      string          The wrapped JS code, ready to put into a XHTML page
         * @author      Ingmar Schlecht <ingmars@web.de>
         * @author      René Fritz <r.fritz@colorcube.de>
         */
        public static function wrapJS($string, $linebreak=TRUE) {
                if(trim($string)) {
                                // <script wrapped in nl?
                        $cr = $linebreak? "\n" : '';

                                // remove nl from the beginning
                        $string = preg_replace ('/^\n+/', '', $string);
                                // re-ident to one tab using the first line as reference
                        $match = array();
                        if(preg_match('/^(\t+)/',$string,$match)) {
                                $string = str_replace($match[1],"\t", $string);
                        }
                        $string = $cr.'<script type="text/javascript">
/*<![CDATA[*/
'.$string.'
/*]]>*/
</script>'.$cr;
                }
                return trim($string);
        }


        /**
         * Parses XML input into a PHP array with associative keys
         * Usage: 0
         *
         * @param       string          XML data input
         * @param       integer         Number of element levels to resolve the XML into an array. Any further structure will be set as XML.
         * @return      mixed           The array with the parsed structure unless the XML parser returns with an error in which case the error message string is returned.
         * @author bisqwit at iki dot fi dot not dot for dot ads dot invalid / http://dk.php.net/xml_parse_into_struct + kasperYYYY@typo3.com
         */
        public static function xml2tree($string,$depth=999) {
                $parser = xml_parser_create();
                $vals = array();
                $index = array();

                xml_parser_set_option($parser, XML_OPTION_CASE_FOLDING, 0);
                xml_parser_set_option($parser, XML_OPTION_SKIP_WHITE, 0);
                xml_parse_into_struct($parser, $string, $vals, $index);

                if (xml_get_error_code($parser))        return 'Line '.xml_get_current_line_number($parser).': '.xml_error_string(xml_get_error_code($parser));
                xml_parser_free($parser);

                $stack = array( array() );
                $stacktop = 0;
                $startPoint=0;

// FIXME don't use unset() - what does that mean? Use NULL or similar.
                unset($tagi);
                foreach($vals as $key => $val) {
                        $type = $val['type'];

                                // open tag:
                        if ($type=='open' || $type=='complete') {
                                $stack[$stacktop++] = $tagi;

                                if ($depth==$stacktop)  {
                                        $startPoint=$key;
                                }

                                $tagi = array('tag' => $val['tag']);

                                if(isset($val['attributes']))  $tagi['attrs'] = $val['attributes'];
                                if(isset($val['value']))        $tagi['values'][] = $val['value'];
                        }
                                // finish tag:
                        if ($type=='complete' || $type=='close')        {
                                $oldtagi = $tagi;
                                $tagi = $stack[--$stacktop];
                                $oldtag = $oldtagi['tag'];
                                unset($oldtagi['tag']);

                                if ($depth==($stacktop+1))      {
                                        if ($key-$startPoint > 0)       {
                                                $partArray = array_slice(
                                                        $vals,
                                                        $startPoint+1,
                                                        $key-$startPoint-1
                                                );
                                                #$oldtagi=array('XMLvalue'=>t3lib_div::xmlRecompileFromStructValArray($partArray));
                                                $oldtagi['XMLvalue']=t3lib_div::xmlRecompileFromStructValArray($partArray);
                                        } else {
                                                $oldtagi['XMLvalue']=$oldtagi['values'][0];
                                        }
                                }

                                $tagi['ch'][$oldtag][] = $oldtagi;
                                unset($oldtagi);
                        }
                                // cdata
                        if($type=='cdata') {
                                $tagi['values'][] = $val['value'];
                        }
                }
                return $tagi['ch'];
        }

        /**
         * Turns PHP array into XML. See array2xml()
         *
         * @param       array           The input PHP array with any kind of data; text, binary, integers. Not objects though.
         * @param       string          Alternative document tag. Default is "phparray".
         * @param       array           Options for the compilation. See array2xml() for description.
         * @param       string          Forced charset to prologue
         * @return      string          An XML string made from the input content in the array.
         * @see xml2array(),array2xml()
         */
        public static function array2xml_cs(array $array,$docTag='phparray',array $options=array(),$charset='') {

                        // Figure out charset if not given explicitly:
                if (!$charset)  {
                        if ($GLOBALS['TYPO3_CONF_VARS']['BE']['forceCharset'])  {       // First priority: forceCharset! If set, this will be authoritative!
                                $charset = $GLOBALS['TYPO3_CONF_VARS']['BE']['forceCharset'];
                        } elseif (is_object($GLOBALS['LANG']))  {
                                $charset = $GLOBALS['LANG']->charSet;   // If "LANG" is around, that will hold the current charset
                        } else {
                                $charset = 'iso-8859-1';        // THIS is just a hopeful guess!
                        }
                }

                        // Return XML:
                return '<?xml version="1.0" encoding="'.htmlspecialchars($charset).'" standalone="yes" ?>'.chr(10).
                                t3lib_div::array2xml($array,'',0,$docTag,0, $options);
        }

        /**
         * Deprecated to call directly (unless you are aware of using XML prologues)! Use "array2xml_cs" instead (which adds an XML-prologue)
         *
         * Converts a PHP array into an XML string.
         * The XML output is optimized for readability since associative keys are used as tagnames.
         * This also means that only alphanumeric characters are allowed in the tag names AND only keys NOT starting with numbers (so watch your usage of keys!). However there are options you can set to avoid this problem.
         * Numeric keys are stored with the default tagname "numIndex" but can be overridden to other formats)
         * The function handles input values from the PHP array in a binary-safe way; All characters below 32 (except 9,10,13) will trigger the content to be converted to a base64-string
         * The PHP variable type of the data IS preserved as long as the types are strings, arrays, integers and booleans. Strings are the default type unless the "type" attribute is set.
         * The output XML has been tested with the PHP XML-parser and parses OK under all tested circumstances with 4.x versions. However, with PHP5 there seems to be the need to add an XML prologue a la <?xml version="1.0" encoding="[charset]" standalone="yes" ?> - otherwise UTF-8 is assumed! Unfortunately, many times the output from this function is used without adding that prologue meaning that non-ASCII characters will break the parsing!! This suchs of course! Effectively it means that the prologue should always be prepended setting the right characterset, alternatively the system should always run as utf-8!
         * However using MSIE to read the XML output didn't always go well: One reason could be that the character encoding is not observed in the PHP data. The other reason may be if the tag-names are invalid in the eyes of MSIE. Also using the namespace feature will make MSIE break parsing. There might be more reasons...
         * Usage: 5
         *
         * @param       array           The input PHP array with any kind of data; text, binary, integers. Not objects though.
         * @param       string          tag-prefix, eg. a namespace prefix like "T3:"
         * @param       integer         Current recursion level. Don't change, stay at zero!
         * @param       string          Alternative document tag. Default is "phparray".
         * @param       integer         If greater than zero, then the number of spaces corresponding to this number is used for indenting, if less than zero - no indentation, if zero - a single chr(9) (TAB) is used
         * @param       array           Options for the compilation. Key "useNindex" => 0/1 (boolean: whether to use "n0, n1, n2" for num. indexes); Key "useIndexTagForNum" => "[tag for numerical indexes]"; Key "useIndexTagForAssoc" => "[tag for associative indexes"; Key "parentTagMap" => array('parentTag' => 'thisLevelTag')
         * @param       string          Stack data. Don't touch.
         * @return      string          An XML string made from the input content in the array.
         * @see xml2array()
         */
        public static function array2xml(array $array,$NSprefix='',$level=0,$docTag='phparray',$spaceInd=0,array $options=array(),array $stackData=array())     {
                        // The list of byte values which will trigger binary-safe storage. If any value has one of these char values in it, it will be encoded in base64
                $binaryChars = chr(0).chr(1).chr(2).chr(3).chr(4).chr(5).chr(6).chr(7).chr(8).
                                                chr(11).chr(12).chr(14).chr(15).chr(16).chr(17).chr(18).chr(19).
                                                chr(20).chr(21).chr(22).chr(23).chr(24).chr(25).chr(26).chr(27).chr(28).chr(29).
                                                chr(30).chr(31);
                        // Set indenting mode:
                $indentChar = $spaceInd ? ' ' : chr(9);
                $indentN = $spaceInd>0 ? $spaceInd : 1;
                $nl = ($spaceInd >= 0 ? chr(10) : '');

                        // Init output variable:
                $output='';

                        // Traverse the input array
                foreach($array as $k=>$v)       {
                        $attr = '';
                        $tagName = $k;

                                // Construct the tag name.
                        if(isset($options['grandParentTagMap'][$stackData['grandParentTagName'].'/'.$stackData['parentTagName']])) {            // Use tag based on grand-parent + parent tag name
                                $attr.=' index="'.htmlspecialchars($tagName).'"';
                                $tagName = (string)$options['grandParentTagMap'][$stackData['grandParentTagName'].'/'.$stackData['parentTagName']];
                        }elseif(isset($options['parentTagMap'][$stackData['parentTagName'].':_IS_NUM']) && t3lib_div::testInt($tagName)) {              // Use tag based on parent tag name + if current tag is numeric
                                $attr.=' index="'.htmlspecialchars($tagName).'"';
                                $tagName = (string)$options['parentTagMap'][$stackData['parentTagName'].':_IS_NUM'];
                        }elseif(isset($options['parentTagMap'][$stackData['parentTagName'].':'.$tagName])) {            // Use tag based on parent tag name + current tag
                                $attr.=' index="'.htmlspecialchars($tagName).'"';
                                $tagName = (string)$options['parentTagMap'][$stackData['parentTagName'].':'.$tagName];
                        } elseif(isset($options['parentTagMap'][$stackData['parentTagName']])) {                // Use tag based on parent tag name:
                                $attr.=' index="'.htmlspecialchars($tagName).'"';
                                $tagName = (string)$options['parentTagMap'][$stackData['parentTagName']];
                        } elseif (!strcmp(intval($tagName),$tagName))   {       // If integer...;
                                if ($options['useNindex']) {    // If numeric key, prefix "n"
                                        $tagName = 'n'.$tagName;
                                } else {        // Use special tag for num. keys:
                                        $attr.=' index="'.$tagName.'"';
                                        $tagName = $options['useIndexTagForNum'] ? $options['useIndexTagForNum'] : 'numIndex';
                                }
                        } elseif($options['useIndexTagForAssoc']) {             // Use tag for all associative keys:
                                $attr.=' index="'.htmlspecialchars($tagName).'"';
                                $tagName = $options['useIndexTagForAssoc'];
                        }

                                // The tag name is cleaned up so only alphanumeric chars (plus - and _) are in there and not longer than 100 chars either.
                        $tagName = substr(ereg_replace('[^[:alnum:]_-]','',$tagName),0,100);

                                // If the value is an array then we will call this function recursively:
                        if (is_array($v))       {

                                        // Sub elements:
                                if ($options['alt_options'][$stackData['path'].'/'.$tagName])   {
                                        $subOptions = $options['alt_options'][$stackData['path'].'/'.$tagName];
                                        $clearStackPath = $subOptions['clearStackPath'];
                                } else {
                                        $subOptions = $options;
                                        $clearStackPath = FALSE;
                                }

                                $content = $nl .
                                                        t3lib_div::array2xml(
                                                                $v,
                                                                $NSprefix,
                                                                $level+1,
                                                                '',
                                                                $spaceInd,
                                                                $subOptions,
                                                                array(
                                                                        'parentTagName' => $tagName,
                                                                        'grandParentTagName' => $stackData['parentTagName'],
                                                                        'path' => $clearStackPath ? '' : $stackData['path'].'/'.$tagName,
                                                                )
                                                        ).
                                                        ($spaceInd >= 0 ? str_pad('',($level+1)*$indentN,$indentChar) : '');
                                if ((int)$options['disableTypeAttrib']!=2)      {       // Do not set "type = array". Makes prettier XML but means that empty arrays are not restored with xml2array
                                        $attr.=' type="array"';
                                }
                        } else {        // Just a value:

                                        // Look for binary chars:
                                $vLen = strlen($v);     // check for length, because PHP 5.2.0 may crash when first argument of strcspn is empty
                                if ($vLen && strcspn($v,$binaryChars) != $vLen) {       // Go for base64 encoding if the initial segment NOT matching any binary char has the same length as the whole string!
                                                // If the value contained binary chars then we base64-encode it an set an attribute to notify this situation:
                                        $content = $nl.chunk_split(base64_encode($v));
                                        $attr.=' base64="1"';
                                } else {
                                                // Otherwise, just htmlspecialchar the stuff:
                                        $content = htmlspecialchars($v);
                                        $dType = gettype($v);
                                        if ($dType == 'string') {
                                                if ($options['useCDATA'] && $content != $v) {
                                                        $content = '<![CDATA[' . $v . ']]>';
                                                }
                                        } elseif (!$options['disableTypeAttrib']) {
                                                $attr.= ' type="'.$dType.'"';
                                        }
                                }
                        }

                                // Add the element to the output string:
                        $output.=($spaceInd >= 0 ? str_pad('',($level+1)*$indentN,$indentChar) : '').'<'.$NSprefix.$tagName.$attr.'>'.$content.'</'.$NSprefix.$tagName.'>'.$nl;
                }

                // If we are at the outer-most level, then we finally wrap it all in the document tags and return that as the value:
                if (!$level)    {
                        $output =
                                '<'.$docTag.'>'.$nl.
                                $output.
                                '</'.$docTag.'>';
                }

                return $output;
        }

        /**
         * Converts an XML string to a PHP array.
         * This is the reverse function of array2xml()
         * Usage: 17
         *
         * @param       string          XML content to convert into an array
         * @param       string          The tag-prefix resolve, eg. a namespace like "T3:"
         * @param       boolean         If set, the document tag will be set in the key "_DOCUMENT_TAG" of the output array
         * @return      mixed           If the parsing had errors, a string with the error message is returned. Otherwise an array with the content.
         * @see array2xml()
         */
        public static function xml2array($string,$NSprefix='',$reportDocTag=FALSE) {
                global $TYPO3_CONF_VARS;

                        // Create parser:
                $parser = xml_parser_create();
                $vals = array();
                $index = array();

                xml_parser_set_option($parser, XML_OPTION_CASE_FOLDING, 0);
                xml_parser_set_option($parser, XML_OPTION_SKIP_WHITE, 0);

                        // PHP 5.0.0 & 5.0.1: default output charset is ISO-8859-1, only ASCII, ISO-8859-1 and UTF-8 are supported!!!
                        // PHP 5.0.2+: default output charset is UTF-8  , only ASCII, ISO-8859-1 and UTF-8 are supported!!!
                $match = array();
                preg_match('/^[[:space:]]*<\?xml[^>]*encoding[[:space:]]*=[[:space:]]*"([^"]*)"/',substr($string,0,200),$match);
                $theCharset = $match[1] ? $match[1] : ($TYPO3_CONF_VARS['BE']['forceCharset'] ? $TYPO3_CONF_VARS['BE']['forceCharset'] : 'iso-8859-1');
                xml_parser_set_option($parser, XML_OPTION_TARGET_ENCODING, $theCharset);  // us-ascii / utf-8 / iso-8859-1

                        // Parse content:
                xml_parse_into_struct($parser, $string, $vals, $index);

                        // If error, return error message:
                if (xml_get_error_code($parser))        {
                        return 'Line '.xml_get_current_line_number($parser).': '.xml_error_string(xml_get_error_code($parser));
                }
                xml_parser_free($parser);

                        // Init vars:
                $stack = array(array());
                $stacktop = 0;
                $current = array();
                $tagName = '';
                $documentTag = '';

                        // Traverse the parsed XML structure:
                foreach($vals as $key => $val) {

                                // First, process the tag-name (which is used in both cases, whether "complete" or "close")
                        $tagName = $val['tag'];
                        if (!$documentTag)      $documentTag = $tagName;

                                // Test for name space:
                        $tagName = ($NSprefix && substr($tagName,0,strlen($NSprefix))==$NSprefix) ? substr($tagName,strlen($NSprefix)) : $tagName;

                                // Test for numeric tag, encoded on the form "nXXX":
                        $testNtag = substr($tagName,1); // Closing tag.
                        $tagName = (substr($tagName,0,1)=='n' && !strcmp(intval($testNtag),$testNtag)) ? intval($testNtag) : $tagName;

                                // Test for alternative index value:
                        if (strlen($val['attributes']['index']))        { $tagName = $val['attributes']['index']; }

                                // Setting tag-values, manage stack:
                        switch($val['type'])    {
                                case 'open':            // If open tag it means there is an array stored in sub-elements. Therefore increase the stackpointer and reset the accumulation array:
                                        $current[$tagName] = array();   // Setting blank place holder
                                        $stack[$stacktop++] = $current;
                                        $current = array();
                                break;
                                case 'close':   // If the tag is "close" then it is an array which is closing and we decrease the stack pointer.
                                        $oldCurrent = $current;
                                        $current = $stack[--$stacktop];
                                        end($current);  // Going to the end of array to get placeholder key, key($current), and fill in array next:
                                        $current[key($current)] = $oldCurrent;
                                        unset($oldCurrent);
                                break;
                                case 'complete':        // If "complete", then it's a value. If the attribute "base64" is set, then decode the value, otherwise just set it.
                                        if ($val['attributes']['base64'])       {
                                                $current[$tagName] = base64_decode($val['value']);
                                        } else {
                                                $current[$tagName] = (string)$val['value']; // Had to cast it as a string - otherwise it would be evaluate false if tested with isset()!!

                                                        // Cast type:
                                                switch((string)$val['attributes']['type'])      {
                                                        case 'integer':
                                                                $current[$tagName] = (integer)$current[$tagName];
                                                        break;
                                                        case 'double':
                                                                $current[$tagName] = (double)$current[$tagName];
                                                        break;
                                                        case 'boolean':
                                                                $current[$tagName] = (bool)$current[$tagName];
                                                        break;
                                                        case 'array':
                                                                $current[$tagName] = array();   // MUST be an empty array since it is processed as a value; Empty arrays would end up here because they would have no tags inside...
                                                        break;
                                                }
                                        }
                                break;
                        }
                }

                if ($reportDocTag)      {
                        $current[$tagName]['_DOCUMENT_TAG'] = $documentTag;
                }

                        // Finally return the content of the document tag.
                return $current[$tagName];
        }

        /**
         * This implodes an array of XML parts (made with xml_parse_into_struct()) into XML again.
         * Usage: 2
         *
         * @param       array           A array of XML parts, see xml2tree
         * @return      string          Re-compiled XML data.
         */
        public static function xmlRecompileFromStructValArray(array $vals)      {
                $XMLcontent='';

                foreach($vals as $val) {
                        $type = $val['type'];

                                // open tag:
                        if ($type=='open' || $type=='complete') {
                                $XMLcontent.='<'.$val['tag'];
                                if(isset($val['attributes']))  {
                                        foreach($val['attributes'] as $k => $v) {
                                                $XMLcontent.=' '.$k.'="'.htmlspecialchars($v).'"';
                                        }
                                }
                                if ($type=='complete')  {
                                        if(isset($val['value']))        {
                                                $XMLcontent.='>'.htmlspecialchars($val['value']).'</'.$val['tag'].'>';
                                        } else $XMLcontent.='/>';
                                } else $XMLcontent.='>';

                                if ($type=='open' && isset($val['value']))      {
                                        $XMLcontent.=htmlspecialchars($val['value']);
                                }
                        }
                                // finish tag:
                        if ($type=='close')     {
                                $XMLcontent.='</'.$val['tag'].'>';
                        }
                                // cdata
                        if($type=='cdata') {
                                $XMLcontent.=htmlspecialchars($val['value']);
                        }
                }

                return $XMLcontent;
        }

        /**
         * Extracts the attributes (typically encoding and version) of an XML prologue (header).
         * Usage: 1
         *
         * @param       string          XML data
         * @return      array           Attributes of the xml prologue (header)
         */
        public static function xmlGetHeaderAttribs($xmlData)    {
                $match = array();
                if (preg_match('/^\s*<\?xml([^>]*)\?\>/', $xmlData, $match))    {
                        return t3lib_div::get_tag_attributes($match[1]);
                }
        }

        /**
         * Minifies JavaScript
         *
         * @param       string  $script Script to minify
         * @param       string  $error  Error message (if any)
         * @return      string  Minified script or source string if error happened
         */
        public static function minifyJavaScript($script, &$error = '') {
                require_once(PATH_typo3 . 'contrib/jsmin/jsmin.php');
                try {
                        $error = '';
                        $script = trim(JSMin::minify(str_replace(chr(13), '', $script)));
                }
                catch(JSMinException $e) {
                        $error = 'Error while minifying JavaScript: ' . $e->getMessage();
                        t3lib_div::devLog($error, 't3lib_div', 2,
                                array('JavaScript' => $script, 'Stack trace' => $e->getTrace()));
                }
                return $script;
        }








        /*************************
         *
         * FILES FUNCTIONS
         *
         *************************/

        /**
         * Reads the file or url $url and returns the content
         * If you are having trouble with proxys when reading URLs you can configure your way out of that with settings like $TYPO3_CONF_VARS['SYS']['curlUse'] etc.
         * Usage: 83
         *
         * @param       string          Filepath/URL to read
         * @param       integer         Whether the HTTP header should be fetched or not. 0=disable, 1=fetch header+content, 2=fetch header only
         * @param       array           HTTP headers to be used in the request
         * @return      string          The content from the resource given as input.
         */
        public static function getURL($url, $includeHeader = 0, $requestHeaders = false)        {
                $content = false;

                        // (Proxy support implemented by Arco <arco@appeltaart.mine.nu>)
                if ($GLOBALS['TYPO3_CONF_VARS']['SYS']['curlUse'] == '1' && preg_match('/^https?:\/\//', $url)) {
                                // External URL without error checking.
                        $ch = curl_init();
                        if (!$ch)       {
                                return false;
                        }

                        curl_setopt($ch, CURLOPT_URL, $url);
                        curl_setopt($ch, CURLOPT_HEADER, $includeHeader ? 1 : 0);
                        curl_setopt($ch, CURLOPT_NOBODY, $includeHeader == 2 ? 1 : 0);
                        curl_setopt($ch, CURLOPT_FOLLOWLOCATION, 1);
                        curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
                        curl_setopt($ch, CURLOPT_FAILONERROR, 1);
                        if (is_array($requestHeaders))  {
                                curl_setopt($ch, CURLOPT_HTTPHEADER, $requestHeaders);
                        }

                        if ($GLOBALS['TYPO3_CONF_VARS']['SYS']['curlProxyServer'])      {
                                curl_setopt($ch, CURLOPT_PROXY, $GLOBALS['TYPO3_CONF_VARS']['SYS']['curlProxyServer']);

                                        // Not sure if this is needed
                                if ($GLOBALS['TYPO3_CONF_VARS']['SYS']['curlProxyTunnel'])      {
                                        curl_setopt($ch, CURLOPT_HTTPPROXYTUNNEL, $GLOBALS['TYPO3_CONF_VARS']['SYS']['curlProxyTunnel']);
                                }
                                if ($GLOBALS['TYPO3_CONF_VARS']['SYS']['curlProxyUserPass'])    {
                                        curl_setopt($ch, CURLOPT_PROXYUSERPWD, $GLOBALS['TYPO3_CONF_VARS']['SYS']['curlProxyUserPass']);
                                }
                        }
                        $content = curl_exec($ch);
                        curl_close($ch);

                } elseif ($includeHeader)       {
                        $parsedURL = parse_url($url);
                        if (!t3lib_div::inList('ftp,ftps,http,https,gopher,telnet', $parsedURL['scheme']))      {
                                return false;
                        }

                        $fp = @fsockopen($parsedURL['host'], ($parsedURL['port'] > 0 ? $parsedURL['port'] : 80), $errno, $errstr, 2.0);
                        if (!$fp)       {
                                return false;
                        }

                        $msg = 'GET ' . $parsedURL['path'] .
                                        ($parsedURL['query'] ? '?' . $parsedURL['query'] : '') .
                                        ' HTTP/1.0' . "\r\n" . 'Host: ' .
                                        $parsedURL['host'] . "\r\n\r\n";
                        fputs($fp, $msg);
                        while (!feof($fp))      {
                                $line = fgets($fp, 2048);
                                $content.= $line;
                                if ($includeHeader == 2 && !strlen(trim($line)))        {
                                        break;  // Stop at the first empty line (= end of header)
                                }
                        }
                        fclose($fp);

                } elseif (is_array($requestHeaders))    {
                        $ctx = stream_context_create(array(
                                                'http' => array(
                                                        'header' => implode("\r\n", $requestHeaders)
                                                )
                                        )
                                );
                        $content = @file_get_contents($url, false, $ctx);
                }
                else    {
                        $content = @file_get_contents($url);
                }

                return $content;
        }

        /**
         * Writes $content to the file $file
         * Usage: 30
         *
         * @param       string          Filepath to write to
         * @param       string          Content to write
         * @return      boolean         True if the file was successfully opened and written to.
         */
        public static function writeFile($file,$content)        {
                if (!@is_file($file))   $changePermissions = true;

                if ($fd = fopen($file,'wb'))    {
                        $res = fwrite($fd,$content);
                        fclose($fd);

                        if ($res===false)       return false;

                        if ($changePermissions) {       // Change the permissions only if the file has just been created
                                t3lib_div::fixPermissions($file);
                        }

                        return true;
                }

                return false;
        }

        /**
         * Setting file system mode & group ownership of file
         *
         * @param       string          Filepath of newly created file
         * @return      void
         */
        public static function fixPermissions($file)    {
                if (@is_file($file) && TYPO3_OS!='WIN') {
                        @chmod($file, octdec($GLOBALS['TYPO3_CONF_VARS']['BE']['fileCreateMask']));             // "@" is there because file is not necessarily OWNED by the user
                        if($GLOBALS['TYPO3_CONF_VARS']['BE']['createGroup'])    {       // skip this if createGroup is empty
                                @chgrp($file, $GLOBALS['TYPO3_CONF_VARS']['BE']['createGroup']);                // "@" is there because file is not necessarily OWNED by the user
                        }
                }
        }

        /**
         * Writes $content to a filename in the typo3temp/ folder (and possibly one or two subfolders...)
         * Accepts an additional subdirectory in the file path!
         *
         * @param       string          Absolute filepath to write to inside "typo3temp/". First part of this string must match PATH_site."typo3temp/"
         * @param       string          Content string to write
         * @return      string          Returns false on success, otherwise an error string telling about the problem.
         */
        public static function writeFileToTypo3tempDir($filepath,$content)      {

                        // Parse filepath into directory and basename:
                $fI = pathinfo($filepath);
                $fI['dirname'].= '/';

                        // Check parts:
                if (t3lib_div::validPathStr($filepath) && $fI['basename'] && strlen($fI['basename'])<60)        {
                        if (defined('PATH_site'))       {
                                $dirName = PATH_site.'typo3temp/';      // Setting main temporary directory name (standard)
                                if (@is_dir($dirName))  {
                                        if (t3lib_div::isFirstPartOfStr($fI['dirname'],$dirName))       {

                                                        // Checking if the "subdir" is found:
                                                $subdir = substr($fI['dirname'],strlen($dirName));
                                                if ($subdir)    {
                                                        if (ereg('^[[:alnum:]_]+\/$',$subdir) || ereg('^[[:alnum:]_]+\/[[:alnum:]_]+\/$',$subdir))      {
                                                                $dirName.= $subdir;
                                                                if (!@is_dir($dirName)) {
                                                                        t3lib_div::mkdir_deep(PATH_site.'typo3temp/', $subdir);
                                                                }
                                                        } else return 'Subdir, "'.$subdir.'", was NOT on the form "[[:alnum:]_]/" or  "[[:alnum:]_]/[[:alnum:]_]/"';
                                                }
                                                        // Checking dir-name again (sub-dir might have been created):
                                                if (@is_dir($dirName))  {
                                                        if ($filepath == $dirName.$fI['basename'])      {
                                                                t3lib_div::writeFile($filepath, $content);
                                                                if (!@is_file($filepath))       return 'File not written to disk! Write permission error in filesystem?';
                                                        } else return 'Calculated filelocation didn\'t match input $filepath!';
                                                } else return '"'.$dirName.'" is not a directory!';
                                        } else return '"'.$fI['dirname'].'" was not within directory PATH_site + "typo3temp/"';
                                } else return 'PATH_site + "typo3temp/" was not a directory!';
                        } else return 'PATH_site constant was NOT defined!';
                } else return 'Input filepath "'.$filepath.'" was generally invalid!';
        }

        /**
         * Wrapper function for mkdir, setting folder permissions according to $GLOBALS['TYPO3_CONF_VARS']['BE']['folderCreateMask'] and group ownership according to $GLOBALS['TYPO3_CONF_VARS']['BE']['createGroup']
         * Usage: 6
         *
         * @param       string          Absolute path to folder, see PHP mkdir() function. Removes trailing slash internally.
         * @return      boolean         TRUE if @mkdir went well!
         */
        public static function mkdir($theNewFolder)     {
                $theNewFolder = preg_replace('|/$|','',$theNewFolder);
                if (mkdir($theNewFolder, octdec($GLOBALS['TYPO3_CONF_VARS']['BE']['folderCreateMask']))){
                        chmod($theNewFolder, octdec($GLOBALS['TYPO3_CONF_VARS']['BE']['folderCreateMask'])); //added this line, because the mode at 'mkdir' has a strange behaviour sometimes

                        if($GLOBALS['TYPO3_CONF_VARS']['BE']['createGroup'])    {       // skip this if createGroup is empty
                                chgrp($theNewFolder, $GLOBALS['TYPO3_CONF_VARS']['BE']['createGroup']);
                        }
                        return TRUE;
                }
        }

        /**
         * Creates a directory - including parent directories if necessary - in the file system
         *
         * @param       string          Base folder. This must exist! Must have trailing slash! Example "/root/typo3site/"
         * @param       string          Deep directory to create, eg. "xx/yy/" which creates "/root/typo3site/xx/yy/" if $destination is "/root/typo3site/"
         * @return      string          If error, returns error string.
         */
        public static function mkdir_deep($destination,$deepDir)        {
                $allParts = t3lib_div::trimExplode('/',$deepDir,1);
                $root = '';
                foreach($allParts as $part)     {
                        $root.= $part.'/';
                        if (!is_dir($destination.$root))        {
                                t3lib_div::mkdir($destination.$root);
                                if (!@is_dir($destination.$root))       {
                                        return 'Error: The directory "'.$destination.$root.'" could not be created...';
                                }
                        }
                }
        }

        /**
         * Wrapper function for rmdir, allowing recursive deletion of folders and files
         *
         * @param       string          Absolute path to folder, see PHP rmdir() function. Removes trailing slash internally.
         * @param       boolean         Allow deletion of non-empty directories
         * @return      boolean         true if @rmdir went well!
         */
        public static function rmdir($path,$removeNonEmpty=false)       {
                $OK = false;
                $path = preg_replace('|/$|','',$path);  // Remove trailing slash

                if (file_exists($path)) {
                        $OK = true;

                        if (is_dir($path))      {
                                if ($removeNonEmpty==true && $handle = opendir($path))  {
                                        while ($OK && false !== ($file = readdir($handle)))     {
                                                if ($file=='.' || $file=='..') continue;
                                                $OK = t3lib_div::rmdir($path.'/'.$file,$removeNonEmpty);
                                        }
                                        closedir($handle);
                                }
                                if ($OK)        { $OK = rmdir($path); }

                        } else {        // If $dirname is a file, simply remove it
                                $OK = unlink($path);
                        }

                        clearstatcache();
                }

                return $OK;
        }

        /**
         * Returns an array with the names of folders in a specific path
         * Will return 'error' (string) if there were an error with reading directory content.
         * Usage: 11
         *
         * @param       string          Path to list directories from
         * @return      array           Returns an array with the directory entries as values. If no path, the return value is nothing.
         */
        public static function get_dirs($path)  {
                if ($path)      {
                        $d = @dir($path);
                        if (is_object($d))      {
                                while($entry=$d->read()) {
                                        if (@is_dir($path.'/'.$entry) && $entry!= '..' && $entry!= '.') {
                                            $filearray[]=$entry;
                                        }
                                }
                                $d->close();
                        } else return 'error';
                        return $filearray;
                }
        }

        /**
         * Returns an array with the names of files in a specific path
         * Usage: 18
         *
         * @param       string          $path: Is the path to the file
         * @param       string          $extensionList is the comma list of extensions to read only (blank = all)
         * @param       boolean         If set, then the path is prepended the filenames. Otherwise only the filenames are returned in the array
         * @param       string          $order is sorting: 1= sort alphabetically, 'mtime' = sort by modification time.
         * @param       string          A comma seperated list of filenames to exclude, no wildcards
         * @return      array           Array of the files found
         */
        public static function getFilesInDir($path,$extensionList='',$prependPath=0,$order='',$excludePattern='')       {

                        // Initialize variabels:
                $filearray = array();
                $sortarray = array();
                $path = ereg_replace('\/$','',$path);

                        // Find files+directories:
                if (@is_dir($path))     {
                        $extensionList = strtolower($extensionList);
                        $d = dir($path);
                        if (is_object($d))      {
                                while($entry=$d->read()) {
                                        if (@is_file($path.'/'.$entry)) {
                                                $fI = pathinfo($entry);
                                                $key = md5($path.'/'.$entry);   // Don't change this ever - extensions may depend on the fact that the hash is an md5 of the path! (import/export extension)
                                                if ((!strlen($extensionList) || t3lib_div::inList($extensionList,strtolower($fI['extension']))) && (!strlen($excludePattern) || !preg_match('/^'.$excludePattern.'$/',$entry))) {
                                                    $filearray[$key]=($prependPath?$path.'/':'').$entry;
                                                                if ($order=='mtime') {$sortarray[$key]=filemtime($path.'/'.$entry);}
                                                                elseif ($order) {$sortarray[$key]=$entry;}
                                                }
                                        }
                                }
                                $d->close();
                        } else return 'error opening path: "'.$path.'"';
                }

                        // Sort them:
                if ($order) {
                        asort($sortarray);
                        reset($sortarray);
                        $newArr=array();
                        while(list($k,$v)=each($sortarray))     {
                                $newArr[$k]=$filearray[$k];
                        }
                        $filearray=$newArr;
                }

                        // Return result
                reset($filearray);
                return $filearray;
        }

        /**
         * Recursively gather all files and folders of a path.
         * Usage: 5
         *
         * @param       array           $fileArr: Empty input array (will have files added to it)
         * @param       string          $path: The path to read recursively from (absolute) (include trailing slash!)
         * @param       string          $extList: Comma list of file extensions: Only files with extensions in this list (if applicable) will be selected.
         * @param       boolean         $regDirs: If set, directories are also included in output.
         * @param       integer         $recursivityLevels: The number of levels to dig down...
         * @param string                $excludePattern: regex pattern of files/directories to exclude
         * @return      array           An array with the found files/directories.
         */
        public static function getAllFilesAndFoldersInPath(array $fileArr,$path,$extList='',$regDirs=0,$recursivityLevels=99,$excludePattern='')        {
                if ($regDirs)   $fileArr[] = $path;
                $fileArr = array_merge($fileArr, t3lib_div::getFilesInDir($path,$extList,1,1,$excludePattern));

                $dirs = t3lib_div::get_dirs($path);
                if (is_array($dirs) && $recursivityLevels>0)    {
                        foreach ($dirs as $subdirs)     {
                                if ((string)$subdirs!='' && (!strlen($excludePattern) || !preg_match('/^'.$excludePattern.'$/',$subdirs)))      {
                                        $fileArr = t3lib_div::getAllFilesAndFoldersInPath($fileArr,$path.$subdirs.'/',$extList,$regDirs,$recursivityLevels-1,$excludePattern);
                                }
                        }
                }
                return $fileArr;
        }

        /**
         * Removes the absolute part of all files/folders in fileArr
         * Usage: 2
         *
         * @param       array           $fileArr: The file array to remove the prefix from
         * @param       string          $prefixToRemove: The prefix path to remove (if found as first part of string!)
         * @return      array           The input $fileArr processed.
         */
        public static function removePrefixPathFromList(array $fileArr,$prefixToRemove) {
                foreach($fileArr as $k => $absFileRef)  {
                        if(t3lib_div::isFirstPartOfStr($absFileRef,$prefixToRemove))    {
                                $fileArr[$k] = substr($absFileRef,strlen($prefixToRemove));
                        } else return 'ERROR: One or more of the files was NOT prefixed with the prefix-path!';
                }
                return $fileArr;
        }

        /**
         * Fixes a path for windows-backslashes and reduces double-slashes to single slashes
         * Usage: 2
         *
         * @param       string          File path to process
         * @return      string
         */
        public static function fixWindowsFilePath($theFile)     {
                return str_replace('//','/', str_replace('\\','/', $theFile));
        }

        /**
         * Resolves "../" sections in the input path string.
         * For example "fileadmin/directory/../other_directory/" will be resolved to "fileadmin/other_directory/"
         * Usage: 2
         *
         * @param       string          File path in which "/../" is resolved
         * @return      string
         */
        public static function resolveBackPath($pathStr)        {
                $parts = explode('/',$pathStr);
                $output=array();
                $c = 0;
                foreach($parts as $pV)  {
                        if ($pV=='..')  {
                                if ($c) {
                                        array_pop($output);
                                        $c--;
                                } else $output[]=$pV;
                        } else {
                                $c++;
                                $output[]=$pV;
                        }
                }
                return implode('/',$output);
        }

        /**
         * Prefixes a URL used with 'header-location' with 'http://...' depending on whether it has it already.
         * - If already having a scheme, nothing is prepended
         * - If having REQUEST_URI slash '/', then prefixing 'http://[host]' (relative to host)
         * - Otherwise prefixed with TYPO3_REQUEST_DIR (relative to current dir / TYPO3_REQUEST_DIR)
         * Usage: 30
         *
         * @param       string          URL / path to prepend full URL addressing to.
         * @return      string
         */
        public static function locationHeaderUrl($path) {
                $uI = parse_url($path);
                if (substr($path,0,1)=='/')     { // relative to HOST
                        $path = t3lib_div::getIndpEnv('TYPO3_REQUEST_HOST').$path;
                } elseif (!$uI['scheme'])       { // No scheme either
                        $path = t3lib_div::getIndpEnv('TYPO3_REQUEST_DIR').$path;
                }
                return $path;
        }
















        /*************************
         *
         * DEBUG helper FUNCTIONS
         *
         *************************/

        /**
         * Returns a string with a list of ascii-values for the first $characters characters in $string
         * Usage: 0
         *
         * @param       string          String to show ASCII value for
         * @param       integer         Number of characters to show
         * @return      string          The string with ASCII values in separated by a space char.
         * @internal
         */
        public static function debug_ordvalue($string,$characters=100)  {
                if(strlen($string) < $characters)       $characters = strlen($string);
                for ($i=0; $i<$characters; $i++)        {
                        $valuestring.=' '.ord(substr($string,$i,1));
                }
                return trim($valuestring);
        }

        /**
         * Returns HTML-code, which is a visual representation of a multidimensional array
         * use t3lib_div::print_array() in order to print an array
         * Returns false if $array_in is not an array
         * Usage: 31
         *
         * @param       mixed           Array to view
         * @return      string          HTML output
         */
        public static function view_array($array_in)    {
                if (is_array($array_in))        {
                        $result='
                        <table border="1" cellpadding="1" cellspacing="0" bgcolor="white">';
                        if (count($array_in) == 0)      {
                                $result.= '<tr><td><font face="Verdana,Arial" size="1"><b>EMPTY!</b></font></td></tr>';
                        } else  {
                                foreach ($array_in as $key => $val)     {
                                        $result.= '<tr>
                                                <td valign="top"><font face="Verdana,Arial" size="1">'.htmlspecialchars((string)$key).'</font></td>
                                                <td>';
                                        if (is_array($val))     {
                                                $result.=t3lib_div::view_array($val);
                                        } elseif (is_object($val))      {
                                                $string = get_class($val);
                                                if (method_exists($val, '__toString'))  {
                                                        $string .= ': '.(string)$val;
                                                }
                                                $result .= '<font face="Verdana,Arial" size="1" color="red">'.nl2br(htmlspecialchars($string)).'<br /></font>';
                                        } else  {
                                                if (gettype($val) == 'object')  {
                                                        $string = 'Unknown object';
                                                } else  {
                                                        $string = (string)$val;
                                                }
                                                $result.= '<font face="Verdana,Arial" size="1" color="red">'.nl2br(htmlspecialchars($string)).'<br /></font>';
                                        }
                                        $result.= '</td>
                                        </tr>';
                                }
                        }
                        $result.= '</table>';
                } else  {
                        $result  = '<table border="1" cellpadding="1" cellspacing="0" bgcolor="white">
                                <tr>
                                        <td><font face="Verdana,Arial" size="1" color="red">'.nl2br(htmlspecialchars((string)$array_in)).'<br /></font></td>
                                </tr>
                        </table>';      // Output it as a string.
                }
                return $result;
        }

        /**
         * Prints an array
         * Usage: 6
         *
         * @param       mixed           Array to print visually (in a table).
         * @return      void
         * @internal
         * @see view_array()
         */
        public static function print_array($array_in)   {
                echo t3lib_div::view_array($array_in);
        }

        /**
         * Makes debug output
         * Prints $var in bold between two vertical lines
         * If not $var the word 'debug' is printed
         * If $var is an array, the array is printed by t3lib_div::print_array()
         * Usage: 8
         *
         * @param       mixed           Variable to print
         * @param       mixed           If the parameter is a string it will be used as header. Otherwise number of break tags to apply after (positive integer) or before (negative integer) the output.
         * @return      void
         */
        public static function debug($var='',$brOrHeader=0)     {
                        // buffer the output of debug if no buffering started before
                if (ob_get_level()==0) {
                        ob_start();
                }

                if ($brOrHeader && !t3lib_div::testInt($brOrHeader))    {
                        echo '<table class="typo3-debug" border="0" cellpadding="0" cellspacing="0" bgcolor="white" style="border:0px; margin-top:3px; margin-bottom:3px;"><tr><td style="background-color:#bbbbbb; font-family: verdana,arial; font-weight: bold; font-size: 10px;">'.htmlspecialchars((string)$brOrHeader).'</td></tr><tr><td>';
                } elseif ($brOrHeader<0)        {
                        for($a=0;$a<abs(intval($brOrHeader));$a++){echo '<br />';}
                }

                if (is_array($var))     {
                        t3lib_div::print_array($var);
                } elseif (is_object($var))      {
                        echo '<b>|Object:<pre>';
                        print_r($var);
                        echo '</pre>|</b>';
                } elseif ((string)$var!='')     {
                        echo '<b>|'.htmlspecialchars((string)$var).'|</b>';
                } else {
                        echo '<b>| debug |</b>';
                }

                if ($brOrHeader && !t3lib_div::testInt($brOrHeader))    {
                        echo '</td></tr></table>';
                } elseif ($brOrHeader>0)        {
                        for($a=0;$a<intval($brOrHeader);$a++){echo '<br />';}
                }
        }

        /**
         * Displays the "path" of the function call stack in a string, using debug_backtrace
         *
         * @return      string
         */
        public static function debug_trail()    {
                $trail = debug_backtrace();
                $trail = array_reverse($trail);
                array_pop($trail);

                $path = array();
                foreach($trail as $dat) {
                        $path[] = $dat['class'].$dat['type'].$dat['function'];
                }

                return implode(' // ',$path);
        }

        /**
         * Displays an array as rows in a table. Useful to debug output like an array of database records.
         *
         * @param       mixed           Array of arrays with similar keys
         * @param       string          Table header
         * @param       boolean         If TRUE, will return content instead of echo'ing out.
         * @return      void            Outputs to browser.
         */
        public static function debugRows($rows,$header='',$returnHTML=FALSE)    {
                if (is_array($rows))    {
                        reset($rows);
                        $firstEl = current($rows);
                        if (is_array($firstEl)) {
                                $headerColumns = array_keys($firstEl);
                                $tRows = array();

                                        // Header:
                                $tRows[] = '<tr><td colspan="'.count($headerColumns).'" style="background-color:#bbbbbb; font-family: verdana,arial; font-weight: bold; font-size: 10px;"><strong>'.htmlspecialchars($header).'</strong></td></tr>';
                                $tCells = array();
                                foreach($headerColumns as $key) {
                                        $tCells[] = '
                                                        <td><font face="Verdana,Arial" size="1"><strong>'.htmlspecialchars($key).'</strong></font></td>';
                                }
                                $tRows[] = '
                                                <tr>'.implode('',$tCells).'
                                                </tr>';

                                        // Rows:
                                foreach($rows as $singleRow)    {
                                        $tCells = array();
                                        foreach($headerColumns as $key) {
                                                $tCells[] = '
                                                        <td><font face="Verdana,Arial" size="1">'.(is_array($singleRow[$key]) ? t3lib_div::debugRows($singleRow[$key],'',TRUE) : htmlspecialchars($singleRow[$key])).'</font></td>';
                                        }
                                        $tRows[] = '
                                                <tr>'.implode('',$tCells).'
                                                </tr>';
                                }

                                $table = '
                                        <table border="1" cellpadding="1" cellspacing="0" bgcolor="white">'.implode('',$tRows).'
                                        </table>';
                                if ($returnHTML)        return $table; else echo $table;
                        } else debug('Empty array of rows',$header);
                } else {
                        debug('No array of rows',$header);
                }
        }




























        /*************************
         *
         * SYSTEM INFORMATION
         *
         *************************/

        /**
         * Returns the HOST+DIR-PATH of the current script (The URL, but without 'http://' and without script-filename)
         * Usage: 1
         *
         * @return      string
         */
        public static function getThisUrl()     {
                $p=parse_url(t3lib_div::getIndpEnv('TYPO3_REQUEST_SCRIPT'));            // Url of this script
                $dir=t3lib_div::dirname($p['path']).'/';        // Strip file
                $url = str_replace('//','/',$p['host'].($p['port']?':'.$p['port']:'').$dir);
                return $url;
        }

        /**
         * Returns the link-url to the current script.
         * In $getParams you can set associative keys corresponding to the GET-vars you wish to add to the URL. If you set them empty, they will remove existing GET-vars from the current URL.
         * REMEMBER to always use htmlspecialchars() for content in href-properties to get ampersands converted to entities (XHTML requirement and XSS precaution)
         * Usage: 52
         *
         * @param       array           Array of GET parameters to include
         * @return      string
         */
        public static function linkThisScript(array $getParams=array()) {
                $parts = t3lib_div::getIndpEnv('SCRIPT_NAME');
                $params = t3lib_div::_GET();

                foreach($getParams as $k => $v) {
                        if (strcmp($v,''))      {
                                $params[$k]=$v;
                        } else unset($params[$k]);
                }

                $pString = t3lib_div::implodeArrayForUrl('',$params);

                return $pString ? $parts.'?'.ereg_replace('^&','',$pString) : $parts;
        }

        /**
         * Takes a full URL, $url, possibly with a querystring and overlays the $getParams arrays values onto the quirystring, packs it all together and returns the URL again.
         * So basically it adds the parameters in $getParams to an existing URL, $url
         * Usage: 2
         *
         * @param       string          URL string
         * @param       array           Array of key/value pairs for get parameters to add/overrule with. Can be multidimensional.
         * @return      string          Output URL with added getParams.
         */
        public static function linkThisUrl($url,array $getParams=array())       {
                $parts = parse_url($url);
                $getP = array();
                if ($parts['query'])    {
                        parse_str($parts['query'],$getP);
                }
                $getP = t3lib_div::array_merge_recursive_overrule($getP,$getParams);
                $uP = explode('?',$url);

                $params = t3lib_div::implodeArrayForUrl('',$getP);
                $outurl = $uP[0].($params ? '?'.substr($params, 1) : '');

                return $outurl;
        }

        /**
         * Abstraction method which returns System Environment Variables regardless of server OS, CGI/MODULE version etc. Basically this is SERVER variables for most of them.
         * This should be used instead of getEnv() and $_SERVER/ENV_VARS to get reliable values for all situations.
         * Usage: 221
         *
         * @param       string          Name of the "environment variable"/"server variable" you wish to use. Valid values are SCRIPT_NAME, SCRIPT_FILENAME, REQUEST_URI, PATH_INFO, REMOTE_ADDR, REMOTE_HOST, HTTP_REFERER, HTTP_HOST, HTTP_USER_AGENT, HTTP_ACCEPT_LANGUAGE, QUERY_STRING, TYPO3_DOCUMENT_ROOT, TYPO3_HOST_ONLY, TYPO3_HOST_ONLY, TYPO3_REQUEST_HOST, TYPO3_REQUEST_URL, TYPO3_REQUEST_SCRIPT, TYPO3_REQUEST_DIR, TYPO3_SITE_URL, _ARRAY
         * @return      string          Value based on the input key, independent of server/os environment.
         */
        public static function getIndpEnv($getEnvName)  {
                /*
                        Conventions:
                        output from parse_url():
                        URL:    http://username:password@192.168.1.4:8080/typo3/32/temp/phpcheck/index.php/arg1/arg2/arg3/?arg1,arg2,arg3&p1=parameter1&p2[key]=value#link1
                            [scheme] => 'http'
                            [user] => 'username'
                            [pass] => 'password'
                            [host] => '192.168.1.4'
                                [port] => '8080'
                            [path] => '/typo3/32/temp/phpcheck/index.php/arg1/arg2/arg3/'
                            [query] => 'arg1,arg2,arg3&p1=parameter1&p2[key]=value'
                            [fragment] => 'link1'

                                Further definition: [path_script] = '/typo3/32/temp/phpcheck/index.php'
                                                                        [path_dir] = '/typo3/32/temp/phpcheck/'
                                                                        [path_info] = '/arg1/arg2/arg3/'
                                                                        [path] = [path_script/path_dir][path_info]


                        Keys supported:

                        URI______:
                                REQUEST_URI             =       [path]?[query]          = /typo3/32/temp/phpcheck/index.php/arg1/arg2/arg3/?arg1,arg2,arg3&p1=parameter1&p2[key]=value
                                HTTP_HOST               =       [host][:[port]]         = 192.168.1.4:8080
                                SCRIPT_NAME             =       [path_script]++         = /typo3/32/temp/phpcheck/index.php             // NOTICE THAT SCRIPT_NAME will return the php-script name ALSO. [path_script] may not do that (eg. '/somedir/' may result in SCRIPT_NAME '/somedir/index.php')!
                                PATH_INFO               =       [path_info]                     = /arg1/arg2/arg3/
                                QUERY_STRING    =       [query]                         = arg1,arg2,arg3&p1=parameter1&p2[key]=value
                                HTTP_REFERER    =       [scheme]://[host][:[port]][path]        = http://192.168.1.4:8080/typo3/32/temp/phpcheck/index.php/arg1/arg2/arg3/?arg1,arg2,arg3&p1=parameter1&p2[key]=value
                                                                                (Notice: NO username/password + NO fragment)

                        CLIENT____:
                                REMOTE_ADDR             =       (client IP)
                                REMOTE_HOST             =       (client host)
                                HTTP_USER_AGENT =       (client user agent)
                                HTTP_ACCEPT_LANGUAGE    = (client accept language)

                        SERVER____:
                                SCRIPT_FILENAME =       Absolute filename of script             (Differs between windows/unix). On windows 'C:\\blabla\\blabl\\' will be converted to 'C:/blabla/blabl/'

                        Special extras:
                                TYPO3_HOST_ONLY =               [host] = 192.168.1.4
                                TYPO3_PORT =                    [port] = 8080 (blank if 80, taken from host value)
                                TYPO3_REQUEST_HOST =    [scheme]://[host][:[port]]
                                TYPO3_REQUEST_URL =             [scheme]://[host][:[port]][path]?[query] (scheme will by default be "http" until we can detect something different)
                                TYPO3_REQUEST_SCRIPT =  [scheme]://[host][:[port]][path_script]
                                TYPO3_REQUEST_DIR =             [scheme]://[host][:[port]][path_dir]
                                TYPO3_SITE_URL =                [scheme]://[host][:[port]][path_dir] of the TYPO3 website frontend
                                TYPO3_SITE_SCRIPT =     [script / Speaking URL] of the TYPO3 website
                                TYPO3_DOCUMENT_ROOT =   Absolute path of root of documents: TYPO3_DOCUMENT_ROOT.SCRIPT_NAME = SCRIPT_FILENAME (typically)
                                TYPO3_SSL =                     Returns TRUE if this session uses SSL (HTTPS)

                        Notice: [fragment] is apparently NEVER available to the script!


                        Testing suggestions:
                        - Output all the values.
                        - In the script, make a link to the script it self, maybe add some parameters and click the link a few times so HTTP_REFERER is seen
                        - ALSO TRY the script from the ROOT of a site (like 'http://www.mytest.com/' and not 'http://www.mytest.com/test/' !!)

                */

#               if ($getEnvName=='HTTP_REFERER')        return '';

                $retVal = '';

                switch ((string)$getEnvName)    {
                        case 'SCRIPT_NAME':
                                $retVal = (php_sapi_name()=='cgi'||php_sapi_name()=='cgi-fcgi')&&($_SERVER['ORIG_PATH_INFO']?$_SERVER['ORIG_PATH_INFO']:$_SERVER['PATH_INFO']) ? ($_SERVER['ORIG_PATH_INFO']?$_SERVER['ORIG_PATH_INFO']:$_SERVER['PATH_INFO']) : ($_SERVER['ORIG_SCRIPT_NAME']?$_SERVER['ORIG_SCRIPT_NAME']:$_SERVER['SCRIPT_NAME']);
                        break;
                        case 'SCRIPT_FILENAME':
                                $retVal = str_replace('//','/', str_replace('\\','/', (php_sapi_name()=='cgi'||php_sapi_name()=='isapi' ||php_sapi_name()=='cgi-fcgi')&&($_SERVER['ORIG_PATH_TRANSLATED']?$_SERVER['ORIG_PATH_TRANSLATED']:$_SERVER['PATH_TRANSLATED'])? ($_SERVER['ORIG_PATH_TRANSLATED']?$_SERVER['ORIG_PATH_TRANSLATED']:$_SERVER['PATH_TRANSLATED']):($_SERVER['ORIG_SCRIPT_FILENAME']?$_SERVER['ORIG_SCRIPT_FILENAME']:$_SERVER['SCRIPT_FILENAME'])));
                        break;
                        case 'REQUEST_URI':
                                        // Typical application of REQUEST_URI is return urls, forms submitting to itself etc. Example: returnUrl='.rawurlencode(t3lib_div::getIndpEnv('REQUEST_URI'))
                                if ($GLOBALS['TYPO3_CONF_VARS']['SYS']['requestURIvar'])        {       // This is for URL rewriters that store the original URI in a server variable (eg ISAPI_Rewriter for IIS: HTTP_X_REWRITE_URL)
                                        list($v,$n) = explode('|',$GLOBALS['TYPO3_CONF_VARS']['SYS']['requestURIvar']);
                                        $retVal = $GLOBALS[$v][$n];
                                } elseif (!$_SERVER['REQUEST_URI'])     {       // This is for ISS/CGI which does not have the REQUEST_URI available.
                                        $retVal = '/'.ereg_replace('^/','',t3lib_div::getIndpEnv('SCRIPT_NAME')).
                                                ($_SERVER['QUERY_STRING']?'?'.$_SERVER['QUERY_STRING']:'');
                                } else $retVal = $_SERVER['REQUEST_URI'];
                        break;
                        case 'PATH_INFO':
                                        // $_SERVER['PATH_INFO']!=$_SERVER['SCRIPT_NAME'] is necessary because some servers (Windows/CGI) are seen to set PATH_INFO equal to script_name
                                        // Further, there must be at least one '/' in the path - else the PATH_INFO value does not make sense.
                                        // IF 'PATH_INFO' never works for our purpose in TYPO3 with CGI-servers, then 'php_sapi_name()=='cgi'' might be a better check. Right now strcmp($_SERVER['PATH_INFO'],t3lib_div::getIndpEnv('SCRIPT_NAME')) will always return false for CGI-versions, but that is only as long as SCRIPT_NAME is set equal to PATH_INFO because of php_sapi_name()=='cgi' (see above)
//                              if (strcmp($_SERVER['PATH_INFO'],t3lib_div::getIndpEnv('SCRIPT_NAME')) && count(explode('/',$_SERVER['PATH_INFO']))>1)  {
                                if (php_sapi_name()!='cgi'&&php_sapi_name()!='cgi-fcgi')        {
                                        $retVal = $_SERVER['PATH_INFO'];
                                }
                        break;
                                // These are let through without modification
                        case 'REMOTE_ADDR':
                        case 'REMOTE_HOST':
                        case 'HTTP_REFERER':
                        case 'HTTP_HOST':
                        case 'HTTP_USER_AGENT':
                        case 'HTTP_ACCEPT_ENCODING':
                        case 'HTTP_ACCEPT_LANGUAGE':
                        case 'QUERY_STRING':
                                $retVal = $_SERVER[$getEnvName];
                        break;
                        case 'TYPO3_DOCUMENT_ROOT':
                                // Some CGI-versions (LA13CGI) and mod-rewrite rules on MODULE versions will deliver a 'wrong' DOCUMENT_ROOT (according to our description). Further various aliases/mod_rewrite rules can disturb this as well.
                                // Therefore the DOCUMENT_ROOT is now always calculated as the SCRIPT_FILENAME minus the end part shared with SCRIPT_NAME.
                                $SFN = t3lib_div::getIndpEnv('SCRIPT_FILENAME');
                                $SN_A = explode('/',strrev(t3lib_div::getIndpEnv('SCRIPT_NAME')));
                                $SFN_A = explode('/',strrev($SFN));
                                $acc = array();
                                while(list($kk,$vv)=each($SN_A))        {
                                        if (!strcmp($SFN_A[$kk],$vv))   {
                                                $acc[] = $vv;
                                        } else break;
                                }
                                $commonEnd=strrev(implode('/',$acc));
                                if (strcmp($commonEnd,''))      { $DR = substr($SFN,0,-(strlen($commonEnd)+1)); }
                                $retVal = $DR;
                        break;
                        case 'TYPO3_HOST_ONLY':
                                $p = explode(':',$_SERVER['HTTP_HOST']);
                                $retVal = $p[0];
                        break;