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

<?php
/***************************************************************
 *  Copyright notice
 *
 *  (c) 1999-2011 Kasper Skårhøj (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!
 ***************************************************************/

        // a tabulator
define('TAB', chr(9));
        // a linefeed
define('LF', chr(10));
        // a carriage return
define('CR', chr(13));
        // a CR-LF combination
define('CRLF', CR . LF);

/**
 * The legendary "t3lib_div" class - Miscellaneous functions for general purpose.
 * Most of the functions do 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 Skårhøj <kasperYYYY@typo3.com>
 * @package TYPO3
 * @subpackage t3lib
 */
final class t3lib_div {

                // Severity constants used by t3lib_div::sysLog()
        const SYSLOG_SEVERITY_INFO = 0;
        const SYSLOG_SEVERITY_NOTICE = 1;
        const SYSLOG_SEVERITY_WARNING = 2;
        const SYSLOG_SEVERITY_ERROR = 3;
        const SYSLOG_SEVERITY_FATAL = 4;

        /**
         * Singleton instances returned by makeInstance, using the class names as
         * array keys
         *
         * @var array<t3lib_Singleton>
         */
        protected static $singletonInstances = array();

        /**
         * Instances returned by makeInstance, using the class names as array keys
         *
         * @var array<array><object>
         */
        protected static $nonSingletonInstances = array();

        /**
         * Register for makeInstance with given class name and final class names to reduce number of class_exists() calls
         *
         * @var array Given class name => final class name
         */
        protected static $finalClassNameRegister = array();

        /*************************
         *
         * 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.
         * 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!
         *
         * @param string $var GET/POST var to return
         * @return mixed POST var named $var and if not set, the GET var of the same name.
         */
        public static function _GP($var) {
                if (empty($var)) {
                        return;
                }
                $value = isset($_POST[$var]) ? $_POST[$var] : $_GET[$var];
                if (isset($value)) {
                        if (is_array($value)) {
                                self::stripSlashesOnArray($value);
                        } else {
                                $value = stripslashes($value);
                        }
                }
                return $value;
        }

        /**
         * Returns the global arrays $_GET and $_POST merged with $_POST taking precedence.
         *
         * @param string $parameter Key (variable name) from GET or POST vars
         * @return array Returns the GET vars merged recursively onto the POST vars.
         */
        public static function _GPmerged($parameter) {
                $postParameter = (isset($_POST[$parameter]) && is_array($_POST[$parameter])) ? $_POST[$parameter] : array();
                $getParameter = (isset($_GET[$parameter]) && is_array($_GET[$parameter])) ? $_GET[$parameter] : array();

                $mergedParameters = self::array_merge_recursive_overrule($getParameter, $postParameter);
                self::stripSlashesOnArray($mergedParameters);

                return $mergedParameters;
        }

        /**
         * Returns the global $_GET array (or value from) normalized to contain un-escaped values.
         * ALWAYS use this API function to acquire the GET variables!
         *
         * @param string $var 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)) {
                                self::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!
         *
         * @param string $var 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)) {
                                self::stripSlashesOnArray($value);
                        } else {
                                $value = stripslashes($value);
                        }
                }
                return $value;
        }

        /**
         * Writes input value to $_GET.
         *
         * @param mixed $inputGet
         *              array or single value to write to $_GET. Values should NOT be
         *              escaped at input time (but will be escaped before writing
         *              according to TYPO3 standards).
         * @param string $key
         *              alternative key; If set, this will not set the WHOLE GET array,
         *              but only the key in it specified by this value!
         *              You can specify to replace keys on deeper array levels by
         *              separating the keys with a pipe.
         *              Example: 'parentKey|childKey' will result in
         *              array('parentKey' => array('childKey' => $inputGet))
         *
         * @return void
         */
        public static function _GETset($inputGet, $key = '') {
                        // adds slashes since TYPO3 standard currently is that slashes
                        // must be applied (regardless of magic_quotes setting)
                if (is_array($inputGet)) {
                        self::addSlashesOnArray($inputGet);
                } else {
                        $inputGet = addslashes($inputGet);
                }

                if ($key != '') {
                        if (strpos($key, '|') !== FALSE) {
                                $pieces = explode('|', $key);
                                $newGet = array();
                                $pointer =& $newGet;
                                foreach ($pieces as $piece) {
                                        $pointer =& $pointer[$piece];
                                }
                                $pointer = $inputGet;
                                $mergedGet = self::array_merge_recursive_overrule(
                                        $_GET, $newGet
                                );

                                $_GET = $mergedGet;
                                $GLOBALS['HTTP_GET_VARS'] = $mergedGet;
                        } else {
                                $_GET[$key] = $inputGet;
                                $GLOBALS['HTTP_GET_VARS'][$key] = $inputGet;
                        }
                } elseif (is_array($inputGet)) {
                        $_GET = $inputGet;
                        $GLOBALS['HTTP_GET_VARS'] = $inputGet;
                }
        }

