#2731: Improved caching of locallang - changed internal caching from default characte...
[Packages/TYPO3.CMS.git] / t3lib / class.t3lib_div.php
1 <?php
2 /***************************************************************
3 * Copyright notice
4 *
5 * (c) 1999-2008 Kasper Skaarhoj (kasperYYYY@typo3.com)
6 * All rights reserved
7 *
8 * This script is part of the TYPO3 project. The TYPO3 project is
9 * free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
13 *
14 * The GNU General Public License can be found at
15 * http://www.gnu.org/copyleft/gpl.html.
16 * A copy is found in the textfile GPL.txt and important notices to the license
17 * from the author is found in LICENSE.txt distributed with these scripts.
18 *
19 *
20 * This script is distributed in the hope that it will be useful,
21 * but WITHOUT ANY WARRANTY; without even the implied warranty of
22 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
23 * GNU General Public License for more details.
24 *
25 * This copyright notice MUST APPEAR in all copies of the script!
26 ***************************************************************/
27 /**
28 * Contains the reknown class "t3lib_div" with general purpose functions
29 *
30 * $Id$
31 * Revised for TYPO3 3.6 July/2003 by Kasper Skaarhoj
32 * XHTML compliant
33 * Usage counts are based on search 22/2 2003 through whole source including tslib/
34 *
35 * @author Kasper Skaarhoj <kasperYYYY@typo3.com>
36 */
37 /**
38 * [CLASS/FUNCTION INDEX of SCRIPT]
39 *
40 *
41 *
42 * 232: class t3lib_div
43 *
44 * SECTION: GET/POST Variables
45 * 262: function _GP($var)
46 * 280: function _GET($var=NULL)
47 * 297: function _POST($var=NULL)
48 * 313: function _GETset($inputGet,$key='')
49 * 336: function GPvar($var,$strip=0)
50 * 353: function GParrayMerged($var)
51 *
52 * SECTION: IMAGE FUNCTIONS
53 * 397: function gif_compress($theFile, $type)
54 * 425: function png_to_gif_by_imagemagick($theFile)
55 * 450: function read_png_gif($theFile,$output_png=0)
56 *
57 * SECTION: STRING FUNCTIONS
58 * 499: function fixed_lgd($string,$origChars,$preStr='...')
59 * 524: function fixed_lgd_pre($string,$chars)
60 * 538: function fixed_lgd_cs($string,$chars)
61 * 555: function breakTextForEmail($str,$implChar="\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)
101 *
102 * SECTION: ARRAY FUNCTIONS
103 * 1394: function inArray($in_array,$item)
104 * 1411: function intExplode($delim, $string)
105 * 1430: function revExplode($delim, $string, $count=0)
106 * 1450: function trimExplode($delim, $string, $onlyNonEmptyValues=0)
107 * 1472: function uniqueArray($valueArray)
108 * 1484: function removeArrayEntryByValue($array,$cmpValue)
109 * 1513: function implodeArrayForUrl($name,$theArray,$str='',$skipBlank=0,$rawurlencodeParamName=0)
110 * 1538: function explodeUrl2Array($string,$multidim=FALSE)
111 * 1564: function compileSelectedGetVarsFromArray($varList,$getArray,$GPvarAlt=1)
112 * 1587: function addSlashesOnArray(&$theArray)
113 * 1611: function stripSlashesOnArray(&$theArray)
114 * 1633: function slashArray($arr,$cmd)
115 * 1650: function array_merge_recursive_overrule($arr0,$arr1,$notAddKeys=0,$includeEmtpyValues=true)
116 * 1683: function array_merge($arr1,$arr2)
117 * 1696: function csvValues($row,$delim=',',$quote='"')
118 *
119 * SECTION: HTML/XML PROCESSING
120 * 1738: function get_tag_attributes($tag)
121 * 1775: function split_tag_attributes($tag)
122 * 1809: function implodeAttributes($arr,$xhtmlSafe=FALSE,$dontOmitBlankAttribs=FALSE)
123 * 1836: function implodeParams($arr,$xhtmlSafe=FALSE,$dontOmitBlankAttribs=FALSE)
124 * 1851: function wrapJS($string, $linebreak=TRUE)
125 * 1882: function xml2tree($string,$depth=999)
126 * 1969: function array2xml($array,$NSprefix='',$level=0,$docTag='phparray',$spaceInd=0, $options=array(),$stackData=array())
127 * 2088: function xml2array($string,$NSprefix='',$reportDocTag=FALSE)
128 * 2198: function xmlRecompileFromStructValArray($vals)
129 * 2242: function xmlGetHeaderAttribs($xmlData)
130 *
131 * SECTION: FILES FUNCTIONS
132 * 2275: function getURL($url, $includeHeader=0)
133 * 2342: function writeFile($file,$content)
134 * 2367: function fixPermissions($file)
135 * 2384: function writeFileToTypo3tempDir($filepath,$content)
136 * 2427: function mkdir($theNewFolder)
137 * 2446: function mkdir_deep($destination,$deepDir)
138 * 2468: function get_dirs($path)
139 * 2493: function getFilesInDir($path,$extensionList='',$prependPath=0,$order='')
140 * 2547: function getAllFilesAndFoldersInPath($fileArr,$path,$extList='',$regDirs=0,$recursivityLevels=99)
141 * 2570: function removePrefixPathFromList($fileArr,$prefixToRemove)
142 * 2586: function fixWindowsFilePath($theFile)
143 * 2598: function resolveBackPath($pathStr)
144 * 2626: function locationHeaderUrl($path)
145 *
146 * SECTION: DEBUG helper FUNCTIONS
147 * 2666: function debug_ordvalue($string,$characters=100)
148 * 2683: function view_array($array_in)
149 * 2711: function print_array($array_in)
150 * 2726: function debug($var="",$brOrHeader=0)
151 * 2757: function debug_trail()
152 * 2779: function debugRows($rows,$header='')
153 *
154 * SECTION: SYSTEM INFORMATION
155 * 2857: function getThisUrl()
156 * 2873: function linkThisScript($getParams=array())
157 * 2897: function linkThisUrl($url,$getParams=array())
158 * 2920: function getIndpEnv($getEnvName)
159 * 3113: function milliseconds()
160 * 3125: function clientInfo($useragent='')
161 *
162 * SECTION: TYPO3 SPECIFIC FUNCTIONS
163 * 3212: function getFileAbsFileName($filename,$onlyRelative=1,$relToTYPO3_mainDir=0)
164 * 3248: function validPathStr($theFile)
165 * 3259: function isAbsPath($path)
166 * 3270: function isAllowedAbsPath($path)
167 * 3287: function verifyFilenameAgainstDenyPattern($filename)
168 * 3305: function upload_copy_move($source,$destination)
169 * 3331: function upload_to_tempfile($uploadedFileName)
170 * 3349: function unlink_tempfile($uploadedTempFileName)
171 * 3365: function tempnam($filePrefix)
172 * 3379: function stdAuthCode($uid_or_record,$fields='',$codeLength=8)
173 * 3410: function cHashParams($addQueryParams)
174 * 3433: function hideIfNotTranslated($l18n_cfg_fieldValue)
175 * 3448: function readLLfile($fileRef,$langKey)
176 * 3472: function readLLXMLfile($fileRef,$langKey)
177 * 3589: function llXmlAutoFileName($fileRef,$language)
178 * 3633: function loadTCA($table)
179 * 3653: function resolveSheetDefInDS($dataStructArray,$sheet='sDEF')
180 * 3686: function resolveAllSheetsInDS($dataStructArray)
181 * 3715: function callUserFunction($funcName,&$params,&$ref,$checkPrefix='user_',$silent=0)
182 * 3813: function &getUserObj($classRef,$checkPrefix='user_',$silent=0)
183 * 3871: function &makeInstance($className)
184 * 3883: function makeInstanceClassName($className)
185 * 3897: function &makeInstanceService($serviceType, $serviceSubType='', $excludeServiceKeys=array())
186 * 3961: function plainMailEncoded($email,$subject,$message,$headers='',$enc='',$charset='',$dontEncodeHeader=false)
187 * 4031: function quoted_printable($string,$maxlen=76)
188 * 4078: function encodeHeader($line,$enc='',$charset='ISO-8859-1')
189 * 4121: function substUrlsInPlainText($message,$urlmode='76',$index_script_url='')
190 * 4155: function makeRedirectUrl($inUrl,$l=0,$index_script_url='')
191 * 4182: function freetypeDpiComp($font_size)
192 * 4194: function initSysLog()
193 * 4251: function sysLog($msg, $extKey, $severity=0)
194 * 4334: function devLog($msg, $extKey, $severity=0, $dataVar=FALSE)
195 * 4355: function arrayToLogString($arr, $valueList=array(), $valueLength=20)
196 * 4378: function imageMagickCommand($command, $parameters, $path='')
197 * 4425: function unQuoteFilenames($parameters,$unQuote=FALSE)
198 * 4459: function quoteJSvalue($value, $inScriptTags = false)
199 *
200 * TOTAL FUNCTIONS: 138
201 * (This index is automatically created/updated by the extension "extdeveval")
202 *
203 */
204
205
206
207
208
209
210
211
212
213
214
215
216 /**
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!
222 *
223 * USE:
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()'
227 *
228 * @author Kasper Skaarhoj <kasperYYYY@typo3.com>
229 * @package TYPO3
230 * @subpackage t3lib
231 */
232 class t3lib_div {
233
234
235
236
237
238 /*************************
239 *
240 * GET/POST Variables
241 *
242 * Background:
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.
248 *
249 *************************/
250
251 /**
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!
256 * Usage: 537
257 *
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.
260 * @see GPvar()
261 */
262 public static function _GP($var) {
263 if(empty($var)) return;
264 $value = isset($_POST[$var]) ? $_POST[$var] : $_GET[$var];
265 if (isset($value)) {
266 if (is_array($value)) { t3lib_div::stripSlashesOnArray($value); } else { $value = stripslashes($value); }
267 }
268 return $value;
269 }
270
271 /**
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!
274 * Usage: 27
275 *
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()
279 */
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); }
284 }
285 return $value;
286 }
287
288 /**
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!
291 * Usage: 41
292 *
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!*
295 * @see _GET(), _GP()
296 */
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); }
301 }
302 return $value;
303 }
304
305 /**
306 * Writes input value to $_GET
307 * Usage: 2
308 *
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!
311 * @return void
312 */
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;
321 }
322 }
323
324 /**
325 * GET/POST variable
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.
328 * Usage: 2
329 *
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!)
334 * @see _GP()
335 */
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); }
341 return $value;
342 }
343
344 /**
345 * Returns the GET/POST global arrays merged with POST taking precedence.
346 * Usage: 1
347 *
348 * @param string Key (variable name) from GET or POST vars
349 * @return array Returns the GET vars merged recursively onto the POST vars.
350 * @ignore
351 * @deprecated
352 */
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);
358 return $mergedA;
359 }
360
361 /**
362 * Wrapper for the RemoveXSS function.
363 * Removes potential XSS code from an input string.
364 *
365 * Using an external class by Travis Puderbaugh <kallahar@quickwired.com>
366 *
367 * @param string Input string
368 * @return string Input string with potential XSS code removed
369 */
370 public function removeXSS($string) {
371 require_once(PATH_typo3.'contrib/RemoveXSS/RemoveXSS.php');
372 $string = RemoveXSS::RemoveXSS($string);
373 return $string;
374 }
375
376
377
378
379
380
381
382
383
384
385 /*************************
386 *
387 * IMAGE FUNCTIONS
388 *
389 *************************/
390
391
392 /**
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)
395 *
396 * The function takes a file-reference, $theFile, and saves it again through GD or ImageMagick in order to compress the file
397 * GIF:
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
400 * PNG:
401 * No changes.
402 *
403 * $theFile is expected to be a valid GIF-file!
404 * The function returns a code for the operation.
405 * Usage: 9
406 *
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.
410 * @internal
411 */
412 public static function gif_compress($theFile, $type) {
413 $gfxConf = $GLOBALS['TYPO3_CONF_VARS']['GFX'];
414 $returnCode='';
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']);
418 exec($cmd);
419
420 $returnCode='IM';
421 } elseif (($type=='GD' || !$type) && $gfxConf['gdlib'] && !$gfxConf['gdlib_png']) { // GD
422 $tempImage = imageCreateFromGif($theFile);
423 imageGif($tempImage, $theFile);
424 imageDestroy($tempImage);
425 $returnCode='GD';
426 }
427 }
428 return $returnCode;
429 }
430
431 /**
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.
434 * Usage: 5
435 *
436 * @param string $theFile the filename with path
437 * @return string new filename
438 * @internal
439 */
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']);
448 exec($cmd);
449 $theFile = $newFile;
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!!
451 }
452 return $theFile;
453 }
454
455 /**
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.
458 * Usage: 2
459 *
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
463 * @internal
464 */
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));
468 if (
469 ((string)$ext=='.png' && $output_png) ||
470 ((string)$ext=='.gif' && !$output_png)
471 ) {
472 return $theFile;
473 } else {
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']);
476 exec($cmd);
477 if (@is_file($newFile)) return $newFile;
478 }
479 }
480 }
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496 /*************************
497 *
498 * STRING FUNCTIONS
499 *
500 *************************/
501
502 /**
503 * Truncate string
504 * Returns a new string of max. $chars length.
505 * If the string is longer, it will be truncated and appended with '...'.
506 * Usage: 39
507 *
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()
514 */
515 public static function fixed_lgd($string,$origChars,$preStr='...') {
516 $chars = abs($origChars);
517 if ($chars >= 4) {
518 if(strlen($string)>$chars) {
519 return $origChars < 0 ?
520 $preStr.trim(substr($string, -($chars-3))) :
521 trim(substr($string, 0, $chars-3)).$preStr;
522 }
523 }
524 return $string;
525 }
526
527 /**
528 * Truncate string
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
532 * Usage: 6
533 *
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)
538 * @see fixed_lgd()
539 */
540 public static function fixed_lgd_pre($string,$chars) {
541 return strrev(t3lib_div::fixed_lgd(strrev($string),$chars));
542 }
543
544 /**
545 * Truncates a string with appended/prepended "..." and takes backend character set into consideration
546 * Use only from backend!
547 * Usage: 75
548 *
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
552 * @see fixed_lgd()
553 */
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,'...');
557 } else {
558 return t3lib_div::fixed_lgd($string, $chars);
559 }
560 }
561
562 /**
563 * Breaks up the text for emails
564 * Usage: 1
565 *
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()
570 * @return string
571 */
572 public static function breakTextForEmail($str,$implChar="\n",$charWidth=76) {
573 $lines = explode(chr(10),$str);
574 $outArr=array();
575 while(list(,$lStr)=each($lines)) {
576 $outArr[] = t3lib_div::breakLinesForEmail($lStr,$implChar,$charWidth);
577 }
578 return implode(chr(10),$outArr);
579 }
580
581 /**
582 * Breaks up a single line of text for emails
583 * Usage: 5
584 *
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
588 * @return string
589 * @see breakTextForEmail()
590 */
591 public static function breakLinesForEmail($str,$implChar="\n",$charWidth=76) {
592 $lines=array();
593 $l=$charWidth;
594 $p=0;
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]);
602 } else {
603 $afterParts = explode(' ',substr($str,$l+$p),2);
604 $theLine = $substr.$afterParts[0];
605 }
606 if (!strlen($theLine)) {break; } // Error, because this would keep us in an endless loop.
607 } else {
608 $theLine=$substr;
609 }
610
611 $lines[]=trim($theLine);
612 $p+=strlen($theLine);
613 if (!trim(substr($str,$p,$l))) break; // added...
614 }
615 return implode($implChar,$lines);
616 }
617
618 /**
619 * Match IP number with list of numbers with wildcard
620 * Dispatcher method for switching into specialised IPv4 and IPv6 methods.
621 * Usage: 10
622 *
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
626 */
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);
631 } else {
632 return t3lib_div::cmpIPv4($baseIP, $list);
633 }
634 }
635
636 /**
637 * Match IPv4 number with list of numbers with wildcard
638 *
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
642 */
643 public static function cmpIPv4($baseIP, $list) {
644 $IPpartsReq = explode('.',$baseIP);
645 if (count($IPpartsReq)==4) {
646 $values = t3lib_div::trimExplode(',',$list,1);
647
648 foreach($values as $test) {
649 list($test,$mask) = explode('/',$test);
650
651 if(intval($mask)) {
652 // "192.168.3.0/24"
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);
660 } else {
661 // "192.168.*.*"
662 $IPparts = explode('.',$test);
663 $yes = 1;
664 reset($IPparts);
665 while(list($index,$val)=each($IPparts)) {
666 $val = trim($val);
667 if (strcmp($val,'*') && strcmp($IPpartsReq[$index],$val)) {
668 $yes=0;
669 }
670 }
671 }
672 if ($yes) return true;
673 }
674 }
675 return false;
676 }
677
678 /**
679 * Match IPv6 address with a list of IPv6 prefixes
680 *
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
684 */
685 public static function cmpIPv6($baseIP, $list) {
686 $success = false; // Policy default: Deny connection
687 $baseIP = t3lib_div::normalizeIPv6($baseIP);
688
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);
694 if (intval($mask)) {
695 switch ($mask) { // test on /48 /64
696 case '48':
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;
700 break;
701 case '64':
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;
705 break;
706 default:
707 $success = false;
708 }
709 } else {
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;
714 }
715 }
716 }
717 if ($success) return true;
718 }
719 return false;
720 }
721
722 /**
723 * [Describe function...]
724 *
725 * @param [type] $hex: ...
726 * @return [type] ...
727 */
728 public static function IPv6Hex2Bin ($hex) {
729 $bin = '';
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)));
733 }
734 return $bin;
735 }
736
737 /**
738 * Normalize an IPv6 address to full length
739 *
740 * @param string Given IPv6 address
741 * @return string Normalized address
742 */
743 public static function normalizeIPv6($address) {
744 $normalizedAddress = '';
745 $stageOneAddress = '';
746
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);
753
754 // Special case: leading zero-only blocks count to 1, should be 0
755 if ($left==1 && strlen($chunksLeft[0])==0) $left=0;
756
757 $hiddenBlocks = 8 - ($left + $right);
758 $hiddenPart = '';
759 while ($h<$hiddenBlocks) {
760 $hiddenPart .= '0000:';
761 $h++;
762 }
763
764 if ($left == 0) {
765 $stageOneAddress = $hiddenPart . $chunks[1];
766 } else {
767 $stageOneAddress = $chunks[0] . ':' . $hiddenPart . $chunks[1];
768 }
769 } else $stageOneAddress = $address;
770
771 // normalize the blocks:
772 $blocks = explode(':', $stageOneAddress);
773 $divCounter = 0;
774 foreach ($blocks as $block) {
775 $tmpBlock = '';
776 $i = 0;
777 $hiddenZeros = 4 - strlen($block);
778 while ($i < $hiddenZeros) {
779 $tmpBlock .= '0';
780 $i++;
781 }
782 $normalizedAddress .= $tmpBlock . $block;
783 if ($divCounter < 7) {
784 $normalizedAddress .= ':';
785 $divCounter++;
786 }
787 }
788 return $normalizedAddress;
789 }
790
791 /**
792 * Validate a given IP address to the IPv6 address format.
793 *
794 * Example for possible format: 43FB::BB3F:A0A0:0 | ::1
795 *
796 * @param string IP address to be tested
797 * @return boolean True if $ip is of IPv6 format.
798 */
799 public static function validIPv6($ip) {
800 $uppercaseIP = strtoupper($ip);
801
802 $regex = '/^(';
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})';
810 $regex.= ')$/';
811
812 return preg_match($regex, $uppercaseIP) ? true : false;
813 }
814
815 /**
816 * Match fully qualified domain name with list of strings with wildcard
817 *
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
821 */
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);
826
827 foreach($values as $test) {
828 $hostNameParts = explode('.',$test);
829 $yes = 1;
830
831 foreach($hostNameParts as $index => $val) {
832 $val = trim($val);
833 if (strcmp($val,'*') && strcmp($resolvedHostName[$index],$val)) {
834 $yes=0;
835 }
836 }
837 if ($yes) return true;
838 }
839 }
840 return false;
841 }
842
843 /**
844 * Check for item in list
845 * Check if an item exists in a comma-separated list of items.
846 * Usage: 163
847 *
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
851 */
852 public static function inList($list,$item) {
853 return strstr(','.$list.',', ','.$item.',') ? true : false;
854 }
855
856 /**
857 * Removes an item from a comma-separated list of items.
858 * Usage: 1
859 *
860 * @param string element to remove
861 * @param string comma-separated list of items (string)
862 * @return string new comma-separated list of items
863 */
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]);}
868 }
869 return implode(',',$items);
870 }
871
872 /**
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.
875 *
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>
879 */
880 public static function expandList($list) {
881 $items = explode(',',$list);
882 $list = array();
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++) {
888 $list[] = $n;
889
890 $runAwayBrake--;
891 if ($runAwayBrake<=0) break;
892 }
893 } else {
894 $list[] = $item;
895 }
896 }
897
898 return implode(',',$list);
899 }
900
901 /**
902 * Forces the integer $theInt into the boundaries of $min and $max. If the $theInt is 'false' then the $zeroValue is applied.
903 * Usage: 224
904 *
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
910 */
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;}
917 return $theInt;
918 }
919
920 /**
921 * Returns the $integer if greater than zero, otherwise returns zero.
922 * Usage: 1
923 *
924 * @param integer Integer string to process
925 * @return integer
926 */
927 public static function intval_positive($theInt) {
928 $theInt = intval($theInt);
929 if ($theInt<0){$theInt=0;}
930 return $theInt;
931 }
932
933 /**
934 * Returns an integer from a three part version number, eg '4.12.3' -> 4012003
935 * Usage: 2
936 *
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)
939 */
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));
943 }
944
945 /**
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)
948 *
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
952 */
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;
956
957 if (t3lib_div::int_from_ver($currVersionStr) < t3lib_div::int_from_ver($verNumberStr)) {
958 return FALSE;
959 } else {
960 return TRUE;
961 }
962 }
963
964 /**
965 * Makes a positive integer hash out of the first 7 chars from the md5 hash of the input
966 * Usage: 5
967 *
968 * @param string String to md5-hash
969 * @return integer Returns 28bit integer-hash
970 */
971 public static function md5int($str) {
972 return hexdec(substr(md5($str),0,7));
973 }
974
975 /**
976 * Returns the first 10 positions of the MD5-hash (changed from 6 to 10 recently)
977 *
978 * Usage: 37
979 *
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)
983 */
984 public static function shortMD5($input, $len=10) {
985 return substr(md5($input),0,$len);
986 }
987
988 /**
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.
991 * Usage: 16
992 *
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
996 */
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.');
1000
1001 return implode(',',array_unique(t3lib_div::trimExplode(',',$in_list,1)));
1002 }
1003
1004 /**
1005 * Splits a reference to a file in 5 parts
1006 * Usage: 43
1007 *
1008 * @param string Filename/filepath to be analysed
1009 * @return array Contains keys [path], [file], [filebody], [fileext], [realFileext]
1010 */
1011 public static function split_fileref($fileref) {
1012 $reg = array();
1013 if ( ereg('(.*/)(.*)$',$fileref,$reg) ) {
1014 $info['path'] = $reg[1];
1015 $info['file'] = $reg[2];
1016 } else {
1017 $info['path'] = '';
1018 $info['file'] = $fileref;
1019 }
1020 $reg='';
1021 if ( ereg('(.*)\.([^\.]*$)',$info['file'],$reg) ) {
1022 $info['filebody'] = $reg[1];
1023 $info['fileext'] = strtolower($reg[2]);
1024 $info['realFileext'] = $reg[2];
1025 } else {
1026 $info['filebody'] = $info['file'];
1027 $info['fileext'] = '';
1028 }
1029 reset($info);
1030 return $info;
1031 }
1032
1033 /**
1034 * Returns the directory part of a path without trailing slash
1035 * If there is no dir-part, then an empty string is returned.
1036 * Behaviour:
1037 *
1038 * '/dir1/dir2/script.php' => '/dir1/dir2'
1039 * '/dir1/' => '/dir1'
1040 * 'dir1/script.php' => 'dir1'
1041 * 'd/script.php' => 'd'
1042 * '/script.php' => ''
1043 * '' => ''
1044 * Usage: 5
1045 *
1046 * @param string Directory name / path
1047 * @return string Processed input value. See function description.
1048 */
1049 public static function dirname($path) {
1050 $p=t3lib_div::revExplode('/',$path,2);
1051 return count($p)==2?$p[0]:'';
1052 }
1053
1054 /**
1055 * Modifies a HTML Hex color by adding/subtracting $R,$G and $B integers
1056 * Usage: 11
1057 *
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()
1064 */
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);
1070 return '#'.
1071 substr('0'.dechex($nR),-2).
1072 substr('0'.dechex($nG),-2).
1073 substr('0'.dechex($nB),-2);
1074 }
1075
1076 /**
1077 * Modifies a HTML Hex color by adding/subtracting $all integer from all R/G/B channels
1078 * Usage: 6
1079 *
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()
1084 */
1085 public static function modifyHTMLColorAll($color,$all) {
1086 return t3lib_div::modifyHTMLColor($color,$all,$all,$all);
1087 }
1088
1089 /**
1090 * Removes comma (if present) in the end of string
1091 * Usage: 2
1092 *
1093 * @param string String from which the comma in the end (if any) will be removed.
1094 * @return string
1095 */
1096 public static function rm_endcomma($string) {
1097 return ereg_replace(',$','',$string);
1098 }
1099
1100 /**
1101 * strtoupper which converts danish (and other characters) characters as well
1102 * Usage: 0
1103 *
1104 * @param string String to process
1105 * @return string
1106 * @deprecated Use t3lib_cs::conv_case() instead or for HTML output, wrap your content in <span class="uppercase">...</span>)
1107 * @ignore
1108 */
1109 public static function danish_strtoupper($string) {
1110 $value = strtoupper($string);
1111 return strtr($value, 'áéúíâêûôîæøåäöü', 'ÁÉÚÍÄËÜÖÏÆØÅÄÖÜ');
1112 }
1113
1114 /**
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.
1117 *
1118 * ä => ae, Ö => Oe
1119 *
1120 * @param string String to convert.
1121 * @deprecated Works only for western europe single-byte charsets! Use t3lib_cs::specCharsToASCII() instead!
1122 * @return string
1123 */
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);
1128 }
1129
1130 /**
1131 * Tests if the input is an integer.
1132 * Usage: 77
1133 *
1134 * @param mixed Any input variable to test.
1135 * @return boolean Returns true if string is an integer
1136 */
1137 public static function testInt($var) {
1138 return !strcmp($var,intval($var));
1139 }
1140
1141 /**
1142 * Returns true if the first part of $str matches the string $partStr
1143 * Usage: 59
1144 *
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
1148 */
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);
1152 if ($psLen) {
1153 return substr($str,0,$psLen)==(string)$partStr;
1154 } else return false;
1155 }
1156
1157 /**
1158 * Formats the input integer $sizeInBytes as bytes/kilobytes/megabytes (-/K/M)
1159 * Usage: 53
1160 *
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.
1164 */
1165 public static function formatSize($sizeInBytes,$labels='') {
1166
1167 // Set labels:
1168 if (strlen($labels) == 0) {
1169 $labels = ' | K| M| G';
1170 } else {
1171 $labels = str_replace('"','',$labels);
1172 }
1173 $labelArr = explode('|',$labels);
1174
1175 // Find size:
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];
1180 }
1181 elseif ($sizeInBytes>900000) { // MB
1182 $val = $sizeInBytes/(1024*1024);
1183 return number_format($val, (($val<20)?1:0), '.', '').$labelArr[2];
1184 } else { // KB
1185 $val = $sizeInBytes/(1024);
1186 return number_format($val, (($val<20)?1:0), '.', '').$labelArr[1];
1187 }
1188 } else { // Bytes
1189 return $sizeInBytes.$labelArr[0];
1190 }
1191 }
1192
1193 /**
1194 * Returns microtime input to milliseconds
1195 * Usage: 2
1196 *
1197 * @param string Microtime
1198 * @return integer Microtime input string converted to an integer (milliseconds)
1199 */
1200 public static function convertMicrotime($microtime) {
1201 $parts = explode(' ',$microtime);
1202 return round(($parts[0]+$parts[1])*1000);
1203 }
1204
1205 /**
1206 * This splits a string by the chars in $operators (typical /+-*) and returns an array with them in
1207 * Usage: 2
1208 *
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()
1213 */
1214 public static function splitCalc($string,$operators) {
1215 $res = Array();
1216 $sign='+';
1217 while($string) {
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);
1223 }
1224 reset($res);
1225 return $res;
1226 }
1227
1228 /**
1229 * Calculates the input by +,-,*,/,%,^ with priority to + and -
1230 * Usage: 1
1231 *
1232 * @param string Input string, eg "123 + 456 / 789 - 4"
1233 * @return integer Calculated value. Or error string.
1234 * @see calcParenthesis()
1235 */
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
1239 $qm='\*\/\+-^%';
1240 $regex = '(['.$qm.'])(['.$qm.']?[0-9\.]*)';
1241 // split the expression here:
1242 $reg = array();
1243 preg_match_all('/'.$regex.'/',$string,$reg);
1244
1245 reset($reg[2]);
1246 $number=0;
1247 $Msign='+';
1248 $err='';
1249 $buffer=doubleval(current($reg[2]));
1250 next($reg[2]); // Advance pointer
1251 while(list($k,$v)=each($reg[2])) {
1252 $v=doubleval($v);
1253 $sign = $reg[1][$k];
1254 if ($sign=='+' || $sign=='-') {
1255 $number = $Msign=='-' ? $number-=$buffer : $number+=$buffer;
1256 $Msign = $sign;
1257 $buffer=$v;
1258 } else {
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);}
1263 }
1264 }
1265 $number = $Msign=='-' ? $number-=$buffer : $number+=$buffer;
1266 return $err ? 'ERROR: '.$err : $number;
1267 }
1268
1269 /**
1270 * Calculates the input with parenthesis levels
1271 * Usage: 2
1272 *
1273 * @param string Input string, eg "(123 + 456) / 789 - 4"
1274 * @return integer Calculated value. Or error string.
1275 * @see calcPriority(), tslib_cObj::stdWrap()
1276 */
1277 public static function calcParenthesis($string) {
1278 $securC=100;
1279 do {
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);
1285 return $string;
1286 } else {
1287 $string = substr($string,0,$valueLenO).t3lib_div::calcParenthesis(substr($string,$valueLenO+1));
1288 }
1289 // Security:
1290 $securC--;
1291 if ($securC<=0) break;
1292 } while($valueLenO<strlen($string));
1293 return $string;
1294 }
1295
1296 /**
1297 * Inverse version of htmlspecialchars()
1298 * Usage: 4
1299 *
1300 * @param string Value where &gt;, &lt;, &quot; and &amp; should be converted to regular chars.
1301 * @return string Converted result.
1302 */
1303 public static function htmlspecialchars_decode($value) {
1304 $value = str_replace('&gt;','>',$value);
1305 $value = str_replace('&lt;','<',$value);
1306 $value = str_replace('&quot;','"',$value);
1307 $value = str_replace('&amp;','&',$value);
1308 return $value;
1309 }
1310
1311 /**
1312 * Re-converts HTML entities if they have been converted by htmlspecialchars()
1313 * Usage: 10
1314 *
1315 * @param string String which contains eg. "&amp;amp;" which should stay "&amp;". Or "&amp;#1234;" to "&#1234;". Or "&amp;#x1b;" to "&#x1b;"
1316 * @return string Converted result.
1317 */
1318 public static function deHSCentities($str) {
1319 return ereg_replace('&amp;([#[:alnum:]]*;)','&\1',$str);
1320 }
1321
1322 /**
1323 * This function is used to escape any ' -characters when transferring text to JavaScript!
1324 * Usage: 3
1325 *
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
1330 */
1331 public static function slashJS($string,$extended=0,$char="'") {
1332 if ($extended) {$string = str_replace ("\\", "\\\\", $string);}
1333 return str_replace ($char, "\\".$char, $string);
1334 }
1335
1336 /**
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.
1339 * Usage: 4
1340 *
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.
1343 */
1344 public static function rawUrlEncodeJS($str) {
1345 return str_replace('%20',' ',rawurlencode($str));
1346 }
1347
1348 /**
1349 * rawurlencode which preserves "/" chars
1350 * Usefull when filepaths should keep the "/" chars, but have all other special chars encoded.
1351 * Usage: 5
1352 *
1353 * @param string Input string
1354 * @return string Output string
1355 */
1356 public static function rawUrlEncodeFP($str) {
1357 return str_replace('%2F','/',rawurlencode($str));
1358 }
1359
1360 /**
1361 * Checking syntax of input email address
1362 * Usage: 5
1363 *
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.
1366 */
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;
1371 }
1372
1373 /**
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!
1377 * Usage: 23
1378 *
1379 * @param string Input string to be formatted.
1380 * @return string Formatted for <textarea>-tags
1381 */
1382 public static function formatForTextarea($content) {
1383 return chr(10).htmlspecialchars($content);
1384 }
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397 /*************************
1398 *
1399 * ARRAY FUNCTIONS
1400 *
1401 *************************/
1402
1403 /**
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()!!!
1406 * Usage: 3
1407 *
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
1411 * @internal
1412 */
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;
1416 }
1417 }
1418
1419 /**
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.
1422 * Usage: 76
1423 *
1424 * @param string Delimiter string to explode with
1425 * @param string The string to explode
1426 * @return array Exploded values, all converted to integers
1427 */
1428 public static function intExplode($delim, $string) {
1429 $temp = explode($delim,$string);
1430 while(list($key,$val)=each($temp)) {
1431 $temp[$key]=intval($val);
1432 }
1433 reset($temp);
1434 return $temp;
1435 }
1436
1437 /**
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')
1440 * Usage: 8
1441 *
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
1446 */
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);
1451 }
1452 $temp = array_reverse($temp);
1453 reset($temp);
1454 return $temp;
1455 }
1456
1457 /**
1458 * Explodes a string and trims all values for whitespace in the ends.
1459 * If $onlyNonEmptyValues is set, then all blank ('') values are removed.
1460 * Usage: 256
1461 *
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
1466 */
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);
1476 if ($value != '') {
1477 $new_array[] = $value;
1478 }
1479 }
1480 // direct return for perfomance reasons
1481 return $new_array;
1482 }
1483
1484 foreach($array as &$value) {
1485 $value = trim($value);
1486 }
1487
1488 return $array;
1489 }
1490
1491 /**
1492 * Remove duplicate values from an array
1493 * Usage: 0
1494 *
1495 * @param array Array of values to make unique
1496 * @return array
1497 * @ignore
1498 * @deprecated Use the PHP function array_unique instead
1499 */
1500 public static function uniqueArray(array $valueArray) {
1501 return array_unique($valueArray);
1502 }
1503
1504 /**
1505 * Removes the value $cmpValue from the $array if found there. Returns the modified array
1506 * Usage: 3
1507 *
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
1511 */
1512 public static function removeArrayEntryByValue(array $array, $cmpValue) {
1513 reset($array);
1514 while(list($k,$v)=each($array)) {
1515 if (is_array($v)) {
1516 $array[$k] = t3lib_div::removeArrayEntryByValue($v,$cmpValue);
1517 } else {
1518 if (!strcmp($v,$cmpValue)) {
1519 unset($array[$k]);
1520 }
1521 }
1522 }
1523 reset($array);
1524 return $array;
1525 }
1526
1527 /**
1528 * Implodes a multidim-array into GET-parameters (eg. &param[key][key2]=value2&param[key][key3]=value3)
1529 * Usage: 24
1530 *
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. &param[key][key2]=value2&param[key][key3]=value3
1537 * @see explodeUrl2Array()
1538 */
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);
1544 } else {
1545 if (!$skipBlank || strcmp($AVal,'')) {
1546 $str.='&'.($rawurlencodeParamName ? rawurlencode($thisKeyName) : $thisKeyName).
1547 '='.rawurlencode($AVal);
1548 }
1549 }
1550 }
1551 return $str;
1552 }
1553
1554 /**
1555 * Explodes a string with GETvars (eg. "&id=1&type=2&ext[mykey]=3") into an array
1556 *
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()
1561 */
1562 public static function explodeUrl2Array($string,$multidim=FALSE) {
1563 $output = array();
1564 if ($multidim) {
1565 parse_str($string,$output);
1566 } else {
1567 $p = explode('&',$string);
1568 foreach($p as $v) {
1569 if (strlen($v)) {
1570 list($pK,$pV) = explode('=',$v,2);
1571 $output[rawurldecode($pK)] = rawurldecode($pV);
1572 }
1573 }
1574 }
1575 return $output;
1576 }
1577
1578 /**
1579 * Returns an array with selected keys from incoming data.
1580 * (Better read source code if you want to find out...)
1581 * Usage: 3
1582 *
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.
1587 */
1588 public static function compileSelectedGetVarsFromArray($varList,array $getArray,$GPvarAlt=1) {
1589 $keys = t3lib_div::trimExplode(',',$varList,1);
1590 $outArr = array();
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);
1596 }
1597 }
1598 return $outArr;
1599 }
1600
1601 /**
1602 * AddSlash array
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
1606 * Usage: 8
1607 *
1608 * @param array Multidimensional input array, (REFERENCE!)
1609 * @return array
1610 */
1611 public static function addSlashesOnArray(array &$theArray) {
1612 reset($theArray);
1613 while(list($Akey,$AVal)=each($theArray)) {
1614 if (is_array($AVal)) {
1615 t3lib_div::addSlashesOnArray($theArray[$Akey]);
1616 } else {
1617 $theArray[$Akey] = addslashes($AVal);
1618 }
1619 }
1620 reset($theArray);
1621 }
1622
1623 /**
1624 * StripSlash array
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
1628 * Usage: 10
1629 *
1630 * @param array Multidimensional input array, (REFERENCE!)
1631 * @return array
1632 */
1633 public static function stripSlashesOnArray(array &$theArray) {
1634 reset($theArray);
1635 while(list($Akey,$AVal)=each($theArray)) {
1636 if (is_array($AVal)) {
1637 t3lib_div::stripSlashesOnArray($theArray[$Akey]);
1638 } else {
1639 $theArray[$Akey] = stripslashes($AVal);
1640 }
1641 }
1642 reset($theArray);
1643 }
1644
1645 /**
1646 * Either slashes ($cmd=add) or strips ($cmd=strip) array $arr depending on $cmd
1647 * Usage: 0
1648 *
1649 * @param array Multidimensional input array
1650 * @param string "add" or "strip", depending on usage you wish.
1651 * @return array
1652 */
1653 public static function slashArray(array $arr,$cmd) {
1654 if ($cmd=='strip') t3lib_div::stripSlashesOnArray($arr);
1655 if ($cmd=='add') t3lib_div::addSlashesOnArray($arr);
1656 return $arr;
1657 }
1658
1659 /**
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.
1662 * Usage: 0
1663 *
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
1669 */
1670 public static function array_merge_recursive_overrule(array $arr0,array $arr1,$notAddKeys=0,$includeEmtpyValues=true) {
1671 reset($arr1);
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);
1676 }
1677 } else {
1678 if ($notAddKeys) {
1679 if (isset($arr0[$key])) {
1680 if ($includeEmtpyValues || $val) {
1681 $arr0[$key] = $val;
1682 }
1683 }
1684 } else {
1685 if ($includeEmtpyValues || $val) {
1686 $arr0[$key] = $val;
1687 }
1688 }
1689 }
1690 }
1691 reset($arr0);
1692 return $arr0;
1693 }
1694
1695 /**
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.
1697 * Usage: 16
1698 *
1699 * @param array First array
1700 * @param array Second array
1701 * @return array Merged result.
1702 */
1703 public static function array_merge(array $arr1,array $arr2) {
1704 return $arr2+$arr1;
1705 }
1706
1707 /**
1708 * Takes a row and returns a CSV string of the values with $delim (default is ,) and $quote (default is ") as separator chars.
1709 * Usage: 5
1710 *
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
1715 */
1716 public static function csvValues(array $row,$delim=',',$quote='"') {
1717 reset($row);
1718 $out=array();
1719 foreach ($row as $value) {
1720 $out[] = str_replace($quote, $quote.$quote, $value);
1721 }
1722 $str = $quote.implode($quote.$delim.$quote,$out).$quote;
1723 return $str;
1724 }
1725
1726 /**
1727 * Creates recursively a JSON literal from a mulidimensional associative array.
1728 * Uses Services_JSON (http://mike.teczno.com/JSON/doc/)
1729 *
1730 * @param array $jsonArray: The array to be transformed to JSON
1731 * @return string JSON string
1732 */
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');
1737 }
1738 return $GLOBALS['JSON']->encode($jsonArray);
1739 }
1740
1741 /**
1742 * Removes dots "." from end of a key identifier of TypoScript styled array.
1743 * array('key.' => array('property.' => 'value')) --> array('key' => array('property' => 'value'))
1744 *
1745 * @param array $ts: TypoScript configuration array
1746 * @return array TypoScript configuration array without dots at the end of all keys
1747 */
1748 public static function removeDotsFromTS(array $ts) {
1749 $out = array();
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);
1755 } else {
1756 $out[$key] = $value;
1757 }
1758 }
1759 }
1760 return $out;
1761 }
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778 /*************************
1779 *
1780 * HTML/XML PROCESSING
1781 *
1782 *************************/
1783
1784 /**
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()
1788 * Usage: 8
1789 *
1790 * @param string HTML-tag string (or attributes only)
1791 * @return array Array with the attribute values.
1792 */
1793 public static function get_tag_attributes($tag) {
1794 $components = t3lib_div::split_tag_attributes($tag);
1795 $name = ''; // attribute name is stored here
1796 $valuemode = false;
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
1800 if ($valuemode) {
1801 if ($name) {
1802 $attributes[$name] = $val;
1803 $name = '';
1804 }
1805 } else {
1806 if ($key = strtolower(ereg_replace('[^a-zA-Z0-9]','',$val))) {
1807 $attributes[$key] = '';
1808 $name = $key;
1809 }
1810 }
1811 $valuemode = false;
1812 } else {
1813 $valuemode = true;
1814 }
1815 }
1816 return $attributes;
1817 }
1818
1819 /**
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
1822 * Usage: 2
1823 *
1824 * @param string HTML-tag string (or attributes only)
1825 * @return array Array with the attribute values.
1826 * @internal
1827 */
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));
1832
1833 $value = array();
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);
1838 $value[]=$reg[1];
1839 $tag_tmp=trim($reg[2]);
1840 } elseif (!strcmp($firstChar,'=')) {
1841 $value[] = '=';
1842 $tag_tmp = trim(substr($tag_tmp,1)); // Removes = chars.
1843 } else {
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]);
1848 }
1849 }
1850 reset($value);
1851 return $value;
1852 }
1853
1854 /**
1855 * Implodes attributes in the array $arr for an attribute list in eg. and HTML tag (with quotes)
1856 * Usage: 14
1857 *
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"'
1862 */
1863 public static function implodeAttributes(array $arr,$xhtmlSafe=FALSE,$dontOmitBlankAttribs=FALSE) {
1864 if ($xhtmlSafe) {
1865 $newArr=array();
1866 foreach($arr as $p => $v) {
1867 if (!isset($newArr[strtolower($p)])) $newArr[strtolower($p)] = htmlspecialchars($v);
1868 }
1869 $arr = $newArr;
1870 }
1871 $list = array();
1872 foreach($arr as $p => $v) {
1873 if (strcmp($v,'') || $dontOmitBlankAttribs) {$list[]=$p.'="'.$v.'"';}
1874 }
1875 return implode(' ',$list);
1876 }
1877
1878 /**
1879 * Implodes attributes in the array $arr for an attribute list in eg. and HTML tag (with quotes)
1880 *
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()
1887 */
1888 public static function implodeParams(array $arr,$xhtmlSafe=FALSE,$dontOmitBlankAttribs=FALSE) {
1889 return t3lib_div::implodeAttributes($arr,$xhtmlSafe,$dontOmitBlankAttribs);
1890 }
1891
1892 /**
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.
1896 *
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>
1902 */
1903 public static function wrapJS($string, $linebreak=TRUE) {
1904 if(trim($string)) {
1905 // <script wrapped in nl?
1906 $cr = $linebreak? "\n" : '';
1907
1908 // remove nl from the beginning
1909 $string = preg_replace ('/^\n+/', '', $string);
1910 // re-ident to one tab using the first line as reference
1911 $match = array();
1912 if(preg_match('/^(\t+)/',$string,$match)) {
1913 $string = str_replace($match[1],"\t", $string);
1914 }
1915 $string = $cr.'<script type="text/javascript">
1916 /*<![CDATA[*/
1917 '.$string.'
1918 /*]]>*/
1919 </script>'.$cr;
1920 }
1921 return trim($string);
1922 }
1923
1924
1925 /**
1926 * Parses XML input into a PHP array with associative keys
1927 * Usage: 0
1928 *
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
1933 */
1934 public static function xml2tree($string,$depth=999) {
1935 $parser = xml_parser_create();
1936 $vals = array();
1937 $index = array();
1938
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);
1942
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);
1945
1946 $stack = array( array() );
1947 $stacktop = 0;
1948 $startPoint=0;
1949
1950 // FIXME don't use unset() - what does that mean? Use NULL or similar.
1951 unset($tagi);
1952 foreach($vals as $key => $val) {
1953 $type = $val['type'];
1954
1955 // open tag:
1956 if ($type=='open' || $type=='complete') {
1957 $stack[$stacktop++] = $tagi;
1958
1959 if ($depth==$stacktop) {
1960 $startPoint=$key;
1961 }
1962
1963 $tagi = array('tag' => $val['tag']);
1964
1965 if(isset($val['attributes'])) $tagi['attrs'] = $val['attributes'];
1966 if(isset($val['value'])) $tagi['values'][] = $val['value'];
1967 }
1968 // finish tag:
1969 if ($type=='complete' || $type=='close') {
1970 $oldtagi = $tagi;
1971 $tagi = $stack[--$stacktop];
1972 $oldtag = $oldtagi['tag'];
1973 unset($oldtagi['tag']);
1974
1975 if ($depth==($stacktop+1)) {
1976 if ($key-$startPoint > 0) {
1977 $partArray = array_slice(
1978 $vals,
1979 $startPoint+1,
1980 $key-$startPoint-1
1981 );
1982 #$oldtagi=array('XMLvalue'=>t3lib_div::xmlRecompileFromStructValArray($partArray));
1983 $oldtagi['XMLvalue']=t3lib_div::xmlRecompileFromStructValArray($partArray);
1984 } else {
1985 $oldtagi['XMLvalue']=$oldtagi['values'][0];
1986 }
1987 }
1988
1989 $tagi['ch'][$oldtag][] = $oldtagi;
1990 unset($oldtagi);
1991 }
1992 // cdata
1993 if($type=='cdata') {
1994 $tagi['values'][] = $val['value'];
1995 }
1996 }
1997 return $tagi['ch'];
1998 }
1999
2000 /**
2001 * Turns PHP array into XML. See array2xml()
2002 *
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()
2009 */
2010 public static function array2xml_cs(array $array,$docTag='phparray',array $options=array(),$charset='') {
2011
2012 // Figure out charset if not given explicitly:
2013 if (!$charset) {
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
2018 } else {
2019 $charset = 'iso-8859-1'; // THIS is just a hopeful guess!
2020 }
2021 }
2022
2023 // Return XML:
2024 return '<?xml version="1.0" encoding="'.htmlspecialchars($charset).'" standalone="yes" ?>'.chr(10).
2025 t3lib_div::array2xml($array,'',0,$docTag,0, $options);
2026 }
2027
2028 /**
2029 * Deprecated to call directly (unless you are aware of using XML prologues)! Use "array2xml_cs" instead (which adds an XML-prologue)
2030 *
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...
2039 * Usage: 5
2040 *
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.
2049 * @see xml2array()
2050 */
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).
2056 chr(30).chr(31);
2057 // Set indenting mode:
2058 $indentChar = $spaceInd ? ' ' : chr(9);
2059 $indentN = $spaceInd>0 ? $spaceInd : 1;
2060 $nl = ($spaceInd >= 0 ? chr(10) : '');
2061
2062 // Init output variable:
2063 $output='';
2064
2065 // Traverse the input array
2066 foreach($array as $k=>$v) {
2067 $attr = '';
2068 $tagName = $k;
2069
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';
2089 }
2090 } elseif($options['useIndexTagForAssoc']) { // Use tag for all associative keys:
2091 $attr.=' index="'.htmlspecialchars($tagName).'"';
2092 $tagName = $options['useIndexTagForAssoc'];
2093 }
2094
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);
2097
2098 // If the value is an array then we will call this function recursively:
2099 if (is_array($v)) {
2100
2101 // Sub elements:
2102 if ($options['alt_options'][$stackData['path'].'/'.$tagName]) {
2103 $subOptions = $options['alt_options'][$stackData['path'].'/'.$tagName];
2104 $clearStackPath = $subOptions['clearStackPath'];
2105 } else {
2106 $subOptions = $options;
2107 $clearStackPath = FALSE;
2108 }
2109
2110 $content = $nl .
2111 t3lib_div::array2xml(
2112 $v,
2113 $NSprefix,
2114 $level+1,
2115 '',
2116 $spaceInd,
2117 $subOptions,
2118 array(
2119 'parentTagName' => $tagName,
2120 'grandParentTagName' => $stackData['parentTagName'],
2121 'path' => $clearStackPath ? '' : $stackData['path'].'/'.$tagName,
2122 )
2123 ).
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"';
2127 }
2128 } else { // Just a value:
2129
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"';
2136 } else {
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 . ']]>';
2143 }
2144 } elseif (!$options['disableTypeAttrib']) {
2145 $attr.= ' type="'.$dType.'"';
2146 }
2147 }
2148 }
2149
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;
2152 }
2153
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:
2155 if (!$level) {
2156 $output =
2157 '<'.$docTag.'>'.$nl.
2158 $output.
2159 '</'.$docTag.'>';
2160 }
2161
2162 return $output;
2163 }
2164
2165 /**
2166 * Converts an XML string to a PHP array.
2167 * This is the reverse function of array2xml()
2168 * Usage: 17
2169 *
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.
2174 * @see array2xml()
2175 */
2176 public static function xml2array($string,$NSprefix='',$reportDocTag=FALSE) {
2177 global $TYPO3_CONF_VARS;
2178
2179 // Create parser:
2180 $parser = xml_parser_create();
2181 $vals = array();
2182 $index = array();
2183
2184 xml_parser_set_option($parser, XML_OPTION_CASE_FOLDING, 0);
2185 xml_parser_set_option($parser, XML_OPTION_SKIP_WHITE, 0);
2186
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!!!
2189 $match = array();
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
2193
2194 // Parse content:
2195 xml_parse_into_struct($parser, $string, $vals, $index);
2196
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));
2200 }
2201 xml_parser_free($parser);
2202
2203 // Init vars:
2204 $stack = array(array());
2205 $stacktop = 0;
2206 $current = array();
2207 $tagName = '';
2208 $documentTag = '';
2209
2210 // Traverse the parsed XML structure:
2211 foreach($vals as $key => $val) {
2212
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;
2216
2217 // Test for name space:
2218 $tagName = ($NSprefix && substr($tagName,0,strlen($NSprefix))==$NSprefix) ? substr($tagName,strlen($NSprefix)) : $tagName;
2219
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;
2223
2224 // Test for alternative index value:
2225 if (strlen($val['attributes']['index'])) { $tagName = $val['attributes']['index']; }
2226
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;
2232 $current = array();
2233 break;
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;
2239 unset($oldCurrent);
2240 break;
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']);
2244 } else {
2245 $current[$tagName] = (string)$val['value']; // Had to cast it as a string - otherwise it would be evaluate false if tested with isset()!!
2246
2247 // Cast type:
2248 switch((string)$val['attributes']['type']) {
2249 case 'integer':
2250 $current[$tagName] = (integer)$current[$tagName];
2251 break;
2252 case 'double':
2253 $current[$tagName] = (double)$current[$tagName];
2254 break;
2255 case 'boolean':
2256 $current[$tagName] = (bool)$current[$tagName];
2257 break;
2258 case 'array':
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...
2260 break;
2261 }
2262 }
2263 break;
2264 }
2265 }
2266
2267 if ($reportDocTag) {
2268 $current[$tagName]['_DOCUMENT_TAG'] = $documentTag;
2269 }
2270
2271 // Finally return the content of the document tag.
2272 return $current[$tagName];
2273 }
2274
2275 /**
2276 * This implodes an array of XML parts (made with xml_parse_into_struct()) into XML again.
2277 * Usage: 2
2278 *
2279 * @param array A array of XML parts, see xml2tree
2280 * @return string Re-compiled XML data.
2281 */
2282 public static function xmlRecompileFromStructValArray(array $vals) {
2283 $XMLcontent='';
2284
2285 foreach($vals as $val) {
2286 $type = $val['type'];
2287
2288 // open tag:
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).'"';
2294 }
2295 }
2296 if ($type=='complete') {
2297 if(isset($val['value'])) {
2298 $XMLcontent.='>'.htmlspecialchars($val['value']).'</'.$val['tag'].'>';
2299 } else $XMLcontent.='/>';
2300 } else $XMLcontent.='>';
2301
2302 if ($type=='open' && isset($val['value'])) {
2303 $XMLcontent.=htmlspecialchars($val['value']);
2304 }
2305 }
2306 // finish tag:
2307 if ($type=='close') {
2308 $XMLcontent.='</'.$val['tag'].'>';
2309 }
2310 // cdata
2311 if($type=='cdata') {
2312 $XMLcontent.=htmlspecialchars($val['value']);
2313 }
2314 }
2315
2316 return $XMLcontent;
2317 }
2318
2319 /**
2320 * Extracts the attributes (typically encoding and version) of an XML prologue (header).
2321 * Usage: 1
2322 *
2323 * @param string XML data
2324 * @return array Attributes of the xml prologue (header)
2325 */
2326 public static function xmlGetHeaderAttribs($xmlData) {
2327 $match = array();
2328 if (preg_match('/^\s*<\?xml([^>]*)\?\>/', $xmlData, $match)) {
2329 return t3lib_div::get_tag_attributes($match[1]);
2330 }
2331 }
2332
2333 /**
2334 * Minifies JavaScript
2335 *
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
2339 */
2340 public static function minifyJavaScript($script, &$error = '') {
2341 require_once(PATH_typo3 . 'contrib/jsmin/jsmin.php');
2342 try {
2343 $error = '';
2344 $script = trim(JSMin::minify(str_replace(chr(13), '', $script)));
2345 }
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()));
2350 }
2351 return $script;
2352 }
2353
2354
2355
2356
2357
2358
2359
2360
2361 /*************************
2362 *
2363 * FILES FUNCTIONS
2364 *
2365 *************************/
2366
2367 /**
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.
2370 * Usage: 83
2371 *
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.
2376 */
2377 public static function getURL($url, $includeHeader = 0, $requestHeaders = false) {
2378 $content = false;
2379
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.
2383 $ch = curl_init();
2384 if (!$ch) {
2385 return false;
2386 }
2387
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);
2396 }
2397
2398 if ($GLOBALS['TYPO3_CONF_VARS']['SYS']['curlProxyServer']) {
2399 curl_setopt($ch, CURLOPT_PROXY, $GLOBALS['TYPO3_CONF_VARS']['SYS']['curlProxyServer']);
2400
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']);
2404 }
2405 if ($GLOBALS['TYPO3_CONF_VARS']['SYS']['curlProxyUserPass']) {
2406 curl_setopt($ch, CURLOPT_PROXYUSERPWD, $GLOBALS['TYPO3_CONF_VARS']['SYS']['curlProxyUserPass']);
2407 }
2408 }
2409 $content = curl_exec($ch);
2410 curl_close($ch);
2411
2412 } elseif ($includeHeader) {
2413 $parsedURL = parse_url($url);
2414 if (!t3lib_div::inList('ftp,ftps,http,https,gopher,telnet', $parsedURL['scheme'])) {
2415 return false;
2416 }
2417
2418 $fp = @fsockopen($parsedURL['host'], ($parsedURL['port'] > 0 ? $parsedURL['port'] : 80), $errno, $errstr, 2.0);
2419 if (!$fp) {
2420 return false;
2421 }
2422
2423 $msg = 'GET ' . $parsedURL['path'] .
2424 ($parsedURL['query'] ? '?' . $parsedURL['query'] : '') .
2425 ' HTTP/1.0' . "\r\n" . 'Host: ' .
2426 $parsedURL['host'] . "\r\n\r\n";
2427 fputs($fp, $msg);
2428 while (!feof($fp)) {
2429 $line = fgets($fp, 2048);
2430 $content.= $line;
2431 if ($includeHeader == 2 && !strlen(trim($line))) {
2432 break; // Stop at the first empty line (= end of header)
2433 }
2434 }
2435 fclose($fp);
2436
2437 } elseif (is_array($requestHeaders)) {
2438 $ctx = stream_context_create(array(
2439 'http' => array(
2440 'header' => implode("\r\n", $requestHeaders)
2441 )
2442 )
2443 );
2444 $content = @file_get_contents($url, false, $ctx);
2445 }
2446 else {
2447 $content = @file_get_contents($url);
2448 }
2449
2450 return $content;
2451 }
2452
2453 /**
2454 * Writes $content to the file $file
2455 * Usage: 30
2456 *
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.
2460 */
2461 public static function writeFile($file,$content) {
2462 if (!@is_file($file)) $changePermissions = true;
2463
2464 if ($fd = fopen($file,'wb')) {
2465 $res = fwrite($fd,$content);
2466 fclose($fd);
2467
2468 if ($res===false) return false;
2469
2470 if ($changePermissions) { // Change the permissions only if the file has just been created
2471 t3lib_div::fixPermissions($file);
2472 }
2473
2474 return true;
2475 }
2476
2477 return false;
2478 }
2479
2480 /**
2481 * Setting file system mode & group ownership of file
2482 *
2483 * @param string Filepath of newly created file
2484 * @return void
2485 */
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
2491 }
2492 }
2493 }
2494
2495 /**
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!
2498 *
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.
2502 */
2503 public static function writeFileToTypo3tempDir($filepath,$content) {
2504
2505 // Parse filepath into directory and basename:
2506 $fI = pathinfo($filepath);
2507 $fI['dirname'].= '/';
2508
2509 // Check parts:
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)) {
2515
2516 // Checking if the "subdir" is found:
2517 $subdir = substr($fI['dirname'],strlen($dirName));
2518 if ($subdir) {
2519 if (ereg('^[[:alnum:]_]+\/$',$subdir) || ereg('^[[:alnum:]_]+\/[[:alnum:]_]+\/$',$subdir)) {
2520 $dirName.= $subdir;
2521 if (!@is_dir($dirName)) {
2522 t3lib_div::mkdir_deep(PATH_site.'typo3temp/', $subdir);
2523 }
2524 } else return 'Subdir, "'.$subdir.'", was NOT on the form "[[:alnum:]_]/" or "[[:alnum:]_]/[[:alnum:]_]/"';
2525 }
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!';
2537 }
2538
2539 /**
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']
2541 * Usage: 6
2542 *
2543 * @param string Absolute path to folder, see PHP mkdir() function. Removes trailing slash internally.
2544 * @return boolean TRUE if @mkdir went well!
2545 */
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
2550
2551 if($GLOBALS['TYPO3_CONF_VARS']['BE']['createGroup']) { // skip this if createGroup is empty
2552 chgrp($theNewFolder, $GLOBALS['TYPO3_CONF_VARS']['BE']['createGroup']);
2553 }
2554 return TRUE;
2555 }
2556 }
2557
2558 /**
2559 * Creates a directory - including parent directories if necessary - in the file system
2560 *
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.
2564 */
2565 public static function mkdir_deep($destination,$deepDir) {
2566 $allParts = t3lib_div::trimExplode('/',$deepDir,1);
2567 $root = '';
2568 foreach($allParts as $part) {
2569 $root.= $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...';
2574 }
2575 }
2576 }
2577 }
2578
2579 /**
2580 * Wrapper function for rmdir, allowing recursive deletion of folders and files
2581 *
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!
2585 */
2586 public static function rmdir($path,$removeNonEmpty=false) {
2587 $OK = false;
2588 $path = preg_replace('|/$|','',$path); // Remove trailing slash
2589
2590 if (file_exists($path)) {
2591 $OK = true;
2592
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);
2598 }
2599 closedir($handle);
2600 }
2601 if ($OK) { $OK = rmdir($path); }
2602
2603 } else { // If $dirname is a file, simply remove it
2604 $OK = unlink($path);
2605 }
2606
2607 clearstatcache();
2608 }
2609
2610 return $OK;
2611 }
2612
2613 /**
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.
2616 * Usage: 11
2617 *
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.
2620 */
2621 public static function get_dirs($path) {
2622 if ($path) {
2623 $d = @dir($path);
2624 if (is_object($d)) {
2625 while($entry=$d->read()) {
2626 if (@is_dir($path.'/'.$entry) && $entry!= '..' && $entry!= '.') {
2627 $filearray[]=$entry;
2628 }
2629 }
2630 $d->close();
2631 } else return 'error';
2632 return $filearray;
2633 }
2634 }
2635
2636 /**
2637 * Returns an array with the names of files in a specific path
2638 * Usage: 18
2639 *
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
2646 */
2647 public static function getFilesInDir($path,$extensionList='',$prependPath=0,$order='',$excludePattern='') {
2648
2649 // Initialize variabels:
2650 $filearray = array();
2651 $sortarray = array();
2652 $path = ereg_replace('\/$','',$path);
2653
2654 // Find files+directories:
2655 if (@is_dir($path)) {
2656 $extensionList = strtolower($extensionList);
2657 $d = dir($path);
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;}
2667 }
2668 }
2669 }
2670 $d->close();
2671 } else return 'error opening path: "'.$path.'"';
2672 }
2673
2674 // Sort them:
2675 if ($order) {
2676 asort($sortarray);
2677 reset($sortarray);
2678 $newArr=array();
2679 while(list($k,$v)=each($sortarray)) {
2680 $newArr[$k]=$filearray[$k];
2681 }
2682 $filearray=$newArr;
2683 }
2684
2685 // Return result
2686 reset($filearray);
2687 return $filearray;
2688 }
2689
2690 /**
2691 * Recursively gather all files and folders of a path.
2692 * Usage: 5
2693 *
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.
2701 */
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));
2705
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);
2711 }
2712 }
2713 }
2714 return $fileArr;
2715 }
2716
2717 /**
2718 * Removes the absolute part of all files/folders in fileArr
2719 * Usage: 2
2720 *
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.
2724 */
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!';
2730 }
2731 return $fileArr;
2732 }
2733
2734 /**
2735 * Fixes a path for windows-backslashes and reduces double-slashes to single slashes
2736 * Usage: 2
2737 *
2738 * @param string File path to process
2739 * @return string
2740 */
2741 public static function fixWindowsFilePath($theFile) {
2742 return str_replace('//','/', str_replace('\\','/', $theFile));
2743 }
2744
2745 /**
2746 * Resolves "../" sections in the input path string.
2747 * For example "fileadmin/directory/../other_directory/" will be resolved to "fileadmin/other_directory/"
2748 * Usage: 2
2749 *
2750 * @param string File path in which "/../" is resolved
2751 * @return string
2752 */
2753 public static function resolveBackPath($pathStr) {
2754 $parts = explode('/',$pathStr);
2755 $output=array();
2756 $c = 0;
2757 foreach($parts as $pV) {
2758 if ($pV=='..') {
2759 if ($c) {
2760 array_pop($output);
2761 $c--;
2762 } else $output[]=$pV;
2763 } else {
2764 $c++;
2765 $output[]=$pV;
2766 }
2767 }
2768 return implode('/',$output);
2769 }
2770
2771 /**
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)
2776 * Usage: 30
2777 *
2778 * @param string URL / path to prepend full URL addressing to.
2779 * @return string
2780 */
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;
2787 }
2788 return $path;
2789 }
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806 /*************************
2807 *
2808 * DEBUG helper FUNCTIONS
2809 *
2810 *************************/
2811
2812 /**
2813 * Returns a string with a list of ascii-values for the first $characters characters in $string
2814 * Usage: 0
2815 *
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.
2819 * @internal
2820 */
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));
2825 }
2826 return trim($valuestring);
2827 }
2828
2829 /**
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
2833 * Usage: 31
2834 *
2835 * @param mixed Array to view
2836 * @return string HTML output
2837 */
2838 public static function view_array($array_in) {
2839 if (is_array($array_in)) {
2840 $result='
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>';
2844 } else {
2845 foreach ($array_in as $key => $val) {
2846 $result.= '<tr>
2847 <td valign="top"><font face="Verdana,Arial" size="1">'.htmlspecialchars((string)$key).'</font></td>
2848 <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;
2855 }
2856 $result .= '<font face="Verdana,Arial" size="1" color="red">'.nl2br(htmlspecialchars($string)).'<br /></font>';
2857 } else {
2858 if (gettype($val) == 'object') {
2859 $string = 'Unknown object';
2860 } else {
2861 $string = (string)$val;
2862 }
2863 $result.= '<font face="Verdana,Arial" size="1" color="red">'.nl2br(htmlspecialchars($string)).'<br /></font>';
2864 }
2865 $result.= '</td>
2866 </tr>';
2867 }
2868 }
2869 $result.= '</table>';
2870 } else {
2871 $result = '<table border="1" cellpadding="1" cellspacing="0" bgcolor="white">
2872 <tr>
2873 <td><font face="Verdana,Arial" size="1" color="red">'.nl2br(htmlspecialchars((string)$array_in)).'<br /></font></td>
2874 </tr>
2875 </table>'; // Output it as a string.
2876 }
2877 return $result;
2878 }
2879
2880 /**
2881 * Prints an array
2882 * Usage: 6
2883 *
2884 * @param mixed Array to print visually (in a table).
2885 * @return void
2886 * @internal
2887 * @see view_array()
2888 */
2889 public static function print_array($array_in) {
2890 echo t3lib_div::view_array($array_in);
2891 }
2892
2893 /**
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()
2898 * Usage: 8
2899 *
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.
2902 * @return void
2903 */
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) {
2907 ob_start();
2908 }
2909
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 />';}
2914 }
2915
2916 if (is_array($var)) {
2917 t3lib_div::print_array($var);
2918 } elseif (is_object($var)) {
2919 echo '<b>|Object:<pre>';
2920 print_r($var);
2921 echo '</pre>|</b>';
2922 } elseif ((string)$var!='') {
2923 echo '<b>|'.htmlspecialchars((string)$var).'|</b>';
2924 } else {
2925 echo '<b>| debug |</b>';
2926 }
2927
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 />';}
2932 }
2933 }
2934
2935 /**
2936 * Displays the "path" of the function call stack in a string, using debug_backtrace
2937 *
2938 * @return string
2939 */
2940 public static function debug_trail() {
2941 $trail = debug_backtrace();
2942 $trail = array_reverse($trail);
2943 array_pop($trail);
2944
2945 $path = array();
2946 foreach($trail as $dat) {
2947 $path[] = $dat['class'].$dat['type'].$dat['function'];
2948 }
2949
2950 return implode(' // ',$path);
2951 }
2952
2953 /**
2954 * Displays an array as rows in a table. Useful to debug output like an array of database records.
2955 *
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.
2960 */
2961 public static function debugRows($rows,$header='',$returnHTML=FALSE) {
2962 if (is_array($rows)) {
2963 reset($rows);
2964 $firstEl = current($rows);
2965 if (is_array($firstEl)) {
2966 $headerColumns = array_keys($firstEl);
2967 $tRows = array();
2968
2969 // Header:
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>';
2971 $tCells = array();
2972 foreach($headerColumns as $key) {
2973 $tCells[] = '
2974 <td><font face="Verdana,Arial" size="1"><strong>'.htmlspecialchars($key).'</strong></font></td>';
2975 }
2976 $tRows[] = '
2977 <tr>'.implode('',$tCells).'
2978 </tr>';
2979
2980 // Rows:
2981 foreach($rows as $singleRow) {
2982 $tCells = array();
2983 foreach($headerColumns as $key) {
2984 $tCells[] = '
2985 <td><font face="Verdana,Arial" size="1">'.(is_array($singleRow[$key]) ? t3lib_div::debugRows($singleRow[$key],'',TRUE) : htmlspecialchars($singleRow[$key])).'</font></td>';
2986 }
2987 $tRows[] = '
2988 <tr>'.implode('',$tCells).'
2989 </tr>';
2990 }
2991
2992 $table = '
2993 <table border="1" cellpadding="1" cellspacing="0" bgcolor="white">'.implode('',$tRows).'
2994 </table>';
2995 if ($returnHTML) return $table; else echo $table;
2996 } else debug('Empty array of rows',$header);
2997 } else {
2998 debug('No array of rows',$header);
2999 }
3000 }
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029 /*************************
3030 *
3031 * SYSTEM INFORMATION
3032 *
3033 *************************/
3034
3035 /**
3036 * Returns the HOST+DIR-PATH of the current script (The URL, but without 'http://' and without script-filename)
3037 * Usage: 1
3038 *
3039 * @return string
3040 */
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);
3045 return $url;
3046 }
3047
3048 /**
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)
3052 * Usage: 52
3053 *
3054 * @param array Array of GET parameters to include
3055 * @return string
3056 */
3057 public static function linkThisScript(array $getParams=array()) {
3058 $parts = t3lib_div::getIndpEnv('SCRIPT_NAME');
3059 $params = t3lib_div::_GET();
3060
3061 foreach($getParams as $k => $v) {
3062 if (strcmp($v,'')) {
3063 $params[$k]=$v;
3064 } else unset($params[$k]);
3065 }
3066
3067 $pString = t3lib_div::implodeArrayForUrl('',$params);
3068
3069 return $pString ? $parts.'?'.ereg_replace('^&','',$pString) : $parts;
3070 }
3071
3072 /**
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
3075 * Usage: 2
3076 *
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.
3080 */
3081 public static function linkThisUrl($url,array $getParams=array()) {
3082 $parts = parse_url($url);
3083 $getP = array();
3084 if ($parts['query']) {
3085 parse_str($parts['query'],$getP);
3086 }
3087 $getP = t3lib_div::array_merge_recursive_overrule($getP,$getParams);
3088 $uP = explode('?',$url);
3089
3090 $params = t3lib_div::implodeArrayForUrl('',$getP);
3091 $outurl = $uP[0].($params ? '?'.substr($params, 1) : '');
3092
3093 return $outurl;
3094 }
3095
3096 /**
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.
3099 * Usage: 221
3100 *
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.
3103 */
3104 public static function getIndpEnv($getEnvName) {
3105 /*
3106 Conventions:
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
3109 [scheme] => 'http'
3110 [user] => 'username'
3111 [pass] => 'password'
3112 [host] => '192.168.1.4'
3113 [port] => '8080'
3114 [path] => '/typo3/32/temp/phpcheck/index.php/arg1/arg2/arg3/'
3115 [query] => 'arg1,arg2,arg3&p1=parameter1&p2[key]=value'
3116 [fragment] => 'link1'
3117
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]
3122
3123
3124 Keys supported:
3125
3126 URI______:
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)
3134
3135 CLIENT____:
3136 REMOTE_ADDR = (client IP)
3137 REMOTE_HOST = (client host)
3138 HTTP_USER_AGENT = (client user agent)
3139 HTTP_ACCEPT_LANGUAGE = (client accept language)
3140
3141 SERVER____:
3142 SCRIPT_FILENAME = Absolute filename of script (Differs between windows/unix). On windows 'C:\\blabla\\blabl\\' will be converted to 'C:/blabla/blabl/'
3143
3144 Special extras:
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)
3155
3156 Notice: [fragment] is apparently NEVER available to the script!
3157
3158
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/' !!)
3163
3164 */
3165
3166 # if ($getEnvName=='HTTP_REFERER') return '';
3167
3168 $retVal = '';
3169
3170 switch ((string)$getEnvName) {
3171 case 'SCRIPT_NAME':
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']);
3173 break;
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'])));
3176 break;
3177 case 'REQUEST_URI':
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'];
3186 break;
3187 case 'PATH_INFO':
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'];
3194 }
3195 break;
3196 // These are let through without modification
3197 case 'REMOTE_ADDR':
3198 case 'REMOTE_HOST':
3199 case 'HTTP_REFERER':
3200 case 'HTTP_HOST':
3201 case 'HTTP_USER_AGENT':
3202 case 'HTTP_ACCEPT_ENCODING':
3203 case 'HTTP_ACCEPT_LANGUAGE':
3204 case 'QUERY_STRING':
3205 $retVal = $_SERVER[$getEnvName];
3206 break;
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));
3213 $acc = array();
3214 while(list($kk,$vv)=each($SN_A)) {
3215 if (!strcmp($SFN_A[$kk],$vv)) {
3216 $acc[] = $vv;
3217 } else break;
3218 }
3219 $commonEnd=strrev(implode('/',$acc));
3220 if (strcmp($commonEnd,'')) { $DR = substr($SFN,0,-(strlen($commonEnd)+1)); }
3221 $retVal = $DR;
3222 break;
3223 case 'TYPO3_HOST_ONLY':
3224 $p = explode(':',$_SERVER['HTTP_HOST']);
3225 $retVal = $p[0];
3226 break;
3227 case 'TYPO3_PORT':
3228 $p = explode(':',$_SERVER['HTTP_HOST']);
3229 $retVal = $p[1];
3230 break;
3231 case 'TYPO3_REQUEST_HOST':
3232 $retVal = (t3lib_div::getIndpEnv('TYPO3_SSL') ? 'https://' : 'http://').
3233 $_SERVER['HTTP_HOST'];
3234 break;
3235 case 'TYPO3_REQUEST_URL':
3236 $retVal = t3lib_div::getIndpEnv('TYPO3_REQUEST_HOST').t3lib_div::getIndpEnv('REQUEST_URI');
3237 break;
3238 case 'TYPO3_REQUEST_SCRIPT':
3239 $retVal = t3lib_div::getIndpEnv('TYPO3_REQUEST_HOST').t3lib_div::getIndpEnv('SCRIPT_NAME');
3240 break;
3241 case 'TYPO3_REQUEST_DIR':
3242 $retVal = t3lib_div::getIndpEnv('TYPO3_REQUEST_HOST').t3lib_div::dirname(t3lib_div::getIndpEnv('SCRIPT_NAME')).'/';
3243 break;
3244 case 'TYPO3_SITE_URL':
3245 if (defined('PATH_thisScript') && defined('PATH_site')) {
3246 $lPath = substr(dirname(PATH_thisScript),strlen(PATH_site)).'/';
3247 $url = t3lib_div::getIndpEnv('TYPO3_REQUEST_DIR');
3248 $siteUrl = substr($url,0,-strlen($lPath));
3249 if (substr($siteUrl,-1)!='/') $siteUrl.='/';
3250 $retVal = $siteUrl