2 /***************************************************************
5 * (c) 1999-2008 Kasper Skaarhoj (kasperYYYY@typo3.com)
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.
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.
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.
25 * This copyright notice MUST APPEAR in all copies of the script!
26 ***************************************************************/
28 * Contains the reknown class "t3lib_div" with general purpose functions
31 * Revised for TYPO3 3.6 July/2003 by Kasper Skaarhoj
33 * Usage counts are based on search 22/2 2003 through whole source including tslib/
35 * @author Kasper Skaarhoj <kasperYYYY@typo3.com>
38 * [CLASS/FUNCTION INDEX of SCRIPT]
42 * 232: class t3lib_div
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)
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)
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="\n",$charWidth=76)
62 * 574: function breakLinesForEmail($str,$implChar="\n",$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)
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='"')
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)
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)
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='')
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='')
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)
200 * TOTAL FUNCTIONS: 138
201 * (This index is automatically created/updated by the extension "extdeveval")
217 * The legendary "t3lib_div" class - Miscellaneous functions for general purpose.
218 * Most of the functions does not relate specifically to TYPO3
219 * However a section of functions requires certain TYPO3 features available
220 * See comments in the source.
221 * You are encouraged to use this library in your own scripts!
224 * The class is intended to be used without creating an instance of it.
225 * So: Don't instantiate - call functions with "t3lib_div::" prefixed the function name.
226 * So use t3lib_div::[method-name] to refer to the functions, eg. 't3lib_div::milliseconds()'
228 * @author Kasper Skaarhoj <kasperYYYY@typo3.com>
238 /*************************
243 * Input GET/POST variables in PHP may have their quotes escaped with "\" or not depending on configuration.
244 * TYPO3 has always converted quotes to BE escaped if the configuration told that they would not be so.
245 * But the clean solution is that quotes are never escaped and that is what the functions below offers.
246 * Eventually TYPO3 should provide this in the global space as well.
247 * In the transitional phase (or forever..?) we need to encourage EVERY to read and write GET/POST vars through the API functions below.
249 *************************/
252 * Returns the 'GLOBAL' value of incoming data from POST or GET, with priority to POST (that is equalent to 'GP' order)
253 * Strips slashes from all output, both strings and arrays.
254 * This function substitutes t3lib_div::GPvar()
255 * 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 * @param string GET/POST var to return
259 * @return mixed POST var named $var and if not set, the GET var of the same name.
262 public static function _GP($var) {
263 if(empty($var)) return;
264 $value = isset($_POST[$var]) ?
$_POST[$var] : $_GET[$var];
266 if (is_array($value)) { t3lib_div
::stripSlashesOnArray($value); } else { $value = stripslashes($value); }
272 * Returns the global GET array (or value from) normalized to contain un-escaped values.
273 * ALWAYS use this API function to acquire the GET variables!
276 * @param string Optional pointer to value in GET array (basically name of GET var)
277 * @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!*
278 * @see _POST(), _GP(), _GETset()
280 public static function _GET($var=NULL) {
281 $value = ($var === NULL) ?
$_GET : (empty($var) ?
NULL : $_GET[$var]);
282 if (isset($value)) { // Removes slashes since TYPO3 has added them regardless of magic_quotes setting.
283 if (is_array($value)) { t3lib_div
::stripSlashesOnArray($value); } else { $value = stripslashes($value); }
289 * Returns the global POST array (or value from) normalized to contain un-escaped values.
290 * ALWAYS use this API function to acquire the POST variables!
293 * @param string Optional pointer to value in POST array (basically name of POST var)
294 * @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!*
297 public static function _POST($var=NULL) {
298 $value = ($var === NULL) ?
$_POST : (empty($var) ?
NULL : $_POST[$var]);
299 if (isset($value)) { // Removes slashes since TYPO3 has added them regardless of magic_quotes setting.
300 if (is_array($value)) { t3lib_div
::stripSlashesOnArray($value); } else { $value = stripslashes($value); }
306 * Writes input value to $_GET
309 * @param array Array to write to $_GET. Values should NOT be escaped at input time (but will be escaped before writing according to TYPO3 standards).
310 * @param string Alternative key; If set, this will not set the WHOLE GET array, but only the key in it specified by this value!
313 public static function _GETset(array $inputGet,$key='') {
314 // ADDS slashes since TYPO3 standard currently is that slashes MUST be applied (regardless of magic_quotes setting).
315 if (strcmp($key,'')) {
316 if (is_array($inputGet)) { t3lib_div
::addSlashesOnArray($inputGet); } else { $inputGet = addslashes($inputGet); }
317 $GLOBALS['HTTP_GET_VARS'][$key] = $_GET[$key] = $inputGet;
318 } elseif (is_array($inputGet)){
319 t3lib_div
::addSlashesOnArray($inputGet);
320 $GLOBALS['HTTP_GET_VARS'] = $_GET = $inputGet;
326 * Returns the 'GLOBAL' value of incoming data from POST or GET, with priority to POST (that is equalent to 'GP' order)
327 * Strips slashes of string-outputs, but not arrays UNLESS $strip is set. If $strip is set all output will have escaped characters unescaped.
330 * @param string GET/POST var to return
331 * @param boolean If set, values are stripped of return values that are *arrays!* - string/integer values returned are always strip-slashed()
332 * @return mixed POST var named $var and if not set, the GET var of the same name.
333 * @deprecated Use t3lib_div::_GP instead (ALWAYS delivers a value with un-escaped values!)
336 public static function GPvar($var,$strip=0) {
337 if(empty($var)) return;
338 $value = isset($_POST[$var]) ?
$_POST[$var] : $_GET[$var];
339 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.
340 if ($strip && isset($value) && is_array($value)) { t3lib_div
::stripSlashesOnArray($value); }
345 * Returns the GET/POST global arrays merged with POST taking precedence.
348 * @param string Key (variable name) from GET or POST vars
349 * @return array Returns the GET vars merged recursively onto the POST vars.
353 public static function GParrayMerged($var) {
354 $postA = is_array($_POST[$var]) ?
$_POST[$var] : array();
355 $getA = is_array($_GET[$var]) ?
$_GET[$var] : array();
356 $mergedA = t3lib_div
::array_merge_recursive_overrule($getA,$postA);
357 t3lib_div
::stripSlashesOnArray($mergedA);
362 * Wrapper for the RemoveXSS function.
363 * Removes potential XSS code from an input string.
365 * Using an external class by Travis Puderbaugh <kallahar@quickwired.com>
367 * @param string Input string
368 * @return string Input string with potential XSS code removed
370 public function removeXSS($string) {
371 require_once(PATH_typo3
.'contrib/RemoveXSS/RemoveXSS.php');
372 $string = RemoveXSS
::RemoveXSS($string);
385 /*************************
389 *************************/
393 * Compressing a GIF file if not already LZW compressed
394 * 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)
396 * The function takes a file-reference, $theFile, and saves it again through GD or ImageMagick in order to compress the file
398 * 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!)
399 * If $type is set to either 'IM' or 'GD' the compression is done with ImageMagick and GD respectively
403 * $theFile is expected to be a valid GIF-file!
404 * The function returns a code for the operation.
407 * @param string Filepath
408 * @param string See description of function
409 * @return string Returns "GD" if GD was used, otherwise "IM" if ImageMagick was used. If nothing done at all, it returns empty string.
412 public static function gif_compress($theFile, $type) {
413 $gfxConf = $GLOBALS['TYPO3_CONF_VARS']['GFX'];
415 if ($gfxConf['gif_compress'] && strtolower(substr($theFile,-4,4))=='.gif') { // GIF...
416 if (($type=='IM' ||
!$type) && $gfxConf['im'] && $gfxConf['im_path_lzw']) { // IM
417 $cmd = t3lib_div
::imageMagickCommand('convert', '"'.$theFile.'" "'.$theFile.'"', $gfxConf['im_path_lzw']);
421 } elseif (($type=='GD' ||
!$type) && $gfxConf['gdlib'] && !$gfxConf['gdlib_png']) { // GD
422 $tempImage = imageCreateFromGif($theFile);
423 imageGif($tempImage, $theFile);
424 imageDestroy($tempImage);
432 * Converts a png file to gif
433 * This converts a png file to gif IF the FLAG $GLOBALS['TYPO3_CONF_VARS']['FE']['png_to_gif'] is set true.
436 * @param string $theFile the filename with path
437 * @return string new filename
440 public static function png_to_gif_by_imagemagick($theFile) {
441 if ($GLOBALS['TYPO3_CONF_VARS']['FE']['png_to_gif']
442 && $GLOBALS['TYPO3_CONF_VARS']['GFX']['im']
443 && $GLOBALS['TYPO3_CONF_VARS']['GFX']['im_path_lzw']
444 && strtolower(substr($theFile,-4,4))=='.png'
445 && @is_file
($theFile)) { // IM
446 $newFile = substr($theFile,0,-4).'.gif';
447 $cmd = t3lib_div
::imageMagickCommand('convert', '"'.$theFile.'" "'.$newFile.'"', $GLOBALS['TYPO3_CONF_VARS']['GFX']['im_path_lzw']);
450 // 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!!
456 * Returns filename of the png/gif version of the input file (which can be png or gif).
457 * If input file type does not match the wanted output type a conversion is made and temp-filename returned.
460 * @param string Filepath of image file
461 * @param boolean If set, then input file is converted to PNG, otherwise to GIF
462 * @return string If the new image file exists, it's filepath is returned
465 public static function read_png_gif($theFile,$output_png=0) {
466 if ($GLOBALS['TYPO3_CONF_VARS']['GFX']['im'] && @is_file
($theFile)) {
467 $ext = strtolower(substr($theFile,-4,4));
469 ((string)$ext=='.png' && $output_png) ||
470 ((string)$ext=='.gif' && !$output_png)
474 $newFile = PATH_site
.'typo3temp/readPG_'.md5($theFile.'|'.filemtime($theFile)).($output_png?
'.png':'.gif');
475 $cmd = t3lib_div
::imageMagickCommand('convert', '"'.$theFile.'" "'.$newFile.'"', $GLOBALS['TYPO3_CONF_VARS']['GFX']['im_path']);
477 if (@is_file
($newFile)) return $newFile;
496 /*************************
500 *************************/
504 * Returns a new string of max. $chars length.
505 * If the string is longer, it will be truncated and appended with '...'.
508 * @param string string to truncate
509 * @param integer must be an integer with an absolute value of at least 4. if negative the string is cropped from the right end.
510 * @param string String to append to the output if it is truncated, default is '...'
511 * @return string new string
512 * @deprecated Works ONLY for single-byte charsets! USE t3lib_div::fixed_lgd_cs() instead
513 * @see fixed_lgd_pre()
515 public static function fixed_lgd($string,$origChars,$preStr='...') {
516 $chars = abs($origChars);
518 if(strlen($string)>$chars) {
519 return $origChars < 0 ?
520 $preStr.trim(substr($string, -($chars-3))) :
521 trim(substr($string, 0, $chars-3)).$preStr;
529 * Returns a new string of max. $chars length.
530 * If the string is longer, it will be truncated and prepended with '...'.
531 * This works like fixed_lgd, but is truncated in the start of the string instead of the end
534 * @param string string to truncate
535 * @param integer must be an integer of at least 4
536 * @return string new string
537 * @deprecated Use either fixed_lgd() or fixed_lgd_cs() (with negative input value for $chars)
540 public static function fixed_lgd_pre($string,$chars) {
541 return strrev(t3lib_div
::fixed_lgd(strrev($string),$chars));
545 * Truncates a string with appended/prepended "..." and takes backend character set into consideration
546 * Use only from backend!
549 * @param string string to truncate
550 * @param integer must be an integer with an absolute value of at least 4. if negative the string is cropped from the right end.
551 * @return string New string
554 public static function fixed_lgd_cs($string,$chars) {
555 if (is_object($GLOBALS['LANG'])) {
556 return $GLOBALS['LANG']->csConvObj
->crop($GLOBALS['LANG']->charSet
,$string,$chars,'...');
558 return t3lib_div
::fixed_lgd($string, $chars);
563 * Breaks up the text for emails
566 * @param string The string to break up
567 * @param string The string to implode the broken lines with (default/typically \n)
568 * @param integer The line length
569 * @deprecated Use PHP function wordwrap()
572 public static function breakTextForEmail($str,$implChar="\n",$charWidth=76) {
573 $lines = explode(chr(10),$str);
575 while(list(,$lStr)=each($lines)) {
576 $outArr[] = t3lib_div
::breakLinesForEmail($lStr,$implChar,$charWidth);
578 return implode(chr(10),$outArr);
582 * Breaks up a single line of text for emails
585 * @param string The string to break up
586 * @param string The string to implode the broken lines with (default/typically \n)
587 * @param integer The line length
589 * @see breakTextForEmail()
591 public static function breakLinesForEmail($str,$implChar="\n",$charWidth=76) {
595 while(strlen($str)>$p) {
596 $substr=substr($str,$p,$l);
597 if (strlen($substr)==$l) {
598 $count = count(explode(' ',trim(strrev($substr))));
599 if ($count>1) { // OK...
600 $parts = explode(' ',strrev($substr),2);
601 $theLine = strrev($parts[1]);
603 $afterParts = explode(' ',substr($str,$l+
$p),2);
604 $theLine = $substr.$afterParts[0];
606 if (!strlen($theLine)) {break; } // Error, because this would keep us in an endless loop.
611 $lines[]=trim($theLine);
612 $p+
=strlen($theLine);
613 if (!trim(substr($str,$p,$l))) break; // added...
615 return implode($implChar,$lines);
619 * Match IP number with list of numbers with wildcard
620 * Dispatcher method for switching into specialised IPv4 and IPv6 methods.
623 * @param string $baseIP is the current remote IP address for instance, typ. REMOTE_ADDR
624 * @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.
625 * @return boolean True if an IP-mask from $list matches $baseIP
627 public static function cmpIP($baseIP, $list) {
628 if ($list==='*') return TRUE;
629 if (strstr($baseIP, ':') && t3lib_div
::validIPv6($baseIP)) {
630 return t3lib_div
::cmpIPv6($baseIP, $list);
632 return t3lib_div
::cmpIPv4($baseIP, $list);
637 * Match IPv4 number with list of numbers with wildcard
639 * @param string $baseIP is the current remote IP address for instance, typ. REMOTE_ADDR
640 * @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)
641 * @return boolean True if an IP-mask from $list matches $baseIP
643 public static function cmpIPv4($baseIP, $list) {
644 $IPpartsReq = explode('.',$baseIP);
645 if (count($IPpartsReq)==4) {
646 $values = t3lib_div
::trimExplode(',',$list,1);
648 foreach($values as $test) {
649 list($test,$mask) = explode('/',$test);
653 $lnet = ip2long($test);
654 $lip = ip2long($baseIP);
655 $binnet = str_pad( decbin($lnet),32,'0','STR_PAD_LEFT');
656 $firstpart = substr($binnet,0,$mask);
657 $binip = str_pad( decbin($lip),32,'0','STR_PAD_LEFT');
658 $firstip = substr($binip,0,$mask);
659 $yes = (strcmp($firstpart,$firstip)==0);
662 $IPparts = explode('.',$test);
665 while(list($index,$val)=each($IPparts)) {
667 if (strcmp($val,'*') && strcmp($IPpartsReq[$index],$val)) {
672 if ($yes) return true;
679 * Match IPv6 address with a list of IPv6 prefixes
681 * @param string $baseIP is the current remote IP address for instance
682 * @param string $list is a comma-list of IPv6 prefixes, could also contain IPv4 addresses
683 * @return boolean True if an baseIP matches any prefix
685 public static function cmpIPv6($baseIP, $list) {
686 $success = false; // Policy default: Deny connection
687 $baseIP = t3lib_div
::normalizeIPv6($baseIP);
689 $values = t3lib_div
::trimExplode(',',$list,1);
690 foreach ($values as $test) {
691 list($test,$mask) = explode('/',$test);
692 if (t3lib_div
::validIPv6($test)) {
693 $test = t3lib_div
::normalizeIPv6($test);
695 switch ($mask) { // test on /48 /64
697 $testBin = substr(t3lib_div
::IPv6Hex2Bin($test), 0, 48);
698 $baseIPBin = substr(t3lib_div
::IPv6Hex2Bin($baseIP), 0, 48);
699 $success = strcmp($testBin, $baseIPBin)==0 ?
true : false;
702 $testBin = substr(t3lib_div
::IPv6Hex2Bin($test), 0, 64);
703 $baseIPBin = substr(t3lib_div
::IPv6Hex2Bin($baseIP), 0, 64);
704 $success = strcmp($testBin, $baseIPBin)==0 ?
true : false;
710 if (t3lib_div
::validIPv6($test)) { // test on full ip address 128 bits
711 $testBin = t3lib_div
::IPv6Hex2Bin($test);
712 $baseIPBin = t3lib_div
::IPv6Hex2Bin($baseIP);
713 $success = strcmp($testBin, $baseIPBin)==0 ?
true : false;
717 if ($success) return true;
723 * [Describe function...]
725 * @param [type] $hex: ...
728 public static function IPv6Hex2Bin ($hex) {
730 $hex = str_replace(':', '', $hex); // Replace colon to nothing
731 for ($i=0; $i<strlen($hex); $i=$i+
2) {
732 $bin.= chr(hexdec(substr($hex, $i, 2)));
738 * Normalize an IPv6 address to full length
740 * @param string Given IPv6 address
741 * @return string Normalized address
743 public static function normalizeIPv6($address) {
744 $normalizedAddress = '';
745 $stageOneAddress = '';
747 $chunks = explode('::', $address); // Count 2 if if address has hidden zero blocks
748 if (count($chunks)==2) {
749 $chunksLeft = explode(':', $chunks[0]);
750 $chunksRight = explode(':', $chunks[1]);
751 $left = count($chunksLeft);
752 $right = count($chunksRight);
754 // Special case: leading zero-only blocks count to 1, should be 0
755 if ($left==1 && strlen($chunksLeft[0])==0) $left=0;
757 $hiddenBlocks = 8 - ($left +
$right);
759 while ($h<$hiddenBlocks) {
760 $hiddenPart .= '0000:';
765 $stageOneAddress = $hiddenPart . $chunks[1];
767 $stageOneAddress = $chunks[0] . ':' . $hiddenPart . $chunks[1];
769 } else $stageOneAddress = $address;
771 // normalize the blocks:
772 $blocks = explode(':', $stageOneAddress);
774 foreach ($blocks as $block) {
777 $hiddenZeros = 4 - strlen($block);
778 while ($i < $hiddenZeros) {
782 $normalizedAddress .= $tmpBlock . $block;
783 if ($divCounter < 7) {
784 $normalizedAddress .= ':';
788 return $normalizedAddress;
792 * Validate a given IP address to the IPv6 address format.
794 * Example for possible format: 43FB::BB3F:A0A0:0 | ::1
796 * @param string IP address to be tested
797 * @return boolean True if $ip is of IPv6 format.
799 public static function validIPv6($ip) {
800 $uppercaseIP = strtoupper($ip);
803 $regex.= '(([\dA-F]{1,4}:){7}[\dA-F]{1,4})|';
804 $regex.= '(([\dA-F]{1,4}){1}::([\dA-F]{1,4}:){1,5}[\dA-F]{1,4})|';
805 $regex.= '(([\dA-F]{1,4}:){2}:([\dA-F]{1,4}:){1,4}[\dA-F]{1,4})|';
806 $regex.= '(([\dA-F]{1,4}:){3}:([\dA-F]{1,4}:){1,3}[\dA-F]{1,4})|';
807 $regex.= '(([\dA-F]{1,4}:){4}:([\dA-F]{1,4}:){1,2}[\dA-F]{1,4})|';
808 $regex.= '(([\dA-F]{1,4}:){5}:([\dA-F]{1,4}:){0,1}[\dA-F]{1,4})|';
809 $regex.= '(::([\dA-F]{1,4}:){0,6}[\dA-F]{1,4})';
812 return preg_match($regex, $uppercaseIP) ?
true : false;
816 * Match fully qualified domain name with list of strings with wildcard
818 * @param string The current remote IP address for instance, typ. REMOTE_ADDR
819 * @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)
820 * @return boolean True if a domain name mask from $list matches $baseIP
822 public static function cmpFQDN($baseIP, $list) {
823 if (count(explode('.',$baseIP))==4) {
824 $resolvedHostName = explode('.', gethostbyaddr($baseIP));
825 $values = t3lib_div
::trimExplode(',',$list,1);
827 foreach($values as $test) {
828 $hostNameParts = explode('.',$test);
831 foreach($hostNameParts as $index => $val) {
833 if (strcmp($val,'*') && strcmp($resolvedHostName[$index],$val)) {
837 if ($yes) return true;
844 * Check for item in list
845 * Check if an item exists in a comma-separated list of items.
848 * @param string comma-separated list of items (string)
849 * @param string item to check for
850 * @return boolean true if $item is in $list
852 public static function inList($list,$item) {
853 return strstr(','.$list.',', ','.$item.',') ?
true : false;
857 * Removes an item from a comma-separated list of items.
860 * @param string element to remove
861 * @param string comma-separated list of items (string)
862 * @return string new comma-separated list of items
864 public static function rmFromList($element,$list) {
865 $items = explode(',',$list);
866 while(list($k,$v)=each($items)) {
867 if ($v==$element) {unset($items[$k]);}
869 return implode(',',$items);
873 * Expand a comma-separated list of integers with ranges (eg 1,3-5,7 becomes 1,3,4,5,7).
874 * Ranges are limited to 1000 values per range.
876 * @param string comma-separated list of integers with ranges (string)
877 * @return string new comma-separated list of items
878 * @author Martin Kutschker <martin.kutschker@activesolution.at>
880 public static function expandList($list) {
881 $items = explode(',',$list);
883 while(list(,$item)=each($items)) {
884 $range = explode('-',$item);
885 if (isset($range[1])) {
886 $runAwayBrake = 1000;
887 for ($n=$range[0]; $n<=$range[1]; $n++
) {
891 if ($runAwayBrake<=0) break;
898 return implode(',',$list);
902 * Forces the integer $theInt into the boundaries of $min and $max. If the $theInt is 'false' then the $zeroValue is applied.
905 * @param integer Input value
906 * @param integer Lower limit
907 * @param integer Higher limit
908 * @param integer Default value if input is false.
909 * @return integer The input value forced into the boundaries of $min and $max
911 public static function intInRange($theInt,$min,$max=2000000000,$zeroValue=0) {
912 // Returns $theInt as an integer in the integerspace from $min to $max
913 $theInt = intval($theInt);
914 if ($zeroValue && !$theInt) {$theInt=$zeroValue;} // If the input value is zero after being converted to integer, zeroValue may set another default value for it.
915 if ($theInt<$min){$theInt=$min;}
916 if ($theInt>$max){$theInt=$max;}
921 * Returns the $integer if greater than zero, otherwise returns zero.
924 * @param integer Integer string to process
927 public static function intval_positive($theInt) {
928 $theInt = intval($theInt);
929 if ($theInt<0){$theInt=0;}
934 * Returns an integer from a three part version number, eg '4.12.3' -> 4012003
937 * @param string Version number on format x.x.x
938 * @return integer Integer version of version number (where each part can count to 999)
940 public static function int_from_ver($verNumberStr) {
941 $verParts = explode('.',$verNumberStr);
942 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
));
946 * Returns true if the current TYPO3 version (or compatibility version) is compatible to the input version
947 * Notice that this function compares branches, not versions (4.0.1 would be > 4.0.0 although they use the same compat_version)
949 * @param string Minimum branch number required (format x.y / e.g. "4.0" NOT "4.0.0"!)
950 * @return boolean Returns true if this setup is compatible with the provided version number
951 * @todo Still needs a function to convert versions to branches
953 public static function compat_version($verNumberStr) {
954 global $TYPO3_CONF_VARS;
955 $currVersionStr = $TYPO3_CONF_VARS['SYS']['compat_version'] ?
$TYPO3_CONF_VARS['SYS']['compat_version'] : TYPO3_branch
;
957 if (t3lib_div
::int_from_ver($currVersionStr) < t3lib_div
::int_from_ver($verNumberStr)) {
965 * Makes a positive integer hash out of the first 7 chars from the md5 hash of the input
968 * @param string String to md5-hash
969 * @return integer Returns 28bit integer-hash
971 public static function md5int($str) {
972 return hexdec(substr(md5($str),0,7));
976 * Returns the first 10 positions of the MD5-hash (changed from 6 to 10 recently)
980 * @param string Input string to be md5-hashed
981 * @param integer The string-length of the output
982 * @return string Substring of the resulting md5-hash, being $len chars long (from beginning)
984 public static function shortMD5($input, $len=10) {
985 return substr(md5($input),0,$len);
989 * Takes comma-separated lists and arrays and removes all duplicates
990 * If a value in the list is trim(empty), the value is ignored.
993 * @param string Accept multiple parameters wich can be comma-separated lists of values and arrays.
994 * @param mixed $secondParameter: Dummy field, which if set will show a warning!
995 * @return string Returns the list without any duplicates of values, space around values are trimmed
997 public static function uniqueList($in_list, $secondParameter=NULL) {
998 if (is_array($in_list)) die('t3lib_div::uniqueList() does NOT support array arguments anymore! Only string comma lists!');
999 if (isset($secondParameter)) die('t3lib_div::uniqueList() does NOT support more than a single argument value anymore. You have specified more than one.');
1001 return implode(',',array_unique(t3lib_div
::trimExplode(',',$in_list,1)));
1005 * Splits a reference to a file in 5 parts
1008 * @param string Filename/filepath to be analysed
1009 * @return array Contains keys [path], [file], [filebody], [fileext], [realFileext]
1011 public static function split_fileref($fileref) {
1013 if ( ereg('(.*/)(.*)$',$fileref,$reg) ) {
1014 $info['path'] = $reg[1];
1015 $info['file'] = $reg[2];
1018 $info['file'] = $fileref;
1021 if ( ereg('(.*)\.([^\.]*$)',$info['file'],$reg) ) {
1022 $info['filebody'] = $reg[1];
1023 $info['fileext'] = strtolower($reg[2]);
1024 $info['realFileext'] = $reg[2];
1026 $info['filebody'] = $info['file'];
1027 $info['fileext'] = '';
1034 * Returns the directory part of a path without trailing slash
1035 * If there is no dir-part, then an empty string is returned.
1038 * '/dir1/dir2/script.php' => '/dir1/dir2'
1039 * '/dir1/' => '/dir1'
1040 * 'dir1/script.php' => 'dir1'
1041 * 'd/script.php' => 'd'
1042 * '/script.php' => ''
1046 * @param string Directory name / path
1047 * @return string Processed input value. See function description.
1049 public static function dirname($path) {
1050 $p=t3lib_div
::revExplode('/',$path,2);
1051 return count($p)==2?
$p[0]:'';
1055 * Modifies a HTML Hex color by adding/subtracting $R,$G and $B integers
1058 * @param string A hexadecimal color code, #xxxxxx
1059 * @param integer Offset value 0-255
1060 * @param integer Offset value 0-255
1061 * @param integer Offset value 0-255
1062 * @return string A hexadecimal color code, #xxxxxx, modified according to input vars
1063 * @see modifyHTMLColorAll()
1065 public static function modifyHTMLColor($color,$R,$G,$B) {
1066 // This takes a hex-color (# included!) and adds $R, $G and $B to the HTML-color (format: #xxxxxx) and returns the new color
1067 $nR = t3lib_div
::intInRange(hexdec(substr($color,1,2))+
$R,0,255);
1068 $nG = t3lib_div
::intInRange(hexdec(substr($color,3,2))+
$G,0,255);
1069 $nB = t3lib_div
::intInRange(hexdec(substr($color,5,2))+
$B,0,255);
1071 substr('0'.dechex($nR),-2).
1072 substr('0'.dechex($nG),-2).
1073 substr('0'.dechex($nB),-2);
1077 * Modifies a HTML Hex color by adding/subtracting $all integer from all R/G/B channels
1080 * @param string A hexadecimal color code, #xxxxxx
1081 * @param integer Offset value 0-255 for all three channels.
1082 * @return string A hexadecimal color code, #xxxxxx, modified according to input vars
1083 * @see modifyHTMLColor()
1085 public static function modifyHTMLColorAll($color,$all) {
1086 return t3lib_div
::modifyHTMLColor($color,$all,$all,$all);
1090 * Removes comma (if present) in the end of string
1093 * @param string String from which the comma in the end (if any) will be removed.
1096 public static function rm_endcomma($string) {
1097 return ereg_replace(',$','',$string);
1101 * strtoupper which converts danish (and other characters) characters as well
1104 * @param string String to process
1106 * @deprecated Use t3lib_cs::conv_case() instead or for HTML output, wrap your content in <span class="uppercase">...</span>)
1109 public static function danish_strtoupper($string) {
1110 $value = strtoupper($string);
1111 return strtr($value, 'áéúíâêûôîæøåäöü', 'ÁÉÚÍÄËÜÖÏÆØÅÄÖÜ');
1115 * Change umlaut characters to plain ASCII with normally two character target
1116 * Only known characters will be converted, so don't expect a result for any character.
1120 * @param string String to convert.
1121 * @deprecated Works only for western europe single-byte charsets! Use t3lib_cs::specCharsToASCII() instead!
1124 public static function convUmlauts($str) {
1125 $pat = array ( '/ä/', '/Ä/', '/ö/', '/Ö/', '/ü/', '/Ü/', '/ß/', '/å/', '/Å/', '/ø/', '/Ø/', '/æ/', '/Æ/' );
1126 $repl = array ( 'ae', 'Ae', 'oe', 'Oe', 'ue', 'Ue', 'ss', 'aa', 'AA', 'oe', 'OE', 'ae', 'AE' );
1127 return preg_replace($pat,$repl,$str);
1131 * Tests if the input is an integer.
1134 * @param mixed Any input variable to test.
1135 * @return boolean Returns true if string is an integer
1137 public static function testInt($var) {
1138 return !strcmp($var,intval($var));
1142 * Returns true if the first part of $str matches the string $partStr
1145 * @param string Full string to check
1146 * @param string Reference string which must be found as the "first part" of the full string
1147 * @return boolean True if $partStr was found to be equal to the first part of $str
1149 public static function isFirstPartOfStr($str,$partStr) {
1150 // Returns true, if the first part of a $str equals $partStr and $partStr is not ''
1151 $psLen = strlen($partStr);
1153 return substr($str,0,$psLen)==(string)$partStr;
1154 } else return false;
1158 * Formats the input integer $sizeInBytes as bytes/kilobytes/megabytes (-/K/M)
1161 * @param integer Number of bytes to format.
1162 * @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)
1163 * @return string Formatted representation of the byte number, for output.
1165 public static function formatSize($sizeInBytes,$labels='') {
1168 if (strlen($labels) == 0) {
1169 $labels = ' | K| M| G';
1171 $labels = str_replace('"','',$labels);
1173 $labelArr = explode('|',$labels);
1176 if ($sizeInBytes>900) {
1177 if ($sizeInBytes>900000000) { // GB
1178 $val = $sizeInBytes/(1024*1024*1024);
1179 return number_format($val, (($val<20)?
1:0), '.', '').$labelArr[3];
1181 elseif ($sizeInBytes>900000) { // MB
1182 $val = $sizeInBytes/(1024*1024);
1183 return number_format($val, (($val<20)?
1:0), '.', '').$labelArr[2];
1185 $val = $sizeInBytes/(1024);
1186 return number_format($val, (($val<20)?
1:0), '.', '').$labelArr[1];
1189 return $sizeInBytes.$labelArr[0];
1194 * Returns microtime input to milliseconds
1197 * @param string Microtime
1198 * @return integer Microtime input string converted to an integer (milliseconds)
1200 public static function convertMicrotime($microtime) {
1201 $parts = explode(' ',$microtime);
1202 return round(($parts[0]+
$parts[1])*1000);
1206 * This splits a string by the chars in $operators (typical /+-*) and returns an array with them in
1209 * @param string Input string, eg "123 + 456 / 789 - 4"
1210 * @param string Operators to split by, typically "/+-*"
1211 * @return array Array with operators and operands separated.
1212 * @see tslib_cObj::calc(), tslib_gifBuilder::calcOffset()
1214 public static function splitCalc($string,$operators) {
1218 $valueLen=strcspn($string,$operators);
1219 $value=substr($string,0,$valueLen);
1220 $res[] = Array($sign,trim($value));
1221 $sign=substr($string,$valueLen,1);
1222 $string=substr($string,$valueLen+
1);
1229 * Calculates the input by +,-,*,/,%,^ with priority to + and -
1232 * @param string Input string, eg "123 + 456 / 789 - 4"
1233 * @return integer Calculated value. Or error string.
1234 * @see calcParenthesis()
1236 public static function calcPriority($string) {
1237 $string=ereg_replace('[[:space:]]*','',$string); // removing all whitespace
1238 $string='+'.$string; // Ensuring an operator for the first entrance
1240 $regex = '(['.$qm.'])(['.$qm.']?[0-9\.]*)';
1241 // split the expression here:
1243 preg_match_all('/'.$regex.'/',$string,$reg);
1249 $buffer=doubleval(current($reg[2]));
1250 next($reg[2]); // Advance pointer
1251 while(list($k,$v)=each($reg[2])) {
1253 $sign = $reg[1][$k];
1254 if ($sign=='+' ||
$sign=='-') {
1255 $number = $Msign=='-' ?
$number-=$buffer : $number+
=$buffer;
1259 if ($sign=='/') {if ($v) $buffer/=$v; else $err='dividing by zero';}
1260 if ($sign=='%') {if ($v) $buffer%
=$v; else $err='dividing by zero';}
1261 if ($sign=='*') {$buffer*=$v;}
1262 if ($sign=='^') {$buffer=pow($buffer,$v);}
1265 $number = $Msign=='-' ?
$number-=$buffer : $number+
=$buffer;
1266 return $err ?
'ERROR: '.$err : $number;
1270 * Calculates the input with parenthesis levels
1273 * @param string Input string, eg "(123 + 456) / 789 - 4"
1274 * @return integer Calculated value. Or error string.
1275 * @see calcPriority(), tslib_cObj::stdWrap()
1277 public static function calcParenthesis($string) {
1280 $valueLenO=strcspn($string,'(');
1281 $valueLenC=strcspn($string,')');
1282 if ($valueLenC==strlen($string) ||
$valueLenC < $valueLenO) {
1283 $value = t3lib_div
::calcPriority(substr($string,0,$valueLenC));
1284 $string = $value.substr($string,$valueLenC+
1);
1287 $string = substr($string,0,$valueLenO).t3lib_div
::calcParenthesis(substr($string,$valueLenO+
1));
1291 if ($securC<=0) break;
1292 } while($valueLenO<strlen($string));
1297 * Inverse version of htmlspecialchars()
1300 * @param string Value where >, <, " and & should be converted to regular chars.
1301 * @return string Converted result.
1303 public static function htmlspecialchars_decode($value) {
1304 $value = str_replace('>','>',$value);
1305 $value = str_replace('<','<',$value);
1306 $value = str_replace('"','"',$value);
1307 $value = str_replace('&','&',$value);
1312 * Re-converts HTML entities if they have been converted by htmlspecialchars()
1315 * @param string String which contains eg. "&amp;" which should stay "&". Or "&#1234;" to "Ӓ". Or "&#x1b;" to ""
1316 * @return string Converted result.
1318 public static function deHSCentities($str) {
1319 return ereg_replace('&([#[:alnum:]]*;)','&\1',$str);
1323 * This function is used to escape any ' -characters when transferring text to JavaScript!
1326 * @param string String to escape
1327 * @param boolean If set, also backslashes are escaped.
1328 * @param string The character to escape, default is ' (single-quote)
1329 * @return string Processed input string
1331 public static function slashJS($string,$extended=0,$char="'") {
1332 if ($extended) {$string = str_replace ("\\", "\\\\", $string);}
1333 return str_replace ($char, "\\".$char, $string);
1337 * Version of rawurlencode() where all spaces (%20) are re-converted to space-characters.
1338 * Usefull when passing text to JavaScript where you simply url-encode it to get around problems with syntax-errors, linebreaks etc.
1341 * @param string String to raw-url-encode with spaces preserved
1342 * @return string Rawurlencoded result of input string, but with all %20 (space chars) converted to real spaces.
1344 public static function rawUrlEncodeJS($str) {
1345 return str_replace('%20',' ',rawurlencode($str));
1349 * rawurlencode which preserves "/" chars
1350 * Usefull when filepaths should keep the "/" chars, but have all other special chars encoded.
1353 * @param string Input string
1354 * @return string Output string
1356 public static function rawUrlEncodeFP($str) {
1357 return str_replace('%2F','/',rawurlencode($str));
1361 * Checking syntax of input email address
1364 * @param string Input string to evaluate
1365 * @return boolean Returns true if the $email address (input string) is valid; Has a "@", domain name with at least one period and only allowed a-z characters.
1367 public static function validEmail($email) {
1368 $email = trim ($email);
1369 if (strstr($email,' ')) return FALSE;
1370 return ereg('^[A-Za-z0-9\._-]+[@][A-Za-z0-9\._-]+[\.].[A-Za-z0-9]+$',$email) ?
TRUE : FALSE;
1374 * Formats a string for output between <textarea>-tags
1375 * All content outputted in a textarea form should be passed through this function
1376 * 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!
1379 * @param string Input string to be formatted.
1380 * @return string Formatted for <textarea>-tags
1382 public static function formatForTextarea($content) {
1383 return chr(10).htmlspecialchars($content);
1397 /*************************
1401 *************************/
1404 * Check if an item exists in an array
1405 * Please note that the order of parameters is reverse compared to the php4-function in_array()!!!
1408 * @param array one-dimensional array of items
1409 * @param string item to check for
1410 * @return boolean true if $item is in the one-dimensional array $in_array
1413 public static function inArray(array $in_array,$item) {
1414 while (list(,$val)=each($in_array)) {
1415 if (!is_array($val) && !strcmp($val,$item)) return true;
1420 * Explodes a $string delimited by $delim and passes each item in the array through intval().
1421 * Corresponds to explode(), but with conversion to integers for all values.
1424 * @param string Delimiter string to explode with
1425 * @param string The string to explode
1426 * @return array Exploded values, all converted to integers
1428 public static function intExplode($delim, $string) {
1429 $temp = explode($delim,$string);
1430 while(list($key,$val)=each($temp)) {
1431 $temp[$key]=intval($val);
1438 * Reverse explode which explodes the string counting from behind.
1439 * Thus t3lib_div::revExplode(':','my:words:here',2) will return array('my:words','here')
1442 * @param string Delimiter string to explode with
1443 * @param string The string to explode
1444 * @param integer Number of array entries
1445 * @return array Exploded values
1447 public static function revExplode($delim, $string, $count=0) {
1448 $temp = explode($delim,strrev($string),$count);
1449 while(list($key,$val)=each($temp)) {
1450 $temp[$key]=strrev($val);
1452 $temp = array_reverse($temp);
1458 * Explodes a string and trims all values for whitespace in the ends.
1459 * If $onlyNonEmptyValues is set, then all blank ('') values are removed.
1462 * @param string Delimiter string to explode with
1463 * @param string The string to explode
1464 * @param boolean If set, all empty values (='') will NOT be set in output
1465 * @return array Exploded values
1467 public static function trimExplode($delim, $string, $onlyNonEmptyValues=0) {
1468 $array = explode($delim, $string);
1469 // for two perfomance reasons the loop is duplicated
1470 // a) avoid check for $onlyNonEmptyValues in foreach loop
1471 // b) avoid unnecessary code when $onlyNonEmptyValues is not set
1472 if ($onlyNonEmptyValues) {
1473 $new_array = array();
1474 foreach($array as $value) {
1475 $value = trim($value);
1477 $new_array[] = $value;
1480 // direct return for perfomance reasons
1484 foreach($array as &$value) {
1485 $value = trim($value);
1492 * Remove duplicate values from an array
1495 * @param array Array of values to make unique
1498 * @deprecated Use the PHP function array_unique instead
1500 public static function uniqueArray(array $valueArray) {
1501 return array_unique($valueArray);
1505 * Removes the value $cmpValue from the $array if found there. Returns the modified array
1508 * @param array Array containing the values
1509 * @param string Value to search for and if found remove array entry where found.
1510 * @return array Output array with entries removed if search string is found
1512 public static function removeArrayEntryByValue(array $array, $cmpValue) {
1514 while(list($k,$v)=each($array)) {
1516 $array[$k] = t3lib_div
::removeArrayEntryByValue($v,$cmpValue);
1518 if (!strcmp($v,$cmpValue)) {
1528 * Implodes a multidim-array into GET-parameters (eg. ¶m[key][key2]=value2¶m[key][key3]=value3)
1531 * @param string Name prefix for entries. Set to blank if you wish none.
1532 * @param array The (multidim) array to implode
1533 * @param string (keep blank)
1534 * @param boolean If set, parameters which were blank strings would be removed.
1535 * @param boolean If set, the param name itself (for example "param[key][key2]") would be rawurlencoded as well.
1536 * @return string Imploded result, fx. ¶m[key][key2]=value2¶m[key][key3]=value3
1537 * @see explodeUrl2Array()
1539 public static function implodeArrayForUrl($name,array $theArray,$str='',$skipBlank=0,$rawurlencodeParamName=0) {
1540 foreach($theArray as $Akey => $AVal) {
1541 $thisKeyName = $name ?
$name.'['.$Akey.']' : $Akey;
1542 if (is_array($AVal)) {
1543 $str = t3lib_div
::implodeArrayForUrl($thisKeyName,$AVal,$str,$skipBlank,$rawurlencodeParamName);
1545 if (!$skipBlank ||
strcmp($AVal,'')) {
1546 $str.='&'.($rawurlencodeParamName ?
rawurlencode($thisKeyName) : $thisKeyName).
1547 '='.rawurlencode($AVal);
1555 * Explodes a string with GETvars (eg. "&id=1&type=2&ext[mykey]=3") into an array
1557 * @param string GETvars string
1558 * @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())
1559 * @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!
1560 * @see implodeArrayForUrl()
1562 public static function explodeUrl2Array($string,$multidim=FALSE) {
1565 parse_str($string,$output);
1567 $p = explode('&',$string);
1570 list($pK,$pV) = explode('=',$v,2);
1571 $output[rawurldecode($pK)] = rawurldecode($pV);
1579 * Returns an array with selected keys from incoming data.
1580 * (Better read source code if you want to find out...)
1583 * @param string List of variable/key names
1584 * @param array Array from where to get values based on the keys in $varList
1585 * @param boolean If set, then t3lib_div::_GP() is used to fetch the value if not found (isset) in the $getArray
1586 * @return array Output array with selected variables.
1588 public static function compileSelectedGetVarsFromArray($varList,array $getArray,$GPvarAlt=1) {
1589 $keys = t3lib_div
::trimExplode(',',$varList,1);
1591 foreach($keys as $v) {
1592 if (isset($getArray[$v])) {
1593 $outArr[$v] = $getArray[$v];
1594 } elseif ($GPvarAlt) {
1595 $outArr[$v] = t3lib_div
::_GP($v);
1603 * This function traverses a multidimentional array and adds slashes to the values.
1604 * NOTE that the input array is and argument by reference.!!
1605 * Twin-function to stripSlashesOnArray
1608 * @param array Multidimensional input array, (REFERENCE!)
1611 public static function addSlashesOnArray(array &$theArray) {
1613 while(list($Akey,$AVal)=each($theArray)) {
1614 if (is_array($AVal)) {
1615 t3lib_div
::addSlashesOnArray($theArray[$Akey]);
1617 $theArray[$Akey] = addslashes($AVal);
1625 * This function traverses a multidimentional array and strips slashes to the values.
1626 * NOTE that the input array is and argument by reference.!!
1627 * Twin-function to addSlashesOnArray
1630 * @param array Multidimensional input array, (REFERENCE!)
1633 public static function stripSlashesOnArray(array &$theArray) {
1635 while(list($Akey,$AVal)=each($theArray)) {
1636 if (is_array($AVal)) {
1637 t3lib_div
::stripSlashesOnArray($theArray[$Akey]);
1639 $theArray[$Akey] = stripslashes($AVal);
1646 * Either slashes ($cmd=add) or strips ($cmd=strip) array $arr depending on $cmd
1649 * @param array Multidimensional input array
1650 * @param string "add" or "strip", depending on usage you wish.
1653 public static function slashArray(array $arr,$cmd) {
1654 if ($cmd=='strip') t3lib_div
::stripSlashesOnArray($arr);
1655 if ($cmd=='add') t3lib_div
::addSlashesOnArray($arr);
1660 * Merges two arrays recursively and "binary safe" (integer keys are overridden as well), overruling similar values in the first array ($arr0) with the values of the second array ($arr1)
1661 * In case of identical keys, ie. keeping the values of the second.
1664 * @param array First array
1665 * @param array Second array, overruling the first array
1666 * @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.
1667 * @param boolean If set, values from $arr1 will overrule if they are empty or zero. Default: true
1668 * @return array Resulting array where $arr1 values has overruled $arr0 values
1670 public static function array_merge_recursive_overrule(array $arr0,array $arr1,$notAddKeys=0,$includeEmtpyValues=true) {
1672 while(list($key,$val) = each($arr1)) {
1673 if(is_array($arr0[$key])) {
1674 if (is_array($arr1[$key])) {
1675 $arr0[$key] = t3lib_div
::array_merge_recursive_overrule($arr0[$key],$arr1[$key],$notAddKeys,$includeEmtpyValues);
1679 if (isset($arr0[$key])) {
1680 if ($includeEmtpyValues ||
$val) {
1685 if ($includeEmtpyValues ||
$val) {
1696 * 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.
1699 * @param array First array
1700 * @param array Second array
1701 * @return array Merged result.
1703 public static function array_merge(array $arr1,array $arr2) {
1708 * Takes a row and returns a CSV string of the values with $delim (default is ,) and $quote (default is ") as separator chars.
1711 * @param array Input array of values
1712 * @param string Delimited, default is comman
1713 * @param string Quote-character to wrap around the values.
1714 * @return string A single line of CSV
1716 public static function csvValues(array $row,$delim=',',$quote='"') {
1719 foreach ($row as $value) {
1720 $out[] = str_replace($quote, $quote.$quote, $value);
1722 $str = $quote.implode($quote.$delim.$quote,$out).$quote;
1727 * Creates recursively a JSON literal from a mulidimensional associative array.
1728 * Uses Services_JSON (http://mike.teczno.com/JSON/doc/)
1730 * @param array $jsonArray: The array to be transformed to JSON
1731 * @return string JSON string
1733 public static function array2json(array $jsonArray) {
1734 if (!$GLOBALS['JSON']) {
1735 require_once(PATH_typo3
.'contrib/json/json.php');
1736 $GLOBALS['JSON'] = t3lib_div
::makeInstance('Services_JSON');
1738 return $GLOBALS['JSON']->encode($jsonArray);
1742 * Removes dots "." from end of a key identifier of TypoScript styled array.
1743 * array('key.' => array('property.' => 'value')) --> array('key' => array('property' => 'value'))
1745 * @param array $ts: TypoScript configuration array
1746 * @return array TypoScript configuration array without dots at the end of all keys
1748 public static function removeDotsFromTS(array $ts) {
1750 if (is_array($ts)) {
1751 foreach ($ts as $key => $value) {
1752 if (is_array($value)) {
1753 $key = rtrim($key, '.');
1754 $out[$key] = t3lib_div
::removeDotsFromTS($value);
1756 $out[$key] = $value;
1778 /*************************
1780 * HTML/XML PROCESSING
1782 *************************/
1785 * Returns an array with all attributes of the input HTML tag as key/value pairs. Attributes are only lowercase a-z
1786 * $tag is either a whole tag (eg '<TAG OPTION ATTRIB=VALUE>') or the parameterlist (ex ' OPTION ATTRIB=VALUE>')
1787 * If an attribute is empty, then the value for the key is empty. You can check if it existed with isset()
1790 * @param string HTML-tag string (or attributes only)
1791 * @return array Array with the attribute values.
1793 public static function get_tag_attributes($tag) {
1794 $components = t3lib_div
::split_tag_attributes($tag);
1795 $name = ''; // attribute name is stored here
1797 $attributes = array();
1798 foreach ($components as $key => $val) {
1799 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
1802 $attributes[$name] = $val;
1806 if ($key = strtolower(ereg_replace('[^a-zA-Z0-9]','',$val))) {
1807 $attributes[$key] = '';
1820 * Returns an array with the 'components' from an attribute list from an HTML tag. The result is normally analyzed by get_tag_attributes
1821 * Removes tag-name if found
1824 * @param string HTML-tag string (or attributes only)
1825 * @return array Array with the attribute values.
1828 public static function split_tag_attributes($tag) {
1829 $tag_tmp = trim(eregi_replace ('^<[^[:space:]]*','',trim($tag)));
1830 // Removes any > in the end of the string
1831 $tag_tmp = trim(eregi_replace ('>$','',$tag_tmp));
1834 while (strcmp($tag_tmp,'')) { // Compared with empty string instead , 030102
1835 $firstChar=substr($tag_tmp,0,1);
1836 if (!strcmp($firstChar,'"') ||
!strcmp($firstChar,"'")) {
1837 $reg=explode($firstChar,$tag_tmp,3);
1839 $tag_tmp=trim($reg[2]);
1840 } elseif (!strcmp($firstChar,'=')) {
1842 $tag_tmp = trim(substr($tag_tmp,1)); // Removes = chars.
1844 // There are '' around the value. We look for the next ' ' or '>'
1845 $reg = split('[[:space:]=]',$tag_tmp,2);
1846 $value[] = trim($reg[0]);
1847 $tag_tmp = trim(substr($tag_tmp,strlen($reg[0]),1).$reg[1]);
1855 * Implodes attributes in the array $arr for an attribute list in eg. and HTML tag (with quotes)
1858 * @param array Array with attribute key/value pairs, eg. "bgcolor"=>"red", "border"=>0
1859 * @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!
1860 * @param boolean If true, don't check if values are blank. Default is to omit attributes with blank values.
1861 * @return string Imploded attributes, eg. 'bgcolor="red" border="0"'
1863 public static function implodeAttributes(array $arr,$xhtmlSafe=FALSE,$dontOmitBlankAttribs=FALSE) {
1866 foreach($arr as $p => $v) {
1867 if (!isset($newArr[strtolower($p)])) $newArr[strtolower($p)] = htmlspecialchars($v);
1872 foreach($arr as $p => $v) {
1873 if (strcmp($v,'') ||
$dontOmitBlankAttribs) {$list[]=$p.'="'.$v.'"';}
1875 return implode(' ',$list);
1879 * Implodes attributes in the array $arr for an attribute list in eg. and HTML tag (with quotes)
1881 * @param array See implodeAttributes()
1882 * @param boolean See implodeAttributes()
1883 * @param boolean See implodeAttributes()
1884 * @return string See implodeAttributes()
1885 * @deprecated Name was changed into implodeAttributes
1886 * @see implodeAttributes()
1888 public static function implodeParams(array $arr,$xhtmlSafe=FALSE,$dontOmitBlankAttribs=FALSE) {
1889 return t3lib_div
::implodeAttributes($arr,$xhtmlSafe,$dontOmitBlankAttribs);
1893 * Wraps JavaScript code XHTML ready with <script>-tags
1894 * Automatic re-identing of the JS code is done by using the first line as ident reference.
1895 * This is nice for identing JS code with PHP code on the same level.
1897 * @param string JavaScript code
1898 * @param boolean Wrap script element in linebreaks? Default is TRUE.
1899 * @return string The wrapped JS code, ready to put into a XHTML page
1900 * @author Ingmar Schlecht <ingmars@web.de>
1901 * @author René Fritz <r.fritz@colorcube.de>
1903 public static function wrapJS($string, $linebreak=TRUE) {
1905 // <script wrapped in nl?
1906 $cr = $linebreak?
"\n" : '';
1908 // remove nl from the beginning
1909 $string = preg_replace ('/^\n+/', '', $string);
1910 // re-ident to one tab using the first line as reference
1912 if(preg_match('/^(\t+)/',$string,$match)) {
1913 $string = str_replace($match[1],"\t", $string);
1915 $string = $cr.'<script type="text/javascript">
1921 return trim($string);
1926 * Parses XML input into a PHP array with associative keys
1929 * @param string XML data input
1930 * @param integer Number of element levels to resolve the XML into an array. Any further structure will be set as XML.
1931 * @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.
1932 * @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
1934 public static function xml2tree($string,$depth=999) {
1935 $parser = xml_parser_create();
1939 xml_parser_set_option($parser, XML_OPTION_CASE_FOLDING
, 0);
1940 xml_parser_set_option($parser, XML_OPTION_SKIP_WHITE
, 0);
1941 xml_parse_into_struct($parser, $string, $vals, $index);
1943 if (xml_get_error_code($parser)) return 'Line '.xml_get_current_line_number($parser).': '.xml_error_string(xml_get_error_code($parser));
1944 xml_parser_free($parser);
1946 $stack = array( array() );
1950 // FIXME don't use unset() - what does that mean? Use NULL or similar.
1952 foreach($vals as $key => $val) {
1953 $type = $val['type'];
1956 if ($type=='open' ||
$type=='complete') {
1957 $stack[$stacktop++
] = $tagi;
1959 if ($depth==$stacktop) {
1963 $tagi = array('tag' => $val['tag']);
1965 if(isset($val['attributes'])) $tagi['attrs'] = $val['attributes'];
1966 if(isset($val['value'])) $tagi['values'][] = $val['value'];
1969 if ($type=='complete' ||
$type=='close') {
1971 $tagi = $stack[--$stacktop];
1972 $oldtag = $oldtagi['tag'];
1973 unset($oldtagi['tag']);
1975 if ($depth==($stacktop+
1)) {
1976 if ($key-$startPoint > 0) {
1977 $partArray = array_slice(
1982 #$oldtagi=array('XMLvalue'=>t3lib_div::xmlRecompileFromStructValArray($partArray));
1983 $oldtagi['XMLvalue']=t3lib_div
::xmlRecompileFromStructValArray($partArray);
1985 $oldtagi['XMLvalue']=$oldtagi['values'][0];
1989 $tagi['ch'][$oldtag][] = $oldtagi;
1993 if($type=='cdata') {
1994 $tagi['values'][] = $val['value'];
2001 * Turns PHP array into XML. See array2xml()
2003 * @param array The input PHP array with any kind of data; text, binary, integers. Not objects though.
2004 * @param string Alternative document tag. Default is "phparray".
2005 * @param array Options for the compilation. See array2xml() for description.
2006 * @param string Forced charset to prologue
2007 * @return string An XML string made from the input content in the array.
2008 * @see xml2array(),array2xml()
2010 public static function array2xml_cs(array $array,$docTag='phparray',array $options=array(),$charset='') {
2012 // Figure out charset if not given explicitly:
2014 if ($GLOBALS['TYPO3_CONF_VARS']['BE']['forceCharset']) { // First priority: forceCharset! If set, this will be authoritative!
2015 $charset = $GLOBALS['TYPO3_CONF_VARS']['BE']['forceCharset'];
2016 } elseif (is_object($GLOBALS['LANG'])) {
2017 $charset = $GLOBALS['LANG']->charSet
; // If "LANG" is around, that will hold the current charset
2019 $charset = 'iso-8859-1'; // THIS is just a hopeful guess!
2024 return '<?xml version="1.0" encoding="'.htmlspecialchars($charset).'" standalone="yes" ?>'.chr(10).
2025 t3lib_div
::array2xml($array,'',0,$docTag,0, $options);
2029 * Deprecated to call directly (unless you are aware of using XML prologues)! Use "array2xml_cs" instead (which adds an XML-prologue)
2031 * Converts a PHP array into an XML string.
2032 * The XML output is optimized for readability since associative keys are used as tagnames.
2033 * 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.
2034 * Numeric keys are stored with the default tagname "numIndex" but can be overridden to other formats)
2035 * 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
2036 * 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.
2037 * 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!
2038 * 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...
2041 * @param array The input PHP array with any kind of data; text, binary, integers. Not objects though.
2042 * @param string tag-prefix, eg. a namespace prefix like "T3:"
2043 * @param integer Current recursion level. Don't change, stay at zero!
2044 * @param string Alternative document tag. Default is "phparray".
2045 * @param integer If greater than zero, then the number of spaces corresponding to this number is used for indenting, if less than zero - no indentation, if zero - a single chr(9) (TAB) is used
2046 * @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')
2047 * @param string Stack data. Don't touch.
2048 * @return string An XML string made from the input content in the array.
2051 public static function array2xml(array $array,$NSprefix='',$level=0,$docTag='phparray',$spaceInd=0,array $options=array(),array $stackData=array()) {
2052 // 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
2053 $binaryChars = chr(0).chr(1).chr(2).chr(3).chr(4).chr(5).chr(6).chr(7).chr(8).
2054 chr(11).chr(12).chr(14).chr(15).chr(16).chr(17).chr(18).chr(19).
2055 chr(20).chr(21).chr(22).chr(23).chr(24).chr(25).chr(26).chr(27).chr(28).chr(29).
2057 // Set indenting mode:
2058 $indentChar = $spaceInd ?
' ' : chr(9);
2059 $indentN = $spaceInd>0 ?
$spaceInd : 1;
2060 $nl = ($spaceInd >= 0 ?
chr(10) : '');
2062 // Init output variable:
2065 // Traverse the input array
2066 foreach($array as $k=>$v) {
2070 // Construct the tag name.
2071 if(isset($options['grandParentTagMap'][$stackData['grandParentTagName'].'/'.$stackData['parentTagName']])) { // Use tag based on grand-parent + parent tag name
2072 $attr.=' index="'.htmlspecialchars($tagName).'"';
2073 $tagName = (string)$options['grandParentTagMap'][$stackData['grandParentTagName'].'/'.$stackData['parentTagName']];
2074 }elseif(isset($options['parentTagMap'][$stackData['parentTagName'].':_IS_NUM']) && t3lib_div
::testInt($tagName)) { // Use tag based on parent tag name + if current tag is numeric
2075 $attr.=' index="'.htmlspecialchars($tagName).'"';
2076 $tagName = (string)$options['parentTagMap'][$stackData['parentTagName'].':_IS_NUM'];
2077 }elseif(isset($options['parentTagMap'][$stackData['parentTagName'].':'.$tagName])) { // Use tag based on parent tag name + current tag
2078 $attr.=' index="'.htmlspecialchars($tagName).'"';
2079 $tagName = (string)$options['parentTagMap'][$stackData['parentTagName'].':'.$tagName];
2080 } elseif(isset($options['parentTagMap'][$stackData['parentTagName']])) { // Use tag based on parent tag name:
2081 $attr.=' index="'.htmlspecialchars($tagName).'"';
2082 $tagName = (string)$options['parentTagMap'][$stackData['parentTagName']];
2083 } elseif (!strcmp(intval($tagName),$tagName)) { // If integer...;
2084 if ($options['useNindex']) { // If numeric key, prefix "n"
2085 $tagName = 'n'.$tagName;
2086 } else { // Use special tag for num. keys:
2087 $attr.=' index="'.$tagName.'"';
2088 $tagName = $options['useIndexTagForNum'] ?
$options['useIndexTagForNum'] : 'numIndex';
2090 } elseif($options['useIndexTagForAssoc']) { // Use tag for all associative keys:
2091 $attr.=' index="'.htmlspecialchars($tagName).'"';
2092 $tagName = $options['useIndexTagForAssoc'];
2095 // The tag name is cleaned up so only alphanumeric chars (plus - and _) are in there and not longer than 100 chars either.
2096 $tagName = substr(ereg_replace('[^[:alnum:]_-]','',$tagName),0,100);
2098 // If the value is an array then we will call this function recursively:
2102 if ($options['alt_options'][$stackData['path'].'/'.$tagName]) {
2103 $subOptions = $options['alt_options'][$stackData['path'].'/'.$tagName];
2104 $clearStackPath = $subOptions['clearStackPath'];
2106 $subOptions = $options;
2107 $clearStackPath = FALSE;
2111 t3lib_div
::array2xml(
2119 'parentTagName' => $tagName,
2120 'grandParentTagName' => $stackData['parentTagName'],
2121 'path' => $clearStackPath ?
'' : $stackData['path'].'/'.$tagName,
2124 ($spaceInd >= 0 ?
str_pad('',($level+
1)*$indentN,$indentChar) : '');
2125 if ((int)$options['disableTypeAttrib']!=2) { // Do not set "type = array". Makes prettier XML but means that empty arrays are not restored with xml2array
2126 $attr.=' type="array"';
2128 } else { // Just a value:
2130 // Look for binary chars:
2131 $vLen = strlen($v); // check for length, because PHP 5.2.0 may crash when first argument of strcspn is empty
2132 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!
2133 // If the value contained binary chars then we base64-encode it an set an attribute to notify this situation:
2134 $content = $nl.chunk_split(base64_encode($v));
2135 $attr.=' base64="1"';
2137 // Otherwise, just htmlspecialchar the stuff:
2138 $content = htmlspecialchars($v);
2139 $dType = gettype($v);
2140 if ($dType == 'string') {
2141 if ($options['useCDATA'] && $content != $v) {
2142 $content = '<![CDATA[' . $v . ']]>';
2144 } elseif (!$options['disableTypeAttrib']) {
2145 $attr.= ' type="'.$dType.'"';
2150 // Add the element to the output string:
2151 $output.=($spaceInd >= 0 ?
str_pad('',($level+
1)*$indentN,$indentChar) : '').'<'.$NSprefix.$tagName.$attr.'>'.$content.'</'.$NSprefix.$tagName.'>'.$nl;
2154 // If we are at the outer-most level, then we finally wrap it all in the document tags and return that as the value:
2157 '<'.$docTag.'>'.$nl.
2166 * Converts an XML string to a PHP array.
2167 * This is the reverse function of array2xml()
2170 * @param string XML content to convert into an array
2171 * @param string The tag-prefix resolve, eg. a namespace like "T3:"
2172 * @param boolean If set, the document tag will be set in the key "_DOCUMENT_TAG" of the output array
2173 * @return mixed If the parsing had errors, a string with the error message is returned. Otherwise an array with the content.
2176 public static function xml2array($string,$NSprefix='',$reportDocTag=FALSE) {
2177 global $TYPO3_CONF_VARS;
2180 $parser = xml_parser_create();
2184 xml_parser_set_option($parser, XML_OPTION_CASE_FOLDING
, 0);
2185 xml_parser_set_option($parser, XML_OPTION_SKIP_WHITE
, 0);
2187 // PHP 5.0.0 & 5.0.1: default output charset is ISO-8859-1, only ASCII, ISO-8859-1 and UTF-8 are supported!!!
2188 // PHP 5.0.2+: default output charset is UTF-8 , only ASCII, ISO-8859-1 and UTF-8 are supported!!!
2190 preg_match('/^[[:space:]]*<\?xml[^>]*encoding[[:space:]]*=[[:space:]]*"([^"]*)"/',substr($string,0,200),$match);
2191 $theCharset = $match[1] ?
$match[1] : ($TYPO3_CONF_VARS['BE']['forceCharset'] ?
$TYPO3_CONF_VARS['BE']['forceCharset'] : 'iso-8859-1');
2192 xml_parser_set_option($parser, XML_OPTION_TARGET_ENCODING
, $theCharset); // us-ascii / utf-8 / iso-8859-1
2195 xml_parse_into_struct($parser, $string, $vals, $index);
2197 // If error, return error message:
2198 if (xml_get_error_code($parser)) {
2199 return 'Line '.xml_get_current_line_number($parser).': '.xml_error_string(xml_get_error_code($parser));
2201 xml_parser_free($parser);
2204 $stack = array(array());
2210 // Traverse the parsed XML structure:
2211 foreach($vals as $key => $val) {
2213 // First, process the tag-name (which is used in both cases, whether "complete" or "close")
2214 $tagName = $val['tag'];
2215 if (!$documentTag) $documentTag = $tagName;
2217 // Test for name space:
2218 $tagName = ($NSprefix && substr($tagName,0,strlen($NSprefix))==$NSprefix) ?
substr($tagName,strlen($NSprefix)) : $tagName;
2220 // Test for numeric tag, encoded on the form "nXXX":
2221 $testNtag = substr($tagName,1); // Closing tag.
2222 $tagName = (substr($tagName,0,1)=='n' && !strcmp(intval($testNtag),$testNtag)) ?
intval($testNtag) : $tagName;
2224 // Test for alternative index value:
2225 if (strlen($val['attributes']['index'])) { $tagName = $val['attributes']['index']; }
2227 // Setting tag-values, manage stack:
2228 switch($val['type']) {
2229 case 'open': // If open tag it means there is an array stored in sub-elements. Therefore increase the stackpointer and reset the accumulation array:
2230 $current[$tagName] = array(); // Setting blank place holder
2231 $stack[$stacktop++
] = $current;
2234 case 'close': // If the tag is "close" then it is an array which is closing and we decrease the stack pointer.
2235 $oldCurrent = $current;
2236 $current = $stack[--$stacktop];
2237 end($current); // Going to the end of array to get placeholder key, key($current), and fill in array next:
2238 $current[key($current)] = $oldCurrent;
2241 case 'complete': // If "complete", then it's a value. If the attribute "base64" is set, then decode the value, otherwise just set it.
2242 if ($val['attributes']['base64']) {
2243 $current[$tagName] = base64_decode($val['value']);
2245 $current[$tagName] = (string)$val['value']; // Had to cast it as a string - otherwise it would be evaluate false if tested with isset()!!
2248 switch((string)$val['attributes']['type']) {
2250 $current[$tagName] = (integer)$current[$tagName];
2253 $current[$tagName] = (double)$current[$tagName];
2256 $current[$tagName] = (bool)$current[$tagName];
2259 $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...
2267 if ($reportDocTag) {
2268 $current[$tagName]['_DOCUMENT_TAG'] = $documentTag;
2271 // Finally return the content of the document tag.
2272 return $current[$tagName];
2276 * This implodes an array of XML parts (made with xml_parse_into_struct()) into XML again.
2279 * @param array A array of XML parts, see xml2tree
2280 * @return string Re-compiled XML data.
2282 public static function xmlRecompileFromStructValArray(array $vals) {
2285 foreach($vals as $val) {
2286 $type = $val['type'];
2289 if ($type=='open' ||
$type=='complete') {
2290 $XMLcontent.='<'.$val['tag'];
2291 if(isset($val['attributes'])) {
2292 foreach($val['attributes'] as $k => $v) {
2293 $XMLcontent.=' '.$k.'="'.htmlspecialchars($v).'"';
2296 if ($type=='complete') {
2297 if(isset($val['value'])) {
2298 $XMLcontent.='>'.htmlspecialchars($val['value']).'</'.$val['tag'].'>';
2299 } else $XMLcontent.='/>';
2300 } else $XMLcontent.='>';
2302 if ($type=='open' && isset($val['value'])) {
2303 $XMLcontent.=htmlspecialchars($val['value']);
2307 if ($type=='close') {
2308 $XMLcontent.='</'.$val['tag'].'>';
2311 if($type=='cdata') {
2312 $XMLcontent.=htmlspecialchars($val['value']);
2320 * Extracts the attributes (typically encoding and version) of an XML prologue (header).
2323 * @param string XML data
2324 * @return array Attributes of the xml prologue (header)
2326 public static function xmlGetHeaderAttribs($xmlData) {
2328 if (preg_match('/^\s*<\?xml([^>]*)\?\>/', $xmlData, $match)) {
2329 return t3lib_div
::get_tag_attributes($match[1]);
2334 * Minifies JavaScript
2336 * @param string $script Script to minify
2337 * @param string $error Error message (if any)
2338 * @return string Minified script or source string if error happened
2340 public static function minifyJavaScript($script, &$error = '') {
2341 require_once(PATH_typo3
. 'contrib/jsmin/jsmin.php');
2344 $script = trim(JSMin
::minify(str_replace(chr(13), '', $script)));
2346 catch(JSMinException
$e) {
2347 $error = 'Error while minifying JavaScript: ' . $e->getMessage();
2348 t3lib_div
::devLog($error, 't3lib_div', 2,
2349 array('JavaScript' => $script, 'Stack trace' => $e->getTrace()));
2361 /*************************
2365 *************************/
2368 * Reads the file or url $url and returns the content
2369 * 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.
2372 * @param string Filepath/URL to read
2373 * @param integer Whether the HTTP header should be fetched or not. 0=disable, 1=fetch header+content, 2=fetch header only
2374 * @param array HTTP headers to be used in the request
2375 * @return string The content from the resource given as input.
2377 public static function getURL($url, $includeHeader = 0, $requestHeaders = false) {
2380 // (Proxy support implemented by Arco <arco@appeltaart.mine.nu>)
2381 if ($GLOBALS['TYPO3_CONF_VARS']['SYS']['curlUse'] == '1' && preg_match('/^https?:\/\//', $url)) {
2382 // External URL without error checking.
2388 curl_setopt($ch, CURLOPT_URL
, $url);
2389 curl_setopt($ch, CURLOPT_HEADER
, $includeHeader ?
1 : 0);
2390 curl_setopt($ch, CURLOPT_NOBODY
, $includeHeader == 2 ?
1 : 0);
2391 curl_setopt($ch, CURLOPT_FOLLOWLOCATION
, 1);
2392 curl_setopt($ch, CURLOPT_RETURNTRANSFER
, 1);
2393 curl_setopt($ch, CURLOPT_FAILONERROR
, 1);
2394 if (is_array($requestHeaders)) {
2395 curl_setopt($ch, CURLOPT_HTTPHEADER
, $requestHeaders);
2398 if ($GLOBALS['TYPO3_CONF_VARS']['SYS']['curlProxyServer']) {
2399 curl_setopt($ch, CURLOPT_PROXY
, $GLOBALS['TYPO3_CONF_VARS']['SYS']['curlProxyServer']);
2401 // Not sure if this is needed
2402 if ($GLOBALS['TYPO3_CONF_VARS']['SYS']['curlProxyTunnel']) {
2403 curl_setopt($ch, CURLOPT_HTTPPROXYTUNNEL
, $GLOBALS['TYPO3_CONF_VARS']['SYS']['curlProxyTunnel']);
2405 if ($GLOBALS['TYPO3_CONF_VARS']['SYS']['curlProxyUserPass']) {
2406 curl_setopt($ch, CURLOPT_PROXYUSERPWD
, $GLOBALS['TYPO3_CONF_VARS']['SYS']['curlProxyUserPass']);
2409 $content = curl_exec($ch);
2412 } elseif ($includeHeader) {
2413 $parsedURL = parse_url($url);
2414 if (!t3lib_div
::inList('ftp,ftps,http,https,gopher,telnet', $parsedURL['scheme'])) {
2418 $fp = @fsockopen
($parsedURL['host'], ($parsedURL['port'] > 0 ?
$parsedURL['port'] : 80), $errno, $errstr, 2.0);
2423 $msg = 'GET ' . $parsedURL['path'] .
2424 ($parsedURL['query'] ?
'?' . $parsedURL['query'] : '') .
2425 ' HTTP/1.0' . "\r\n" . 'Host: ' .
2426 $parsedURL['host'] . "\r\n\r\n";
2428 while (!feof($fp)) {
2429 $line = fgets($fp, 2048);
2431 if ($includeHeader == 2 && !strlen(trim($line))) {
2432 break; // Stop at the first empty line (= end of header)
2437 } elseif (is_array($requestHeaders)) {
2438 $ctx = stream_context_create(array(
2440 'header' => implode("\r\n", $requestHeaders)
2444 $content = @file_get_contents
($url, false, $ctx);
2447 $content = @file_get_contents
($url);
2454 * Writes $content to the file $file
2457 * @param string Filepath to write to
2458 * @param string Content to write
2459 * @return boolean True if the file was successfully opened and written to.
2461 public static function writeFile($file,$content) {
2462 if (!@is_file
($file)) $changePermissions = true;
2464 if ($fd = fopen($file,'wb')) {
2465 $res = fwrite($fd,$content);
2468 if ($res===false) return false;
2470 if ($changePermissions) { // Change the permissions only if the file has just been created
2471 t3lib_div
::fixPermissions($file);
2481 * Setting file system mode & group ownership of file
2483 * @param string Filepath of newly created file
2486 public static function fixPermissions($file) {
2487 if (@is_file
($file) && TYPO3_OS
!='WIN') {
2488 @chmod
($file, octdec($GLOBALS['TYPO3_CONF_VARS']['BE']['fileCreateMask'])); // "@" is there because file is not necessarily OWNED by the user
2489 if($GLOBALS['TYPO3_CONF_VARS']['BE']['createGroup']) { // skip this if createGroup is empty
2490 @chgrp
($file, $GLOBALS['TYPO3_CONF_VARS']['BE']['createGroup']); // "@" is there because file is not necessarily OWNED by the user
2496 * Writes $content to a filename in the typo3temp/ folder (and possibly one or two subfolders...)
2497 * Accepts an additional subdirectory in the file path!
2499 * @param string Absolute filepath to write to inside "typo3temp/". First part of this string must match PATH_site."typo3temp/"
2500 * @param string Content string to write
2501 * @return string Returns false on success, otherwise an error string telling about the problem.
2503 public static function writeFileToTypo3tempDir($filepath,$content) {
2505 // Parse filepath into directory and basename:
2506 $fI = pathinfo($filepath);
2507 $fI['dirname'].= '/';
2510 if (t3lib_div
::validPathStr($filepath) && $fI['basename'] && strlen($fI['basename'])<60) {
2511 if (defined('PATH_site')) {
2512 $dirName = PATH_site
.'typo3temp/'; // Setting main temporary directory name (standard)
2513 if (@is_dir
($dirName)) {
2514 if (t3lib_div
::isFirstPartOfStr($fI['dirname'],$dirName)) {
2516 // Checking if the "subdir" is found:
2517 $subdir = substr($fI['dirname'],strlen($dirName));
2519 if (ereg('^[[:alnum:]_]+\/$',$subdir) ||
ereg('^[[:alnum:]_]+\/[[:alnum:]_]+\/$',$subdir)) {
2521 if (!@is_dir
($dirName)) {
2522 t3lib_div
::mkdir_deep(PATH_site
.'typo3temp/', $subdir);
2524 } else return 'Subdir, "'.$subdir.'", was NOT on the form "[[:alnum:]_]/" or "[[:alnum:]_]/[[:alnum:]_]/"';
2526 // Checking dir-name again (sub-dir might have been created):
2527 if (@is_dir
($dirName)) {
2528 if ($filepath == $dirName.$fI['basename']) {
2529 t3lib_div
::writeFile($filepath, $content);
2530 if (!@is_file
($filepath)) return 'File not written to disk! Write permission error in filesystem?';
2531 } else return 'Calculated filelocation didn\'t match input $filepath!';
2532 } else return '"'.$dirName.'" is not a directory!';
2533 } else return '"'.$fI['dirname'].'" was not within directory PATH_site + "typo3temp/"';
2534 } else return 'PATH_site + "typo3temp/" was not a directory!';
2535 } else return 'PATH_site constant was NOT defined!';
2536 } else return 'Input filepath "'.$filepath.'" was generally invalid!';
2540 * Wrapper function for mkdir, setting folder permissions according to $GLOBALS['TYPO3_CONF_VARS']['BE']['folderCreateMask'] and group ownership according to $GLOBALS['TYPO3_CONF_VARS']['BE']['createGroup']
2543 * @param string Absolute path to folder, see PHP mkdir() function. Removes trailing slash internally.
2544 * @return boolean TRUE if @mkdir went well!
2546 public static function mkdir($theNewFolder) {
2547 $theNewFolder = preg_replace('|/$|','',$theNewFolder);
2548 if (mkdir($theNewFolder, octdec($GLOBALS['TYPO3_CONF_VARS']['BE']['folderCreateMask']))){
2549 chmod($theNewFolder, octdec($GLOBALS['TYPO3_CONF_VARS']['BE']['folderCreateMask'])); //added this line, because the mode at 'mkdir' has a strange behaviour sometimes
2551 if($GLOBALS['TYPO3_CONF_VARS']['BE']['createGroup']) { // skip this if createGroup is empty
2552 chgrp($theNewFolder, $GLOBALS['TYPO3_CONF_VARS']['BE']['createGroup']);
2559 * Creates a directory - including parent directories if necessary - in the file system
2561 * @param string Base folder. This must exist! Must have trailing slash! Example "/root/typo3site/"
2562 * @param string Deep directory to create, eg. "xx/yy/" which creates "/root/typo3site/xx/yy/" if $destination is "/root/typo3site/"
2563 * @return string If error, returns error string.
2565 public static function mkdir_deep($destination,$deepDir) {
2566 $allParts = t3lib_div
::trimExplode('/',$deepDir,1);
2568 foreach($allParts as $part) {
2570 if (!is_dir($destination.$root)) {
2571 t3lib_div
::mkdir($destination.$root);
2572 if (!@is_dir
($destination.$root)) {
2573 return 'Error: The directory "'.$destination.$root.'" could not be created...';
2580 * Wrapper function for rmdir, allowing recursive deletion of folders and files
2582 * @param string Absolute path to folder, see PHP rmdir() function. Removes trailing slash internally.
2583 * @param boolean Allow deletion of non-empty directories
2584 * @return boolean true if @rmdir went well!
2586 public static function rmdir($path,$removeNonEmpty=false) {
2588 $path = preg_replace('|/$|','',$path); // Remove trailing slash
2590 if (file_exists($path)) {
2593 if (is_dir($path)) {
2594 if ($removeNonEmpty==true && $handle = opendir($path)) {
2595 while ($OK && false !== ($file = readdir($handle))) {
2596 if ($file=='.' ||
$file=='..') continue;
2597 $OK = t3lib_div
::rmdir($path.'/'.$file,$removeNonEmpty);
2601 if ($OK) { $OK = rmdir($path); }
2603 } else { // If $dirname is a file, simply remove it
2604 $OK = unlink($path);
2614 * Returns an array with the names of folders in a specific path
2615 * Will return 'error' (string) if there were an error with reading directory content.
2618 * @param string Path to list directories from
2619 * @return array Returns an array with the directory entries as values. If no path, the return value is nothing.
2621 public static function get_dirs($path) {
2624 if (is_object($d)) {
2625 while($entry=$d->read()) {
2626 if (@is_dir
($path.'/'.$entry) && $entry!= '..' && $entry!= '.') {
2627 $filearray[]=$entry;
2631 } else return 'error';
2637 * Returns an array with the names of files in a specific path
2640 * @param string $path: Is the path to the file
2641 * @param string $extensionList is the comma list of extensions to read only (blank = all)
2642 * @param boolean If set, then the path is prepended the filenames. Otherwise only the filenames are returned in the array
2643 * @param string $order is sorting: 1= sort alphabetically, 'mtime' = sort by modification time.
2644 * @param string A comma seperated list of filenames to exclude, no wildcards
2645 * @return array Array of the files found
2647 public static function getFilesInDir($path,$extensionList='',$prependPath=0,$order='',$excludePattern='') {
2649 // Initialize variabels:
2650 $filearray = array();
2651 $sortarray = array();
2652 $path = ereg_replace('\/$','',$path);
2654 // Find files+directories:
2655 if (@is_dir
($path)) {
2656 $extensionList = strtolower($extensionList);
2658 if (is_object($d)) {
2659 while($entry=$d->read()) {
2660 if (@is_file
($path.'/'.$entry)) {
2661 $fI = pathinfo($entry);
2662 $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)
2663 if ((!strlen($extensionList) || t3lib_div
::inList($extensionList,strtolower($fI['extension']))) && (!strlen($excludePattern) ||
!preg_match('/^'.$excludePattern.'$/',$entry))) {
2664 $filearray[$key]=($prependPath?
$path.'/':'').$entry;
2665 if ($order=='mtime') {$sortarray[$key]=filemtime($path.'/'.$entry);}
2666 elseif ($order) {$sortarray[$key]=$entry;}
2671 } else return 'error opening path: "'.$path.'"';
2679 while(list($k,$v)=each($sortarray)) {
2680 $newArr[$k]=$filearray[$k];
2691 * Recursively gather all files and folders of a path.
2694 * @param array $fileArr: Empty input array (will have files added to it)
2695 * @param string $path: The path to read recursively from (absolute) (include trailing slash!)
2696 * @param string $extList: Comma list of file extensions: Only files with extensions in this list (if applicable) will be selected.
2697 * @param boolean $regDirs: If set, directories are also included in output.
2698 * @param integer $recursivityLevels: The number of levels to dig down...
2699 * @param string $excludePattern: regex pattern of files/directories to exclude
2700 * @return array An array with the found files/directories.
2702 public static function getAllFilesAndFoldersInPath(array $fileArr,$path,$extList='',$regDirs=0,$recursivityLevels=99,$excludePattern='') {
2703 if ($regDirs) $fileArr[] = $path;
2704 $fileArr = array_merge($fileArr, t3lib_div
::getFilesInDir($path,$extList,1,1,$excludePattern));
2706 $dirs = t3lib_div
::get_dirs($path);
2707 if (is_array($dirs) && $recursivityLevels>0) {
2708 foreach ($dirs as $subdirs) {
2709 if ((string)$subdirs!='' && (!strlen($excludePattern) ||
!preg_match('/^'.$excludePattern.'$/',$subdirs))) {
2710 $fileArr = t3lib_div
::getAllFilesAndFoldersInPath($fileArr,$path.$subdirs.'/',$extList,$regDirs,$recursivityLevels-1,$excludePattern);
2718 * Removes the absolute part of all files/folders in fileArr
2721 * @param array $fileArr: The file array to remove the prefix from
2722 * @param string $prefixToRemove: The prefix path to remove (if found as first part of string!)
2723 * @return array The input $fileArr processed.
2725 public static function removePrefixPathFromList(array $fileArr,$prefixToRemove) {
2726 foreach($fileArr as $k => $absFileRef) {
2727 if(t3lib_div
::isFirstPartOfStr($absFileRef,$prefixToRemove)) {
2728 $fileArr[$k] = substr($absFileRef,strlen($prefixToRemove));
2729 } else return 'ERROR: One or more of the files was NOT prefixed with the prefix-path!';
2735 * Fixes a path for windows-backslashes and reduces double-slashes to single slashes
2738 * @param string File path to process
2741 public static function fixWindowsFilePath($theFile) {
2742 return str_replace('//','/', str_replace('\\','/', $theFile));
2746 * Resolves "../" sections in the input path string.
2747 * For example "fileadmin/directory/../other_directory/" will be resolved to "fileadmin/other_directory/"
2750 * @param string File path in which "/../" is resolved
2753 public static function resolveBackPath($pathStr) {
2754 $parts = explode('/',$pathStr);
2757 foreach($parts as $pV) {
2762 } else $output[]=$pV;
2768 return implode('/',$output);
2772 * Prefixes a URL used with 'header-location' with 'http://...' depending on whether it has it already.
2773 * - If already having a scheme, nothing is prepended
2774 * - If having REQUEST_URI slash '/', then prefixing 'http://[host]' (relative to host)
2775 * - Otherwise prefixed with TYPO3_REQUEST_DIR (relative to current dir / TYPO3_REQUEST_DIR)
2778 * @param string URL / path to prepend full URL addressing to.
2781 public static function locationHeaderUrl($path) {
2782 $uI = parse_url($path);
2783 if (substr($path,0,1)=='/') { // relative to HOST
2784 $path = t3lib_div
::getIndpEnv('TYPO3_REQUEST_HOST').$path;
2785 } elseif (!$uI['scheme']) { // No scheme either
2786 $path = t3lib_div
::getIndpEnv('TYPO3_REQUEST_DIR').$path;
2806 /*************************
2808 * DEBUG helper FUNCTIONS
2810 *************************/
2813 * Returns a string with a list of ascii-values for the first $characters characters in $string
2816 * @param string String to show ASCII value for
2817 * @param integer Number of characters to show
2818 * @return string The string with ASCII values in separated by a space char.
2821 public static function debug_ordvalue($string,$characters=100) {
2822 if(strlen($string) < $characters) $characters = strlen($string);
2823 for ($i=0; $i<$characters; $i++
) {
2824 $valuestring.=' '.ord(substr($string,$i,1));
2826 return trim($valuestring);
2830 * Returns HTML-code, which is a visual representation of a multidimensional array
2831 * use t3lib_div::print_array() in order to print an array
2832 * Returns false if $array_in is not an array
2835 * @param mixed Array to view
2836 * @return string HTML output
2838 public static function view_array($array_in) {
2839 if (is_array($array_in)) {
2841 <table border="1" cellpadding="1" cellspacing="0" bgcolor="white">';
2842 if (count($array_in) == 0) {
2843 $result.= '<tr><td><font face="Verdana,Arial" size="1"><b>EMPTY!</b></font></td></tr>';
2845 foreach ($array_in as $key => $val) {
2847 <td valign="top"><font face="Verdana,Arial" size="1">'.htmlspecialchars((string)$key).'</font></td>
2849 if (is_array($val)) {
2850 $result.=t3lib_div
::view_array($val);
2851 } elseif (is_object($val)) {
2852 $string = get_class($val);
2853 if (method_exists($val, '__toString')) {
2854 $string .= ': '.(string)$val;
2856 $result .= '<font face="Verdana,Arial" size="1" color="red">'.nl2br(htmlspecialchars($string)).'<br /></font>';
2858 if (gettype($val) == 'object') {
2859 $string = 'Unknown object';
2861 $string = (string)$val;
2863 $result.= '<font face="Verdana,Arial" size="1" color="red">'.nl2br(htmlspecialchars($string)).'<br /></font>';
2869 $result.= '</table>';
2871 $result = '<table border="1" cellpadding="1" cellspacing="0" bgcolor="white">
2873 <td><font face="Verdana,Arial" size="1" color="red">'.nl2br(htmlspecialchars((string)$array_in)).'<br /></font></td>
2875 </table>'; // Output it as a string.
2884 * @param mixed Array to print visually (in a table).
2889 public static function print_array($array_in) {
2890 echo t3lib_div
::view_array($array_in);
2894 * Makes debug output
2895 * Prints $var in bold between two vertical lines
2896 * If not $var the word 'debug' is printed
2897 * If $var is an array, the array is printed by t3lib_div::print_array()
2900 * @param mixed Variable to print
2901 * @param mixed If the parameter is a string it will be used as header. Otherwise number of break tags to apply after (positive integer) or before (negative integer) the output.
2904 public static function debug($var='',$brOrHeader=0) {
2905 // buffer the output of debug if no buffering started before
2906 if (ob_get_level()==0) {
2910 if ($brOrHeader && !t3lib_div
::testInt($brOrHeader)) {
2911 echo '<table class="typo3-debug" border="0" cellpadding="0" cellspacing="0" bgcolor="white" style="border:0px; margin-top:3px; margin-bottom:3px;"><tr><td style="background-color:#bbbbbb; font-family: verdana,arial; font-weight: bold; font-size: 10px;">'.htmlspecialchars((string)$brOrHeader).'</td></tr><tr><td>';
2912 } elseif ($brOrHeader<0) {
2913 for($a=0;$a<abs(intval($brOrHeader));$a++
){echo '<br />';}
2916 if (is_array($var)) {
2917 t3lib_div
::print_array($var);
2918 } elseif (is_object($var)) {
2919 echo '<b>|Object:<pre>';
2922 } elseif ((string)$var!='') {
2923 echo '<b>|'.htmlspecialchars((string)$var).'|</b>';
2925 echo '<b>| debug |</b>';
2928 if ($brOrHeader && !t3lib_div
::testInt($brOrHeader)) {
2929 echo '</td></tr></table>';
2930 } elseif ($brOrHeader>0) {
2931 for($a=0;$a<intval($brOrHeader);$a++
){echo '<br />';}
2936 * Displays the "path" of the function call stack in a string, using debug_backtrace
2940 public static function debug_trail() {
2941 $trail = debug_backtrace();
2942 $trail = array_reverse($trail);
2946 foreach($trail as $dat) {
2947 $path[] = $dat['class'].$dat['type'].$dat['function'];
2950 return implode(' // ',$path);
2954 * Displays an array as rows in a table. Useful to debug output like an array of database records.
2956 * @param mixed Array of arrays with similar keys
2957 * @param string Table header
2958 * @param boolean If TRUE, will return content instead of echo'ing out.
2959 * @return void Outputs to browser.
2961 public static function debugRows($rows,$header='',$returnHTML=FALSE) {
2962 if (is_array($rows)) {
2964 $firstEl = current($rows);
2965 if (is_array($firstEl)) {
2966 $headerColumns = array_keys($firstEl);
2970 $tRows[] = '<tr><td colspan="'.count($headerColumns).'" style="background-color:#bbbbbb; font-family: verdana,arial; font-weight: bold; font-size: 10px;"><strong>'.htmlspecialchars($header).'</strong></td></tr>';
2972 foreach($headerColumns as $key) {
2974 <td><font face="Verdana,Arial" size="1"><strong>'.htmlspecialchars($key).'</strong></font></td>';
2977 <tr>'.implode('',$tCells).'
2981 foreach($rows as $singleRow) {
2983 foreach($headerColumns as $key) {
2985 <td><font face="Verdana,Arial" size="1">'.(is_array($singleRow[$key]) ? t3lib_div
::debugRows($singleRow[$key],'',TRUE) : htmlspecialchars($singleRow[$key])).'</font></td>';
2988 <tr>'.implode('',$tCells).'
2993 <table border="1" cellpadding="1" cellspacing="0" bgcolor="white">'.implode('',$tRows).'
2995 if ($returnHTML) return $table; else echo $table;
2996 } else debug('Empty array of rows',$header);
2998 debug('No array of rows',$header);
3029 /*************************
3031 * SYSTEM INFORMATION
3033 *************************/
3036 * Returns the HOST+DIR-PATH of the current script (The URL, but without 'http://' and without script-filename)
3041 public static function getThisUrl() {
3042 $p=parse_url(t3lib_div
::getIndpEnv('TYPO3_REQUEST_SCRIPT')); // Url of this script
3043 $dir=t3lib_div
::dirname($p['path']).'/'; // Strip file
3044 $url = str_replace('//','/',$p['host'].($p['port']?
':'.$p['port']:'').$dir);
3049 * Returns the link-url to the current script.
3050 * In $getParams you can set associative keys corresponding to the GET-vars you wish to add to the URL. If you set them empty, they will remove existing GET-vars from the current URL.
3051 * REMEMBER to always use htmlspecialchars() for content in href-properties to get ampersands converted to entities (XHTML requirement and XSS precaution)
3054 * @param array Array of GET parameters to include
3057 public static function linkThisScript(array $getParams=array()) {
3058 $parts = t3lib_div
::getIndpEnv('SCRIPT_NAME');
3059 $params = t3lib_div
::_GET();
3061 foreach($getParams as $k => $v) {
3062 if (strcmp($v,'')) {
3064 } else unset($params[$k]);
3067 $pString = t3lib_div
::implodeArrayForUrl('',$params);
3069 return $pString ?
$parts.'?'.ereg_replace('^&','',$pString) : $parts;
3073 * Takes a full URL, $url, possibly with a querystring and overlays the $getParams arrays values onto the quirystring, packs it all together and returns the URL again.
3074 * So basically it adds the parameters in $getParams to an existing URL, $url
3077 * @param string URL string
3078 * @param array Array of key/value pairs for get parameters to add/overrule with. Can be multidimensional.
3079 * @return string Output URL with added getParams.
3081 public static function linkThisUrl($url,array $getParams=array()) {
3082 $parts = parse_url($url);
3084 if ($parts['query']) {
3085 parse_str($parts['query'],$getP);
3087 $getP = t3lib_div
::array_merge_recursive_overrule($getP,$getParams);
3088 $uP = explode('?',$url);
3090 $params = t3lib_div
::implodeArrayForUrl('',$getP);
3091 $outurl = $uP[0].($params ?
'?'.substr($params, 1) : '');
3097 * Abstraction method which returns System Environment Variables regardless of server OS, CGI/MODULE version etc. Basically this is SERVER variables for most of them.
3098 * This should be used instead of getEnv() and $_SERVER/ENV_VARS to get reliable values for all situations.
3101 * @param string Name of the "environment variable"/"server variable" you wish to use. Valid values are SCRIPT_NAME, SCRIPT_FILENAME, REQUEST_URI, PATH_INFO, REMOTE_ADDR, REMOTE_HOST, HTTP_REFERER, HTTP_HOST, HTTP_USER_AGENT, HTTP_ACCEPT_LANGUAGE, QUERY_STRING, TYPO3_DOCUMENT_ROOT, TYPO3_HOST_ONLY, TYPO3_HOST_ONLY, TYPO3_REQUEST_HOST, TYPO3_REQUEST_URL, TYPO3_REQUEST_SCRIPT, TYPO3_REQUEST_DIR, TYPO3_SITE_URL, _ARRAY
3102 * @return string Value based on the input key, independent of server/os environment.
3104 public static function getIndpEnv($getEnvName) {
3107 output from parse_url():
3108 URL: http://username:password@192.168.1.4:8080/typo3/32/temp/phpcheck/index.php/arg1/arg2/arg3/?arg1,arg2,arg3&p1=parameter1&p2[key]=value#link1
3110 [user] => 'username'
3111 [pass] => 'password'
3112 [host] => '192.168.1.4'
3114 [path] => '/typo3/32/temp/phpcheck/index.php/arg1/arg2/arg3/'
3115 [query] => 'arg1,arg2,arg3&p1=parameter1&p2[key]=value'
3116 [fragment] => 'link1'
3118 Further definition: [path_script] = '/typo3/32/temp/phpcheck/index.php'
3119 [path_dir] = '/typo3/32/temp/phpcheck/'
3120 [path_info] = '/arg1/arg2/arg3/'
3121 [path] = [path_script/path_dir][path_info]
3127 REQUEST_URI = [path]?[query] = /typo3/32/temp/phpcheck/index.php/arg1/arg2/arg3/?arg1,arg2,arg3&p1=parameter1&p2[key]=value
3128 HTTP_HOST = [host][:[port]] = 192.168.1.4:8080
3129 SCRIPT_NAME = [path_script]++ = /typo3/32/temp/phpcheck/index.php // NOTICE THAT SCRIPT_NAME will return the php-script name ALSO. [path_script] may not do that (eg. '/somedir/' may result in SCRIPT_NAME '/somedir/index.php')!
3130 PATH_INFO = [path_info] = /arg1/arg2/arg3/
3131 QUERY_STRING = [query] = arg1,arg2,arg3&p1=parameter1&p2[key]=value
3132 HTTP_REFERER = [scheme]://[host][:[port]][path] = http://192.168.1.4:8080/typo3/32/temp/phpcheck/index.php/arg1/arg2/arg3/?arg1,arg2,arg3&p1=parameter1&p2[key]=value
3133 (Notice: NO username/password + NO fragment)
3136 REMOTE_ADDR = (client IP)
3137 REMOTE_HOST = (client host)
3138 HTTP_USER_AGENT = (client user agent)
3139 HTTP_ACCEPT_LANGUAGE = (client accept language)
3142 SCRIPT_FILENAME = Absolute filename of script (Differs between windows/unix). On windows 'C:\\blabla\\blabl\\' will be converted to 'C:/blabla/blabl/'
3145 TYPO3_HOST_ONLY = [host] = 192.168.1.4
3146 TYPO3_PORT = [port] = 8080 (blank if 80, taken from host value)
3147 TYPO3_REQUEST_HOST = [scheme]://[host][:[port]]
3148 TYPO3_REQUEST_URL = [scheme]://[host][:[port]][path]?[query] (scheme will by default be "http" until we can detect something different)
3149 TYPO3_REQUEST_SCRIPT = [scheme]://[host][:[port]][path_script]
3150 TYPO3_REQUEST_DIR = [scheme]://[host][:[port]][path_dir]
3151 TYPO3_SITE_URL = [scheme]://[host][:[port]][path_dir] of the TYPO3 website frontend
3152 TYPO3_SITE_SCRIPT = [script / Speaking URL] of the TYPO3 website
3153 TYPO3_DOCUMENT_ROOT = Absolute path of root of documents: TYPO3_DOCUMENT_ROOT.SCRIPT_NAME = SCRIPT_FILENAME (typically)
3154 TYPO3_SSL = Returns TRUE if this session uses SSL (HTTPS)
3156 Notice: [fragment] is apparently NEVER available to the script!
3159 Testing suggestions:
3160 - Output all the values.
3161 - In the script, make a link to the script it self, maybe add some parameters and click the link a few times so HTTP_REFERER is seen
3162 - ALSO TRY the script from the ROOT of a site (like 'http://www.mytest.com/' and not 'http://www.mytest.com/test/' !!)
3166 # if ($getEnvName=='HTTP_REFERER') return '';
3170 switch ((string)$getEnvName) {
3172 $retVal = (php_sapi_name()=='cgi'||
php_sapi_name()=='cgi-fcgi')&&($_SERVER['ORIG_PATH_INFO']?
$_SERVER['ORIG_PATH_INFO']:$_SERVER['PATH_INFO']) ?
($_SERVER['ORIG_PATH_INFO']?
$_SERVER['ORIG_PATH_INFO']:$_SERVER['PATH_INFO']) : ($_SERVER['ORIG_SCRIPT_NAME']?
$_SERVER['ORIG_SCRIPT_NAME']:$_SERVER['SCRIPT_NAME']);
3174 case 'SCRIPT_FILENAME':
3175 $retVal = str_replace('//','/', str_replace('\\','/', (php_sapi_name()=='cgi'||
php_sapi_name()=='isapi' ||
php_sapi_name()=='cgi-fcgi')&&($_SERVER['ORIG_PATH_TRANSLATED']?
$_SERVER['ORIG_PATH_TRANSLATED']:$_SERVER['PATH_TRANSLATED'])?
($_SERVER['ORIG_PATH_TRANSLATED']?
$_SERVER['ORIG_PATH_TRANSLATED']:$_SERVER['PATH_TRANSLATED']):($_SERVER['ORIG_SCRIPT_FILENAME']?
$_SERVER['ORIG_SCRIPT_FILENAME']:$_SERVER['SCRIPT_FILENAME'])));
3178 // Typical application of REQUEST_URI is return urls, forms submitting to itself etc. Example: returnUrl='.rawurlencode(t3lib_div::getIndpEnv('REQUEST_URI'))
3179 if ($GLOBALS['TYPO3_CONF_VARS']['SYS']['requestURIvar']) { // This is for URL rewriters that store the original URI in a server variable (eg ISAPI_Rewriter for IIS: HTTP_X_REWRITE_URL)
3180 list($v,$n) = explode('|',$GLOBALS['TYPO3_CONF_VARS']['SYS']['requestURIvar']);
3181 $retVal = $GLOBALS[$v][$n];
3182 } elseif (!$_SERVER['REQUEST_URI']) { // This is for ISS/CGI which does not have the REQUEST_URI available.
3183 $retVal = '/'.ereg_replace('^/','',t3lib_div
::getIndpEnv('SCRIPT_NAME')).
3184 ($_SERVER['QUERY_STRING']?
'?'.$_SERVER['QUERY_STRING']:'');
3185 } else $retVal = $_SERVER['REQUEST_URI'];
3188 // $_SERVER['PATH_INFO']!=$_SERVER['SCRIPT_NAME'] is necessary because some servers (Windows/CGI) are seen to set PATH_INFO equal to script_name
3189 // Further, there must be at least one '/' in the path - else the PATH_INFO value does not make sense.
3190 // IF 'PATH_INFO' never works for our purpose in TYPO3 with CGI-servers, then 'php_sapi_name()=='cgi'' might be a better check. Right now strcmp($_SERVER['PATH_INFO'],t3lib_div::getIndpEnv('SCRIPT_NAME')) will always return false for CGI-versions, but that is only as long as SCRIPT_NAME is set equal to PATH_INFO because of php_sapi_name()=='cgi' (see above)
3191 // if (strcmp($_SERVER['PATH_INFO'],t3lib_div::getIndpEnv('SCRIPT_NAME')) && count(explode('/',$_SERVER['PATH_INFO']))>1) {
3192 if (php_sapi_name()!='cgi'&&php_sapi_name()!='cgi-fcgi') {
3193 $retVal = $_SERVER['PATH_INFO'];
3196 // These are let through without modification
3199 case 'HTTP_REFERER':
3201 case 'HTTP_USER_AGENT':
3202 case 'HTTP_ACCEPT_ENCODING':
3203 case 'HTTP_ACCEPT_LANGUAGE':
3204 case 'QUERY_STRING':
3205 $retVal = $_SERVER[$getEnvName];
3207 case 'TYPO3_DOCUMENT_ROOT':
3208 // Some CGI-versions (LA13CGI) and mod-rewrite rules on MODULE versions will deliver a 'wrong' DOCUMENT_ROOT (according to our description). Further various aliases/mod_rewrite rules can disturb this as well.
3209 // Therefore the DOCUMENT_ROOT is now always calculated as the SCRIPT_FILENAME minus the end part shared with SCRIPT_NAME.
3210 $SFN = t3lib_div
::getIndpEnv('SCRIPT_FILENAME');
3211 $SN_A = explode('/',strrev(t3lib_div
::getIndpEnv('SCRIPT_NAME')));
3212 $SFN_A = explode('/',strrev($SFN));
3214 while(list($kk,$vv)=each($SN_A)) {
3215 if (!strcmp($SFN_A[$kk],$vv)) {
3219 $commonEnd=strrev(implode('/',$acc));
3220 if (strcmp($commonEnd,'')) { $DR = substr($SFN,0,-(strlen($commonEnd)+
1)); }
3223 case 'TYPO3_HOST_ONLY':
3224 $p = explode(':',$_SERVER['HTTP_HOST']);