        /**
         * 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 $string Input string
         * @return string Input string with potential XSS code removed
         */
        public static function removeXSS($string) {
                require_once(PATH_typo3 . 'contrib/RemoveXSS/RemoveXSS.php');
                $string = RemoveXSS::process($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.
         *
         * @param string $theFile Filepath
         * @param string $type 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.
         */
        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
                                        // use temporary file to prevent problems with read and write lock on same file on network file systems
                                $temporaryName  =  dirname($theFile) . '/' . md5(uniqid()) . '.gif';
                                        // rename could fail, if a simultaneous thread is currently working on the same thing
                                if (@rename($theFile, $temporaryName)) {
                                        $cmd = self::imageMagickCommand('convert', '"' . $temporaryName . '" "' . $theFile . '"', $gfxConf['im_path_lzw']);
                                        t3lib_utility_Command::exec($cmd);
                                        unlink($temporaryName);
                                }

                                $returnCode = 'IM';
                                if (@is_file($theFile)) {
                                        self::fixPermissions($theFile);
                                }
                        } elseif (($type == 'GD' || !$type) && $gfxConf['gdlib'] && !$gfxConf['gdlib_png']) { // GD
                                $tempImage = imageCreateFromGif($theFile);
                                imageGif($tempImage, $theFile);
                                imageDestroy($tempImage);
                                $returnCode = 'GD';
                                if (@is_file($theFile)) {
                                        self::fixPermissions($theFile);
                                }
                        }
                }
                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.
         *
         * @param string $theFile the filename with path
         * @return string new filename
         */
        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 = self::imageMagickCommand('convert', '"' . $theFile . '" "' . $newFile . '"', $GLOBALS['TYPO3_CONF_VARS']['GFX']['im_path_lzw']);
                        t3lib_utility_Command::exec($cmd);
                        $theFile = $newFile;
                        if (@is_file($newFile)) {
                                self::fixPermissions($newFile);
                        }
                                // unlink old file?? May be bad idea because 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.
         *
         * @param string $theFile Filepath of image file
         * @param boolean $output_png If set, then input file is converted to PNG, otherwise to GIF
         * @return string If the new image file exists, its filepath is returned
         */
        public static function read_png_gif($theFile, $output_png = FALSE) {
                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 = self::imageMagickCommand('convert', '"' . $theFile . '" "' . $newFile . '"', $GLOBALS['TYPO3_CONF_VARS']['GFX']['im_path']);
                                t3lib_utility_Command::exec($cmd);
                                if (@is_file($newFile)) {
                                        self::fixPermissions($newFile);
                                        return $newFile;
                                }
                        }
                }
        }


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

        /**
         * Truncates a string with appended/prepended "..." and takes current character set into consideration.
         *
         * @param string $string string to truncate
         * @param integer $chars must be an integer with an absolute value of at least 4. if negative the string is cropped from the right end.
         * @param string $appendString appendix to the truncated string
         * @return string cropped string
         */
        public static function fixed_lgd_cs($string, $chars, $appendString = '...') {
                if (is_object($GLOBALS['LANG'])) {
                        return $GLOBALS['LANG']->csConvObj->crop($GLOBALS['LANG']->charSet, $string, $chars, $appendString);
                } elseif (is_object($GLOBALS['TSFE'])) {
                        $charSet = ($GLOBALS['TSFE']->renderCharset != '' ? $GLOBALS['TSFE']->renderCharset : $GLOBALS['TSFE']->defaultCharSet);
                        return $GLOBALS['TSFE']->csConvObj->crop($charSet, $string, $chars, $appendString);
                } else {
                                // this case should not happen
                        $csConvObj = self::makeInstance('t3lib_cs');
                        return $csConvObj->crop('iso-8859-1', $string, $chars, $appendString);
                }
        }

        /**
         * Breaks up a single line of text for emails
         *
         * @param string $str The string to break up
         * @param string $newlineChar The string to implode the broken lines with (default/typically \n)
         * @param integer $lineWidth The line width
         * @return string reformatted text
         * @deprecated since TYPO3 4.6, will be removed in TYPO3 4.8 - Use t3lib_utility_Mail::breakLinesForEmail()
         */
        public static function breakLinesForEmail($str, $newlineChar = LF, $lineWidth = 76) {
                self::logDeprecatedFunction();
                return t3lib_utility_Mail::breakLinesForEmail($str, $newlineChar, $lineWidth);
        }

        /**
         * Match IP number with list of numbers with wildcard
         * Dispatcher method for switching into specialised IPv4 and IPv6 methods.
         *
         * @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. An empty list always returns FALSE.
         * @return boolean TRUE if an IP-mask from $list matches $baseIP
         */
        public static function cmpIP($baseIP, $list) {
                $list = trim($list);
                if ($list === '') {
                        return FALSE;
                } elseif ($list === '*') {
                        return TRUE;
                }
                if (strpos($baseIP, ':') !== FALSE && self::validIPv6($baseIP)) {
                        return self::cmpIPv6($baseIP, $list);
                } else {
                        return self::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), could also contain IPv6 addresses
         * @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 = self::trimExplode(',', $list, 1);

                        foreach ($values as $test) {
                                $testList = explode('/', $test);
                                if (count($testList) == 2) {
                                        list($test, $mask) = $testList;
                                } else {
                                        $mask = FALSE;
                                }

                                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;
                                        foreach ($IPparts as $index => $val) {
                                                $val = trim($val);
                                                if (($val !== '*') && ($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 = self::normalizeIPv6($baseIP);

                $values = self::trimExplode(',', $list, 1);
                foreach ($values as $test) {
                        $testList = explode('/', $test);
                        if (count($testList) == 2) {
                                list($test, $mask) = $testList;
                        } else {
                                $mask = FALSE;
                        }

                        if (self::validIPv6($test)) {
                                $test = self::normalizeIPv6($test);
                                $maskInt = intval($mask) ? intval($mask) : 128;
                                if ($mask === '0') { // special case; /0 is an allowed mask - equals a wildcard
                                        $success = TRUE;
                                } elseif ($maskInt == 128) {
                                        $success = ($test === $baseIP);
                                } else {
                                        $testBin = self::IPv6Hex2Bin($test);
                                        $baseIPBin = self::IPv6Hex2Bin($baseIP);
                                        $success = TRUE;

                                        // modulo is 0 if this is a 8-bit-boundary
                                        $maskIntModulo = $maskInt % 8;
                                        $numFullCharactersUntilBoundary = intval($maskInt / 8);

                                        if (substr($testBin, 0, $numFullCharactersUntilBoundary) !== substr($baseIPBin, 0, $numFullCharactersUntilBoundary)) {
                                                $success = FALSE;
                                        } elseif ($maskIntModulo > 0) {
                                                // if not an 8-bit-boundary, check bits of last character
                                                $testLastBits = str_pad(decbin(ord(substr($testBin, $numFullCharactersUntilBoundary, 1))), 8, '0', STR_PAD_LEFT);
                                                $baseIPLastBits = str_pad(decbin(ord(substr($baseIPBin, $numFullCharactersUntilBoundary, 1))), 8, '0', STR_PAD_LEFT);
                                                if (strncmp($testLastBits, $baseIPLastBits, $maskIntModulo) != 0) {
                                                        $success = FALSE;
                                                }
                                        }
                                }
                        }
                        if ($success) {
                                return TRUE;
                        }
                }
                return FALSE;
        }

        /**
         * Transform a regular IPv6 address from hex-representation into binary
         *
         * @param string $hex IPv6 address in hex-presentation
         * @return string Binary representation (16 characters, 128 characters)
         * @see IPv6Bin2Hex()
         */
        public static function IPv6Hex2Bin($hex) {
                        // use PHP-function if PHP was compiled with IPv6-support
                if (defined('AF_INET6')) {
                        $bin = inet_pton($hex);
                } else {
                        $hex = self::normalizeIPv6($hex);
                        $hex = str_replace(':', '', $hex); // Replace colon to nothing
                        $bin = pack("H*" , $hex);
                }
                return $bin;
        }

        /**
         * Transform an IPv6 address from binary to hex-representation
         *
         * @param string $bin IPv6 address in hex-presentation
         * @return string Binary representation (16 characters, 128 characters)
         * @see IPv6Hex2Bin()
         */
        public static function IPv6Bin2Hex($bin) {
                        // use PHP-function if PHP was compiled with IPv6-support
                if (defined('AF_INET6')) {
                        $hex = inet_ntop($bin);
                } else {
                        $hex = unpack("H*" , $bin);
                        $hex = chunk_split($hex[1], 4, ':');
                                // strip last colon (from chunk_split)
                        $hex = substr($hex, 0, -1);
                                // IPv6 is now in normalized form
                                // compress it for easier handling and to match result from inet_ntop()
                        $hex = self::compressIPv6($hex);
                }
                return $hex;

        }

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

                        // according to RFC lowercase-representation is recommended
                $address = strtolower($address);

                        // normalized representation has 39 characters (0000:0000:0000:0000:0000:0000:0000:0000)
                if (strlen($address) == 39) {
                                // already in full expanded form
                        return $address;
                }

                $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 = '';
                        $h = 0;
                        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;
        }


        /**
         * Compress an IPv6 address to the shortest notation
         *
         * @param string $address Given IPv6 address
         * @return string Compressed address
         * @see normalizeIPv6()
         */
        public static function compressIPv6($address) {
                        // use PHP-function if PHP was compiled with IPv6-support
                if (defined('AF_INET6')) {
                        $bin = inet_pton($address);
                        $address = inet_ntop($bin);
                } else {
                        $address = self::normalizeIPv6($address);

                                // append one colon for easier handling
                                // will be removed later
                        $address .= ':';

                                // according to IPv6-notation the longest match
                                // of a package of '0000:' may be replaced with ':'
                                // (resulting in something like '1234::abcd')
                        for ($counter = 8; $counter > 1; $counter--) {
                                $search = str_repeat('0000:', $counter);
                                if (($pos = strpos($address, $search)) !== FALSE) {
                                        $address = substr($address, 0, $pos) . ':' . substr($address, $pos + ($counter*5));
                                        break;
                                }
                        }

                                // up to 3 zeros in the first part may be removed
                        $address = preg_replace('/^0{1,3}/', '', $address);
                                // up to 3 zeros at the beginning of other parts may be removed
                        $address = preg_replace('/:0{1,3}/', ':', $address);

                                // strip last colon (from chunk_split)
                        $address = substr($address, 0, -1);
                }
                return $address;
        }

        /**
         * Validate a given IP address.
         *
         * Possible format are IPv4 and IPv6.
         *
         * @param string $ip IP address to be tested
         * @return boolean TRUE if $ip is either of IPv4 or IPv6 format.
         */
        public static function validIP($ip) {
                return (filter_var($ip, FILTER_VALIDATE_IP) !== FALSE);
        }

        /**
         * Validate a given IP address to the IPv4 address format.
         *
         * Example for possible format: 10.0.45.99
         *
         * @param string $ip IP address to be tested
         * @return boolean TRUE if $ip is of IPv4 format.
         */
        public static function validIPv4($ip) {
                return (filter_var($ip, FILTER_VALIDATE_IP, FILTER_FLAG_IPV4) !== FALSE);
        }

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

        /**
         * Match fully qualified domain name with list of strings with wildcard
         *
         * @param string $baseHost A hostname or an IPv4/IPv6-address (will by reverse-resolved; typically REMOTE_ADDR)
         * @param string $list 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($baseHost, $list) {
                $baseHost = trim($baseHost);
                if (empty($baseHost)) {
                        return FALSE;
                }
                if (self::validIPv4($baseHost) || self::validIPv6($baseHost)) {
                                // resolve hostname
                                // note: this is reverse-lookup and can be randomly set as soon as somebody is able to set
                                // the reverse-DNS for his IP (security when for example used with REMOTE_ADDR)
                        $baseHostName = gethostbyaddr($baseHost);
                        if ($baseHostName === $baseHost) {
                                        // unable to resolve hostname
                                return FALSE;
                        }
                } else {
                        $baseHostName = $baseHost;
                }
                $baseHostNameParts = explode('.', $baseHostName);

                $values = self::trimExplode(',', $list, 1);

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

                                // to match hostNameParts can only be shorter (in case of wildcards) or equal
                        if (count($hostNameParts) > count($baseHostNameParts)) {
                                continue;
                        }

                        $yes = TRUE;
                        foreach ($hostNameParts as $index => $val) {
                                $val = trim($val);
                                if ($val === '*') {
                                                // wildcard valid for one or more hostname-parts

                                        $wildcardStart = $index + 1;
                                                // wildcard as last/only part always matches, otherwise perform recursive checks
                                        if ($wildcardStart < count($hostNameParts)) {
                                                $wildcardMatched = FALSE;
                                                $tempHostName = implode('.', array_slice($hostNameParts, $index + 1));
                                                while (($wildcardStart < count($baseHostNameParts)) && (!$wildcardMatched)) {
                                                        $tempBaseHostName = implode('.', array_slice($baseHostNameParts, $wildcardStart));
                                                        $wildcardMatched = self::cmpFQDN($tempBaseHostName, $tempHostName);
                                                        $wildcardStart++;
                                                }
                                                if ($wildcardMatched) {
                                                                // match found by recursive compare
                                                        return TRUE;
                                                } else {
                                                        $yes = FALSE;
                                                }
                                        }
                                } elseif ($baseHostNameParts[$index] !== $val) {
                                                // in case of no match
                                        $yes = FALSE;
                                }
                        }
                        if ($yes) {
                                return TRUE;
                        }
                }
                return FALSE;
        }

        /**
         * Checks if a given URL matches the host that currently handles this HTTP request.
         * Scheme, hostname and (optional) port of the given URL are compared.
         *
         * @param string $url: URL to compare with the TYPO3 request host
         * @return boolean Whether the URL matches the TYPO3 request host
         */
        public static function isOnCurrentHost($url) {
                return (stripos($url . '/', self::getIndpEnv('TYPO3_REQUEST_HOST') . '/') === 0);
        }

        /**
         * Check for item in list
         * Check if an item exists in a comma-separated list of items.
         *
         * @param string $list comma-separated list of items (string)
         * @param string $item item to check for
         * @return boolean TRUE if $item is in $list
         */
        public static function inList($list, $item) {
                return (strpos(',' . $list . ',', ',' . $item . ',') !== FALSE ? TRUE : FALSE);
        }

        /**
         * Removes an item from a comma-separated list of items.
         *
         * @param string $element element to remove
         * @param string $list comma-separated list of items (string)
         * @return string new comma-separated list of items
         */
        public static function rmFromList($element, $list) {
                $items = explode(',', $list);
                foreach ($items as $k => $v) {
                        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 $list comma-separated list of integers with ranges (string)
         * @return string new comma-separated list of items
         */
        public static function expandList($list) {
                $items = explode(',', $list);
                $list = array();
                foreach ($items as $item) {
                        $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.
         *
         * @param integer $theInt Input value
         * @param integer $min Lower limit
         * @param integer $max Higher limit
         * @param integer $zeroValue Default value if input is FALSE.
         * @return integer The input value forced into the boundaries of $min and $max
         * @deprecated since TYPO3 4.6, will be removed in TYPO3 4.8 - Use t3lib_utility_Math::forceIntegerInRange() instead
         */
        public static function intInRange($theInt, $min, $max = 2000000000, $zeroValue = 0) {
                self::logDeprecatedFunction();
                return t3lib_utility_Math::forceIntegerInRange($theInt, $min, $max, $zeroValue);
        }

        /**
         * Returns the $integer if greater than zero, otherwise returns zero.
         *
         * @param integer $theInt Integer string to process
         * @return integer
         * @deprecated since TYPO3 4.6, will be removed in TYPO3 4.8 - Use t3lib_utility_Math::convertToPositiveInteger() instead
         */
        public static function intval_positive($theInt) {
                self::logDeprecatedFunction();
                return t3lib_utility_Math::convertToPositiveInteger($theInt);
        }

        /**
         * Returns an integer from a three part version number, eg '4.12.3' -> 4012003
         *
         * @param string $verNumberStr Version number on format x.x.x
         * @return integer Integer version of version number (where each part can count to 999)
         * @deprecated since TYPO3 4.6, will be removed in TYPO3 4.9 - Use t3lib_utility_VersionNumber::convertVersionNumberToInteger() instead
         */
        public static function int_from_ver($verNumberStr) {
                        // Deprecation log is activated only for TYPO3 4.7 and above
                if (t3lib_utility_VersionNumber::convertVersionNumberToInteger(TYPO3_version) >= 4007000) {
                        self::logDeprecatedFunction();
                }
                return t3lib_utility_VersionNumber::convertVersionNumberToInteger($verNumberStr);
        }

        /**
         * 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 $verNumberStr  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) {
                $currVersionStr = $GLOBALS['TYPO3_CONF_VARS']['SYS']['compat_version'] ? $GLOBALS['TYPO3_CONF_VARS']['SYS']['compat_version'] : TYPO3_branch;

                if (t3lib_utility_VersionNumber::convertVersionNumberToInteger($currVersionStr) < t3lib_utility_VersionNumber::convertVersionNumberToInteger($verNumberStr)) {
                        return FALSE;
                } else {
                        return TRUE;
                }
        }

        /**
         * Makes a positive integer hash out of the first 7 chars from the md5 hash of the input
         *
         * @param string $str 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)
         *
         * @param string $input Input string to be md5-hashed
         * @param integer $len 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);
        }

        /**
         * Returns a proper HMAC on a given input string and secret TYPO3 encryption key.
         *
         * @param string $input Input string to create HMAC from
         * @return string resulting (hexadecimal) HMAC currently with a length of 40 (HMAC-SHA-1)
         */
        public static function hmac($input) {
                $hashAlgorithm = 'sha1';
                $hashBlocksize = 64;
                $hmac = '';

                if (extension_loaded('hash') && function_exists('hash_hmac') && function_exists('hash_algos') && in_array($hashAlgorithm, hash_algos())) {
                        $hmac = hash_hmac($hashAlgorithm, $input, $GLOBALS['TYPO3_CONF_VARS']['SYS']['encryptionKey']);
                } else {
                                // outer padding
                        $opad = str_repeat(chr(0x5C), $hashBlocksize);
                                // inner padding
                        $ipad = str_repeat(chr(0x36), $hashBlocksize);
                        if (strlen($GLOBALS['TYPO3_CONF_VARS']['SYS']['encryptionKey']) > $hashBlocksize) {
                                        // keys longer than block size are shorten
                                $key = str_pad(pack('H*', call_user_func($hashAlgorithm, $GLOBALS['TYPO3_CONF_VARS']['SYS']['encryptionKey'])), $hashBlocksize, chr(0x00));
                        } else {
                                        // keys shorter than block size are zero-padded
                                $key = str_pad($GLOBALS['TYPO3_CONF_VARS']['SYS']['encryptionKey'], $hashBlocksize, chr(0x00));
                        }
                        $hmac = call_user_func($hashAlgorithm, ($key ^ $opad) . pack('H*', call_user_func($hashAlgorithm, ($key ^ $ipad) . $input)));
                }
                return $hmac;
        }

        /**
         * Takes comma-separated lists and arrays and removes all duplicates
         * If a value in the list is trim(empty), the value is ignored.
         *
         * @param string $in_list Accept multiple parameters which 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)) {
                        throw new InvalidArgumentException(
                                'TYPO3 Fatal Error: t3lib_div::uniqueList() does NOT support array arguments anymore! Only string comma lists!',
                                1270853885
                        );
                }
                if (isset($secondParameter)) {
                        throw new InvalidArgumentException(
                                'TYPO3 Fatal Error: t3lib_div::uniqueList() does NOT support more than a single argument value anymore. You have specified more than one!',
                                1270853886
                        );
                }

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

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

                $reg = '';
                if (!is_dir($fileref) && preg_match('/(.*)\.([^\.]*$)/', $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' => ''
         * '' => ''
         *
         * @param string $path Directory name / path
         * @return string Processed input value. See function description.
         */
        public static function dirname($path) {
                $p = self::revExplode('/', $path, 2);
                return count($p) == 2 ? $p[0] : '';
        }

        /**
         * Modifies a HTML Hex color by adding/subtracting $R,$G and $B integers
         *
         * @param string $color A hexadecimal color code, #xxxxxx
         * @param integer $R Offset value 0-255
         * @param integer $G Offset value 0-255
         * @param integer $B 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_utility_Math::forceIntegerInRange(hexdec(substr($color, 1, 2)) + $R, 0, 255);
                $nG = t3lib_utility_Math::forceIntegerInRange(hexdec(substr($color, 3, 2)) + $G, 0, 255);
                $nB = t3lib_utility_Math::forceIntegerInRange(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
         *
         * @param string $color A hexadecimal color code, #xxxxxx
         * @param integer $all 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 self::modifyHTMLColor($color, $all, $all, $all);
        }

        /**
         * Tests if the input can be interpreted as integer.
         *
         * @param mixed $var Any input variable to test
         * @return boolean Returns TRUE if string is an integer
         * @deprecated since TYPO3 4.6, will be removed in TYPO3 4.8 - Use t3lib_utility_Math::canBeInterpretedAsInteger() instead
         */
        public static function testInt($var) {
                self::logDeprecatedFunction();

                return t3lib_utility_Math::canBeInterpretedAsInteger($var);
        }

        /**
         * Returns TRUE if the first part of $str matches the string $partStr
         *
         * @param string $str Full string to check
         * @param string $partStr 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) {
                return $partStr != '' && strpos((string) $str, (string) $partStr, 0) === 0;
        }

        /**
         * Formats the input integer $sizeInBytes as bytes/kilobytes/megabytes (-/K/M)
         *
         * @param integer $sizeInBytes Number of bytes to format.
         * @param string $labels 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
         *
         * @param string $microtime 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
         *
         * @param string $string Input string, eg "123 + 456 / 789 - 4"
         * @param string $operators 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 -
         *
         * @param string $string Input string, eg "123 + 456 / 789 - 4"
         * @return integer Calculated value. Or error string.
         * @see calcParenthesis()
         * @deprecated since TYPO3 4.6, will be removed in TYPO3 4.8 - Use t3lib_utility_Math::calculateWithPriorityToAdditionAndSubtraction() instead
         */
        public static function calcPriority($string) {
                self::logDeprecatedFunction();

                return t3lib_utility_Math::calculateWithPriorityToAdditionAndSubtraction($string);
        }

        /**
         * Calculates the input with parenthesis levels
         *
         * @param string $string Input string, eg "(123 + 456) / 789 - 4"
         * @return integer Calculated value. Or error string.
         * @see calcPriority(), tslib_cObj::stdWrap()
         * @deprecated since TYPO3 4.6, will be removed in TYPO3 4.8 - Use t3lib_utility_Math::calculateWithParentheses() instead
         */
        public static function calcParenthesis($string) {
                self::logDeprecatedFunction();

                return t3lib_utility_Math::calculateWithParentheses($string);
        }

        /**
         * Inverse version of htmlspecialchars()
         *
         * @param string $value 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()
         *
         * @param string $str 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 preg_replace('/&amp;([#[:alnum:]]*;)/', '&\1', $str);
        }

        /**
         * This function is used to escape any ' -characters when transferring text to JavaScript!
         *
         * @param string $string String to escape
         * @param boolean $extended If set, also backslashes are escaped.
         * @param string $char The character to escape, default is ' (single-quote)
         * @return string Processed input string
         */
        public static function slashJS($string, $extended = FALSE, $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.
         * Useful when passing text to JavaScript where you simply url-encode it to get around problems with syntax-errors, linebreaks etc.
         *
         * @param string $str 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
         * Useful when file paths should keep the "/" chars, but have all other special chars encoded.
         *
         * @param string $str Input string
         * @return string Output string
         */
        public static function rawUrlEncodeFP($str) {
                return str_replace('%2F', '/', rawurlencode($str));
        }

        /**
         * Checking syntax of input email address
         *
         * @param string $email Input string to evaluate
         * @return boolean Returns TRUE if the $email address (input string) is valid
         */
        public static function validEmail($email) {
                        // enforce maximum length to prevent libpcre recursion crash bug #52929 in PHP
                        // fixed in PHP 5.3.4; length restriction per SMTP RFC 2821
                if (strlen($email) > 320) {
                        return FALSE;
                }
                return (filter_var($email, FILTER_VALIDATE_EMAIL) !== FALSE);
        }

        /**
         * Checks if current e-mail sending method does not accept recipient/sender name
         * in a call to PHP mail() function. Windows version of mail() and mini_sendmail
         * program are known not to process such input correctly and they cause SMTP
         * errors. This function will return TRUE if current mail sending method has
         * problem with recipient name in recipient/sender argument for mail().
         *
         * TODO: 4.3 should have additional configuration variable, which is combined
         * by || with the rest in this function.
         *
         * @return boolean TRUE if mail() does not accept recipient name
         */
        public static function isBrokenEmailEnvironment() {
                return TYPO3_OS == 'WIN' || (FALSE !== strpos(ini_get('sendmail_path'), 'mini_sendmail'));
        }

        /**
         * Changes from/to arguments for mail() function to work in any environment.
         *
         * @param string $address Address to adjust
         * @return string Adjusted address
         * @see t3lib_::isBrokenEmailEnvironment()
         */
        public static function normalizeMailAddress($address) {
                if (self::isBrokenEmailEnvironment() && FALSE !== ($pos1 = strrpos($address, '<'))) {
                        $pos2 = strpos($address, '>', $pos1);
                        $address = substr($address, $pos1 + 1, ($pos2 ? $pos2 : strlen($address)) - $pos1 - 1);
                }
                return $address;
        }

        /**
         * 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!
         *
         * @param string $content Input string to be formatted.
         * @return string Formatted for <textarea>-tags
         */
        public static function formatForTextarea($content) {
                return LF . htmlspecialchars($content);
        }

        /**
         * Converts string to uppercase
         * The function converts all Latin characters (a-z, but no accents, etc) to
         * uppercase. It is safe for all supported character sets (incl. utf-8).
         * Unlike strtoupper() it does not honour the locale.
         *
         * @param string $str Input string
         * @return string Uppercase String
         */
        public static function strtoupper($str) {
                return strtr((string) $str, 'abcdefghijklmnopqrstuvwxyz', 'ABCDEFGHIJKLMNOPQRSTUVWXYZ');
        }

        /**
         * Converts string to lowercase
         * The function converts all Latin characters (A-Z, but no accents, etc) to
         * lowercase. It is safe for all supported character sets (incl. utf-8).
         * Unlike strtolower() it does not honour the locale.
         *
         * @param string $str Input string
         * @return string Lowercase String
         */
        public static function strtolower($str) {
                return strtr((string) $str, 'ABCDEFGHIJKLMNOPQRSTUVWXYZ', 'abcdefghijklmnopqrstuvwxyz');
        }

        /**
         * Returns a string of highly randomized bytes (over the full 8-bit range).
         *
         * Note: Returned values are not guaranteed to be crypto-safe,
         * most likely they are not, depending on the used retrieval method.
         *
         * @param integer $bytesToReturn Number of characters (bytes) to return
         * @return string Random Bytes
         * @see http://bugs.php.net/bug.php?id=52523
         * @see http://www.php-security.org/2010/05/09/mops-submission-04-generating-unpredictable-session-ids-and-hashes/index.html
         */
        public static function generateRandomBytes($bytesToReturn) {
                        // Cache 4k of the generated bytestream.
                static $bytes = '';
                $bytesToGenerate = max(4096, $bytesToReturn);

                        // if we have not enough random bytes cached, we generate new ones
                if (!isset($bytes{$bytesToReturn - 1})) {
                        if (TYPO3_OS === 'WIN') {
                                        // Openssl seems to be deadly slow on Windows, so try to use mcrypt
                                        // Windows PHP versions have a bug when using urandom source (see #24410)
                                $bytes .= self::generateRandomBytesMcrypt($bytesToGenerate, MCRYPT_RAND);
                        } else {
                                        // Try to use native PHP functions first, precedence has openssl
                                $bytes .= self::generateRandomBytesOpenSsl($bytesToGenerate);

                                if (!isset($bytes{$bytesToReturn - 1})) {
                                        $bytes .= self::generateRandomBytesMcrypt($bytesToGenerate, MCRYPT_DEV_URANDOM);
                                }

                                        // If openssl and mcrypt failed, try /dev/urandom
                                if (!isset($bytes{$bytesToReturn - 1})) {
                                        $bytes .= self::generateRandomBytesUrandom($bytesToGenerate);
                                }
                        }

                                // Fall back if other random byte generation failed until now
                        if (!isset($bytes{$bytesToReturn - 1})) {
                                $bytes .= self::generateRandomBytesFallback($bytesToReturn);
                        }
                }

                        // get first $bytesToReturn and remove it from the byte cache
                $output = substr($bytes, 0, $bytesToReturn);
                $bytes = substr($bytes, $bytesToReturn);

                return $output;
        }

        /**
         * Generate random bytes using openssl if available
         *
         * @param string $bytesToGenerate
         * @return string
         */
        protected static function generateRandomBytesOpenSsl($bytesToGenerate) {
                if (!function_exists('openssl_random_pseudo_bytes')) {
                        return '';
                }
                $isStrong = NULL;
                return (string) openssl_random_pseudo_bytes($bytesToGenerate, $isStrong);
        }

        /**
         * Generate random bytes using mcrypt if available
         *
         * @param $bytesToGenerate
         * @param $randomSource
         * @return string
         */
        protected static function generateRandomBytesMcrypt($bytesToGenerate, $randomSource) {
                if (!function_exists('mcrypt_create_iv')) {
                        return '';
                }
                return (string) @mcrypt_create_iv($bytesToGenerate, $randomSource);
        }

        /**
         * Read random bytes from /dev/urandom if it is accessible
         *
         * @param $bytesToGenerate
         * @return string
         */
        protected static function generateRandomBytesUrandom($bytesToGenerate) {
                $bytes = '';
                $fh = @fopen('/dev/urandom', 'rb');
                if ($fh) {
                                // PHP only performs buffered reads, so in reality it will always read
                                // at least 4096 bytes. Thus, it costs nothing extra to read and store
                                // that much so as to speed any additional invocations.
                        $bytes = fread($fh, $bytesToGenerate);
                        fclose($fh);
                }

                return $bytes;
        }

        /**
         * Generate pseudo random bytes as last resort
         *
         * @param $bytesToReturn
         * @return string
         */
        protected static function generateRandomBytesFallback($bytesToReturn) {
                $bytes = '';
                        // We initialize with somewhat random.
                $randomState = $GLOBALS['TYPO3_CONF_VARS']['SYS']['encryptionKey'] . base_convert(memory_get_usage() % pow(10, 6), 10, 2) . microtime() . uniqid('') . getmypid();
                while (!isset($bytes{$bytesToReturn - 1})) {
                        $randomState = sha1(microtime() . mt_rand() . $randomState);
                        $bytes .= sha1(mt_rand() . $randomState, TRUE);
                }
                return $bytes;
        }

        /**
         * Returns a hex representation of a random byte string.
         *
         * @param integer $count Number of hex characters to return
         * @return string Random Bytes
         */
        public static function getRandomHexString($count) {
                return substr(bin2hex(self::generateRandomBytes(intval(($count + 1) / 2))), 0, $count);
        }

        /**
         * Returns a given string with underscores as UpperCamelCase.
         * Example: Converts blog_example to BlogExample
         *
         * @param string $string: String to be converted to camel case
         * @return string UpperCamelCasedWord
         */
        public static function underscoredToUpperCamelCase($string) {
                $upperCamelCase = str_replace(' ', '', ucwords(str_replace('_', ' ', self::strtolower($string))));
                return $upperCamelCase;
        }

        /**
         * Returns a given string with underscores as lowerCamelCase.
         * Example: Converts minimal_value to minimalValue
         *
         * @param string $string: String to be converted to camel case
         * @return string lowerCamelCasedWord
         */
        public static function underscoredToLowerCamelCase($string) {
                $upperCamelCase = str_replace(' ', '', ucwords(str_replace('_', ' ', self::strtolower($string))));
                $lowerCamelCase = self::lcfirst($upperCamelCase);
                return $lowerCamelCase;
        }

        /**
         * Returns a given CamelCasedString as an lowercase string with underscores.
         * Example: Converts BlogExample to blog_example, and minimalValue to minimal_value
         *
         * @param string $string String to be converted to lowercase underscore
         * @return string lowercase_and_underscored_string
         */
        public static function camelCaseToLowerCaseUnderscored($string) {
                return self::strtolower(preg_replace('/(?<=\w)([A-Z])/', '_\\1', $string));
        }

        /**
         * Converts the first char of a string to lowercase if it is a latin character (A-Z).
         * Example: Converts "Hello World" to "hello World"
         *
         * @param string $string The string to be used to lowercase the first character
         * @return string The string with the first character as lowercase
         */
        public static function lcfirst($string) {
                return self::strtolower(substr($string, 0, 1)) . substr($string, 1);
        }

        /**
         * Checks if a given string is a Uniform Resource Locator (URL).
         *
         * @param string $url The URL to be validated
         * @return boolean Whether the given URL is valid
         */
        public static function isValidUrl($url) {
                return (filter_var($url, FILTER_VALIDATE_URL, FILTER_FLAG_SCHEME_REQUIRED) !== FALSE);
        }


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

        /**
         * Check if an string item exists in an array.
         * Please note that the order of function parameters is reverse compared to the PHP function in_array()!!!
         *
         * Comparison to PHP in_array():
         * -> $array = array(0, 1, 2, 3);
         * -> variant_a := t3lib_div::inArray($array, $needle)
         * -> variant_b := in_array($needle, $array)
         * -> variant_c := in_array($needle, $array, TRUE)
         * +---------+-----------+-----------+-----------+
         * | $needle | variant_a | variant_b | variant_c |
         * +---------+-----------+-----------+-----------+
         * | '1a'       | FALSE  | TRUE   | FALSE        |
         * | ''   | FALSE        | TRUE   | FALSE        |
         * | '0'         | TRUE   | TRUE          | FALSE        |
         * | 0     | TRUE         | TRUE          | TRUE          |
         * +---------+-----------+-----------+-----------+
         *
         * @param array $in_array one-dimensional array of items
         * @param string $item item to check for
         * @return boolean TRUE if $item is in the one-dimensional array $in_array
         */
        public static function inArray(array $in_array, $item) {
                foreach ($in_array as $val) {
                        if (!is_array($val) && !strcmp($val, $item)) {
                                return TRUE;
                        }
                }
                return FALSE;
        }

        /**
         * Explodes a $string delimited by $delim and passes each item in the array through intval().
         * Corresponds to t3lib_div::trimExplode(), but with conversion to integers for all values.
         *
         * @param string $delimiter Delimiter string to explode with
         * @param string $string The string to explode
         * @param boolean $onlyNonEmptyValues If set, all empty values (='') will NOT be set in output
         * @param integer $limit If positive, the result will contain a maximum of limit elements,
         *                                               if negative, all components except the last -limit are returned,
         *                                               if zero (default), the result is not limited at all
         * @return array Exploded values, all converted to integers
         */
        public static function intExplode($delimiter, $string, $onlyNonEmptyValues = FALSE, $limit = 0) {
                $explodedValues = self::trimExplode($delimiter, $string, $onlyNonEmptyValues, $limit);
                return array_map('intval', $explodedValues);
        }

        /**
         * Reverse explode which explodes the string counting from behind.
         * Thus t3lib_div::revExplode(':','my:words:here',2) will return array('my:words','here')
         *
         * @param string $delimiter Delimiter string to explode with
         * @param string $string The string to explode
         * @param integer $count Number of array entries
         * @return array Exploded values
         */
        public static function revExplode($delimiter, $string, $count = 0) {
                $explodedValues = explode($delimiter, strrev($string), $count);
                $explodedValues = array_map('strrev', $explodedValues);
                return array_reverse($explodedValues);
        }

        /**
         * Explodes a string and trims all values for whitespace in the ends.
         * If $onlyNonEmptyValues is set, then all blank ('') values are removed.
         *
         * @param string $delim Delimiter string to explode with
         * @param string $string The string to explode
         * @param boolean $removeEmptyValues If set, all empty values will be removed in output
         * @param integer $limit If positive, the result will contain a maximum of
         *                                               $limit elements, if negative, all components except
         *                                               the last -$limit are returned, if zero (default),
         *                                               the result is not limited at all. Attention though
         *                                               that the use of this parameter can slow down this
         *                                               function.
         * @return array Exploded values
         */
        public static function trimExplode($delim, $string, $removeEmptyValues = FALSE, $limit = 0) {
                $explodedValues = explode($delim, $string);

                $result = array_map('trim', $explodedValues);

                if ($removeEmptyValues) {
                        $temp = array();
                        foreach ($result as $value) {
                                if ($value !== '') {
                                        $temp[] = $value;
                                }
                        }
                        $result = $temp;
                }

                if ($limit != 0) {
                        if ($limit < 0) {
                                $result = array_slice($result, 0, $limit);
                        } elseif (count($result) > $limit) {
                                $lastElements = array_slice($result, $limit - 1);
                                $result = array_slice($result, 0, $limit - 1);
                                $result[] = implode($delim, $lastElements);
                        }
                }

                return $result;
        }

        /**
         * Removes the value $cmpValue from the $array if found there. Returns the modified array
         *
         * @param array $array Array containing the values
         * @param string $cmpValue 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) {
                foreach ($array as $k => $v) {
                        if (is_array($v)) {
                                $array[$k] = self::removeArrayEntryByValue($v, $cmpValue);
                        } elseif (!strcmp($v, $cmpValue)) {
                                unset($array[$k]);
                        }
                }
                return $array;
        }

        /**
         * Filters an array to reduce its elements to match the condition.
         * The values in $keepItems can be optionally evaluated by a custom callback function.
         *
         * Example (arguments used to call this function):
         * $array = array(
         *               array('aa' => array('first', 'second'),
         *               array('bb' => array('third', 'fourth'),
         *               array('cc' => array('fifth', 'sixth'),
         * );
         * $keepItems = array('third');
         * $getValueFunc = create_function('$value', 'return $value[0];');
         *
         * Returns:
         * array(
         *               array('bb' => array('third', 'fourth'),
         * )
         *
         * @param array $array: The initial array to be filtered/reduced
         * @param mixed $keepItems: The items which are allowed/kept in the array - accepts array or csv string
         * @param string $getValueFunc: (optional) Unique function name set by create_function() used to get the value to keep
         * @return array The filtered/reduced array with the kept items
         */
        public static function keepItemsInArray(array $array, $keepItems, $getValueFunc = NULL) {
                if ($array) {
                                // Convert strings to arrays:
                        if (is_string($keepItems)) {
                                $keepItems = self::trimExplode(',', $keepItems);
                        }
                                // create_function() returns a string:
                        if (!is_string($getValueFunc)) {
                                $getValueFunc = NULL;
                        }
                                // Do the filtering:
                        if (is_array($keepItems) && count($keepItems)) {
                                foreach ($array as $key => $value) {
                                                // Get the value to compare by using the callback function:
                                        $keepValue = (isset($getValueFunc) ? $getValueFunc($value) : $value);
                                        if (!in_array($keepValue, $keepItems)) {
                                                unset($array[$key]);
                                        }
                                }
                        }
                }
                return $array;
        }

        /**
         * Implodes a multidim-array into GET-parameters (eg. &param[key][key2]=value2&param[key][key3]=value3)
         *
         * @param string $name Name prefix for entries. Set to blank if you wish none.
         * @param array $theArray The (multidimensional) array to implode
         * @param string $str (keep blank)
         * @param boolean $skipBlank If set, parameters which were blank strings would be removed.
         * @param boolean $rawurlencodeParamName 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 = FALSE, $rawurlencodeParamName = FALSE) {
                foreach ($theArray as $Akey => $AVal) {
                        $thisKeyName = $name ? $name . '[' . $Akey . ']' : $Akey;
                        if (is_array($AVal)) {
                                $str = self::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 $string GETvars string
         * @param boolean $multidim 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...)
         *
         * @param string $varList List of variable/key names
         * @param array $getArray Array from where to get values based on the keys in $varList
         * @param boolean $GPvarAlt 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 = TRUE) {
                $keys = self::trimExplode(',', $varList, 1);
                $outArr = array();
                foreach ($keys as $v) {
                        if (isset($getArray[$v])) {
                                $outArr[$v] = $getArray[$v];
                        } elseif ($GPvarAlt) {
                                $outArr[$v] = self::_GP($v);
                        }
                }
                return $outArr;
        }

        /**
         * AddSlash array
         * This function traverses a multidimensional array and adds slashes to the values.
         * NOTE that the input array is and argument by reference.!!
         * Twin-function to stripSlashesOnArray
         *
         * @param array $theArray Multidimensional input array, (REFERENCE!)
         * @return array
         */
        public static function addSlashesOnArray(array &$theArray) {
                foreach ($theArray as &$value) {
                        if (is_array($value)) {
                                self::addSlashesOnArray($value);
                        } else {
                                $value = addslashes($value);
                        }
                }
                unset($value);
                reset($theArray);
        }

        /**
         * StripSlash array
         * This function traverses a multidimensional array and strips slashes to the values.
         * NOTE that the input array is and argument by reference.!!
         * Twin-function to addSlashesOnArray
         *
         * @param array $theArray Multidimensional input array, (REFERENCE!)
         * @return array
         */
        public static function stripSlashesOnArray(array &$theArray) {
                foreach ($theArray as &$value) {
                        if (is_array($value)) {
                                self::stripSlashesOnArray($value);
                        } else {
                                $value = stripslashes($value);
                        }
                }
                unset($value);
                reset($theArray);
        }

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

        /**
         * Rename Array keys with a given mapping table
         *
         * @param array $array Array by reference which should be remapped
         * @param array $mappingTable Array with remap information, array/$oldKey => $newKey)
         */
        public static function remapArrayKeys(&$array, $mappingTable) {
                if (is_array($mappingTable)) {
                        foreach ($mappingTable as $old => $new) {
                                if ($new && isset($array[$old])) {
                                        $array[$new] = $array[$old];
                                        unset ($array[$old]);
                                }
                        }
                }
        }


        /**
         * 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.
         *
         * @param array $arr0 First array
         * @param array $arr1 Second array, overruling the first array
         * @param boolean $notAddKeys 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 $includeEmptyValues 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 = FALSE, $includeEmptyValues = TRUE) {
                foreach ($arr1 as $key => $val) {
                        if (is_array($arr0[$key])) {
                                if (is_array($arr1[$key])) {
                                        $arr0[$key] = self::array_merge_recursive_overrule($arr0[$key], $arr1[$key], $notAddKeys, $includeEmptyValues);
                                }
                        } else {
                                if ($notAddKeys) {
                                        if (isset($arr0[$key])) {
                                                if ($includeEmptyValues || $val) {
                                                        $arr0[$key] = $val;
                                                }
                                        }
                                } else {
                                        if ($includeEmptyValues || $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.
         *
         * @param array $arr1 First array
         * @param array $arr2 Second array
         * @return array Merged result.
         */
        public static function array_merge(array $arr1, array $arr2) {
                return $arr2 + $arr1;
        }

        /**
         * Filters keys off from first array that also exist in second array. Comparison is done by keys.
         * This method is a recursive version of php array_diff_assoc()
         *
         * @param array $array1 Source array
         * @param array $array2 Reduce source array by this array
         * @return array Source array reduced by keys also present in second array
         */
        public static function arrayDiffAssocRecursive(array $array1, array $array2) {
                $differenceArray = array();
                foreach ($array1 as $key => $value) {
                        if (!array_key_exists($key, $array2)) {
                                $differenceArray[$key] = $value;
                        } elseif (is_array($value)) {
                                if (is_array($array2[$key])) {
                                        $differenceArray[$key] = self::arrayDiffAssocRecursive($value, $array2[$key]);
                                }
                        }
                }

                return $differenceArray;
        }

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

        /**
         * 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();
                foreach ($ts as $key => $value) {
                        if (is_array($value)) {
                                $key = rtrim($key, '.');
                                $out[$key] = self::removeDotsFromTS($value);
                        } else {
                                $out[$key] = $value;
                        }
                }
                return $out;
        }

        /**
         * Sorts an array by key recursive - uses natural sort order (aAbB-zZ)
         *
         * @param array $array array to be sorted recursively, passed by reference
         * @return boolean TRUE if param is an array
         */
        public static function naturalKeySortRecursive(&$array) {
                if (!is_array($array)) {
                        return FALSE;
                }
                uksort($array, 'strnatcasecmp');
                foreach ($array as $key => $value) {
                        self::naturalKeySortRecursive($array[$key]);
                }
                return TRUE;
        }


        /*************************
         *
         * 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 parameter list (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()
         *
         * @param string $tag HTML-tag string (or attributes only)
         * @return array Array with the attribute values.
         */
        public static function get_tag_attributes($tag) {
                $components = self::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(preg_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
         *
         * @param string $tag HTML-tag string (or attributes only)
         * @return array Array with the attribute values.
         */
        public static function split_tag_attributes($tag) {
                $tag_tmp = trim(preg_replace('/^<[^[:space:]]*/', '', trim($tag)));
                        // Removes any > in the end of the string
                $tag_tmp = trim(rtrim($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 = preg_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)
         *
         * @param array $arr Array with attribute key/value pairs, eg. "bgcolor"=>"red", "border"=>0
         * @param boolean $xhtmlSafe 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 $dontOmitBlankAttribs 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);
        }

        /**
         * Wraps JavaScript code XHTML ready with <script>-tags
         * Automatic re-indenting of the JS code is done by using the first line as indent reference.
         * This is nice for indenting JS code with PHP code on the same level.
         *
         * @param string $string JavaScript code
         * @param boolean $linebreak Wrap script element in line breaks? Default is TRUE.
         * @return string The wrapped JS code, ready to put into a XHTML page
         */
        public static function wrapJS($string, $linebreak = TRUE) {
                if (trim($string)) {
                                // <script wrapped in nl?
                        $cr = $linebreak ? LF : '';

                                // 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], TAB, $string);
                        }
                        $string = $cr . '<script type="text/javascript">
/*<![CDATA[*/
' . $string . '
/*]]>*/
</script>' . $cr;
                }
                return trim($string);
        }


        /**
         * Parses XML input into a PHP array with associative keys
         *
         * @param string $string XML data input
         * @param integer $depth 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;

                $tagi = array();
                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['XMLvalue'] = self::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 $array The input PHP array with any kind of data; text, binary, integers. Not objects though.
         * @param string $docTag Alternative document tag. Default is "phparray".
         * @param array $options Options for the compilation. See array2xml() for description.
         * @param string $charset 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" ?>' . LF .
                                self::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 tag names.
         * 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 tag name "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...
         *
         * @param array $array The input PHP array with any kind of data; text, binary, integers. Not objects though.
         * @param string $NSprefix tag-prefix, eg. a namespace prefix like "T3:"
         * @param integer $level Current recursion level. Don't change, stay at zero!
         * @param string $docTag Alternative document tag. Default is "phparray".
         * @param integer $spaceInd 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 TAB is used
         * @param array $options 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 array $stackData 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 ? ' ' : TAB;
                $indentN = $spaceInd > 0 ? $spaceInd : 1;
                $nl = ($spaceInd >= 0 ? LF : '');

                        // 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_utility_Math::canBeInterpretedAsInteger($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(preg_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 .
                                                self::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()
         * This is a wrapper for xml2arrayProcess that adds a two-level cache
         *
         * @param string $string XML content to convert into an array
         * @param string $NSprefix The tag-prefix resolve, eg. a namespace like "T3:"
         * @param boolean $reportDocTag 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(),xml2arrayProcess()
         */
        public static function xml2array($string, $NSprefix = '', $reportDocTag = FALSE) {
                static $firstLevelCache = array();

                $identifier = md5($string . $NSprefix . ($reportDocTag ? '1' : '0'));

                        // look up in first level cache
                if (!empty($firstLevelCache[$identifier])) {
                        $array = $firstLevelCache[$identifier];
                } else {
                                // look up in second level cache
                        $cacheContent = t3lib_pageSelect::getHash($identifier, 0);
                        $array = unserialize($cacheContent);

                        if ($array === FALSE) {
                                $array = self::xml2arrayProcess($string, $NSprefix, $reportDocTag);
                                t3lib_pageSelect::storeHash($identifier, serialize($array), 'ident_xml2array');
                        }
                                // store content in first level cache
                        $firstLevelCache[$identifier] = $array;
                }
                return $array;
        }

        /**
         * Converts an XML string to a PHP array.
         * This is the reverse function of array2xml()
         *
         * @param string $string XML content to convert into an array
         * @param string $NSprefix The tag-prefix resolve, eg. a namespace like "T3:"
         * @param boolean $reportDocTag 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()
         */
        protected static function xml2arrayProcess($string, $NSprefix = '', $reportDocTag = FALSE) {
                        // 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);

                        // 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] : ($GLOBALS['TYPO3_CONF_VARS']['BE']['forceCharset'] ? $GLOBALS['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.
         *
         * @param array $vals An 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).
         *
         * @param string $xmlData 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 self::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(CR, '', $script)));
                }
                catch (JSMinException $e) {
                        $error = 'Error while minifying JavaScript: ' . $e->getMessage();
                        self::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 $GLOBALS['TYPO3_CONF_VARS']['SYS']['curlUse'] etc.
         *
         * @param string $url File/URL to read
         * @param integer $includeHeader Whether the HTTP header should be fetched or not. 0=disable, 1=fetch header+content, 2=fetch header only
         * @param array $requestHeaders HTTP headers to be used in the request
         * @param array $report Error code/message and, if $includeHeader is 1, response meta data (HTTP status and content type)
         * @return mixed The content from the resource given as input. FALSE if an error has occured.
         */
        public static function getUrl($url, $includeHeader = 0, $requestHeaders = FALSE, &$report = NULL) {
                $content = FALSE;

                if (isset($report)) {
                        $report['error'] = 0;
                        $report['message'] = '';
                }

                        // use cURL for: http, https, ftp, ftps, sftp and scp
                if ($GLOBALS['TYPO3_CONF_VARS']['SYS']['curlUse'] == '1' && preg_match('/^(?:http|ftp)s?|s(?:ftp|cp):/', $url)) {
                        if (isset($report)) {
                                $report['lib'] = 'cURL';
                        }

                                // External URL without error checking.
                        if (!function_exists('curl_init') || !($ch = curl_init())) {
                                if (isset($report)) {
                                        $report['error'] = -1;
                                        $report['message'] = 'Couldn\'t initialize cURL.';
                                }
                                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_HTTPGET, $includeHeader == 2 ? 'HEAD' : 'GET');
                        curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
                        curl_setopt($ch, CURLOPT_FAILONERROR, 1);
                        curl_setopt($ch, CURLOPT_CONNECTTIMEOUT, max(0, intval($GLOBALS['TYPO3_CONF_VARS']['SYS']['curlTimeout'])));

                        $followLocation = @curl_setopt($ch, CURLOPT_FOLLOWLOCATION, 1);

                        if (is_array($requestHeaders)) {
                                curl_setopt($ch, CURLOPT_HTTPHEADER, $requestHeaders);
                        }

                                // (Proxy support implemented by Arco <arco@appeltaart.mine.nu>)
                        if ($GLOBALS['TYPO3_CONF_VARS']['SYS']['curlProxyServer']) {
                                curl_setopt($ch, CURLOPT_PROXY, $GLOBALS['TYPO3_CONF_VARS']['SYS']['curlProxyServer']);

                                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);
                        if (isset($report)) {
                                if ($content === FALSE) {
                                        $report['error'] = curl_errno($ch);
                                        $report['message'] = curl_error($ch);
                                } else {
                                        $curlInfo = curl_getinfo($ch);
                                                // We hit a redirection but we couldn't follow it
                                        if (!$followLocation && $curlInfo['status'] >= 300 && $curlInfo['status'] < 400) {
                                                $report['error'] = -1;
                                                $report['message'] = 'Couldn\'t follow location redirect (PHP configuration option open_basedir is in effect).';
                                        } elseif ($includeHeader) {
                                                        // Set only for $includeHeader to work exactly like PHP variant
                                                $report['http_code'] = $curlInfo['http_code'];
                                                $report['content_type'] = $curlInfo['content_type'];
                                        }
                                }
                        }
                        curl_close($ch);

                } elseif ($includeHeader) {
                        if (isset($report)) {
                                $report['lib'] = 'socket';
                        }
                        $parsedURL = parse_url($url);
                        if (!preg_match('/^https?/', $parsedURL['scheme'])) {
                                if (isset($report)) {
                                        $report['error'] = -1;
                                        $report['message'] = 'Reading headers is not allowed for this protocol.';
                                }
                                return FALSE;
                        }
                        $port = intval($parsedURL['port']);
                        if ($port < 1) {
                                if ($parsedURL['scheme'] == 'http') {
                                        $port = ($port > 0 ? $port : 80);
                                        $scheme = '';
                                } else {
                                        $port = ($port > 0 ? $port : 443);
                                        $scheme = 'ssl://';
                                }
                        }
                        $errno = 0;
                                // $errstr = '';
                        $fp = @fsockopen($scheme . $parsedURL['host'], $port, $errno, $errstr, 2.0);
                        if (!$fp || $errno > 0) {
                                if (isset($report)) {
                                        $report['error'] = $errno ? $errno : -1;
                                        $report['message'] = $errno ? ($errstr ? $errstr : 'Socket error.') : 'Socket initialization error.';
                                }
                                return FALSE;
                        }
                        $method = ($includeHeader == 2) ? 'HEAD' : 'GET';
                        $msg = $method . ' ' . (isset($parsedURL['path']) ? $parsedURL['path'] : '/') .
                                        ($parsedURL['query'] ? '?' . $parsedURL['query'] : '') .
                                        ' HTTP/1.0' . CRLF . 'Host: ' .
                                        $parsedURL['host'] . "\r\nConnection: close\r\n";
                        if (is_array($requestHeaders)) {
                                $msg .= implode(CRLF, $requestHeaders) . CRLF;
                        }
                        $msg .= CRLF;

                        fputs($fp, $msg);
                        while (!feof($fp)) {
                                $line = fgets($fp, 2048);
                                if (isset($report)) {
                                        if (preg_match('|^HTTP/\d\.\d +(\d+)|', $line, $status)) {
                                                $report['http_code'] = $status[1];
                                        }
                                        elseif (preg_match('/^Content-Type: *(.*)/i', $line, $type)) {
                                                $report['content_type'] = $type[1];
                                        }
                                }
                                $content .= $line;
                                if (!strlen(trim($line))) {
                                        break; // Stop at the first empty line (= end of header)
                                }
                        }
                        if ($includeHeader != 2) {
                                $content .= stream_get_contents($fp);
                        }
                        fclose($fp);

                } elseif (is_array($requestHeaders)) {
                        if (isset($report)) {
                                $report['lib'] = 'file/context';
                        }
                        $parsedURL = parse_url($url);
                        if (!preg_match('/^https?/', $parsedURL['scheme'])) {
                                if (isset($report)) {
                                        $report['error'] = -1;
                                        $report['message'] = 'Sending request headers is not allowed for this protocol.';
                                }
                                return FALSE;
                        }
                        $ctx = stream_context_create(array(
                                'http' => array(
                                        'header' => implode(CRLF, $requestHeaders)
                                )
                        )
                        );
                        $content = @file_get_contents($url, FALSE, $ctx);
                        if ($content === FALSE && isset($report)) {
                                $phpError = error_get_last();
                                $report['error'] = $phpError['type'];
                                $report['message'] = $phpError['message'];
                        }
                } else {
                        if (isset($report)) {
                                $report['lib'] = 'file';
                        }
                        $content = @file_get_contents($url);
                        if ($content === FALSE && isset($report)) {
                                if (function_exists('error_get_last')) {
                                        $phpError = error_get_last();
                                        $report['error'] = $phpError['type'];
                                        $report['message'] = $phpError['message'];
                                } else {
                                        $report['error'] = -1;
                                        $report['message'] = 'Couldn\'t get URL.';
                                }
                        }
                }

                return $content;
        }

        /**
         * Writes $content to the file $file
         *
         * @param string $file Filepath to write to
         * @param string $content 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
                                self::fixPermissions($file);
                        }

                        return TRUE;
                }

                return FALSE;
        }

        /**
         * Sets the file system mode and group ownership of a file or a folder.
         *
         * @param string $path Path of file or folder, must not be escaped. Path can be absolute or relative
         * @param boolean $recursive If set, also fixes permissions of files and folders in the folder (if $path is a folder)
         * @return mixed TRUE on success, FALSE on error, always TRUE on Windows OS
         */
        public static function fixPermissions($path, $recursive = FALSE) {
                if (TYPO3_OS != 'WIN') {
                        $result = FALSE;

                                // Make path absolute
                        if (!self::isAbsPath($path)) {
                                $path = self::getFileAbsFileName($path, FALSE);
                        }

                        if (self::isAllowedAbsPath($path)) {
                                if (@is_file($path)) {
                                                // "@" is there because file is not necessarily OWNED by the user
                                        $result = @chmod($path, octdec($GLOBALS['TYPO3_CONF_VARS']['BE']['fileCreateMask']));
                                } elseif (@is_dir($path)) {
                                                // "@" is there because file is not necessarily OWNED by the user
                                        $result = @chmod($path, octdec($GLOBALS['TYPO3_CONF_VARS']['BE']['folderCreateMask']));
                                }

                                        // Set createGroup if not empty
                                if ($GLOBALS['TYPO3_CONF_VARS']['BE']['createGroup']) {
                                                // "@" is there because file is not necessarily OWNED by the user
                                        $changeGroupResult = @chgrp($path, $GLOBALS['TYPO3_CONF_VARS']['BE']['createGroup']);
                                        $result = $changeGroupResult ? $result : FALSE;
                                }

                                        // Call recursive if recursive flag if set and $path is directory
                                if ($recursive && @is_dir($path)) {
                                        $handle = opendir($path);
                                        while (($file = readdir($handle)) !== FALSE) {
                                                $recursionResult = NULL;
                                                if ($file !== '.' && $file !== '..') {
                                                        if (@is_file($path . '/' . $file)) {
                                                                $recursionResult = self::fixPermissions($path . '/' . $file);
                                                        } elseif (@is_dir($path . '/' . $file)) {
                                                                $recursionResult = self::fixPermissions($path . '/' . $file, TRUE);
                                                        }
                                                        if (isset($recursionResult) && !$recursionResult) {
                                                                $result = FALSE;
                                                        }
                                                }
                                        }
                                        closedir($handle);
                                }
                        }
                } else {
                        $result = TRUE;
                }
                return $result;
        }

        /**
         * 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 $filepath Absolute file path to write to inside "typo3temp/". First part of this string must match PATH_site."typo3temp/"
         * @param string $content Content string to write
         * @return string Returns NULL 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 (self::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 (self::isFirstPartOfStr($fI['dirname'], $dirName)) {

                                                        // Checking if the "subdir" is found:
                                                $subdir = substr($fI['dirname'], strlen($dirName));
                                                if ($subdir) {
                                                        if (preg_match('/^[[:alnum:]_]+\/$/', $subdir) || preg_match('/^[[:alnum:]_]+\/[[:alnum:]_]+\/$/', $subdir)) {
                                                                $dirName .= $subdir;
                                                                if (!@is_dir($dirName)) {
                                                                        self::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']) {
                                                                self::writeFile($filepath, $content);
                                                                if (!@is_file($filepath)) {
                                                                        return 'The file was not written to the disk. Please, check that you have write permissions to the typo3temp/ directory.';
                                                                }
                                                        } 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.
         * Sets folder permissions according to $GLOBALS['TYPO3_CONF_VARS']['BE']['folderCreateMask']
         * and group ownership according to $GLOBALS['TYPO3_CONF_VARS']['BE']['createGroup']
         *
         * @param string $newFolder Absolute path to folder, see PHP mkdir() function. Removes trailing slash internally.
         * @return boolean TRUE if @mkdir went well!
         */
        public static function mkdir($newFolder) {
                $result = @mkdir($newFolder, octdec($GLOBALS['TYPO3_CONF_VARS']['BE']['folderCreateMask']));
                if ($result) {
                        self::fixPermissions($newFolder);
                }
                return $result;
        }

        /**
         * Creates a directory - including parent directories if necessary and
         * sets permissions on newly created directories.
         *
         * @param string $directory Target directory to create. Must a have trailing slash
         *              if second parameter is given!
         *              Example: "/root/typo3site/typo3temp/foo/"
         * @param string $deepDirectory Directory to create. This second parameter
         *              is kept for backwards compatibility since 4.6 where this method
         *              was split into a base directory and a deep directory to be created.
         *              Example: "xx/yy/" which creates "/root/typo3site/xx/yy/" if $directory is "/root/typo3site/"
         * @return void
         * @throws \InvalidArgumentException If $directory or $deepDirectory are not strings
         * @throws \RuntimeException If directory could not be created
         */
        public static function mkdir_deep($directory, $deepDirectory = '') {
                if (!is_string($directory)) {
                        throw new \InvalidArgumentException(
                                'The specified directory is of type "' . gettype($directory) . '" but a string is expected.',
                                1303662955
                        );
                }
                if (!is_string($deepDirectory)) {
                        throw new \InvalidArgumentException(
                                'The specified directory is of type "' . gettype($deepDirectory) . '" but a string is expected.',
                                1303662956
                        );
                }

                $fullPath = $directory . $deepDirectory;
                if (!is_dir($fullPath) && strlen($fullPath) > 0) {
                        $firstCreatedPath = self::createDirectoryPath($fullPath);
                        if ($firstCreatedPath !== '') {
                                self::fixPermissions($firstCreatedPath, TRUE);
                        }
                }
        }

        /**
         * Creates directories for the specified paths if they do not exist. This
         * functions sets proper permission mask but does not set proper user and
         * group.
         *
         * @static
         * @param string $fullDirectoryPath
         * @return string Path to the the first created directory in the hierarchy
         * @see t3lib_div::mkdir_deep
         * @throws \RuntimeException If directory could not be created
         */
        protected static function createDirectoryPath($fullDirectoryPath) {
                $currentPath = $fullDirectoryPath;
                $firstCreatedPath = '';
                $permissionMask = octdec($GLOBALS['TYPO3_CONF_VARS']['BE']['folderCreateMask']);
                if (!@is_dir($currentPath)) {
                        do {
                                $firstCreatedPath = $currentPath;
                                $separatorPosition = strrpos($currentPath, DIRECTORY_SEPARATOR);
                                $currentPath = substr($currentPath, 0, $separatorPosition);
                        } while (!is_dir($currentPath) && $separatorPosition !== FALSE);

                        $result = @mkdir($fullDirectoryPath, $permissionMask, TRUE);
                        if (!$result) {
                                throw new \RuntimeException('Could not create directory!', 1170251400);
                        }
                }
                return $firstCreatedPath;
        }

        /**
         * Wrapper function for rmdir, allowing recursive deletion of folders and files
         *
         * @param string $path Absolute path to folder, see PHP rmdir() function. Removes trailing slash internally.
         * @param boolean $removeNonEmpty 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 = self::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.
         *
         * @param string $path 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) {
                        if (is_dir($path)) {
                                $dir = scandir($path);
                                $dirs = array();
                                foreach ($dir as $entry) {
                                        if (is_dir($path . '/' . $entry) && $entry != '..' && $entry != '.') {
                                                $dirs[] = $entry;
                                        }
                                }
                        } else {
                                $dirs = 'error';
                        }
                }
                return $dirs;
        }

        /**
         * Returns an array with the names of files in a specific path
         *
         * @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 $prependPath If set, then the path is prepended the file names. Otherwise only the file names are returned in the array
         * @param string $order is sorting: 1= sort alphabetically, 'mtime' = sort by modification time.
         *
         * @param string $excludePattern A comma separated list of file names to exclude, no wildcards
         * @return array Array of the files found
         */
        public static function getFilesInDir($path, $extensionList = '', $prependPath = FALSE, $order = '', $excludePattern = '') {

                        // Initialize variables:
                $filearray = array();
                $sortarray = array();
                $path = rtrim($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) || self::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);
                        $newArr = array();
                        foreach ($sortarray as $k => $v) {
                                $newArr[$k] = $filearray[$k];
                        }
                        $filearray = $newArr;
                }

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

        /**
         * Recursively gather all files and folders of a path.
         *
         * @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 = FALSE, $recursivityLevels = 99, $excludePattern = '') {
                if ($regDirs) {
                        $fileArr[] = $path;
                }
                $fileArr = array_merge($fileArr, self::getFilesInDir($path, $extList, 1, 1, $excludePattern));

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

        /**
         * Removes the absolute part of all files/folders in fileArr
         *
         * @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 (self::isFirstPartOfStr($absFileRef, $prefixToRemove)) {
                                $absFileRef = substr($absFileRef, strlen($prefixToRemove));
                        } else {
                                return 'ERROR: One or more of the files was NOT prefixed with the prefix-path!';
                        }
                }
                unset($absFileRef);
                return $fileArr;
        }

        /**
         * Fixes a path for windows-backslashes and reduces double-slashes to single slashes
         *
         * @param string $theFile 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/"
         *
         * @param string $pathStr 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)
         *
         * @param string $path 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 = self::getIndpEnv('TYPO3_REQUEST_HOST') . $path;