t3lib/class.t3lib_div.php

   1 <?php
   2 /***************************************************************
   3 *  Copyright notice
   4 *
   5 *  (c) 1999-2009 Kasper Skaarhoj (kasperYYYY@typo3.com)
   6 *  All rights reserved
   7 *
   8 *  This script is part of the TYPO3 project. The TYPO3 project is
   9 *  free software; you can redistribute it and/or modify
  10 *  it under the terms of the GNU General Public License as published by
  11 *  the Free Software Foundation; either version 2 of the License, or
  12 *  (at your option) any later version.
  13 *
  14 *  The GNU General Public License can be found at
  15 *  http://www.gnu.org/copyleft/gpl.html.
  16 *  A copy is found in the textfile GPL.txt and important notices to the license
  17 *  from the author is found in LICENSE.txt distributed with these scripts.
  18 *
  19 *
  20 *  This script is distributed in the hope that it will be useful,
  21 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  22 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  23 *  GNU General Public License for more details.
  24 *
  25 *  This copyright notice MUST APPEAR in all copies of the script!
  26 ***************************************************************/
  27 /**
  28  * Contains the reknown class "t3lib_div" with general purpose functions
  29  *
  30  * $Id$
  31  * Revised for TYPO3 3.6 July/2003 by Kasper Skaarhoj
  32  * XHTML compliant
  33  * Usage counts are based on search 22/2 2003 through whole source including tslib/
  34  *
  35  * @author      Kasper Skaarhoj <kasperYYYY@typo3.com>
  36  */
  37 /**
  38  * [CLASS/FUNCTION INDEX of SCRIPT]
  39  *
  40  *
  41  *
  42  *  232: class t3lib_div
  43  *
  44  *              SECTION: GET/POST Variables
  45  *  262:     function _GP($var)
  46  *  280:     function _GET($var=NULL)
  47  *  297:     function _POST($var=NULL)
  48  *  313:     function _GETset($inputGet,$key='')
  49  *  336:     function GPvar($var,$strip=0)
  50  *  353:     function GParrayMerged($var)
  51  *
  52  *              SECTION: IMAGE FUNCTIONS
  53  *  397:     function gif_compress($theFile, $type)
  54  *  425:     function png_to_gif_by_imagemagick($theFile)
  55  *  450:     function read_png_gif($theFile,$output_png=0)
  56  *
  57  *              SECTION: STRING FUNCTIONS
  58  *  499:     function fixed_lgd($string,$origChars,$preStr='...')
  59  *  524:     function fixed_lgd_pre($string,$chars)
  60  *  538:     function fixed_lgd_cs($string,$chars)
  61  *  555:     function breakTextForEmail($str,$implChar=LF,$charWidth=76)
  62  *  574:     function breakLinesForEmail($str,$implChar=LF,$charWidth=76)
  63  *  610:     function cmpIP($baseIP, $list)
  64  *  626:     function cmpIPv4($baseIP, $list)
  65  *  668:     function cmpIPv6($baseIP, $list)
  66  *  711:     function IPv6Hex2Bin ($hex)
  67  *  726:     function normalizeIPv6($address)
  68  *  782:     function validIPv6($ip)
  69  *  805:     function cmpFQDN($baseIP, $list)
  70  *  835:     function inList($list,$item)
  71  *  847:     function rmFromList($element,$list)
  72  *  863:     function expandList($list)
  73  *  894:     function intInRange($theInt,$min,$max=2000000000,$zeroValue=0)
  74  *  910:     function intval_positive($theInt)
  75  *  923:     function int_from_ver($verNumberStr)
  76  *  934:     function compat_version($verNumberStr)
  77  *  952:     function md5int($str)
  78  *  965:     function shortMD5($input, $len=10)
  79  *  978:     function uniqueList($in_list, $secondParameter=NULL)
  80  *  992:     function split_fileref($fileref)
  81  * 1030:     function dirname($path)
  82  * 1046:     function modifyHTMLColor($color,$R,$G,$B)
  83  * 1066:     function modifyHTMLColorAll($color,$all)
  84  * 1077:     function rm_endcomma($string)
  85  * 1090:     function danish_strtoupper($string)
  86  * 1105:     function convUmlauts($str)
  87  * 1118:     function testInt($var)
  88  * 1130:     function isFirstPartOfStr($str,$partStr)
  89  * 1146:     function formatSize($sizeInBytes,$labels='')
  90  * 1181:     function convertMicrotime($microtime)
  91  * 1195:     function splitCalc($string,$operators)
  92  * 1217:     function calcPriority($string)
  93  * 1258:     function calcParenthesis($string)
  94  * 1284:     function htmlspecialchars_decode($value)
  95  * 1299:     function deHSCentities($str)
  96  * 1312:     function slashJS($string,$extended=0,$char="'")
  97  * 1325:     function rawUrlEncodeJS($str)
  98  * 1337:     function rawUrlEncodeFP($str)
  99  * 1348:     function validEmail($email)
 100  * 1363:     function formatForTextarea($content)
 101  *
 102  *              SECTION: ARRAY FUNCTIONS
 103  * 1394:     function inArray($in_array,$item)
 104  * 1411:     function intExplode($delim, $string)
 105  * 1430:     function revExplode($delim, $string, $count=0)
 106  * 1450:     function trimExplode($delim, $string, $onlyNonEmptyValues=0)
 107  * 1472:     function uniqueArray($valueArray)
 108  * 1484:     function removeArrayEntryByValue($array,$cmpValue)
 109  * 1513:     function implodeArrayForUrl($name,$theArray,$str='',$skipBlank=0,$rawurlencodeParamName=0)
 110  * 1538:     function explodeUrl2Array($string,$multidim=FALSE)
 111  * 1564:     function compileSelectedGetVarsFromArray($varList,$getArray,$GPvarAlt=1)
 112  * 1587:     function addSlashesOnArray(&$theArray)
 113  * 1611:     function stripSlashesOnArray(&$theArray)
 114  * 1633:     function slashArray($arr,$cmd)
 115  * 1650:     function array_merge_recursive_overrule($arr0,$arr1,$notAddKeys=0,$includeEmtpyValues=true)
 116  * 1683:     function array_merge($arr1,$arr2)
 117  * 1696:     function csvValues($row,$delim=',',$quote='"')
 118  *
 119  *              SECTION: HTML/XML PROCESSING
 120  * 1738:     function get_tag_attributes($tag)
 121  * 1775:     function split_tag_attributes($tag)
 122  * 1809:     function implodeAttributes($arr,$xhtmlSafe=FALSE,$dontOmitBlankAttribs=FALSE)
 123  * 1836:     function implodeParams($arr,$xhtmlSafe=FALSE,$dontOmitBlankAttribs=FALSE)
 124  * 1851:     function wrapJS($string, $linebreak=TRUE)
 125  * 1882:     function xml2tree($string,$depth=999)
 126  * 1969:     function array2xml($array,$NSprefix='',$level=0,$docTag='phparray',$spaceInd=0, $options=array(),$stackData=array())
 127  * 2088:     function xml2array($string,$NSprefix='',$reportDocTag=FALSE)
 128  * 2198:     function xmlRecompileFromStructValArray($vals)
 129  * 2242:     function xmlGetHeaderAttribs($xmlData)
 130  *
 131  *              SECTION: FILES FUNCTIONS
 132  * 2275:     function getURL($url, $includeHeader=0)
 133  * 2342:     function writeFile($file,$content)
 134  * 2367:     function fixPermissions($file)
 135  * 2384:     function writeFileToTypo3tempDir($filepath,$content)
 136  * 2427:     function mkdir($theNewFolder)
 137  * 2446:     function mkdir_deep($destination,$deepDir)
 138  * 2468:     function get_dirs($path)
 139  * 2493:     function getFilesInDir($path,$extensionList='',$prependPath=0,$order='')
 140  * 2547:     function getAllFilesAndFoldersInPath($fileArr,$path,$extList='',$regDirs=0,$recursivityLevels=99)
 141  * 2570:     function removePrefixPathFromList($fileArr,$prefixToRemove)
 142  * 2586:     function fixWindowsFilePath($theFile)
 143  * 2598:     function resolveBackPath($pathStr)
 144  * 2626:     function locationHeaderUrl($path)
 145  *
 146  *              SECTION: DEBUG helper FUNCTIONS
 147  * 2666:     function debug_ordvalue($string,$characters=100)
 148  * 2683:     function view_array($array_in)
 149  * 2711:     function print_array($array_in)
 150  * 2726:     function debug($var="",$brOrHeader=0)
 151  * 2757:     function debug_trail()
 152  * 2779:     function debugRows($rows,$header='')
 153  *
 154  *              SECTION: SYSTEM INFORMATION
 155  * 2857:     function getThisUrl()
 156  * 2873:     function linkThisScript($getParams=array())
 157  * 2897:     function linkThisUrl($url,$getParams=array())
 158  * 2920:     function getIndpEnv($getEnvName)
 159  * 3113:     function milliseconds()
 160  * 3125:     function clientInfo($useragent='')
 161  *
 162  *              SECTION: TYPO3 SPECIFIC FUNCTIONS
 163  * 3212:     function getFileAbsFileName($filename,$onlyRelative=1,$relToTYPO3_mainDir=0)
 164  * 3248:     function validPathStr($theFile)
 165  * 3259:     function isAbsPath($path)
 166  * 3270:     function isAllowedAbsPath($path)
 167  * 3287:     function verifyFilenameAgainstDenyPattern($filename)
 168  * 3305:     function upload_copy_move($source,$destination)
 169  * 3331:     function upload_to_tempfile($uploadedFileName)
 170  * 3349:     function unlink_tempfile($uploadedTempFileName)
 171  * 3365:     function tempnam($filePrefix)
 172  * 3379:     function stdAuthCode($uid_or_record,$fields='',$codeLength=8)
 173  * 3410:     function cHashParams($addQueryParams)
 174  * 3433:     function hideIfNotTranslated($l18n_cfg_fieldValue)
 175  * 3448:     function readLLfile($fileRef,$langKey)
 176  * 3472:     function readLLXMLfile($fileRef,$langKey)
 177  * 3589:     function llXmlAutoFileName($fileRef,$language)
 178  * 3633:     function loadTCA($table)
 179  * 3653:     function resolveSheetDefInDS($dataStructArray,$sheet='sDEF')
 180  * 3686:     function resolveAllSheetsInDS($dataStructArray)
 181  * 3715:     function callUserFunction($funcName,&$params,&$ref,$checkPrefix='user_',$silent=0)
 182  * 3813:     function &getUserObj($classRef,$checkPrefix='user_',$silent=0)
 183  * 3871:     function &makeInstance($className)
 184  * 3883:     function makeInstanceClassName($className)
 185  * 3897:     function &makeInstanceService($serviceType, $serviceSubType='', $excludeServiceKeys=array())
 186  * 3961:     function plainMailEncoded($email,$subject,$message,$headers='',$enc='',$charset='',$dontEncodeHeader=false)
 187  * 4031:     function quoted_printable($string,$maxlen=76)
 188  * 4078:     function encodeHeader($line,$enc='',$charset='ISO-8859-1')
 189  * 4121:     function substUrlsInPlainText($message,$urlmode='76',$index_script_url='')
 190  * 4155:     function makeRedirectUrl($inUrl,$l=0,$index_script_url='')
 191  * 4182:     function freetypeDpiComp($font_size)
 192  * 4194:     function initSysLog()
 193  * 4251:     function sysLog($msg, $extKey, $severity=0)
 194  * 4334:     function devLog($msg, $extKey, $severity=0, $dataVar=FALSE)
 195  * 4355:     function arrayToLogString($arr, $valueList=array(), $valueLength=20)
 196  * 4378:     function imageMagickCommand($command, $parameters, $path='')
 197  * 4425:     function unQuoteFilenames($parameters,$unQuote=FALSE)
 198  * 4459:     function quoteJSvalue($value, $inScriptTags = false)
 199  *
 200  * TOTAL FUNCTIONS: 138
 201  * (This index is automatically created/updated by the extension "extdeveval")
 202  *
 203  */
 204
 205         // a tabulator
 206 define('TAB', chr(9));
 207         // a linefeed
 208 define('LF', chr(10));
 209         // a carriage return
 210 define('CR', chr(13));
 211         // a CR-LF combination
 212 define('CRLF', CR . LF);
 213
 214 /**
 215  * The legendary "t3lib_div" class - Miscellaneous functions for general purpose.
 216  * Most of the functions does not relate specifically to TYPO3
 217  * However a section of functions requires certain TYPO3 features available
 218  * See comments in the source.
 219  * You are encouraged to use this library in your own scripts!
 220  *
 221  * USE:
 222  * The class is intended to be used without creating an instance of it.
 223  * So: Don't instantiate - call functions with "t3lib_div::" prefixed the function name.
 224  * So use t3lib_div::[method-name] to refer to the functions, eg. 't3lib_div::milliseconds()'
 225  *
 226  * @author      Kasper Skaarhoj <kasperYYYY@typo3.com>
 227  * @package TYPO3
 228  * @subpackage t3lib
 229  */
 230 final class t3lib_div {
 231
 232                 // Severity constants used by t3lib_div::sysLog()
 233         const SYSLOG_SEVERITY_INFO = 0;
 234         const SYSLOG_SEVERITY_NOTICE = 1;
 235         const SYSLOG_SEVERITY_WARNING = 2;
 236         const SYSLOG_SEVERITY_ERROR = 3;
 237         const SYSLOG_SEVERITY_FATAL = 4;
 238
 239
 240         /*************************
 241          *
 242          * GET/POST Variables
 243          *
 244          * Background:
 245          * Input GET/POST variables in PHP may have their quotes escaped with "\" or not depending on configuration.
 246          * TYPO3 has always converted quotes to BE escaped if the configuration told that they would not be so.
 247          * But the clean solution is that quotes are never escaped and that is what the functions below offers.
 248          * Eventually TYPO3 should provide this in the global space as well.
 249          * In the transitional phase (or forever..?) we need to encourage EVERY to read and write GET/POST vars through the API functions below.
 250          *
 251          *************************/
 252
 253         /**
 254          * Returns the 'GLOBAL' value of incoming data from POST or GET, with priority to POST (that is equalent to 'GP' order)
 255          * Strips slashes from all output, both strings and arrays.
 256          * This function substitutes t3lib_div::GPvar()
 257          * 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!
 258          * Usage: 537
 259          *
 260          * @param       string          GET/POST var to return
 261          * @return      mixed           POST var named $var and if not set, the GET var of the same name.
 262          */
 263         public static function _GP($var)        {
 264                 if(empty($var)) return;
 265                 $value = isset($_POST[$var]) ? $_POST[$var] : $_GET[$var];
 266                 if (isset($value))      {
 267                         if (is_array($value))   { self::stripSlashesOnArray($value); } else { $value = stripslashes($value); }
 268                 }
 269                 return $value;
 270         }
 271
 272         /**
 273          * Returns the global arrays $_GET and $_POST merged with $_POST taking precedence.
 274          *
 275          * @param       string          Key (variable name) from GET or POST vars
 276          * @return      array           Returns the GET vars merged recursively onto the POST vars.
 277          */
 278         public static function _GPmerged($parameter) {
 279                 $postParameter = (isset($_POST[$parameter]) && is_array($_POST[$parameter])) ? $_POST[$parameter] : array();
 280                 $getParameter  = (isset($_GET[$parameter]) && is_array($_GET[$parameter])) ? $_GET[$parameter] : array();
 281
 282                 $mergedParameters = self::array_merge_recursive_overrule($getParameter, $postParameter);
 283                 self::stripSlashesOnArray($mergedParameters);
 284
 285                 return $mergedParameters;
 286         }
 287
 288         /**
 289          * Returns the global $_GET array (or value from) normalized to contain un-escaped values.
 290          * ALWAYS use this API function to acquire the GET variables!
 291          * Usage: 27
 292          *
 293          * @param       string          Optional pointer to value in GET array (basically name of GET var)
 294          * @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!*
 295          * @see _POST(), _GP(), _GETset()
 296          */
 297         public static function _GET($var=NULL)  {
 298                 $value = ($var === NULL) ? $_GET : (empty($var) ? NULL : $_GET[$var]);
 299                 if (isset($value))      {       // Removes slashes since TYPO3 has added them regardless of magic_quotes setting.
 300                         if (is_array($value))   { self::stripSlashesOnArray($value); } else { $value = stripslashes($value); }
 301                 }
 302                 return $value;
 303         }
 304
 305         /**
 306          * Returns the global $_POST array (or value from) normalized to contain un-escaped values.
 307          * ALWAYS use this API function to acquire the $_POST variables!
 308          * Usage: 41
 309          *
 310          * @param       string          Optional pointer to value in POST array (basically name of POST var)
 311          * @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!*
 312          * @see _GET(), _GP()
 313          */
 314         public static function _POST($var=NULL) {
 315                 $value = ($var === NULL) ? $_POST : (empty($var) ? NULL : $_POST[$var]);
 316                 if (isset($value))      {       // Removes slashes since TYPO3 has added them regardless of magic_quotes setting.
 317                         if (is_array($value))   { self::stripSlashesOnArray($value); } else { $value = stripslashes($value); }
 318                 }
 319                 return $value;
 320         }
 321
 322         /**
 323          * Writes input value to $_GET.
 324          * Usage: 2
 325          *
 326          * @param mixed $inputGet
 327          *        array or single value to write to $_GET. Values should NOT be
 328          *        escaped at input time (but will be escaped before writing
 329          *        according to TYPO3 standards).
 330          * @param string $key
 331          *        alternative key; If set, this will not set the WHOLE GET array,
 332          *        but only the key in it specified by this value!
 333          *        You can specify to replace keys on deeper array levels by
 334          *        separating the keys with a pipe.
 335          *        Example: 'parentKey|childKey' will result in
 336          *        array('parentKey' => array('childKey' => $inputGet))
 337          *
 338          * @return      void
 339          */
 340         public static function _GETset($inputGet, $key = '') {
 341                         // adds slashes since TYPO3 standard currently is that slashes
 342                         // must be applied (regardless of magic_quotes setting)
 343                 if (is_array($inputGet)) {
 344                         self::addSlashesOnArray($inputGet);
 345                 } else {
 346                         $inputGet = addslashes($inputGet);
 347                 }
 348
 349                 if ($key != '') {
 350                         if (strpos($key, '|') !== FALSE) {
 351                                 $pieces = explode('|', $key);
 352                                 $newGet = array();
 353                                 $pointer =& $newGet;
 354                                 foreach ($pieces as $piece) {
 355                                         $pointer =& $pointer[$piece];
 356                                 }
 357                                 $pointer = $inputGet;
 358                                 $mergedGet = self::array_merge_recursive_overrule(
 359                                         $_GET, $newGet
 360                                 );
 361
 362                                 $_GET = $mergedGet;
 363                                 $GLOBALS['HTTP_GET_VARS'] = $mergedGet;
 364                         } else {
 365                                 $_GET[$key] = $inputGet;
 366                                 $GLOBALS['HTTP_GET_VARS'][$key] = $inputGet;
 367                         }
 368                 } elseif (is_array($inputGet)) {
 369                         $_GET = $inputGet;
 370                         $GLOBALS['HTTP_GET_VARS'] = $inputGet;
 371                 }
 372         }
 373
 374         /**
 375          * Returns the  value of incoming data from globals variable $_POST or $_GET, with priority to $_POST (that is equalent to 'GP' order).
 376          * Strips slashes of string-outputs, but not arrays UNLESS $strip is set. If $strip is set all output will have escaped characters unescaped.
 377          * Usage: 2
 378          *
 379          * @param       string          GET/POST var to return
 380          * @param       boolean         If set, values are stripped of return values that are *arrays!* - string/integer values returned are always strip-slashed()
 381          * @return      mixed           POST var named $var and if not set, the GET var of the same name.
 382          * @deprecated since TYPO3 3.6 - Use t3lib_div::_GP instead (ALWAYS delivers a value with un-escaped values!)
 383          * @see _GP()
 384          */
 385         public static function GPvar($var,$strip=0)     {
 386                 self::logDeprecatedFunction();
 387
 388                 if(empty($var)) return;
 389                 $value = isset($_POST[$var]) ? $_POST[$var] : $_GET[$var];
 390                 if (isset($value) && is_string($value)) { $value = stripslashes($value); }      // Originally check '&& get_magic_quotes_gpc() ' but the values of $_GET are always slashed regardless of get_magic_quotes_gpc() because HTTP_POST/GET_VARS are run through addSlashesOnArray in the very beginning of index_ts.php eg.
 391                 if ($strip && isset($value) && is_array($value)) { self::stripSlashesOnArray($value); }
 392                 return $value;
 393         }
 394
 395         /**
 396          * Returns the global arrays $_GET and $_POST merged with $_POST taking precedence.
 397          * Usage: 1
 398          *
 399          * @param       string          Key (variable name) from GET or POST vars
 400          * @return      array           Returns the GET vars merged recursively onto the POST vars.
 401          * @deprecated since TYPO3 3.7 - Use t3lib_div::_GPmerged instead
 402          * @see _GP()
 403          */
 404         public static function GParrayMerged($var)      {
 405                 self::logDeprecatedFunction();
 406
 407                 return self::_GPmerged($var);
 408         }
 409
 410         /**
 411          * Wrapper for the RemoveXSS function.
 412          * Removes potential XSS code from an input string.
 413          *
 414          * Using an external class by Travis Puderbaugh <kallahar@quickwired.com>
 415          *
 416          * @param       string          Input string
 417          * @return      string          Input string with potential XSS code removed
 418          */
 419         public static function removeXSS($string)       {
 420                 require_once(PATH_typo3.'contrib/RemoveXSS/RemoveXSS.php');
 421                 $string = RemoveXSS::process($string);
 422                 return $string;
 423         }
 424
 425
 426
 427
 428
 429
 430
 431
 432
 433
 434         /*************************
 435          *
 436          * IMAGE FUNCTIONS
 437          *
 438          *************************/
 439
 440
 441         /**
 442          * Compressing a GIF file if not already LZW compressed.
 443          * 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)
 444          *
 445          *              The function takes a file-reference, $theFile, and saves it again through GD or ImageMagick in order to compress the file
 446          *              GIF:
 447          *              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!)
 448          *              If $type is set to either 'IM' or 'GD' the compression is done with ImageMagick and GD respectively
 449          *              PNG:
 450          *              No changes.
 451          *
 452          *              $theFile is expected to be a valid GIF-file!
 453          *              The function returns a code for the operation.
 454          * Usage: 9
 455          *
 456          * @param       string          Filepath
 457          * @param       string          See description of function
 458          * @return      string          Returns "GD" if GD was used, otherwise "IM" if ImageMagick was used. If nothing done at all, it returns empty string.
 459          */
 460         public static function gif_compress($theFile, $type)    {
 461                 $gfxConf = $GLOBALS['TYPO3_CONF_VARS']['GFX'];
 462                 $returnCode='';
 463                 if ($gfxConf['gif_compress'] && strtolower(substr($theFile,-4,4))=='.gif')      {       // GIF...
 464                         if (($type=='IM' || !$type) && $gfxConf['im'] && $gfxConf['im_path_lzw'])       {       // IM
 465                                 $cmd = self::imageMagickCommand('convert', '"'.$theFile.'" "'.$theFile.'"', $gfxConf['im_path_lzw']);
 466                                 exec($cmd);
 467
 468                                 $returnCode='IM';
 469                         } elseif (($type=='GD' || !$type) && $gfxConf['gdlib'] && !$gfxConf['gdlib_png'])       {       // GD
 470                                 $tempImage = imageCreateFromGif($theFile);
 471                                 imageGif($tempImage, $theFile);
 472                                 imageDestroy($tempImage);
 473                                 $returnCode='GD';
 474                         }
 475                 }
 476                 return $returnCode;
 477         }
 478
 479         /**
 480          * Converts a png file to gif.
 481          * This converts a png file to gif IF the FLAG $GLOBALS['TYPO3_CONF_VARS']['FE']['png_to_gif'] is set true.
 482          * Usage: 5
 483          *
 484          * @param       string          $theFile        the filename with path
 485          * @return      string          new filename
 486          */
 487         public static function png_to_gif_by_imagemagick($theFile)      {
 488                 if ($GLOBALS['TYPO3_CONF_VARS']['FE']['png_to_gif']
 489                         && $GLOBALS['TYPO3_CONF_VARS']['GFX']['im']
 490                         && $GLOBALS['TYPO3_CONF_VARS']['GFX']['im_path_lzw']
 491                         && strtolower(substr($theFile,-4,4))=='.png'
 492                         && @is_file($theFile))  {       // IM
 493                                 $newFile = substr($theFile,0,-4).'.gif';
 494                                 $cmd = self::imageMagickCommand('convert', '"'.$theFile.'" "'.$newFile.'"', $GLOBALS['TYPO3_CONF_VARS']['GFX']['im_path_lzw']);
 495                                 exec($cmd);
 496                                 $theFile = $newFile;
 497                                         // unlink old file?? May be bad idea bacause TYPO3 would then recreate the file every time as TYPO3 thinks the file is not generated because it's missing!! So do not unlink $theFile here!!
 498                 }
 499                 return $theFile;
 500         }
 501
 502         /**
 503          * Returns filename of the png/gif version of the input file (which can be png or gif).
 504          * If input file type does not match the wanted output type a conversion is made and temp-filename returned.
 505          * Usage: 2
 506          *
 507          * @param       string          Filepath of image file
 508          * @param       boolean         If set, then input file is converted to PNG, otherwise to GIF
 509          * @return      string          If the new image file exists, it's filepath is returned
 510          */
 511         public static function read_png_gif($theFile,$output_png=0)     {
 512                 if ($GLOBALS['TYPO3_CONF_VARS']['GFX']['im'] && @is_file($theFile))     {
 513                         $ext = strtolower(substr($theFile,-4,4));
 514                         if (
 515                                         ((string)$ext=='.png' && $output_png)   ||
 516                                         ((string)$ext=='.gif' && !$output_png)
 517                                 )       {
 518                                 return $theFile;
 519                         } else {
 520                                 $newFile = PATH_site.'typo3temp/readPG_'.md5($theFile.'|'.filemtime($theFile)).($output_png?'.png':'.gif');
 521                                 $cmd = self::imageMagickCommand('convert', '"'.$theFile.'" "'.$newFile.'"', $GLOBALS['TYPO3_CONF_VARS']['GFX']['im_path']);
 522                                 exec($cmd);
 523                                 if (@is_file($newFile)) return $newFile;
 524                         }
 525                 }
 526         }
 527
 528
 529
 530
 531
 532
 533
 534
 535
 536
 537
 538
 539
 540
 541
 542         /*************************
 543          *
 544          * STRING FUNCTIONS
 545          *
 546          *************************/
 547
 548         /**
 549          * Truncates string.
 550          * Returns a new string of max. $chars length.
 551          * If the string is longer, it will be truncated and appended with '...'.
 552          * Usage: 39
 553          *
 554          * @param       string          string to truncate
 555          * @param       integer         must be an integer with an absolute value of at least 4. if negative the string is cropped from the right end.
 556          * @param       string          String to append to the output if it is truncated, default is '...'
 557          * @return      string          new string
 558          * @deprecated since TYPO3 4.1 - Works ONLY for single-byte charsets! Use t3lib_div::fixed_lgd_cs() instead
 559          * @see fixed_lgd_pre()
 560          */
 561         public static function fixed_lgd($string,$origChars,$preStr='...')      {
 562                 self::logDeprecatedFunction();
 563
 564                 $chars = abs($origChars);
 565                 if ($chars >= 4)        {
 566                         if(strlen($string)>$chars)  {
 567                                 return $origChars < 0 ?
 568                                         $preStr.trim(substr($string, -($chars-3))) :
 569                                         trim(substr($string, 0, $chars-3)).$preStr;
 570                         }
 571                 }
 572                 return $string;
 573         }
 574
 575         /**
 576          * Truncates string.
 577          * Returns a new string of max. $chars length.
 578          * If the string is longer, it will be truncated and prepended with '...'.
 579          * This works like fixed_lgd(), but is truncated in the start of the string instead of the end
 580          * Usage: 6
 581          *
 582          * @param       string          string to truncate
 583          * @param       integer         must be an integer of at least 4
 584          * @return      string          new string
 585          * @deprecated since TYPO3 4.1 - Use either fixed_lgd() or fixed_lgd_cs() (with negative input value for $chars)
 586          * @see fixed_lgd()
 587          */
 588         public static function fixed_lgd_pre($string,$chars)    {
 589                 self::logDeprecatedFunction();
 590
 591                 return strrev(self::fixed_lgd(strrev($string),$chars));
 592         }
 593
 594         /**
 595          * Truncates a string with appended/prepended "..." and takes current character set into consideration.
 596          * Usage: 75
 597          *
 598          * @param       string          string to truncate
 599          * @param       integer         must be an integer with an absolute value of at least 4. if negative the string is cropped from the right end.
 600          * @param       string          appendix to the truncated string
 601          * @return      string          cropped string
 602          */
 603         public static function fixed_lgd_cs($string, $chars, $appendString='...') {
 604                 if (is_object($GLOBALS['LANG'])) {
 605                         return $GLOBALS['LANG']->csConvObj->crop($GLOBALS['LANG']->charSet, $string, $chars, $appendString);
 606                 } elseif (is_object($GLOBALS['TSFE'])) {
 607                         $charSet = ($GLOBALS['TSFE']->renderCharset != '' ? $GLOBALS['TSFE']->renderCharset : $GLOBALS['TSFE']->defaultCharSet);
 608                         return $GLOBALS['TSFE']->csConvObj->crop($charSet, $string, $chars, $appendString);
 609                 } else {
 610                                 // this case should not happen
 611                         $csConvObj = self::makeInstance('t3lib_cs');
 612                         return $csConvObj->crop('iso-8859-1', $string, $chars, $appendString);
 613                 }
 614         }
 615
 616         /**
 617          * Breaks up the text for emails
 618          * Usage: 1
 619          *
 620          * @param       string          The string to break up
 621          * @param       string          The string to implode the broken lines with (default/typically \n)
 622          * @param       integer         The line length
 623          * @deprecated since TYPO3 4.1 - Use PHP function wordwrap()
 624          * @return      string
 625          */
 626         public static function breakTextForEmail($str,$implChar=LF,$charWidth=76)       {
 627                 self::logDeprecatedFunction();
 628
 629                 $lines = explode(LF,$str);
 630                 $outArr=array();
 631                 foreach ($lines as $lStr) {
 632                         $outArr[] = self::breakLinesForEmail($lStr,$implChar,$charWidth);
 633                 }
 634                 return implode(LF,$outArr);
 635         }
 636
 637         /**
 638          * Breaks up a single line of text for emails
 639          * Usage: 5
 640          *
 641          * @param       string          The string to break up
 642          * @param       string          The string to implode the broken lines with (default/typically \n)
 643          * @param       integer         The line length
 644          * @return      string
 645          * @see breakTextForEmail()
 646          */
 647         public static function breakLinesForEmail($str,$implChar=LF,$charWidth=76)      {
 648                 $lines=array();
 649                 $l=$charWidth;
 650                 $p=0;
 651                 while(strlen($str)>$p)  {
 652                         $substr=substr($str,$p,$l);
 653                         if (strlen($substr)==$l)        {
 654                                 $count = count(explode(' ',trim(strrev($substr))));
 655                                 if ($count>1)   {       // OK...
 656                                         $parts = explode(' ',strrev($substr),2);
 657                                         $theLine = strrev($parts[1]);
 658                                 } else {
 659                                         $afterParts = explode(' ',substr($str,$l+$p),2);
 660                                         $theLine = $substr.$afterParts[0];
 661                                 }
 662                                 if (!strlen($theLine))  {break; }       // Error, because this would keep us in an endless loop.
 663                         } else {
 664                                 $theLine=$substr;
 665                         }
 666
 667                         $lines[]=trim($theLine);
 668                         $p+=strlen($theLine);
 669                         if (!trim(substr($str,$p,$l)))  break;  // added...
 670                 }
 671                 return implode($implChar,$lines);
 672         }
 673
 674         /**
 675          * Match IP number with list of numbers with wildcard
 676          * Dispatcher method for switching into specialised IPv4 and IPv6 methods.
 677          * Usage: 10
 678          *
 679          * @param       string          $baseIP is the current remote IP address for instance, typ. REMOTE_ADDR
 680          * @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.
 681          * @return      boolean         True if an IP-mask from $list matches $baseIP
 682          */
 683         public static function cmpIP($baseIP, $list)    {
 684                 $list = trim($list);
 685                 if ($list === '')       {
 686                         return false;
 687                 } elseif ($list === '*')        {
 688                         return true;
 689                 }
 690                 if (strpos($baseIP, ':') !== false && self::validIPv6($baseIP)) {
 691                         return self::cmpIPv6($baseIP, $list);
 692                 } else {
 693                         return self::cmpIPv4($baseIP, $list);
 694                 }
 695         }
 696
 697         /**
 698          * Match IPv4 number with list of numbers with wildcard
 699          *
 700          * @param       string          $baseIP is the current remote IP address for instance, typ. REMOTE_ADDR
 701          * @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)
 702          * @return      boolean         True if an IP-mask from $list matches $baseIP
 703          */
 704         public static function cmpIPv4($baseIP, $list)  {
 705                 $IPpartsReq = explode('.',$baseIP);
 706                 if (count($IPpartsReq)==4)      {
 707                         $values = self::trimExplode(',',$list,1);
 708
 709                         foreach($values as $test)       {
 710                                 list($test,$mask) = explode('/',$test);
 711
 712                                 if(intval($mask)) {
 713                                                 // "192.168.3.0/24"
 714                                         $lnet = ip2long($test);
 715                                         $lip = ip2long($baseIP);
 716                                         $binnet = str_pad( decbin($lnet),32,'0','STR_PAD_LEFT');
 717                                         $firstpart = substr($binnet,0,$mask);
 718                                         $binip = str_pad( decbin($lip),32,'0','STR_PAD_LEFT');
 719                                         $firstip = substr($binip,0,$mask);
 720                                         $yes = (strcmp($firstpart,$firstip)==0);
 721                                 } else {
 722                                                 // "192.168.*.*"
 723                                         $IPparts = explode('.',$test);
 724                                         $yes = 1;
 725                                         foreach ($IPparts as $index => $val) {
 726                                                 $val = trim($val);
 727                                                 if (strcmp($val,'*') && strcmp($IPpartsReq[$index],$val))       {
 728                                                         $yes=0;
 729                                                 }
 730                                         }
 731                                 }
 732                                 if ($yes) return true;
 733                         }
 734                 }
 735                 return false;
 736         }
 737
 738         /**
 739          * Match IPv6 address with a list of IPv6 prefixes
 740          *
 741          * @param       string          $baseIP is the current remote IP address for instance
 742          * @param       string          $list is a comma-list of IPv6 prefixes, could also contain IPv4 addresses
 743          * @return      boolean         True if an baseIP matches any prefix
 744          */
 745         public static function cmpIPv6($baseIP, $list)  {
 746                 $success = false;       // Policy default: Deny connection
 747                 $baseIP = self::normalizeIPv6($baseIP);
 748
 749                 $values = self::trimExplode(',',$list,1);
 750                 foreach ($values as $test)      {
 751                         list($test,$mask) = explode('/',$test);
 752                         if (self::validIPv6($test))     {
 753                                 $test = self::normalizeIPv6($test);
 754                                 if (intval($mask))      {
 755                                         switch ($mask) {        // test on /48 /64
 756                                                 case '48':
 757                                                         $testBin = substr(self::IPv6Hex2Bin($test), 0, 48);
 758                                                         $baseIPBin = substr(self::IPv6Hex2Bin($baseIP), 0, 48);
 759                                                         $success = strcmp($testBin, $baseIPBin)==0 ? true : false;
 760                                                 break;
 761                                                 case '64':
 762                                                         $testBin = substr(self::IPv6Hex2Bin($test), 0, 64);
 763                                                         $baseIPBin = substr(self::IPv6Hex2Bin($baseIP), 0, 64);
 764                                                         $success = strcmp($testBin, $baseIPBin)==0 ? true : false;
 765                                                 break;
 766                                                 default:
 767                                                         $success = false;
 768                                         }
 769                                 } else {
 770                                         if (self::validIPv6($test))     {       // test on full ip address 128 bits
 771                                                 $testBin = self::IPv6Hex2Bin($test);
 772                                                 $baseIPBin = self::IPv6Hex2Bin($baseIP);
 773                                                 $success = strcmp($testBin, $baseIPBin)==0 ? true : false;
 774                                         }
 775                                 }
 776                         }
 777                         if ($success) return true;
 778                 }
 779                 return false;
 780         }
 781
 782         /**
 783          * [Describe function...]
 784          *
 785          * @param       [type]          $hex: ...
 786          * @return      [type]          ...
 787          */
 788         public static function IPv6Hex2Bin ($hex)       {
 789                 $bin = '';
 790                 $hex = str_replace(':', '', $hex);      // Replace colon to nothing
 791                 for ($i=0; $i<strlen($hex); $i=$i+2)    {
 792                         $bin.= chr(hexdec(substr($hex, $i, 2)));
 793                 }
 794                 return $bin;
 795         }
 796
 797         /**
 798          * Normalize an IPv6 address to full length
 799          *
 800          * @param       string          Given IPv6 address
 801          * @return      string          Normalized address
 802          */
 803         public static function normalizeIPv6($address)  {
 804                 $normalizedAddress = '';
 805                 $stageOneAddress = '';
 806
 807                 $chunks = explode('::', $address);      // Count 2 if if address has hidden zero blocks
 808                 if (count($chunks)==2)  {
 809                         $chunksLeft = explode(':', $chunks[0]);
 810                         $chunksRight = explode(':', $chunks[1]);
 811                         $left = count($chunksLeft);
 812                         $right = count($chunksRight);
 813
 814                                 // Special case: leading zero-only blocks count to 1, should be 0
 815                         if ($left==1 && strlen($chunksLeft[0])==0)      $left=0;
 816
 817                         $hiddenBlocks = 8 - ($left + $right);
 818                         $hiddenPart = '';
 819                         while ($h<$hiddenBlocks)        {
 820                                 $hiddenPart .= '0000:';
 821                                 $h++;
 822                         }
 823
 824                         if ($left == 0) {
 825                                 $stageOneAddress = $hiddenPart . $chunks[1];
 826                         } else {
 827                                 $stageOneAddress = $chunks[0] . ':' . $hiddenPart . $chunks[1];
 828                         }
 829                 } else $stageOneAddress = $address;
 830
 831                         // normalize the blocks:
 832                 $blocks = explode(':', $stageOneAddress);
 833                 $divCounter = 0;
 834                 foreach ($blocks as $block)     {
 835                         $tmpBlock = '';
 836                         $i = 0;
 837                         $hiddenZeros = 4 - strlen($block);
 838                         while ($i < $hiddenZeros)       {
 839                                 $tmpBlock .= '0';
 840                                 $i++;
 841                         }
 842                         $normalizedAddress .= $tmpBlock . $block;
 843                         if ($divCounter < 7)    {
 844                                 $normalizedAddress .= ':';
 845                                 $divCounter++;
 846                         }
 847                 }
 848                 return $normalizedAddress;
 849         }
 850
 851         /**
 852          * Validate a given IP address.
 853          *
 854          * Possible format are IPv4 and IPv6.
 855          *
 856          * @param       string          IP address to be tested
 857          * @return      boolean         True if $ip is either of IPv4 or IPv6 format.
 858          */
 859         public static function validIP($ip) {
 860                 return (filter_var($ip, FILTER_VALIDATE_IP) !== false);
 861         }
 862
 863         /**
 864          * Validate a given IP address to the IPv4 address format.
 865          *
 866          * Example for possible format:  10.0.45.99
 867          *
 868          * @param       string          IP address to be tested
 869          * @return      boolean         True if $ip is of IPv4 format.
 870          */
 871         public static function validIPv4($ip) {
 872                 return (filter_var($ip, FILTER_VALIDATE_IP, FILTER_FLAG_IPV4) !== false);
 873         }
 874
 875         /**
 876          * Validate a given IP address to the IPv6 address format.
 877          *
 878          * Example for possible format:  43FB::BB3F:A0A0:0 | ::1
 879          *
 880          * @param       string          IP address to be tested
 881          * @return      boolean         True if $ip is of IPv6 format.
 882          */
 883         public static function validIPv6($ip)   {
 884                 return (filter_var($ip, FILTER_VALIDATE_IP, FILTER_FLAG_IPV6) !== false);
 885         }
 886
 887         /**
 888          * Match fully qualified domain name with list of strings with wildcard
 889          *
 890          * @param       string          The current remote IP address for instance, typ. REMOTE_ADDR
 891          * @param       string          A comma-list of domain names to match with. *-wildcard allowed but cannot be part of a string, so it must match the full host name (eg. myhost.*.com => correct, myhost.*domain.com => wrong)
 892          * @return      boolean         True if a domain name mask from $list matches $baseIP
 893          */
 894         public static function cmpFQDN($baseIP, $list)        {
 895                 if (count(explode('.',$baseIP))==4)     {
 896                         $resolvedHostName = explode('.', gethostbyaddr($baseIP));
 897                         $values = self::trimExplode(',',$list,1);
 898
 899                         foreach($values as $test)       {
 900                                 $hostNameParts = explode('.',$test);
 901                                 $yes = 1;
 902
 903                                 foreach($hostNameParts as $index => $val)       {
 904                                         $val = trim($val);
 905                                         if (strcmp($val,'*') && strcmp($resolvedHostName[$index],$val)) {
 906                                                 $yes=0;
 907                                         }
 908                                 }
 909                                 if ($yes) return true;
 910                         }
 911                 }
 912                 return false;
 913         }
 914
 915         /**
 916          * Checks if a given URL matches the host that currently handles this HTTP request.
 917          * Scheme, hostname and (optional) port of the given URL are compared.
 918          *
 919          * @param       string          $url: URL to compare with the TYPO3 request host
 920          * @return      boolean         Whether the URL matches the TYPO3 request host
 921          */
 922         public static function isOnCurrentHost($url) {
 923                 return (stripos($url . '/', self::getIndpEnv('TYPO3_REQUEST_HOST') . '/') === 0);
 924         }
 925
 926         /**
 927          * Check for item in list
 928          * Check if an item exists in a comma-separated list of items.
 929          * Usage: 163
 930          *
 931          * @param       string          comma-separated list of items (string)
 932          * @param       string          item to check for
 933          * @return      boolean         true if $item is in $list
 934          */
 935         public static function inList($list, $item)     {
 936                 return (strpos(','.$list.',', ','.$item.',')!==false ? true : false);
 937         }
 938
 939         /**
 940          * Removes an item from a comma-separated list of items.
 941          * Usage: 1
 942          *
 943          * @param       string          element to remove
 944          * @param       string          comma-separated list of items (string)
 945          * @return      string          new comma-separated list of items
 946          */
 947         public static function rmFromList($element,$list)       {
 948                 $items = explode(',',$list);
 949                 foreach ($items as $k => $v) {
 950                         if ($v==$element) {
 951                                 unset($items[$k]);
 952                         }
 953                 }
 954                 return implode(',',$items);
 955         }
 956
 957         /**
 958          * Expand a comma-separated list of integers with ranges (eg 1,3-5,7 becomes 1,3,4,5,7).
 959          * Ranges are limited to 1000 values per range.
 960          *
 961          * @param       string          comma-separated list of integers with ranges (string)
 962          * @return      string          new comma-separated list of items
 963          * @author      Martin Kutschker <martin.kutschker@activesolution.at>
 964          */
 965         public static function expandList($list)      {
 966                 $items = explode(',',$list);
 967                 $list = array();
 968                 foreach ($items as $item) {
 969                         $range = explode('-',$item);
 970                         if (isset($range[1]))   {
 971                                 $runAwayBrake = 1000;
 972                                 for ($n=$range[0]; $n<=$range[1]; $n++) {
 973                                         $list[] = $n;
 974
 975                                         $runAwayBrake--;
 976                                         if ($runAwayBrake<=0)   break;
 977                                 }
 978                         } else {
 979                                 $list[] = $item;
 980                         }
 981                 }
 982                 return implode(',',$list);
 983         }
 984
 985         /**
 986          * Forces the integer $theInt into the boundaries of $min and $max. If the $theInt is 'false' then the $zeroValue is applied.
 987          * Usage: 224
 988          *
 989          * @param       integer         Input value
 990          * @param       integer         Lower limit
 991          * @param       integer         Higher limit
 992          * @param       integer         Default value if input is false.
 993          * @return      integer         The input value forced into the boundaries of $min and $max
 994          */
 995         public static function intInRange($theInt,$min,$max=2000000000,$zeroValue=0)    {
 996                 // Returns $theInt as an integer in the integerspace from $min to $max
 997                 $theInt = intval($theInt);
 998                 if ($zeroValue && !$theInt)     {$theInt=$zeroValue;}   // If the input value is zero after being converted to integer, zeroValue may set another default value for it.
 999                 if ($theInt<$min){$theInt=$min;}
1000                 if ($theInt>$max){$theInt=$max;}
1001                 return $theInt;
1002         }
1003
1004         /**
1005          * Returns the $integer if greater than zero, otherwise returns zero.
1006          * Usage: 1
1007          *
1008          * @param       integer         Integer string to process
1009          * @return      integer
1010          */
1011         public static function intval_positive($theInt) {
1012                 $theInt = intval($theInt);
1013                 if ($theInt<0){$theInt=0;}
1014                 return $theInt;
1015         }
1016
1017         /**
1018          * Returns an integer from a three part version number, eg '4.12.3' -> 4012003
1019          * Usage: 2
1020          *
1021          * @param       string          Version number on format x.x.x
1022          * @return      integer         Integer version of version number (where each part can count to 999)
1023          */
1024         public static function int_from_ver($verNumberStr)      {
1025                 $verParts = explode('.',$verNumberStr);
1026                 return intval((int)$verParts[0].str_pad((int)$verParts[1],3,'0',STR_PAD_LEFT).str_pad((int)$verParts[2],3,'0',STR_PAD_LEFT));
1027         }
1028
1029         /**
1030          * Returns true if the current TYPO3 version (or compatibility version) is compatible to the input version
1031          * Notice that this function compares branches, not versions (4.0.1 would be > 4.0.0 although they use the same compat_version)
1032          *
1033          * @param       string          Minimum branch number required (format x.y / e.g. "4.0" NOT "4.0.0"!)
1034          * @return      boolean         Returns true if this setup is compatible with the provided version number
1035          * @todo        Still needs a function to convert versions to branches
1036          */
1037         public static function compat_version($verNumberStr)    {
1038                 global $TYPO3_CONF_VARS;
1039                 $currVersionStr = $TYPO3_CONF_VARS['SYS']['compat_version'] ? $TYPO3_CONF_VARS['SYS']['compat_version'] : TYPO3_branch;
1040
1041                 if (self::int_from_ver($currVersionStr) < self::int_from_ver($verNumberStr))    {
1042                         return FALSE;
1043                 } else {
1044                         return TRUE;
1045                 }
1046         }
1047
1048         /**
1049          * Makes a positive integer hash out of the first 7 chars from the md5 hash of the input
1050          * Usage: 5
1051          *
1052          * @param       string          String to md5-hash
1053          * @return      integer         Returns 28bit integer-hash
1054          */
1055         public static function md5int($str)     {
1056                 return hexdec(substr(md5($str),0,7));
1057         }
1058
1059         /**
1060          * Returns the first 10 positions of the MD5-hash               (changed from 6 to 10 recently)
1061          *
1062          * Usage: 37
1063          *
1064          * @param       string          Input string to be md5-hashed
1065          * @param       integer         The string-length of the output
1066          * @return      string          Substring of the resulting md5-hash, being $len chars long (from beginning)
1067          */
1068         public static function shortMD5($input, $len=10)        {
1069                 return substr(md5($input),0,$len);
1070         }
1071
1072         /**
1073          * Takes comma-separated lists and arrays and removes all duplicates
1074          * If a value in the list is trim(empty), the value is ignored.
1075          * Usage: 16
1076          *
1077          * @param       string          Accept multiple parameters wich can be comma-separated lists of values and arrays.
1078          * @param       mixed           $secondParameter: Dummy field, which if set will show a warning!
1079          * @return      string          Returns the list without any duplicates of values, space around values are trimmed
1080          */
1081         public static function uniqueList($in_list, $secondParameter=NULL)      {
1082                 if (is_array($in_list)) {
1083                         throw new InvalidArgumentException(
1084                                 'TYPO3 Fatal Error: t3lib_div::uniqueList() does NOT support array arguments anymore! Only string comma lists!',
1085                                 1270853885
1086                         );
1087                 }
1088                 if (isset($secondParameter)) {
1089                         throw new InvalidArgumentException(
1090                                 'TYPO3 Fatal Error: t3lib_div::uniqueList() does NOT support more than a single argument value anymore. You have specified more than one!',
1091                                 1270853886
1092                         );
1093                 }
1094
1095                 return implode(',',array_unique(self::trimExplode(',',$in_list,1)));
1096         }
1097
1098         /**
1099          * Splits a reference to a file in 5 parts
1100          * Usage: 43
1101          *
1102          * @param       string          Filename/filepath to be analysed
1103          * @return      array           Contains keys [path], [file], [filebody], [fileext], [realFileext]
1104          */
1105         public static function split_fileref($fileref)  {
1106                 $reg = array();
1107                 if (preg_match('/(.*\/)(.*)$/',$fileref,$reg)   )       {
1108                         $info['path'] = $reg[1];
1109                         $info['file'] = $reg[2];
1110                 } else {
1111                         $info['path'] = '';
1112                         $info['file'] = $fileref;
1113                 }
1114                 $reg='';
1115                 if (    preg_match('/(.*)\.([^\.]*$)/',$info['file'],$reg)      )       {
1116                         $info['filebody'] = $reg[1];
1117                         $info['fileext'] = strtolower($reg[2]);
1118                         $info['realFileext'] = $reg[2];
1119                 } else {
1120                         $info['filebody'] = $info['file'];
1121                         $info['fileext'] = '';
1122                 }
1123                 reset($info);
1124                 return $info;
1125         }
1126
1127         /**
1128          * Returns the directory part of a path without trailing slash
1129          * If there is no dir-part, then an empty string is returned.
1130          * Behaviour:
1131          *
1132          * '/dir1/dir2/script.php' => '/dir1/dir2'
1133          * '/dir1/' => '/dir1'
1134          * 'dir1/script.php' => 'dir1'
1135          * 'd/script.php' => 'd'
1136          * '/script.php' => ''
1137          * '' => ''
1138          * Usage: 5
1139          *
1140          * @param       string          Directory name / path
1141          * @return      string          Processed input value. See function description.
1142          */
1143         public static function dirname($path)   {
1144                 $p = self::revExplode('/',$path,2);
1145                 return count($p)==2 ? $p[0] : '';
1146         }
1147
1148         /**
1149          * Modifies a HTML Hex color by adding/subtracting $R,$G and $B integers
1150          * Usage: 11
1151          *
1152          * @param       string          A hexadecimal color code, #xxxxxx
1153          * @param       integer         Offset value 0-255
1154          * @param       integer         Offset value 0-255
1155          * @param       integer         Offset value 0-255
1156          * @return      string          A hexadecimal color code, #xxxxxx, modified according to input vars
1157          * @see modifyHTMLColorAll()
1158          */
1159         public static function modifyHTMLColor($color,$R,$G,$B) {
1160                 // This takes a hex-color (# included!) and adds $R, $G and $B to the HTML-color (format: #xxxxxx) and returns the new color
1161                 $nR = self::intInRange(hexdec(substr($color,1,2))+$R,0,255);
1162                 $nG = self::intInRange(hexdec(substr($color,3,2))+$G,0,255);
1163                 $nB = self::intInRange(hexdec(substr($color,5,2))+$B,0,255);
1164                 return '#'.
1165                         substr('0'.dechex($nR),-2).
1166                         substr('0'.dechex($nG),-2).
1167                         substr('0'.dechex($nB),-2);
1168         }
1169
1170         /**
1171          * Modifies a HTML Hex color by adding/subtracting $all integer from all R/G/B channels
1172          * Usage: 6
1173          *
1174          * @param       string          A hexadecimal color code, #xxxxxx
1175          * @param       integer         Offset value 0-255 for all three channels.
1176          * @return      string          A hexadecimal color code, #xxxxxx, modified according to input vars
1177          * @see modifyHTMLColor()
1178          */
1179         public static function modifyHTMLColorAll($color,$all)  {
1180                 return self::modifyHTMLColor($color,$all,$all,$all);
1181         }
1182
1183         /**
1184          * Removes comma (if present) in the end of string
1185          * Usage: 2
1186          *
1187          * @param       string          String from which the comma in the end (if any) will be removed.
1188          * @return      string
1189          */
1190         public static function rm_endcomma($string)     {
1191                 return rtrim($string, ',');
1192         }
1193
1194         /**
1195          * strtoupper which converts danish (and other characters) characters as well
1196          * Usage: 0
1197          *
1198          * @param       string          String to process
1199          * @return      string
1200          * @deprecated since TYPO3 3.5 - Use t3lib_cs::conv_case() instead or for HTML output, wrap your content in <span class="uppercase">...</span>)
1201          * @ignore
1202          */
1203         public static function danish_strtoupper($string)       {
1204                 self::logDeprecatedFunction();
1205
1206                 $value = strtoupper($string);
1207                 return strtr($value, 'áéúíâêûôîæøåäöü', 'ÁÉÚÍÄËÜÖÏÆØÅÄÖÜ');
1208         }
1209
1210         /**
1211          * Change umlaut characters to plain ASCII with normally two character target
1212          * Only known characters will be converted, so don't expect a result for any character.
1213          *
1214          * ä => ae, Ö => Oe
1215          *
1216          * @param       string          String to convert.
1217          * @deprecated since TYPO3 4.1 - Works only for western europe single-byte charsets! Use t3lib_cs::specCharsToASCII() instead!
1218          * @return      string
1219          */
1220         public static function convUmlauts($str)        {
1221                 self::logDeprecatedFunction();
1222
1223                 $pat  = array ( '/ä/', '/Ä/', '/ö/', '/Ö/', '/ü/', '/Ü/', '/ß/', '/å/', '/Å/', '/ø/', '/Ø/', '/æ/', '/Æ/'  );
1224                 $repl = array ( 'ae',   'Ae',   'oe',   'Oe',   'ue',   'Ue',   'ss',   'aa',   'AA',   'oe',   'OE',   'ae',   'AE'    );
1225                 return preg_replace($pat,$repl,$str);
1226         }
1227
1228         /**
1229          * Tests if the input is an integer.
1230          * Usage: 77
1231          *
1232          * @param       mixed           Any input variable to test.
1233          * @return      boolean         Returns true if string is an integer
1234          */
1235         public static function testInt($var)    {
1236                 return !strcmp($var,intval($var));
1237         }
1238
1239         /**
1240          * Returns true if the first part of $str matches the string $partStr
1241          * Usage: 59
1242          *
1243          * @param       string          Full string to check
1244          * @param       string          Reference string which must be found as the "first part" of the full string
1245          * @return      boolean         True if $partStr was found to be equal to the first part of $str
1246          */
1247         public static function isFirstPartOfStr($str,$partStr)  {
1248                 // Returns true, if the first part of a $str equals $partStr and $partStr is not ''
1249                 $psLen = strlen($partStr);
1250                 if ($psLen)     {
1251                         return substr($str,0,$psLen)==(string)$partStr;
1252                 } else return false;
1253         }
1254
1255         /**
1256          * Formats the input integer $sizeInBytes as bytes/kilobytes/megabytes (-/K/M)
1257          * Usage: 53
1258          *
1259          * @param       integer         Number of bytes to format.
1260          * @param       string          Labels for bytes, kilo, mega and giga separated by vertical bar (|) and possibly encapsulated in "". Eg: " | K| M| G" (which is the default value)
1261          * @return      string          Formatted representation of the byte number, for output.
1262          */
1263         public static function formatSize($sizeInBytes,$labels='')      {
1264
1265                         // Set labels:
1266                 if (strlen($labels) == 0) {
1267                         $labels = ' | K| M| G';
1268                 } else {
1269                         $labels = str_replace('"','',$labels);
1270                 }
1271                 $labelArr = explode('|',$labels);
1272
1273                         // Find size:
1274                 if ($sizeInBytes>900)   {
1275                         if ($sizeInBytes>900000000)     {       // GB
1276                                 $val = $sizeInBytes/(1024*1024*1024);
1277                                 return number_format($val, (($val<20)?1:0), '.', '').$labelArr[3];
1278                         }
1279                         elseif ($sizeInBytes>900000)    {       // MB
1280                                 $val = $sizeInBytes/(1024*1024);
1281                                 return number_format($val, (($val<20)?1:0), '.', '').$labelArr[2];
1282                         } else {        // KB
1283                                 $val = $sizeInBytes/(1024);
1284                                 return number_format($val, (($val<20)?1:0), '.', '').$labelArr[1];
1285                         }
1286                 } else {        // Bytes
1287                         return $sizeInBytes.$labelArr[0];
1288                 }
1289         }
1290
1291         /**
1292          * Returns microtime input to milliseconds
1293          * Usage: 2
1294          *
1295          * @param       string          Microtime
1296          * @return      integer         Microtime input string converted to an integer (milliseconds)
1297          */
1298         public static function convertMicrotime($microtime)     {
1299                 $parts = explode(' ',$microtime);
1300                 return round(($parts[0]+$parts[1])*1000);
1301         }
1302
1303         /**
1304          * This splits a string by the chars in $operators (typical /+-*) and returns an array with them in
1305          * Usage: 2
1306          *
1307          * @param       string          Input string, eg "123 + 456 / 789 - 4"
1308          * @param       string          Operators to split by, typically "/+-*"
1309          * @return      array           Array with operators and operands separated.
1310          * @see tslib_cObj::calc(), tslib_gifBuilder::calcOffset()
1311          */
1312         public static function splitCalc($string,$operators)    {
1313                 $res = Array();
1314                 $sign='+';
1315                 while($string)  {
1316                         $valueLen=strcspn($string,$operators);
1317                         $value=substr($string,0,$valueLen);
1318                         $res[] = Array($sign,trim($value));
1319                         $sign=substr($string,$valueLen,1);
1320                         $string=substr($string,$valueLen+1);
1321                 }
1322                 reset($res);
1323                 return $res;
1324         }
1325
1326         /**
1327          * Calculates the input by +,-,*,/,%,^ with priority to + and -
1328          * Usage: 1
1329          *
1330          * @param       string          Input string, eg "123 + 456 / 789 - 4"
1331          * @return      integer         Calculated value. Or error string.
1332          * @see calcParenthesis()
1333          */
1334         public static function calcPriority($string)    {
1335                 $string=preg_replace('/[[:space:]]*/','',$string);      // removing all whitespace
1336                 $string='+'.$string;    // Ensuring an operator for the first entrance
1337                 $qm='\*\/\+-^%';
1338                 $regex = '(['.$qm.'])(['.$qm.']?[0-9\.]*)';
1339                         // split the expression here:
1340                 $reg = array();
1341                 preg_match_all('/'.$regex.'/',$string,$reg);
1342
1343                 reset($reg[2]);
1344                 $number=0;
1345                 $Msign='+';
1346                 $err='';
1347                 $buffer=doubleval(current($reg[2]));
1348                 next($reg[2]);  // Advance pointer
1349
1350                 while(list($k,$v)=each($reg[2])) {
1351                         $v=doubleval($v);
1352                         $sign = $reg[1][$k];
1353                         if ($sign=='+' || $sign=='-')   {
1354                                 $number = $Msign=='-' ? $number-=$buffer : $number+=$buffer;
1355                                 $Msign = $sign;
1356                                 $buffer=$v;
1357                         } else {
1358                                 if ($sign=='/') {if ($v) $buffer/=$v; else $err='dividing by zero';}
1359                                 if ($sign=='%') {if ($v) $buffer%=$v; else $err='dividing by zero';}
1360                                 if ($sign=='*') {$buffer*=$v;}
1361                                 if ($sign=='^') {$buffer=pow($buffer,$v);}
1362                         }
1363                 }
1364                 $number = $Msign=='-' ? $number-=$buffer : $number+=$buffer;
1365                 return $err ? 'ERROR: '.$err : $number;
1366         }
1367
1368         /**
1369          * Calculates the input with parenthesis levels
1370          * Usage: 2
1371          *
1372          * @param       string          Input string, eg "(123 + 456) / 789 - 4"
1373          * @return      integer         Calculated value. Or error string.
1374          * @see calcPriority(), tslib_cObj::stdWrap()
1375          */
1376         public static function calcParenthesis($string) {
1377                 $securC=100;
1378                 do {
1379                         $valueLenO=strcspn($string,'(');
1380                         $valueLenC=strcspn($string,')');
1381                         if ($valueLenC==strlen($string) || $valueLenC < $valueLenO)     {
1382                                 $value = self::calcPriority(substr($string,0,$valueLenC));
1383                                 $string = $value.substr($string,$valueLenC+1);
1384                                 return $string;
1385                         } else {
1386                                 $string = substr($string,0,$valueLenO).self::calcParenthesis(substr($string,$valueLenO+1));
1387                         }
1388                                 // Security:
1389                         $securC--;
1390                         if ($securC<=0) break;
1391                 } while($valueLenO<strlen($string));
1392                 return $string;
1393         }
1394
1395         /**
1396          * Inverse version of htmlspecialchars()
1397          * Usage: 4
1398          *
1399          * @param       string          Value where &gt;, &lt;, &quot; and &amp; should be converted to regular chars.
1400          * @return      string          Converted result.
1401          */
1402         public static function htmlspecialchars_decode($value)  {
1403                 $value = str_replace('&gt;','>',$value);
1404                 $value = str_replace('&lt;','<',$value);
1405                 $value = str_replace('&quot;','"',$value);
1406                 $value = str_replace('&amp;','&',$value);
1407                 return $value;
1408         }
1409
1410         /**
1411          * Re-converts HTML entities if they have been converted by htmlspecialchars()
1412          * Usage: 10
1413          *
1414          * @param       string          String which contains eg. "&amp;amp;" which should stay "&amp;". Or "&amp;#1234;" to "&#1234;". Or "&amp;#x1b;" to "&#x1b;"
1415          * @return      string          Converted result.
1416          */
1417         public static function deHSCentities($str)      {
1418                 return preg_replace('/&amp;([#[:alnum:]]*;)/','&\1',$str);
1419         }
1420
1421         /**
1422          * This function is used to escape any ' -characters when transferring text to JavaScript!
1423          * Usage: 3
1424          *
1425          * @param       string          String to escape
1426          * @param       boolean         If set, also backslashes are escaped.
1427          * @param       string          The character to escape, default is ' (single-quote)
1428          * @return      string          Processed input string
1429          */
1430         public static function slashJS($string,$extended=0,$char="'")   {
1431                 if ($extended)  {$string = str_replace ("\\", "\\\\", $string);}
1432                 return str_replace ($char, "\\".$char, $string);
1433         }
1434
1435         /**
1436          * Version of rawurlencode() where all spaces (%20) are re-converted to space-characters.
1437          * Usefull when passing text to JavaScript where you simply url-encode it to get around problems with syntax-errors, linebreaks etc.
1438          * Usage: 4
1439          *
1440          * @param       string          String to raw-url-encode with spaces preserved
1441          * @return      string          Rawurlencoded result of input string, but with all %20 (space chars) converted to real spaces.
1442          */
1443         public static function rawUrlEncodeJS($str)     {
1444                 return str_replace('%20',' ',rawurlencode($str));
1445         }
1446
1447         /**
1448          * rawurlencode which preserves "/" chars
1449          * Usefull when filepaths should keep the "/" chars, but have all other special chars encoded.
1450          * Usage: 5
1451          *
1452          * @param       string          Input string
1453          * @return      string          Output string
1454          */
1455         public static function rawUrlEncodeFP($str)     {
1456                 return str_replace('%2F','/',rawurlencode($str));
1457         }
1458
1459         /**
1460          * Checking syntax of input email address
1461          * Usage: 5
1462          *
1463          * @param       string          Input string to evaluate
1464          * @return      boolean         Returns true if the $email address (input string) is valid
1465          */
1466         public static function validEmail($email)       {
1467                 return (filter_var($email, FILTER_VALIDATE_EMAIL) !== false);
1468         }
1469
1470         /**
1471          * Checks if current e-mail sending method does not accept recipient/sender name
1472          * in a call to PHP mail() function. Windows version of mail() and mini_sendmail
1473          * program are known not to process such input correctly and they cause SMTP
1474          * errors. This function will return true if current mail sending method has
1475          * problem with recipient name in recipient/sender argument for mail().
1476          *
1477          * TODO: 4.3 should have additional configuration variable, which is combined
1478          * by || with the rest in this function.
1479          *
1480          * @return      boolean true if mail() does not accept recipient name
1481          */
1482         public static function isBrokenEmailEnvironment() {
1483                 return TYPO3_OS == 'WIN' || (false !== strpos(ini_get('sendmail_path'), 'mini_sendmail'));
1484         }
1485
1486         /**
1487          * Changes from/to arguments for mail() function to work in any environment.
1488          *
1489          * @param       string  $address        Address to adjust
1490          * @return      string  Adjusted address
1491          * @see t3lib_::isBrokenEmailEnvironment()
1492          */
1493         public static function normalizeMailAddress($address) {
1494                 if (self::isBrokenEmailEnvironment() && false !== ($pos1 = strrpos($address, '<'))) {
1495                         $pos2 = strpos($address, '>', $pos1);
1496                         $address = substr($address, $pos1 + 1, ($pos2 ? $pos2 : strlen($address)) - $pos1 - 1);
1497                 }
1498                 return $address;
1499         }
1500
1501         /**
1502          * Formats a string for output between <textarea>-tags
1503          * All content outputted in a textarea form should be passed through this function
1504          * 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!
1505          * Usage: 23
1506          *
1507          * @param       string          Input string to be formatted.
1508          * @return      string          Formatted for <textarea>-tags
1509          */
1510         public static function formatForTextarea($content)      {
1511                 return LF.htmlspecialchars($content);
1512         }
1513
1514         /**
1515          * Converts string to uppercase
1516          * The function converts all Latin characters (a-z, but no accents, etc) to
1517          * uppercase. It is safe for all supported character sets (incl. utf-8).
1518          * Unlike strtoupper() it does not honour the locale.
1519          *
1520          * @param   string      Input string
1521          * @return  string      Uppercase String
1522          */
1523         public static function strtoupper($str) {
1524                 return strtr((string)$str, 'abcdefghijklmnopqrstuvwxyz', 'ABCDEFGHIJKLMNOPQRSTUVWXYZ');
1525         }
1526
1527         /**
1528          * Converts string to lowercase
1529          * The function converts all Latin characters (A-Z, but no accents, etc) to
1530          * lowercase. It is safe for all supported character sets (incl. utf-8).
1531          * Unlike strtolower() it does not honour the locale.
1532          *
1533          * @param       string          Input string
1534          * @return      string          Lowercase String
1535          */
1536         public static function strtolower($str) {
1537                 return strtr((string)$str, 'ABCDEFGHIJKLMNOPQRSTUVWXYZ', 'abcdefghijklmnopqrstuvwxyz');
1538         }
1539
1540         /**
1541          * Returns a string of highly randomized bytes (over the full 8-bit range).
1542          *
1543          * @copyright   Drupal CMS
1544          * @license             GNU General Public License version 2
1545          * @param               integer  Number of characters (bytes) to return
1546          * @return              string   Random Bytes
1547          */
1548         public static function generateRandomBytes($count) {
1549                 $output = '';
1550                         // /dev/urandom is available on many *nix systems and is considered
1551                         // the best commonly available pseudo-random source.
1552                 if (TYPO3_OS != 'WIN' && ($fh = @fopen('/dev/urandom', 'rb'))) {
1553                         $output = fread($fh, $count);
1554                         fclose($fh);
1555                 }
1556
1557                         // fallback if /dev/urandom is not available
1558                 if (!isset($output{$count - 1})) {
1559                                 // We initialize with the somewhat random.
1560                         $randomState = $GLOBALS['TYPO3_CONF_VARS']['SYS']['encryptionKey']
1561                                                         . microtime() . getmypid();
1562                         while (!isset($output{$count - 1})) {
1563                                 $randomState = md5(microtime() . mt_rand() . $randomState);
1564                                 $output .= md5(mt_rand() . $randomState, true);
1565                         }
1566                         $output = substr($output, strlen($output) - $count, $count);
1567                 }
1568                 return $output;
1569         }
1570
1571         /**
1572          * Returns a given string with underscores as UpperCamelCase.
1573          * Example: Converts blog_example to BlogExample
1574          *
1575          * @param       string          $string: String to be converted to camel case
1576          * @return      string          UpperCamelCasedWord
1577          */
1578         public static function underscoredToUpperCamelCase($string) {
1579                 $upperCamelCase = str_replace(' ', '', ucwords(str_replace('_', ' ', self::strtolower($string))));
1580                 return $upperCamelCase;
1581         }
1582
1583         /**
1584          * Returns a given string with underscores as lowerCamelCase.
1585          * Example: Converts minimal_value to minimalValue
1586          *
1587          * @param       string          $string: String to be converted to camel case
1588          * @return      string          lowerCamelCasedWord
1589          */
1590         public static function underscoredToLowerCamelCase($string) {
1591                 $upperCamelCase = str_replace(' ', '', ucwords(str_replace('_', ' ', self::strtolower($string))));
1592                 $lowerCamelCase = self::lcfirst($upperCamelCase);
1593                 return $lowerCamelCase;
1594         }
1595
1596         /**
1597          * Returns a given CamelCasedString as an lowercase string with underscores.
1598          * Example: Converts BlogExample to blog_example, and minimalValue to minimal_value
1599          *
1600          * @param       string          $string: String to be converted to lowercase underscore
1601          * @return      string          lowercase_and_underscored_string
1602          */
1603         public static function camelCaseToLowerCaseUnderscored($string) {
1604                 return self::strtolower(preg_replace('/(?<=\w)([A-Z])/', '_\\1', $string));
1605         }
1606
1607         /**
1608          * Converts the first char of a string to lowercase if it is a latin character (A-Z).
1609          * Example: Converts "Hello World" to "hello World"
1610          *
1611          * @param       string          $string: The string to be used to lowercase the first character
1612          * @return      string          The string with the first character as lowercase
1613          */
1614         public static function lcfirst($string) {
1615                 return self::strtolower(substr($string, 0, 1)) . substr($string, 1);
1616         }
1617
1618         /**
1619          * Checks if a given string is a Uniform Resource Locator (URL).
1620          *
1621          * @param       string          $url: The URL to be validated
1622          * @return      boolean         Whether the given URL is valid
1623          */
1624         public static function isValidUrl($url) {
1625                 return (filter_var($url, FILTER_VALIDATE_URL, FILTER_FLAG_SCHEME_REQUIRED) !== false);
1626         }
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637         /*************************
1638          *
1639          * ARRAY FUNCTIONS
1640          *
1641          *************************/
1642
1643         /**
1644          * Check if an string item exists in an array.
1645          * Please note that the order of function parameters is reverse compared to the PHP function in_array()!!!
1646          *
1647          * Comparison to PHP in_array():
1648          * -> $array = array(0, 1, 2, 3);
1649          * -> variant_a := t3lib_div::inArray($array, $needle)
1650          * -> variant_b := in_array($needle, $array)
1651          * -> variant_c := in_array($needle, $array, true)
1652          * +---------+-----------+-----------+-----------+
1653          * | $needle | variant_a | variant_b | variant_c |
1654          * +---------+-----------+-----------+-----------+
1655          * | '1a'    | false     | true      | false     |
1656          * | ''      | false     | true      | false     |
1657          * | '0'     | true      | true      | false     |
1658          * | 0       | true      | true      | true      |
1659          * +---------+-----------+-----------+-----------+
1660          * Usage: 3
1661          *
1662          * @param       array           one-dimensional array of items
1663          * @param       string          item to check for
1664          * @return      boolean         true if $item is in the one-dimensional array $in_array
1665          */
1666         public static function inArray(array $in_array, $item) {
1667                 foreach ($in_array as $val) {
1668                         if (!is_array($val) && !strcmp($val, $item)) {
1669                                 return true;
1670                         }
1671                 }
1672                 return false;
1673         }
1674
1675         /**
1676          * Explodes a $string delimited by $delim and passes each item in the array through intval().
1677          * Corresponds to t3lib_div::trimExplode(), but with conversion to integers for all values.
1678          * Usage: 76
1679          *
1680          * @param       string          Delimiter string to explode with
1681          * @param       string          The string to explode
1682          * @param       boolean         If set, all empty values (='') will NOT be set in output
1683          * @param       integer         If positive, the result will contain a maximum of limit elements,
1684          *                                              if negative, all components except the last -limit are returned,
1685          *                                              if zero (default), the result is not limited at all
1686          * @return      array           Exploded values, all converted to integers
1687          */
1688         public static function intExplode($delimiter, $string, $onlyNonEmptyValues = FALSE, $limit = 0) {
1689                 $explodedValues = self::trimExplode($delimiter, $string, $onlyNonEmptyValues, $limit);
1690                 return array_map('intval', $explodedValues);
1691         }
1692
1693         /**
1694          * Reverse explode which explodes the string counting from behind.
1695          * Thus t3lib_div::revExplode(':','my:words:here',2) will return array('my:words','here')
1696          * Usage: 8
1697          *
1698          * @param       string          Delimiter string to explode with
1699          * @param       string          The string to explode
1700          * @param       integer         Number of array entries
1701          * @return      array           Exploded values
1702          */
1703         public static function revExplode($delimiter, $string, $count=0) {
1704                 $explodedValues = explode($delimiter, strrev($string), $count);
1705                 $explodedValues = array_map('strrev', $explodedValues);
1706                 return array_reverse($explodedValues);
1707         }
1708
1709         /**
1710          * Explodes a string and trims all values for whitespace in the ends.
1711          * If $onlyNonEmptyValues is set, then all blank ('') values are removed.
1712          * Usage: 256
1713          *
1714          * @param       string          Delimiter string to explode with
1715          * @param       string          The string to explode
1716          * @param       boolean         If set, all empty values will be removed in output
1717          * @param       integer         If positive, the result will contain a maximum of
1718          *                                              $limit elements, if negative, all components except
1719          *                                              the last -$limit are returned, if zero (default),
1720          *                                              the result is not limited at all. Attention though
1721          *                                              that the use of this parameter can slow down this
1722          *                                              function.
1723          * @return      array           Exploded values
1724          */
1725         public static function trimExplode($delim, $string, $removeEmptyValues = false, $limit = 0) {
1726                 $explodedValues = explode($delim, $string);
1727
1728                 $result = array_map('trim', $explodedValues);
1729
1730                 if ($removeEmptyValues) {
1731                         $temp = array();
1732                         foreach($result as $value) {
1733                                 if ($value !== '') {
1734                                         $temp[] = $value;
1735                                 }
1736                         }
1737                         $result = $temp;
1738                 }
1739
1740                 if ($limit != 0) {
1741                         if ($limit < 0) {
1742                                 $result = array_slice($result, 0, $limit);
1743                         } elseif (count($result) > $limit) {
1744                                 $lastElements = array_slice($result, $limit - 1);
1745                                 $result = array_slice($result, 0, $limit - 1);
1746                                 $result[] = implode($delim, $lastElements);
1747                         }
1748                 }
1749
1750                 return $result;
1751         }
1752
1753         /**
1754          * Remove duplicate values from an array
1755          * Usage: 0
1756          *
1757          * @param       array           Array of values to make unique
1758          * @return      array
1759          * @ignore
1760          * @deprecated since TYPO3 3.5 - Use the PHP function array_unique instead
1761          */
1762         public static function uniqueArray(array $valueArray)   {
1763                 self::logDeprecatedFunction();
1764
1765                 return array_unique($valueArray);
1766         }
1767
1768         /**
1769          * Removes the value $cmpValue from the $array if found there. Returns the modified array
1770          * Usage: 3
1771          *
1772          * @param       array           Array containing the values
1773          * @param       string          Value to search for and if found remove array entry where found.
1774          * @return      array           Output array with entries removed if search string is found
1775          */
1776         public static function removeArrayEntryByValue(array $array, $cmpValue) {
1777                 foreach ($array as $k => $v) {
1778                         if (is_array($v)) {
1779                                 $array[$k] = self::removeArrayEntryByValue($v, $cmpValue);
1780                         } elseif (!strcmp($v, $cmpValue)) {
1781                                 unset($array[$k]);
1782                         }
1783                 }
1784                 reset($array);
1785                 return $array;
1786         }
1787
1788         /**
1789          * Filters an array to reduce its elements to match the condition.
1790          * The values in $keepItems can be optionally evaluated by a custom callback function.
1791          *
1792          * Example (arguments used to call this function):
1793          * $array = array(
1794          *              array('aa' => array('first', 'second'),
1795          *              array('bb' => array('third', 'fourth'),
1796          *              array('cc' => array('fifth', 'sixth'),
1797          * );
1798          * $keepItems = array('third');
1799          * $getValueFunc = create_function('$value', 'return $value[0];');
1800          *
1801          * Returns:
1802          * array(
1803          *              array('bb' => array('third', 'fourth'),
1804          * )
1805          *
1806          * @param       array           $array: The initial array to be filtered/reduced
1807          * @param       mixed           $keepItems: The items which are allowed/kept in the array - accepts array or csv string
1808          * @param       string          $getValueFunc: (optional) Unique function name set by create_function() used to get the value to keep
1809          * @return      array           The filtered/reduced array with the kept items
1810          */
1811         public static function keepItemsInArray(array $array, $keepItems, $getValueFunc=null) {
1812                 if ($array) {
1813                                 // Convert strings to arrays:
1814                         if (is_string($keepItems)) {
1815                                 $keepItems = self::trimExplode(',', $keepItems);
1816                         }
1817                                 // create_function() returns a string:
1818                         if (!is_string($getValueFunc)) {
1819                                 $getValueFunc = null;
1820                         }
1821                                 // Do the filtering:
1822                         if (is_array($keepItems) && count($keepItems)) {
1823                                 foreach ($array as $key => $value) {
1824                                                 // Get the value to compare by using the callback function:
1825                                         $keepValue = (isset($getValueFunc) ? $getValueFunc($value) : $value);
1826                                         if (!in_array($keepValue, $keepItems)) {
1827                                                 unset($array[$key]);
1828                                         }
1829                                 }
1830                         }
1831                 }
1832                 return $array;
1833         }
1834
1835         /**
1836          * Implodes a multidim-array into GET-parameters (eg. &param[key][key2]=value2&param[key][key3]=value3)
1837          * Usage: 24
1838          *
1839          * @param       string          Name prefix for entries. Set to blank if you wish none.
1840          * @param       array           The (multidim) array to implode
1841          * @param       string          (keep blank)
1842          * @param       boolean         If set, parameters which were blank strings would be removed.
1843          * @param       boolean         If set, the param name itself (for example "param[key][key2]") would be rawurlencoded as well.
1844          * @return      string          Imploded result, fx. &param[key][key2]=value2&param[key][key3]=value3
1845          * @see explodeUrl2Array()
1846          */
1847         public static function implodeArrayForUrl($name, array $theArray, $str = '', $skipBlank = false, $rawurlencodeParamName = false) {
1848                 foreach($theArray as $Akey => $AVal)    {
1849                         $thisKeyName = $name ? $name.'['.$Akey.']' : $Akey;
1850                         if (is_array($AVal))    {
1851                                 $str = self::implodeArrayForUrl($thisKeyName,$AVal,$str,$skipBlank,$rawurlencodeParamName);
1852                         } else {
1853                                 if (!$skipBlank || strcmp($AVal,''))    {
1854                                         $str.='&'.($rawurlencodeParamName ? rawurlencode($thisKeyName) : $thisKeyName).
1855                                                 '='.rawurlencode($AVal);
1856                                 }
1857                         }
1858                 }
1859                 return $str;
1860         }
1861
1862         /**
1863          * Explodes a string with GETvars (eg. "&id=1&type=2&ext[mykey]=3") into an array
1864          *
1865          * @param       string          GETvars string
1866          * @param       boolean         If set, the string will be parsed into a multidimensional array if square brackets are used in variable names (using PHP function parse_str())
1867          * @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!
1868          * @see implodeArrayForUrl()
1869          */
1870         public static function explodeUrl2Array($string,$multidim=FALSE)        {
1871                 $output = array();
1872                 if ($multidim)  {
1873                         parse_str($string,$output);
1874                 } else {
1875                         $p = explode('&',$string);
1876                         foreach($p as $v)       {
1877                                 if (strlen($v)) {
1878                                         list($pK,$pV) = explode('=',$v,2);
1879                                         $output[rawurldecode($pK)] = rawurldecode($pV);
1880                                 }
1881                         }
1882                 }
1883                 return $output;
1884         }
1885
1886         /**
1887          * Returns an array with selected keys from incoming data.
1888          * (Better read source code if you want to find out...)
1889          * Usage: 3
1890          *
1891          * @param       string          List of variable/key names
1892          * @param       array           Array from where to get values based on the keys in $varList
1893          * @param       boolean         If set, then t3lib_div::_GP() is used to fetch the value if not found (isset) in the $getArray
1894          * @return      array           Output array with selected variables.
1895          */
1896         public static function compileSelectedGetVarsFromArray($varList,array $getArray,$GPvarAlt=1)    {
1897                 $keys = self::trimExplode(',',$varList,1);
1898                 $outArr = array();
1899                 foreach($keys as $v)    {
1900                         if (isset($getArray[$v]))       {
1901                                 $outArr[$v] = $getArray[$v];
1902                         } elseif ($GPvarAlt) {
1903                                 $outArr[$v] = self::_GP($v);
1904                         }
1905                 }
1906                 return $outArr;
1907         }
1908
1909         /**
1910          * AddSlash array
1911          * This function traverses a multidimentional array and adds slashes to the values.
1912          * NOTE that the input array is and argument by reference.!!
1913          * Twin-function to stripSlashesOnArray
1914          * Usage: 8
1915          *
1916          * @param       array           Multidimensional input array, (REFERENCE!)
1917          * @return      array
1918          */
1919         public static function addSlashesOnArray(array &$theArray)      {
1920                 foreach ($theArray as &$value) {
1921                         if (is_array($value)) {
1922                                 self::addSlashesOnArray($value);
1923                         } else {
1924                                 $value = addslashes($value);
1925                         }
1926                         unset($value);
1927                 }
1928                 reset($theArray);
1929         }
1930
1931         /**
1932          * StripSlash array
1933          * This function traverses a multidimentional array and strips slashes to the values.
1934          * NOTE that the input array is and argument by reference.!!
1935          * Twin-function to addSlashesOnArray
1936          * Usage: 10
1937          *
1938          * @param       array           Multidimensional input array, (REFERENCE!)
1939          * @return      array
1940          */
1941         public static function stripSlashesOnArray(array &$theArray)    {
1942                 foreach ($theArray as &$value) {
1943                         if (is_array($value)) {
1944                                 self::stripSlashesOnArray($value);
1945                         } else {
1946                                 $value = stripslashes($value);
1947                         }
1948                         unset($value);
1949                 }
1950                 reset($theArray);
1951         }
1952
1953         /**
1954          * Either slashes ($cmd=add) or strips ($cmd=strip) array $arr depending on $cmd
1955          * Usage: 0
1956          *
1957          * @param       array           Multidimensional input array
1958          * @param       string          "add" or "strip", depending on usage you wish.
1959          * @return      array
1960          */
1961         public static function slashArray(array $arr,$cmd)      {
1962                 if ($cmd=='strip')      self::stripSlashesOnArray($arr);
1963                 if ($cmd=='add')        self::addSlashesOnArray($arr);
1964                 return $arr;
1965         }
1966
1967         /**
1968         * Rename Array keys with a given mapping table
1969         * @param        array   Array by reference which should be remapped
1970         * @param        array   Array with remap information, array/$oldKey => $newKey)
1971         */
1972         function remapArrayKeys(&$array, $mappingTable) {
1973                 if (is_array($mappingTable)) {
1974                         foreach ($mappingTable as $old => $new) {
1975                                 if ($new && isset($array[$old])) {
1976                                         $array[$new] = $array[$old];
1977                                         unset ($array[$old]);
1978                                 }
1979                         }
1980                 }
1981         }
1982
1983
1984         /**
1985          * Merges two arrays recursively and "binary safe" (integer keys are
1986          * overridden as well), overruling similar values in the first array
1987          * ($arr0) with the values of the second array ($arr1)
1988          * In case of identical keys, ie. keeping the values of the second.
1989          * Usage: 0
1990          *
1991          * @param       array           First array
1992          * @param       array           Second array, overruling the first array
1993          * @param       boolean         If set, keys that are NOT found in $arr0 (first array) will not be set. Thus only existing value can/will be overruled from second array.
1994          * @param       boolean         If set, values from $arr1 will overrule if they are empty or zero. Default: true
1995          * @return      array           Resulting array where $arr1 values has overruled $arr0 values
1996          */
1997         public static function array_merge_recursive_overrule(array $arr0,array $arr1,$notAddKeys=0,$includeEmtpyValues=true) {
1998                 foreach ($arr1 as $key => $val) {
1999                         if(is_array($arr0[$key])) {
2000                                 if (is_array($arr1[$key]))      {
2001                                         $arr0[$key] = self::array_merge_recursive_overrule($arr0[$key],$arr1[$key],$notAddKeys,$includeEmtpyValues);
2002                                 }
2003                         } else {
2004                                 if ($notAddKeys) {
2005                                         if (isset($arr0[$key])) {
2006                                                 if ($includeEmtpyValues || $val) {
2007                                                         $arr0[$key] = $val;
2008                                                 }
2009                                         }
2010                                 } else {
2011                                         if ($includeEmtpyValues || $val) {
2012                                                 $arr0[$key] = $val;
2013                                         }
2014                                 }
2015                         }
2016                 }
2017                 reset($arr0);
2018                 return $arr0;
2019         }
2020
2021         /**
2022          * 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.
2023          * Usage: 16
2024          *
2025          * @param       array           First array
2026          * @param       array           Second array
2027          * @return      array           Merged result.
2028          */
2029         public static function array_merge(array $arr1,array $arr2)     {
2030                 return $arr2+$arr1;
2031         }
2032
2033         /**
2034          * Filters keys off from first array that also exist in second array. Comparision is done by keys.
2035          * This method is a recursive version of php array_diff_assoc()
2036          *
2037          * @param       array           Source array
2038          * @param       array           Reduce source array by this array
2039          * @return      array           Source array reduced by keys also present in second array
2040          */
2041         public static function arrayDiffAssocRecursive(array $array1, array $array2) {
2042                 $differenceArray = array();
2043                 foreach ($array1 as $key => $value) {
2044                         if (!array_key_exists($key, $array2)) {
2045                                 $differenceArray[$key] = $value;
2046                         } elseif (is_array($value)) {
2047                                 if (is_array($array2[$key])) {
2048                                         $differenceArray[$key] = t3lib_div::arrayDiffAssocRecursive($value, $array2[$key]);
2049                                 }
2050                         }
2051                 }
2052
2053                 return $differenceArray;
2054         }
2055
2056         /**
2057          * Takes a row and returns a CSV string of the values with $delim (default is ,) and $quote (default is ") as separator chars.
2058          * Usage: 5
2059          *
2060          * @param       array           Input array of values
2061          * @param       string          Delimited, default is comman
2062          * @param       string          Quote-character to wrap around the values.
2063          * @return      string          A single line of CSV
2064          */
2065         public static function csvValues(array $row,$delim=',',$quote='"')      {
2066                 reset($row);
2067                 $out=array();
2068                 foreach ($row as $value) {
2069                         $out[] = str_replace($quote, $quote.$quote, $value);
2070                 }
2071                 $str = $quote.implode($quote.$delim.$quote,$out).$quote;
2072                 return $str;
2073         }
2074
2075         /**
2076          * Creates recursively a JSON literal from a multidimensional associative array.
2077          * Uses native function of PHP >= 5.2.0
2078          *
2079          * @param       array           $jsonArray: The array to be transformed to JSON
2080          * @return      string          JSON string
2081          * @deprecated since TYPO3 4.3, use PHP native function json_encode() instead, will be removed in TYPO3 4.5
2082          */
2083         public static function array2json(array $jsonArray) {
2084                 self::logDeprecatedFunction();
2085
2086                 return json_encode($jsonArray);
2087         }
2088
2089         /**
2090          * Removes dots "." from end of a key identifier of TypoScript styled array.
2091          * array('key.' => array('property.' => 'value')) --> array('key' => array('property' => 'value'))
2092          *
2093          * @param       array   $ts: TypoScript configuration array
2094          * @return      array   TypoScript configuration array without dots at the end of all keys
2095          */
2096         public static function removeDotsFromTS(array $ts) {
2097                 $out = array();
2098                 foreach ($ts as $key => $value) {
2099                         if (is_array($value)) {
2100                                 $key = rtrim($key, '.');
2101                                 $out[$key] = self::removeDotsFromTS($value);
2102                         } else {
2103                                 $out[$key] = $value;
2104                         }
2105                 }
2106                 return $out;
2107         }
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124         /*************************
2125          *
2126          * HTML/XML PROCESSING
2127          *
2128          *************************/
2129
2130         /**
2131          * Returns an array with all attributes of the input HTML tag as key/value pairs. Attributes are only lowercase a-z
2132          * $tag is either a whole tag (eg '<TAG OPTION ATTRIB=VALUE>') or the parameterlist (ex ' OPTION ATTRIB=VALUE>')
2133          * If an attribute is empty, then the value for the key is empty. You can check if it existed with isset()
2134          * Usage: 8
2135          *
2136          * @param       string          HTML-tag string (or attributes only)
2137          * @return      array           Array with the attribute values.
2138          */
2139         public static function get_tag_attributes($tag) {
2140                 $components = self::split_tag_attributes($tag);
2141                 $name = '';      // attribute name is stored here
2142                 $valuemode = false;
2143                 $attributes = array();
2144                 foreach ($components as $key => $val)   {
2145                         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
2146                                 if ($valuemode) {
2147                                         if ($name)      {
2148                                                 $attributes[$name] = $val;
2149                                                 $name = '';
2150                                         }
2151                                 } else {
2152                                         if ($key = strtolower(preg_replace('/[^a-zA-Z0-9]/','',$val)))  {
2153                                                 $attributes[$key] = '';
2154                                                 $name = $key;
2155                                         }
2156                                 }
2157                                 $valuemode = false;
2158                         } else {
2159                                 $valuemode = true;
2160                         }
2161                 }
2162                 return $attributes;
2163         }
2164
2165         /**
2166          * Returns an array with the 'components' from an attribute list from an HTML tag. The result is normally analyzed by get_tag_attributes
2167          * Removes tag-name if found
2168          * Usage: 2
2169          *
2170          * @param       string          HTML-tag string (or attributes only)
2171          * @return      array           Array with the attribute values.
2172          */
2173         public static function split_tag_attributes($tag)       {
2174                 $tag_tmp = trim(preg_replace('/^<[^[:space:]]*/','',trim($tag)));
2175                         // Removes any > in the end of the string
2176                 $tag_tmp = trim(rtrim($tag_tmp, '>'));
2177
2178                 $value = array();
2179                 while (strcmp($tag_tmp,''))     {       // Compared with empty string instead , 030102
2180                         $firstChar=substr($tag_tmp,0,1);
2181                         if (!strcmp($firstChar,'"') || !strcmp($firstChar,"'")) {
2182                                 $reg=explode($firstChar,$tag_tmp,3);
2183                                 $value[]=$reg[1];
2184                                 $tag_tmp=trim($reg[2]);
2185                         } elseif (!strcmp($firstChar,'=')) {
2186                                 $value[] = '=';
2187                                 $tag_tmp = trim(substr($tag_tmp,1));            // Removes = chars.
2188                         } else {
2189                                         // There are '' around the value. We look for the next ' ' or '>'
2190                                 $reg = preg_split('/[[:space:]=]/', $tag_tmp, 2);
2191                                 $value[] = trim($reg[0]);
2192                                 $tag_tmp = trim(substr($tag_tmp,strlen($reg[0]),1).$reg[1]);
2193                         }
2194                 }
2195                 reset($value);
2196                 return $value;
2197         }
2198
2199         /**
2200          * Implodes attributes in the array $arr for an attribute list in eg. and HTML tag (with quotes)
2201          * Usage: 14
2202          *
2203          * @param       array           Array with attribute key/value pairs, eg. "bgcolor"=>"red", "border"=>0
2204          * @param       boolean         If set the resulting attribute list will have a) all attributes in lowercase (and duplicates weeded out, first entry taking precedence) and b) all values htmlspecialchar()'ed. It is recommended to use this switch!
2205          * @param       boolean         If true, don't check if values are blank. Default is to omit attributes with blank values.
2206          * @return      string          Imploded attributes, eg. 'bgcolor="red" border="0"'
2207          */
2208         public static function implodeAttributes(array $arr,$xhtmlSafe=FALSE,$dontOmitBlankAttribs=FALSE)       {
2209                 if ($xhtmlSafe) {
2210                         $newArr=array();
2211                         foreach($arr as $p => $v)       {
2212                                 if (!isset($newArr[strtolower($p)])) $newArr[strtolower($p)] = htmlspecialchars($v);
2213                         }
2214                         $arr = $newArr;
2215                 }
2216                 $list = array();
2217                 foreach($arr as $p => $v)       {
2218                         if (strcmp($v,'') || $dontOmitBlankAttribs)     {$list[]=$p.'="'.$v.'"';}
2219                 }
2220                 return implode(' ',$list);
2221         }
2222
2223         /**
2224          * Implodes attributes in the array $arr for an attribute list in eg. and HTML tag (with quotes)
2225          *
2226          * @param       array           See implodeAttributes()
2227          * @param       boolean         See implodeAttributes()
2228          * @param       boolean         See implodeAttributes()
2229          * @return      string          See implodeAttributes()
2230          * @deprecated since TYPO3 3.7 - Name was changed into implodeAttributes
2231          * @see implodeAttributes()
2232          */
2233         public static function implodeParams(array $arr,$xhtmlSafe=FALSE,$dontOmitBlankAttribs=FALSE)   {
2234                 self::logDeprecatedFunction();
2235
2236                 return self::implodeAttributes($arr,$xhtmlSafe,$dontOmitBlankAttribs);
2237         }
2238
2239         /**
2240          * Wraps JavaScript code XHTML ready with <script>-tags
2241          * Automatic re-identing of the JS code is done by using the first line as ident reference.
2242          * This is nice for identing JS code with PHP code on the same level.
2243          *
2244          * @param       string          JavaScript code
2245          * @param       boolean         Wrap script element in linebreaks? Default is TRUE.
2246          * @return      string          The wrapped JS code, ready to put into a XHTML page
2247          * @author      Ingmar Schlecht <ingmars@web.de>
2248          * @author      René Fritz <r.fritz@colorcube.de>
2249          */
2250         public static function wrapJS($string, $linebreak=TRUE) {
2251                 if(trim($string)) {
2252                                 // <script wrapped in nl?
2253                         $cr = $linebreak? LF : '';
2254
2255                                 // remove nl from the beginning
2256                         $string = preg_replace ('/^\n+/', '', $string);
2257                                 // re-ident to one tab using the first line as reference
2258                         $match = array();
2259                         if(preg_match('/^(\t+)/',$string,$match)) {
2260                                 $string = str_replace($match[1],TAB, $string);
2261                         }
2262                         $string = $cr.'<script type="text/javascript">
2263 /*<![CDATA[*/
2264 '.$string.'
2265 /*]]>*/
2266 </script>'.$cr;
2267                 }
2268                 return trim($string);
2269         }
2270
2271
2272         /**
2273          * Parses XML input into a PHP array with associative keys
2274          * Usage: 0
2275          *
2276          * @param       string          XML data input
2277          * @param       integer         Number of element levels to resolve the XML into an array. Any further structure will be set as XML.
2278          * @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.
2279          * @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
2280          */
2281         public static function xml2tree($string,$depth=999) {
2282                 $parser = xml_parser_create();
2283                 $vals = array();
2284                 $index = array();
2285
2286                 xml_parser_set_option($parser, XML_OPTION_CASE_FOLDING, 0);
2287                 xml_parser_set_option($parser, XML_OPTION_SKIP_WHITE, 0);
2288                 xml_parse_into_struct($parser, $string, $vals, $index);
2289
2290                 if (xml_get_error_code($parser))        return 'Line '.xml_get_current_line_number($parser).': '.xml_error_string(xml_get_error_code($parser));
2291                 xml_parser_free($parser);
2292
2293                 $stack = array( array() );
2294                 $stacktop = 0;
2295                 $startPoint=0;
2296
2297 // FIXME don't use unset() - what does that mean? Use NULL or similar.
2298                 unset($tagi);
2299                 foreach($vals as $key => $val) {
2300                         $type = $val['type'];
2301
2302                                 // open tag:
2303                         if ($type=='open' || $type=='complete') {
2304                                 $stack[$stacktop++] = $tagi;
2305
2306                                 if ($depth==$stacktop)  {
2307                                         $startPoint=$key;
2308                                 }
2309
2310                                 $tagi = array('tag' => $val['tag']);
2311
2312                                 if(isset($val['attributes']))  $tagi['attrs'] = $val['attributes'];
2313                                 if(isset($val['value']))        $tagi['values'][] = $val['value'];
2314                         }
2315                                 // finish tag:
2316                         if ($type=='complete' || $type=='close')        {
2317                                 $oldtagi = $tagi;
2318                                 $tagi = $stack[--$stacktop];
2319                                 $oldtag = $oldtagi['tag'];
2320                                 unset($oldtagi['tag']);
2321
2322                                 if ($depth==($stacktop+1))      {
2323                                         if ($key-$startPoint > 0)       {
2324                                                 $partArray = array_slice(
2325                                                         $vals,
2326                                                         $startPoint+1,
2327                                                         $key-$startPoint-1
2328                                                 );
2329                                                 #$oldtagi=array('XMLvalue'=>self::xmlRecompileFromStructValArray($partArray));
2330                                                 $oldtagi['XMLvalue']=self::xmlRecompileFromStructValArray($partArray);
2331                                         } else {
2332                                                 $oldtagi['XMLvalue']=$oldtagi['values'][0];
2333                                         }
2334                                 }
2335
2336                                 $tagi['ch'][$oldtag][] = $oldtagi;
2337                                 unset($oldtagi);
2338                         }
2339                                 // cdata
2340                         if($type=='cdata') {
2341                                 $tagi['values'][] = $val['value'];
2342                         }
2343                 }
2344                 return $tagi['ch'];
2345         }
2346
2347         /**
2348          * Turns PHP array into XML. See array2xml()
2349          *
2350          * @param       array           The input PHP array with any kind of data; text, binary, integers. Not objects though.
2351          * @param       string          Alternative document tag. Default is "phparray".
2352          * @param       array           Options for the compilation. See array2xml() for description.
2353          * @param       string          Forced charset to prologue
2354          * @return      string          An XML string made from the input content in the array.
2355          * @see xml2array(),array2xml()
2356          */
2357         public static function array2xml_cs(array $array,$docTag='phparray',array $options=array(),$charset='') {
2358
2359                         // Figure out charset if not given explicitly:
2360                 if (!$charset)  {
2361                         if ($GLOBALS['TYPO3_CONF_VARS']['BE']['forceCharset'])  {       // First priority: forceCharset! If set, this will be authoritative!
2362                                 $charset = $GLOBALS['TYPO3_CONF_VARS']['BE']['forceCharset'];
2363                         } elseif (is_object($GLOBALS['LANG']))  {
2364                                 $charset = $GLOBALS['LANG']->charSet;   // If "LANG" is around, that will hold the current charset
2365                         } else {
2366                                 $charset = 'iso-8859-1';        // THIS is just a hopeful guess!
2367                         }
2368                 }
2369
2370                         // Return XML:
2371                 return '<?xml version="1.0" encoding="'.htmlspecialchars($charset).'" standalone="yes" ?>'.LF.
2372                                 self::array2xml($array,'',0,$docTag,0, $options);
2373         }
2374
2375         /**
2376          * Deprecated to call directly (unless you are aware of using XML prologues)! Use "array2xml_cs" instead (which adds an XML-prologue)
2377          *
2378          * Converts a PHP array into an XML string.
2379          * The XML output is optimized for readability since associative keys are used as tagnames.
2380          * 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.
2381          * Numeric keys are stored with the default tagname "numIndex" but can be overridden to other formats)
2382          * 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
2383          * 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.
2384          * 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!
2385          * 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...
2386          * Usage: 5
2387          *
2388          * @param       array           The input PHP array with any kind of data; text, binary, integers. Not objects though.
2389          * @param       string          tag-prefix, eg. a namespace prefix like "T3:"
2390          * @param       integer         Current recursion level. Don't change, stay at zero!
2391          * @param       string          Alternative document tag. Default is "phparray".
2392          * @param       integer         If greater than zero, then the number of spaces corresponding to this number is used for indenting, if less than zero - no indentation, if zero - a single TAB is used
2393          * @param       array           Options for the compilation. Key "useNindex" => 0/1 (boolean: whether to use "n0, n1, n2" for num. indexes); Key "useIndexTagForNum" => "[tag for numerical indexes]"; Key "useIndexTagForAssoc" => "[tag for associative indexes"; Key "parentTagMap" => array('parentTag' => 'thisLevelTag')
2394          * @param       string          Stack data. Don't touch.
2395          * @return      string          An XML string made from the input content in the array.
2396          * @see xml2array()
2397          */
2398         public static function array2xml(array $array,$NSprefix='',$level=0,$docTag='phparray',$spaceInd=0,array $options=array(),array $stackData=array())     {
2399                         // 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
2400                 $binaryChars = chr(0).chr(1).chr(2).chr(3).chr(4).chr(5).chr(6).chr(7).chr(8).
2401                                                 chr(11).chr(12).chr(14).chr(15).chr(16).chr(17).chr(18).chr(19).
2402                                                 chr(20).chr(21).chr(22).chr(23).chr(24).chr(25).chr(26).chr(27).chr(28).chr(29).
2403                                                 chr(30).chr(31);
2404                         // Set indenting mode:
2405                 $indentChar = $spaceInd ? ' ' : TAB;
2406                 $indentN = $spaceInd>0 ? $spaceInd : 1;
2407                 $nl = ($spaceInd >= 0 ? LF : '');
2408
2409                         // Init output variable:
2410                 $output='';
2411
2412                         // Traverse the input array
2413                 foreach($array as $k=>$v)       {
2414                         $attr = '';
2415                         $tagName = $k;
2416
2417                                 // Construct the tag name.
2418                         if(isset($options['grandParentTagMap'][$stackData['grandParentTagName'].'/'.$stackData['parentTagName']])) {            // Use tag based on grand-parent + parent tag name
2419                                 $attr.=' index="'.htmlspecialchars($tagName).'"';
2420                                 $tagName = (string)$options['grandParentTagMap'][$stackData['grandParentTagName'].'/'.$stackData['parentTagName']];
2421                         }elseif(isset($options['parentTagMap'][$stackData['parentTagName'].':_IS_NUM']) && self::testInt($tagName)) {           // Use tag based on parent tag name + if current tag is numeric
2422                                 $attr.=' index="'.htmlspecialchars($tagName).'"';
2423                                 $tagName = (string)$options['parentTagMap'][$stackData['parentTagName'].':_IS_NUM'];
2424                         }elseif(isset($options['parentTagMap'][$stackData['parentTagName'].':'.$tagName])) {            // Use tag based on parent tag name + current tag
2425                                 $attr.=' index="'.htmlspecialchars($tagName).'"';
2426                                 $tagName = (string)$options['parentTagMap'][$stackData['parentTagName'].':'.$tagName];
2427                         } elseif(isset($options['parentTagMap'][$stackData['parentTagName']])) {                // Use tag based on parent tag name:
2428                                 $attr.=' index="'.htmlspecialchars($tagName).'"';
2429                                 $tagName = (string)$options['parentTagMap'][$stackData['parentTagName']];
2430                         } elseif (!strcmp(intval($tagName),$tagName))   {       // If integer...;
2431                                 if ($options['useNindex']) {    // If numeric key, prefix "n"
2432                                         $tagName = 'n'.$tagName;
2433                                 } else {        // Use special tag for num. keys:
2434                                         $attr.=' index="'.$tagName.'"';
2435                                         $tagName = $options['useIndexTagForNum'] ? $options['useIndexTagForNum'] : 'numIndex';
2436                                 }
2437                         } elseif($options['useIndexTagForAssoc']) {             // Use tag for all associative keys:
2438                                 $attr.=' index="'.htmlspecialchars($tagName).'"';
2439                                 $tagName = $options['useIndexTagForAssoc'];
2440                         }
2441
2442                                 // The tag name is cleaned up so only alphanumeric chars (plus - and _) are in there and not longer than 100 chars either.
2443                         $tagName = substr(preg_replace('/[^[:alnum:]_-]/','',$tagName),0,100);
2444
2445                                 // If the value is an array then we will call this function recursively:
2446                         if (is_array($v))       {
2447
2448                                         // Sub elements:
2449                                 if ($options['alt_options'][$stackData['path'].'/'.$tagName])   {
2450                                         $subOptions = $options['alt_options'][$stackData['path'].'/'.$tagName];
2451                                         $clearStackPath = $subOptions['clearStackPath'];
2452                                 } else {
2453                                         $subOptions = $options;
2454                                         $clearStackPath = FALSE;
2455                                 }
2456
2457                                 $content = $nl .
2458                                                         self::array2xml(
2459                                                                 $v,
2460                                                                 $NSprefix,
2461                                                                 $level+1,
2462                                                                 '',
2463                                                                 $spaceInd,
2464                                                                 $subOptions,
2465                                                                 array(
2466                                                                         'parentTagName' => $tagName,
2467                                                                         'grandParentTagName' => $stackData['parentTagName'],
2468                                                                         'path' => $clearStackPath ? '' : $stackData['path'].'/'.$tagName,
2469                                                                 )
2470                                                         ).
2471                                                         ($spaceInd >= 0 ? str_pad('',($level+1)*$indentN,$indentChar) : '');
2472                                 if ((int)$options['disableTypeAttrib']!=2)      {       // Do not set "type = array". Makes prettier XML but means that empty arrays are not restored with xml2array
2473                                         $attr.=' type="array"';
2474                                 }
2475                         } else {        // Just a value:
2476
2477                                         // Look for binary chars:
2478                                 $vLen = strlen($v);     // check for length, because PHP 5.2.0 may crash when first argument of strcspn is empty
2479                                 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!
2480                                                 // If the value contained binary chars then we base64-encode it an set an attribute to notify this situation:
2481                                         $content = $nl.chunk_split(base64_encode($v));
2482                                         $attr.=' base64="1"';
2483                                 } else {
2484                                                 // Otherwise, just htmlspecialchar the stuff:
2485                                         $content = htmlspecialchars($v);
2486                                         $dType = gettype($v);
2487                                         if ($dType == 'string') {
2488                                                 if ($options['useCDATA'] && $content != $v) {
2489                                                         $content = '<![CDATA[' . $v . ']]>';
2490                                                 }
2491                                         } elseif (!$options['disableTypeAttrib']) {
2492                                                 $attr.= ' type="'.$dType.'"';
2493                                         }
2494                                 }
2495                         }
2496
2497                                 // Add the element to the output string:
2498                         $output.=($spaceInd >= 0 ? str_pad('',($level+1)*$indentN,$indentChar) : '').'<'.$NSprefix.$tagName.$attr.'>'.$content.'</'.$NSprefix.$tagName.'>'.$nl;
2499                 }
2500
2501                 // If we are at the outer-most level, then we finally wrap it all in the document tags and return that as the value:
2502                 if (!$level)    {
2503                         $output =
2504                                 '<'.$docTag.'>'.$nl.
2505                                 $output.
2506                                 '</'.$docTag.'>';
2507                 }
2508
2509                 return $output;
2510         }
2511
2512         /**
2513          * Converts an XML string to a PHP array.
2514          * This is the reverse function of array2xml()
2515          * This is a wrapper for xml2arrayProcess that adds a two-level cache
2516          * Usage: 17
2517          *
2518          * @param       string          XML content to convert into an array
2519          * @param       string          The tag-prefix resolve, eg. a namespace like "T3:"
2520          * @param       boolean         If set, the document tag will be set in the key "_DOCUMENT_TAG" of the output array
2521          * @return      mixed           If the parsing had errors, a string with the error message is returned. Otherwise an array with the content.
2522          * @see array2xml(),xml2arrayProcess()
2523          * @author      Fabrizio Branca <typo3@fabrizio-branca.de> (added caching)
2524          */
2525         public static function xml2array($string,$NSprefix='',$reportDocTag=FALSE) {
2526                 static $firstLevelCache = array();
2527
2528                 $identifier = md5($string . $NSprefix . ($reportDocTag ? '1' : '0'));
2529
2530                         // look up in first level cache
2531                 if (!empty($firstLevelCache[$identifier])) {
2532                         $array = $firstLevelCache[$identifier];
2533                 } else {
2534                                 // look up in second level cache
2535                         $cacheContent = t3lib_pageSelect::getHash($identifier, 0);
2536                         $array = unserialize($cacheContent);
2537
2538                         if ($array === false) {
2539                                 $array = self::xml2arrayProcess($string, $NSprefix, $reportDocTag);
2540                                 t3lib_pageSelect::storeHash($identifier, serialize($array), 'ident_xml2array');
2541                         }
2542                                 // store content in first level cache
2543                         $firstLevelCache[$identifier] = $array;
2544                 }
2545                 return $array;
2546         }
2547
2548         /**
2549          * Converts an XML string to a PHP array.
2550          * This is the reverse function of array2xml()
2551          * Usage: 1
2552          *
2553          * @param       string          XML content to convert into an array
2554          * @param       string          The tag-prefix resolve, eg. a namespace like "T3:"
2555          * @param       boolean         If set, the document tag will be set in the key "_DOCUMENT_TAG" of the output array
2556          * @return      mixed           If the parsing had errors, a string with the error message is returned. Otherwise an array with the content.
2557          * @see array2xml()
2558          */
2559         protected function xml2arrayProcess($string,$NSprefix='',$reportDocTag=FALSE) {
2560                 global $TYPO3_CONF_VARS;
2561
2562                         // Create parser:
2563                 $parser = xml_parser_create();
2564                 $vals = array();
2565                 $index = array();
2566
2567                 xml_parser_set_option($parser, XML_OPTION_CASE_FOLDING, 0);
2568                 xml_parser_set_option($parser, XML_OPTION_SKIP_WHITE, 0);
2569
2570                         // default output charset is UTF-8, only ASCII, ISO-8859-1 and UTF-8 are supported!!!
2571                 $match = array();
2572                 preg_match('/^[[:space:]]*<\?xml[^>]*encoding[[:space:]]*=[[:space:]]*"([^"]*)"/',substr($string,0,200),$match);
2573                 $theCharset = $match[1] ? $match[1] : ($TYPO3_CONF_VARS['BE']['forceCharset'] ? $TYPO3_CONF_VARS['BE']['forceCharset'] : 'iso-8859-1');
2574                 xml_parser_set_option($parser, XML_OPTION_TARGET_ENCODING, $theCharset);  // us-ascii / utf-8 / iso-8859-1
2575
2576                         // Parse content:
2577                 xml_parse_into_struct($parser, $string, $vals, $index);
2578
2579                         // If error, return error message:
2580                 if (xml_get_error_code($parser))        {
2581                         return 'Line '.xml_get_current_line_number($parser).': '.xml_error_string(xml_get_error_code($parser));
2582                 }
2583                 xml_parser_free($parser);
2584
2585                         // Init vars:
2586                 $stack = array(array());
2587                 $stacktop = 0;
2588                 $current = array();
2589                 $tagName = '';
2590                 $documentTag = '';
2591
2592                         // Traverse the parsed XML structure:
2593                 foreach($vals as $key => $val) {
2594
2595                                 // First, process the tag-name (which is used in both cases, whether "complete" or "close")
2596                         $tagName = $val['tag'];
2597                         if (!$documentTag)      $documentTag = $tagName;
2598
2599                                 // Test for name space:
2600                         $tagName = ($NSprefix && substr($tagName,0,strlen($NSprefix))==$NSprefix) ? substr($tagName,strlen($NSprefix)) : $tagName;
2601
2602                                 // Test for numeric tag, encoded on the form "nXXX":
2603                         $testNtag = substr($tagName,1); // Closing tag.
2604                         $tagName = (substr($tagName,0,1)=='n' && !strcmp(intval($testNtag),$testNtag)) ? intval($testNtag) : $tagName;
2605
2606                                 // Test for alternative index value:
2607                         if (strlen($val['attributes']['index']))        { $tagName = $val['attributes']['index']; }
2608
2609                                 // Setting tag-values, manage stack:
2610                         switch($val['type'])    {
2611                                 case 'open':            // If open tag it means there is an array stored in sub-elements. Therefore increase the stackpointer and reset the accumulation array:
2612                                         $current[$tagName] = array();   // Setting blank place holder
2613                                         $stack[$stacktop++] = $current;
2614                                         $current = array();
2615                                 break;
2616                                 case 'close':   // If the tag is "close" then it is an array which is closing and we decrease the stack pointer.
2617                                         $oldCurrent = $current;
2618                                         $current = $stack[--$stacktop];
2619                                         end($current);  // Going to the end of array to get placeholder key, key($current), and fill in array next:
2620                                         $current[key($current)] = $oldCurrent;
2621                                         unset($oldCurrent);
2622                                 break;
2623                                 case 'complete':        // If "complete", then it's a value. If the attribute "base64" is set, then decode the value, otherwise just set it.
2624                                         if ($val['attributes']['base64'])       {
2625                                                 $current[$tagName] = base64_decode($val['value']);
2626                                         } else {
2627                                                 $current[$tagName] = (string)$val['value']; // Had to cast it as a string - otherwise it would be evaluate false if tested with isset()!!
2628
2629                                                         // Cast type:
2630                                                 switch((string)$val['attributes']['type'])      {
2631                                                         case 'integer':
2632                                                                 $current[$tagName] = (integer)$current[$tagName];
2633                                                         break;
2634                                                         case 'double':
2635                                                                 $current[$tagName] = (double)$current[$tagName];
2636                                                         break;
2637                                                         case 'boolean':
2638                                                                 $current[$tagName] = (bool)$current[$tagName];
2639                                                         break;
2640                                                         case 'array':
2641                                                                 $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...
2642                                                         break;
2643                                                 }
2644                                         }
2645                                 break;
2646                         }
2647                 }
2648
2649                 if ($reportDocTag)      {
2650                         $current[$tagName]['_DOCUMENT_TAG'] = $documentTag;
2651                 }
2652
2653                         // Finally return the content of the document tag.
2654                 return $current[$tagName];
2655         }
2656
2657         /**
2658          * This implodes an array of XML parts (made with xml_parse_into_struct()) into XML again.
2659          * Usage: 2
2660          *
2661          * @param       array           A array of XML parts, see xml2tree
2662          * @return      string          Re-compiled XML data.
2663          */
2664         public static function xmlRecompileFromStructValArray(array $vals)      {
2665                 $XMLcontent='';
2666
2667                 foreach($vals as $val) {
2668                         $type = $val['type'];
2669
2670                                 // open tag:
2671                         if ($type=='open' || $type=='complete') {
2672                                 $XMLcontent.='<'.$val['tag'];
2673                                 if(isset($val['attributes']))  {
2674                                         foreach($val['attributes'] as $k => $v) {
2675                                                 $XMLcontent.=' '.$k.'="'.htmlspecialchars($v).'"';
2676                                         }
2677                                 }
2678                                 if ($type=='complete')  {
2679                                         if(isset($val['value']))        {
2680                                                 $XMLcontent.='>'.htmlspecialchars($val['value']).'</'.$val['tag'].'>';
2681                                         } else $XMLcontent.='/>';
2682                                 } else $XMLcontent.='>';
2683
2684                                 if ($type=='open' && isset($val['value']))      {
2685                                         $XMLcontent.=htmlspecialchars($val['value']);
2686                                 }
2687                         }
2688                                 // finish tag:
2689                         if ($type=='close')     {
2690                                 $XMLcontent.='</'.$val['tag'].'>';
2691                         }
2692                                 // cdata
2693                         if($type=='cdata') {
2694                                 $XMLcontent.=htmlspecialchars($val['value']);
2695                         }
2696                 }
2697
2698                 return $XMLcontent;
2699         }
2700
2701         /**
2702          * Extracts the attributes (typically encoding and version) of an XML prologue (header).
2703          * Usage: 1
2704          *
2705          * @param       string          XML data
2706          * @return      array           Attributes of the xml prologue (header)
2707          */
2708         public static function xmlGetHeaderAttribs($xmlData)    {
2709                 $match = array();
2710                 if (preg_match('/^\s*<\?xml([^>]*)\?\>/', $xmlData, $match))    {
2711                         return self::get_tag_attributes($match[1]);
2712                 }
2713         }
2714
2715         /**
2716          * Minifies JavaScript
2717          *
2718          * @param       string  $script Script to minify
2719          * @param       string  $error  Error message (if any)
2720          * @return      string  Minified script or source string if error happened
2721          */
2722         public static function minifyJavaScript($script, &$error = '') {
2723                 require_once(PATH_typo3 . 'contrib/jsmin/jsmin.php');
2724                 try {
2725                         $error = '';
2726                         $script = trim(JSMin::minify(str_replace(CR, '', $script)));
2727                 }
2728                 catch(JSMinException $e) {
2729                         $error = 'Error while minifying JavaScript: ' . $e->getMessage();
2730                         self::devLog($error, 't3lib_div', 2,
2731                                 array('JavaScript' => $script, 'Stack trace' => $e->getTrace()));
2732                 }
2733                 return $script;
2734         }
2735
2736
2737
2738
2739
2740
2741
2742
2743         /*************************
2744          *
2745          * FILES FUNCTIONS
2746          *
2747          *************************/
2748
2749         /**
2750          * Reads the file or url $url and returns the content
2751          * If you are having trouble with proxys when reading URLs you can configure your way out of that with settings like $TYPO3_CONF_VARS['SYS']['curlUse'] etc.
2752          * Usage: 83
2753          *
2754          * @param       string          File/URL to read
2755          * @param       integer         Whether the HTTP header should be fetched or not. 0=disable, 1=fetch header+content, 2=fetch header only
2756          * @param       array                   HTTP headers to be used in the request
2757          * @param       array                   Error code/message and, if $includeHeader is 1, response meta data (HTTP status and content type)
2758          * @return      string  The content from the resource given as input. FALSE if an error has occured.
2759          */
2760         public static function getURL($url, $includeHeader = 0, $requestHeaders = false, &$report = NULL)       {
2761                 $content = false;
2762
2763                 if (isset($report))     {
2764                         $report['error'] = 0;
2765                         $report['message'] = '';
2766                 }
2767
2768                         // use cURL for: http, https, ftp, ftps, sftp and scp
2769                 if ($GLOBALS['TYPO3_CONF_VARS']['SYS']['curlUse'] == '1' && preg_match('/^(?:http|ftp)s?|s(?:ftp|cp):/', $url)) {
2770                         if (isset($report))     {
2771                                 $report['lib'] = 'cURL';
2772                         }
2773
2774                                 // External URL without error checking.
2775                         $ch = curl_init();
2776                         if (!$ch)       {
2777                                 if (isset($report))     {
2778                                         $report['error'] = -1;
2779                                         $report['message'] = 'Couldn\'t initialize cURL.';
2780                                 }
2781                                 return false;
2782                         }
2783
2784                         curl_setopt($ch, CURLOPT_URL, $url);
2785                         curl_setopt($ch, CURLOPT_HEADER, $includeHeader ? 1 : 0);
2786                         curl_setopt($ch, CURLOPT_NOBODY, $includeHeader == 2 ? 1 : 0);
2787                         curl_setopt($ch, CURLOPT_HTTPGET, $includeHeader == 2 ? 'HEAD' : 'GET');
2788                         curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
2789                         curl_setopt($ch, CURLOPT_FAILONERROR, 1);
2790
2791                                 // may fail (PHP 5.2.0+ and 5.1.5+) when open_basedir or safe_mode are enabled
2792                         $followLocation = @curl_setopt($ch, CURLOPT_FOLLOWLOCATION, 1);
2793
2794                         if (is_array($requestHeaders))  {
2795                                 curl_setopt($ch, CURLOPT_HTTPHEADER, $requestHeaders);
2796                         }
2797
2798                                 // (Proxy support implemented by Arco <arco@appeltaart.mine.nu>)
2799                         if ($GLOBALS['TYPO3_CONF_VARS']['SYS']['curlProxyServer'])      {
2800                                 curl_setopt($ch, CURLOPT_PROXY, $GLOBALS['TYPO3_CONF_VARS']['SYS']['curlProxyServer']);
2801
2802                                 if ($GLOBALS['TYPO3_CONF_VARS']['SYS']['curlProxyTunnel'])      {
2803                                         curl_setopt($ch, CURLOPT_HTTPPROXYTUNNEL, $GLOBALS['TYPO3_CONF_VARS']['SYS']['curlProxyTunnel']);
2804                                 }
2805                                 if ($GLOBALS['TYPO3_CONF_VARS']['SYS']['curlProxyUserPass'])    {
2806                                         curl_setopt($ch, CURLOPT_PROXYUSERPWD, $GLOBALS['TYPO3_CONF_VARS']['SYS']['curlProxyUserPass']);
2807                                 }
2808                         }
2809                         $content = curl_exec($ch);
2810                         if (isset($report))     {
2811                                 if ($content===FALSE)   {
2812                                         $report['error'] = curl_errno($ch);
2813                                         $report['message'] = curl_error($ch);
2814                                 } else {
2815                                         $curlInfo = curl_getinfo($ch);
2816                                                 // We hit a redirection but we couldn't follow it
2817                                         if (!$followLocation && $curlInfo['status'] >= 300 && $curlInfo['status'] < 400)         {
2818                                                 $report['error'] = -1;
2819                                                 $report['message'] = 'Couldn\'t follow location redirect (either PHP configuration option safe_mode or open_basedir is in effect).';
2820                                         } elseif($includeHeader) {
2821                                                         // Set only for $includeHeader to work exactly like PHP variant
2822                                                 $report['http_code'] = $curlInfo['http_code'];
2823                                                 $report['content_type'] = $curlInfo['content_type'];
2824                                         }
2825                                 }
2826                         }
2827                         curl_close($ch);
2828
2829                 } elseif ($includeHeader)       {
2830                         if (isset($report))     {
2831                                 $report['lib'] = 'socket';
2832                         }
2833                         $parsedURL = parse_url($url);
2834                         if (!preg_match('/^https?/', $parsedURL['scheme']))     {
2835                                 if (isset($report))     {
2836                                         $report['error'] = -1;
2837                                         $report['message'] = 'Reading headers is not allowed for this protocol.';
2838                                 }
2839                                 return false;
2840                         }
2841                         $port = intval($parsedURL['port']);
2842                         if ($port < 1)  {
2843                                 if ($parsedURL['scheme'] == 'http')     {
2844                                         $port = ($port>0 ? $port : 80);
2845                                         $scheme = '';
2846                                 } else {
2847                                         $port = ($port>0 ? $port : 443);
2848                                         $scheme = 'ssl://';
2849                                 }
2850                         }
2851                         $errno = 0;
2852                         // $errstr = '';
2853                         $fp = @fsockopen($scheme.$parsedURL['host'], $port, $errno, $errstr, 2.0);
2854                         if (!$fp || $errno > 0) {
2855                                 if (isset($report))     {
2856                                         $report['error'] = $errno ? $errno : -1;
2857                                         $report['message'] = $errno ? ($errstr ? $errstr : 'Socket error.') : 'Socket initialization error.';
2858                                 }
2859                                 return false;
2860                         }
2861                         $method = ($includeHeader == 2) ? 'HEAD' : 'GET';
2862                         $msg = $method . ' ' . $parsedURL['path'] .
2863                                         ($parsedURL['query'] ? '?' . $parsedURL['query'] : '') .
2864                                         ' HTTP/1.0' . CRLF . 'Host: ' .
2865                                         $parsedURL['host'] . "\r\nConnection: close\r\n";
2866                         if (is_array($requestHeaders))  {
2867                                 $msg .= implode(CRLF, $requestHeaders) . CRLF;
2868                         }
2869                         $msg .= CRLF;
2870
2871                         fputs($fp, $msg);
2872                         while (!feof($fp))      {
2873                                 $line = fgets($fp, 2048);
2874                                 if (isset($report))     {
2875                                         if (preg_match('|^HTTP/\d\.\d +(\d+)|', $line, $status))        {
2876                                                 $report['http_code'] = $status[1];
2877                                         }
2878                                         elseif (preg_match('/^Content-Type: *(.*)/i', $line, $type))    {
2879                                                 $report['content_type'] = $type[1];
2880                                         }
2881                                 }
2882                                 $content .= $line;
2883                                 if (!strlen(trim($line)))       {
2884                                         break;  // Stop at the first empty line (= end of header)
2885                                 }
2886                         }
2887                         if ($includeHeader != 2)        {
2888                                 $content .= stream_get_contents($fp);
2889                         }
2890                         fclose($fp);
2891
2892                 } elseif (is_array($requestHeaders))    {
2893                         if (isset($report))     {
2894                                 $report['lib'] = 'file/context';
2895                         }
2896                         $parsedURL = parse_url($url);
2897                         if (!preg_match('/^https?/', $parsedURL['scheme']))     {
2898                                 if (isset($report))     {
2899                                         $report['error'] = -1;
2900                                         $report['message'] = 'Sending request headers is not allowed for this protocol.';
2901                                 }
2902                                 return false;
2903                         }
2904                         $ctx = stream_context_create(array(
2905                                                 'http' => array(
2906                                                         'header' => implode(CRLF, $requestHeaders)
2907                                                 )
2908                                         )
2909                                 );
2910                         $content = @file_get_contents($url, false, $ctx);
2911                         if ($content === false && isset($report)) {
2912                                 $phpError = error_get_last();
2913                                 $report['error'] = $phpError['type'];
2914                                 $report['message'] = $phpError['message'];
2915                         }
2916                 } else  {
2917                         if (isset($report))     {
2918                                 $report['lib'] = 'file';
2919                         }
2920                         $content = @file_get_contents($url);
2921                         if ($content === false && isset($report))       {
2922                                 if (function_exists('error_get_last')) {
2923                                         $phpError = error_get_last();
2924                                         $report['error'] = $phpError['type'];
2925                                         $report['message'] = $phpError['message'];
2926                                 } else {
2927                                         $report['error'] = -1;
2928                                         $report['message'] = 'Couldn\'t get URL.';
2929                                 }
2930                         }
2931                 }
2932
2933                 return $content;
2934         }
2935
2936         /**
2937          * Writes $content to the file $file
2938          * Usage: 30
2939          *
2940          * @param       string          Filepath to write to
2941          * @param       string          Content to write
2942          * @return      boolean         True if the file was successfully opened and written to.
2943          */
2944         public static function writeFile($file,$content)        {
2945                 if (!@is_file($file))   $changePermissions = true;
2946
2947                 if ($fd = fopen($file,'wb'))    {
2948                         $res = fwrite($fd,$content);
2949                         fclose($fd);
2950
2951                         if ($res===false)       return false;
2952
2953                         if ($changePermissions) {       // Change the permissions only if the file has just been created
2954                                 self::fixPermissions($file);
2955                         }
2956
2957                         return true;
2958                 }
2959
2960                 return false;
2961         }
2962
2963         /**
2964          * Sets the file system mode and group ownership of a file or a folder.
2965          *
2966          * @param   string   Absolute filepath of file or folder, must not be escaped.
2967          * @param   boolean  If set, also fixes permissions of files and folders in the folder (if $path is a folder)
2968          * @return  mixed    TRUE on success, FALSE on error, always TRUE on Windows OS
2969          */
2970         public static function fixPermissions($path, $recursive = FALSE) {
2971                 if (TYPO3_OS != 'WIN') {
2972                         $result = FALSE;
2973                         if (self::isAllowedAbsPath($path)) {
2974                                 if (@is_file($path)) {
2975                                                 // "@" is there because file is not necessarily OWNED by the user
2976                                         $result = @chmod($path, octdec($GLOBALS['TYPO3_CONF_VARS']['BE']['fileCreateMask']));
2977                                 } elseif (@is_dir($path)) {
2978                                         $path = preg_replace('|/$|', '', $path);
2979                                                 // "@" is there because file is not necessarily OWNED by the user
2980                                         $result = @chmod($path, octdec($GLOBALS['TYPO3_CONF_VARS']['BE']['folderCreateMask']));
2981                                 }
2982
2983                                         // Set createGroup if not empty
2984                                 if($GLOBALS['TYPO3_CONF_VARS']['BE']['createGroup']) {
2985                                                 // "@" is there because file is not necessarily OWNED by the user
2986                                         $changeGroupResult = @chgrp($path, $GLOBALS['TYPO3_CONF_VARS']['BE']['createGroup']);
2987                                         $result = $changeGroupResult ? $result : FALSE;
2988                                 }
2989
2990                                         // Call recursive if recursive flag if set and $path is directory
2991                                 if ($recursive && @is_dir($path)) {
2992                                         $handle = opendir($path);
2993                                         while (($file = readdir($handle)) !== FALSE) {
2994                                                 unset($recursionResult);
2995                                                 if ($file !== '.' && $file !== '..') {
2996                                                         if (@is_file($path . '/' . $file)) {
2997                                                                 $recursionResult = t3lib_div::fixPermissions($path . '/' . $file);
2998                                                         } elseif (@is_dir($path . '/' . $file)) {
2999                                                                 $recursionResult = t3lib_div::fixPermissions($path . '/' . $file, TRUE);
3000                                                         }
3001                                                         if (isset($recursionResult) && !$recursionResult) {
3002                                                                 $result = FALSE;
3003                                                         }
3004                                                 }
3005                                         }
3006                                         closedir($handle);
3007                                 }
3008                         }
3009                 } else {
3010                         $result = TRUE;
3011                 }
3012                 return $result;
3013         }
3014
3015         /**
3016          * Writes $content to a filename in the typo3temp/ folder (and possibly one or two subfolders...)
3017          * Accepts an additional subdirectory in the file path!
3018          *
3019          * @param       string          Absolute filepath to write to inside "typo3temp/". First part of this string must match PATH_site."typo3temp/"
3020          * @param       string          Content string to write
3021          * @return      string          Returns false on success, otherwise an error string telling about the problem.
3022          */
3023         public static function writeFileToTypo3tempDir($filepath,$content)      {
3024
3025                         // Parse filepath into directory and basename:
3026                 $fI = pathinfo($filepath);
3027                 $fI['dirname'].= '/';
3028
3029                         // Check parts:
3030                 if (self::validPathStr($filepath) && $fI['basename'] && strlen($fI['basename'])<60)     {
3031                         if (defined('PATH_site'))       {
3032                                 $dirName = PATH_site.'typo3temp/';      // Setting main temporary directory name (standard)
3033                                 if (@is_dir($dirName))  {
3034                                         if (self::isFirstPartOfStr($fI['dirname'],$dirName))    {
3035
3036                                                         // Checking if the "subdir" is found:
3037                                                 $subdir = substr($fI['dirname'],strlen($dirName));
3038                                                 if ($subdir)    {
3039                                                         if (preg_match('/^[[:alnum:]_]+\/$/',$subdir) || preg_match('/^[[:alnum:]_]+\/[[:alnum:]_]+\/$/',$subdir))      {
3040                                                                 $dirName.= $subdir;
3041                                                                 if (!@is_dir($dirName)) {
3042                                                                         self::mkdir_deep(PATH_site.'typo3temp/', $subdir);
3043                                                                 }
3044                                                         } else return 'Subdir, "'.$subdir.'", was NOT on the form "[[:alnum:]_]/" or  "[[:alnum:]_]/[[:alnum:]_]/"';
3045                                                 }
3046                                                         // Checking dir-name again (sub-dir might have been created):
3047                                                 if (@is_dir($dirName))  {
3048                                                         if ($filepath == $dirName.$fI['basename'])      {
3049                                                                 self::writeFile($filepath, $content);
3050                                                                 if (!@is_file($filepath))       return 'File not written to disk! Write permission error in filesystem?';
3051                                                         } else return 'Calculated filelocation didn\'t match input $filepath!';
3052                                                 } else return '"'.$dirName.'" is not a directory!';
3053                                         } else return '"'.$fI['dirname'].'" was not within directory PATH_site + "typo3temp/"';
3054                                 } else return 'PATH_site + "typo3temp/" was not a directory!';
3055                         } else return 'PATH_site constant was NOT defined!';
3056                 } else return 'Input filepath "'.$filepath.'" was generally invalid!';
3057         }
3058
3059         /**
3060          * Wrapper function for mkdir.
3061          * Sets folder permissions according to $GLOBALS['TYPO3_CONF_VARS']['BE']['folderCreateMask']
3062          * and group ownership according to $GLOBALS['TYPO3_CONF_VARS']['BE']['createGroup']
3063          *
3064          * @param       string          Absolute path to folder, see PHP mkdir() function. Removes trailing slash internally.
3065          * @return      boolean         TRUE if @mkdir went well!
3066          */
3067         public static function mkdir($newFolder) {
3068                 $newFolder = preg_replace('|/$|', '', $newFolder);
3069                 $result = @mkdir($newFolder, octdec($GLOBALS['TYPO3_CONF_VARS']['BE']['folderCreateMask']));
3070                 if ($result) {
3071                         self::fixPermissions($newFolder);
3072                 }
3073                 return $result;
3074         }
3075
3076         /**
3077          * Creates a directory - including parent directories if necessary - in the file system
3078          *
3079          * @param       string          Base folder. This must exist! Must have trailing slash! Example "/root/typo3site/"
3080          * @param       string          Deep directory to create, eg. "xx/yy/" which creates "/root/typo3site/xx/yy/" if $destination is "/root/typo3site/"
3081          * @return      string          If error, returns error string.
3082          */
3083         public static function mkdir_deep($destination,$deepDir)        {
3084                 $allParts = self::trimExplode('/',$deepDir,1);
3085                 $root = '';
3086                 foreach($allParts as $part)     {
3087                         $root.= $part.'/';
3088                         if (!is_dir($destination.$root))        {
3089                                 self::mkdir($destination.$root);
3090                                 if (!@is_dir($destination.$root))       {
3091                                         return 'Error: The directory "'.$destination.$root.'" could not be created...';
3092                                 }
3093                         }
3094                 }
3095         }
3096
3097         /**
3098          * Wrapper function for rmdir, allowing recursive deletion of folders and files
3099          *
3100          * @param       string          Absolute path to folder, see PHP rmdir() function. Removes trailing slash internally.
3101          * @param       boolean         Allow deletion of non-empty directories
3102          * @return      boolean         true if @rmdir went well!
3103          */
3104         public static function rmdir($path,$removeNonEmpty=false)       {
3105                 $OK = false;
3106                 $path = preg_replace('|/$|','',$path);  // Remove trailing slash
3107
3108                 if (file_exists($path)) {
3109                         $OK = true;
3110
3111                         if (is_dir($path))      {
3112                                 if ($removeNonEmpty==true && $handle = opendir($path))  {
3113                                         while ($OK && false !== ($file = readdir($handle)))     {
3114                                                 if ($file=='.' || $file=='..') continue;
3115                                                 $OK = self::rmdir($path.'/'.$file,$removeNonEmpty);
3116                                         }
3117                                         closedir($handle);
3118                                 }
3119                                 if ($OK)        { $OK = rmdir($path); }
3120
3121                         } else {        // If $dirname is a file, simply remove it
3122                                 $OK = unlink($path);
3123                         }
3124
3125                         clearstatcache();
3126                 }
3127
3128                 return $OK;
3129         }
3130
3131         /**
3132          * Returns an array with the names of folders in a specific path
3133          * Will return 'error' (string) if there were an error with reading directory content.
3134          * Usage: 11
3135          *
3136          * @param       string          Path to list directories from
3137          * @return      array           Returns an array with the directory entries as values. If no path, the return value is nothing.
3138          */
3139         public static function get_dirs($path)  {
3140                 if ($path) {
3141                         if (is_dir($path)) {
3142                                 $dir = scandir($path);
3143                                 $dirs = array();
3144                                 foreach ($dir as $entry) {
3145                                         if (is_dir($path . '/' . $entry) && $entry != '..' && $entry != '.') {
3146                                                 $dirs[] = $entry;
3147                                         }
3148                                 }
3149                         } else {
3150                                 $dirs = 'error';
3151                         }
3152                 }
3153                 return $dirs;
3154         }
3155
3156         /**
3157          * Returns an array with the names of files in a specific path
3158          * Usage: 18
3159          *
3160          * @param       string          $path: Is the path to the file
3161          * @param       string          $extensionList is the comma list of extensions to read only (blank = all)
3162          * @param       boolean         If set, then the path is prepended the filenames. Otherwise only the filenames are returned in the array
3163          * @param       string          $order is sorting: 1= sort alphabetically, 'mtime' = sort by modification time.
3164          * @param       string          A comma seperated list of filenames to exclude, no wildcards
3165          * @return      array           Array of the files found
3166          */
3167         public static function getFilesInDir($path,$extensionList='',$prependPath=0,$order='',$excludePattern='')       {
3168
3169                         // Initialize variabels:
3170                 $filearray = array();
3171                 $sortarray = array();
3172                 $path = rtrim($path, '/');
3173
3174                         // Find files+directories:
3175                 if (@is_dir($path))     {
3176                         $extensionList = strtolower($extensionList);
3177                         $d = dir($path);
3178                         if (is_object($d))      {
3179                                 while($entry=$d->read()) {
3180                                         if (@is_file($path.'/'.$entry)) {
3181                                                 $fI = pathinfo($entry);
3182                                                 $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)
3183                                                 if ((!strlen($extensionList) || self::inList($extensionList,strtolower($fI['extension']))) && (!strlen($excludePattern) || !preg_match('/^'.$excludePattern.'$/',$entry)))      {
3184                                                         $filearray[$key]=($prependPath?$path.'/':'').$entry;
3185                                                                 if ($order=='mtime') {$sortarray[$key]=filemtime($path.'/'.$entry);}
3186                                                                 elseif ($order) {$sortarray[$key]=$entry;}
3187                                                 }
3188                                         }
3189                                 }
3190                                 $d->close();
3191                         } else return 'error opening path: "'.$path.'"';
3192                 }
3193
3194                         // Sort them:
3195                 if ($order) {
3196                         asort($sortarray);
3197                         $newArr=array();
3198                         foreach ($sortarray as $k => $v) {
3199                                 $newArr[$k]=$filearray[$k];
3200                         }
3201                         $filearray=$newArr;
3202                 }
3203
3204                         // Return result
3205                 reset($filearray);
3206                 return $filearray;
3207         }
3208
3209         /**
3210          * Recursively gather all files and folders of a path.
3211          * Usage: 5
3212          *
3213          * @param       array           $fileArr: Empty input array (will have files added to it)
3214          * @param       string          $path: The path to read recursively from (absolute) (include trailing slash!)
3215          * @param       string          $extList: Comma list of file extensions: Only files with extensions in this list (if applicable) will be selected.
3216          * @param       boolean         $regDirs: If set, directories are also included in output.
3217          * @param       integer         $recursivityLevels: The number of levels to dig down...
3218          * @param string                $excludePattern: regex pattern of files/directories to exclude
3219          * @return      array           An array with the found files/directories.
3220          */
3221         public static function getAllFilesAndFoldersInPath(array $fileArr,$path,$extList='',$regDirs=0,$recursivityLevels=99,$excludePattern='')        {
3222                 if ($regDirs)   $fileArr[] = $path;
3223                 $fileArr = array_merge($fileArr, self::getFilesInDir($path,$extList,1,1,$excludePattern));
3224
3225                 $dirs = self::get_dirs($path);
3226                 if (is_array($dirs) && $recursivityLevels>0)    {
3227                         foreach ($dirs as $subdirs)     {
3228                                 if ((string)$subdirs!='' && (!strlen($excludePattern) || !preg_match('/^'.$excludePattern.'$/',$subdirs)))      {
3229                                         $fileArr = self::getAllFilesAndFoldersInPath($fileArr,$path.$subdirs.'/',$extList,$regDirs,$recursivityLevels-1,$excludePattern);
3230