Changed call_user_func to call_user_func_array in t3lib_div to allow passing paramete...
[Packages/TYPO3.CMS.git] / t3lib / class.t3lib_div.php
1 <?php
2 /***************************************************************
3 * Copyright notice
4 *
5 * (c) 1999-2006 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 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 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 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 function _GETset($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 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 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
363
364
365
366
367
368
369
370 /*************************
371 *
372 * IMAGE FUNCTIONS
373 *
374 *************************/
375
376
377 /**
378 * Compressing a GIF file if not already LZW compressed
379 * 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)
380 *
381 * The function takes a file-reference, $theFile, and saves it again through GD or ImageMagick in order to compress the file
382 * GIF:
383 * 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!)
384 * If $type is set to either 'IM' or 'GD' the compression is done with ImageMagick and GD respectively
385 * PNG:
386 * No changes.
387 *
388 * $theFile is expected to be a valid GIF-file!
389 * The function returns a code for the operation.
390 * Usage: 9
391 *
392 * @param string Filepath
393 * @param string See description of function
394 * @return string Returns "GD" if GD was used, otherwise "IM" if ImageMagick was used. If nothing done at all, it returns empty string.
395 * @internal
396 */
397 function gif_compress($theFile, $type) {
398 $gfxConf = $GLOBALS['TYPO3_CONF_VARS']['GFX'];
399 $returnCode='';
400 if ($gfxConf['gif_compress'] && strtolower(substr($theFile,-4,4))=='.gif') { // GIF...
401 if (($type=='IM' || !$type) && $gfxConf['im'] && $gfxConf['im_path_lzw']) { // IM
402 $cmd = t3lib_div::imageMagickCommand('convert', '"'.$theFile.'" "'.$theFile.'"', $gfxConf['im_path_lzw']);
403 exec($cmd);
404
405 $returnCode='IM';
406 } elseif (($type=='GD' || !$type) && $gfxConf['gdlib'] && !$gfxConf['gdlib_png']) { // GD
407 $tempImage = imageCreateFromGif($theFile);
408 imageGif($tempImage, $theFile);
409 imageDestroy($tempImage);
410 $returnCode='GD';
411 }
412 }
413 return $returnCode;
414 }
415
416 /**
417 * Converts a png file to gif
418 * This converts a png file to gif IF the FLAG $GLOBALS['TYPO3_CONF_VARS']['FE']['png_to_gif'] is set true.
419 * Usage: 5
420 *
421 * @param string $theFile the filename with path
422 * @return string new filename
423 * @internal
424 */
425 function png_to_gif_by_imagemagick($theFile) {
426 if ($GLOBALS['TYPO3_CONF_VARS']['FE']['png_to_gif']
427 && $GLOBALS['TYPO3_CONF_VARS']['GFX']['im']
428 && $GLOBALS['TYPO3_CONF_VARS']['GFX']['im_path_lzw']
429 && strtolower(substr($theFile,-4,4))=='.png'
430 && @is_file($theFile)) { // IM
431 $newFile = substr($theFile,0,-4).'.gif';
432 $cmd = t3lib_div::imageMagickCommand('convert', '"'.$theFile.'" "'.$newFile.'"', $GLOBALS['TYPO3_CONF_VARS']['GFX']['im_path_lzw']);
433 exec($cmd);
434 $theFile = $newFile;
435 // 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!!
436 }
437 return $theFile;
438 }
439
440 /**
441 * Returns filename of the png/gif version of the input file (which can be png or gif).
442 * If input file type does not match the wanted output type a conversion is made and temp-filename returned.
443 * Usage: 2
444 *
445 * @param string Filepath of image file
446 * @param boolean If set, then input file is converted to PNG, otherwise to GIF
447 * @return string If the new image file exists, it's filepath is returned
448 * @internal
449 */
450 function read_png_gif($theFile,$output_png=0) {
451 if ($GLOBALS['TYPO3_CONF_VARS']['GFX']['im'] && @is_file($theFile)) {
452 $ext = strtolower(substr($theFile,-4,4));
453 if (
454 ((string)$ext=='.png' && $output_png) ||
455 ((string)$ext=='.gif' && !$output_png)
456 ) {
457 return $theFile;
458 } else {
459 $newFile = PATH_site.'typo3temp/readPG_'.md5($theFile.'|'.filemtime($theFile)).($output_png?'.png':'.gif');
460 exec($GLOBALS['TYPO3_CONF_VARS']['GFX']['im_path'].'convert "'.$theFile.'" "'.$newFile.'"');
461 if (@is_file($newFile)) return $newFile;
462 }
463 }
464 }
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480 /*************************
481 *
482 * STRING FUNCTIONS
483 *
484 *************************/
485
486 /**
487 * Truncate string
488 * Returns a new string of max. $chars length.
489 * If the string is longer, it will be truncated and appended with '...'.
490 * DEPRECATED. Works ONLY for single-byte charsets! USE t3lib_div::fixed_lgd_cs() instead
491 * Usage: 39
492 *
493 * @param string string to truncate
494 * @param integer must be an integer with an absolute value of at least 4. if negative the string is cropped from the right end.
495 * @param string String to append to the output if it is truncated, default is '...'
496 * @return string new string
497 * @see fixed_lgd_pre()
498 */
499 function fixed_lgd($string,$origChars,$preStr='...') {
500 $chars = abs($origChars);
501 if ($chars >= 4) {
502 if(strlen($string)>$chars) {
503 return $origChars < 0 ?
504 $preStr.trim(substr($string, -($chars-3))) :
505 trim(substr($string, 0, $chars-3)).$preStr;
506 }
507 }
508 return $string;
509 }
510
511 /**
512 * Truncate string
513 * Returns a new string of max. $chars length.
514 * If the string is longer, it will be truncated and prepended with '...'.
515 * This works like fixed_lgd, but is truncated in the start of the string instead of the end
516 * DEPRECATED. Use either fixed_lgd() or fixed_lgd_cs() (with negative input value for $chars)
517 * Usage: 6
518 *
519 * @param string string to truncate
520 * @param integer must be an integer of at least 4
521 * @return string new string
522 * @see fixed_lgd()
523 */
524 function fixed_lgd_pre($string,$chars) {
525 return strrev(t3lib_div::fixed_lgd(strrev($string),$chars));
526 }
527
528 /**
529 * Truncates a string with appended/prepended "..." and takes backend character set into consideration
530 * Use only from backend!
531 * Usage: 75
532 *
533 * @param string string to truncate
534 * @param integer must be an integer with an absolute value of at least 4. if negative the string is cropped from the right end.
535 * @return string New string
536 * @see fixed_lgd()
537 */
538 function fixed_lgd_cs($string,$chars) {
539 if (is_object($GLOBALS['LANG'])) {
540 return $GLOBALS['LANG']->csConvObj->crop($GLOBALS['LANG']->charSet,$string,$chars,'...');
541 } else {
542 return t3lib_div::fixed_lgd($string, $chars);
543 }
544 }
545
546 /**
547 * Breaks up the text for emails
548 * Usage: 1
549 *
550 * @param string The string to break up
551 * @param string The string to implode the broken lines with (default/typically \n)
552 * @param integer The line length
553 * @return string
554 */
555 function breakTextForEmail($str,$implChar="\n",$charWidth=76) {
556 $lines = explode(chr(10),$str);
557 $outArr=array();
558 while(list(,$lStr)=each($lines)) {
559 $outArr = array_merge($outArr,t3lib_div::breakLinesForEmail($lStr,$implChar,$charWidth));
560 }
561 return implode(chr(10),$outArr);
562 }
563
564 /**
565 * Breaks up a single line of text for emails
566 * Usage: 5
567 *
568 * @param string The string to break up
569 * @param string The string to implode the broken lines with (default/typically \n)
570 * @param integer The line length
571 * @return string
572 * @see breakTextForEmail()
573 */
574 function breakLinesForEmail($str,$implChar="\n",$charWidth=76) {
575 $lines=array();
576 $l=$charWidth;
577 $p=0;
578 while(strlen($str)>$p) {
579 $substr=substr($str,$p,$l);
580 if (strlen($substr)==$l) {
581 $count = count(explode(' ',trim(strrev($substr))));
582 if ($count>1) { // OK...
583 $parts = explode(' ',strrev($substr),2);
584 $theLine = strrev($parts[1]);
585 } else {
586 $afterParts = explode(' ',substr($str,$l+$p),2);
587 $theLine = $substr.$afterParts[0];
588 }
589 if (!strlen($theLine)) {break; } // Error, because this would keep us in an endless loop.
590 } else {
591 $theLine=$substr;
592 }
593
594 $lines[]=trim($theLine);
595 $p+=strlen($theLine);
596 if (!trim(substr($str,$p,$l))) break; // added...
597 }
598 return implode($implChar,$lines);
599 }
600
601 /**
602 * Match IP number with list of numbers with wildcard
603 * Dispatcher method for switching into specialised IPv4 and IPv6 methods.
604 * Usage: 10
605 *
606 * @param string $baseIP is the current remote IP address for instance, typ. REMOTE_ADDR
607 * @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.
608 * @return boolean True if an IP-mask from $list matches $baseIP
609 */
610 function cmpIP($baseIP, $list) {
611 if ($list==='*') return TRUE;
612 if (strstr($baseIP, ':') && t3lib_div::validIPv6($baseIP)) {
613 return t3lib_div::cmpIPv6($baseIP, $list);
614 } else {
615 return t3lib_div::cmpIPv4($baseIP, $list);
616 }
617 }
618
619 /**
620 * Match IPv4 number with list of numbers with wildcard
621 *
622 * @param string $baseIP is the current remote IP address for instance, typ. REMOTE_ADDR
623 * @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)
624 * @return boolean True if an IP-mask from $list matches $baseIP
625 */
626 function cmpIPv4($baseIP, $list) {
627 $IPpartsReq = explode('.',$baseIP);
628 if (count($IPpartsReq)==4) {
629 $values = t3lib_div::trimExplode(',',$list,1);
630
631 foreach($values as $test) {
632 list($test,$mask) = explode('/',$test);
633
634 if(intval($mask)) {
635 // "192.168.3.0/24"
636 $lnet = ip2long($test);
637 $lip = ip2long($baseIP);
638 $binnet = str_pad( decbin($lnet),32,'0','STR_PAD_LEFT');
639 $firstpart = substr($binnet,0,$mask);
640 $binip = str_pad( decbin($lip),32,'0','STR_PAD_LEFT');
641 $firstip = substr($binip,0,$mask);
642 $yes = (strcmp($firstpart,$firstip)==0);
643 } else {
644 // "192.168.*.*"
645 $IPparts = explode('.',$test);
646 $yes = 1;
647 reset($IPparts);
648 while(list($index,$val)=each($IPparts)) {
649 $val = trim($val);
650 if (strcmp($val,'*') && strcmp($IPpartsReq[$index],$val)) {
651 $yes=0;
652 }
653 }
654 }
655 if ($yes) return true;
656 }
657 }
658 return false;
659 }
660
661 /**
662 * Match IPv6 address with a list of IPv6 prefixes
663 *
664 * @param string $baseIP is the current remote IP address for instance
665 * @param string $list is a comma-list of IPv6 prefixes, could also contain IPv4 addresses
666 * @return boolean True if an baseIP matches any prefix
667 */
668 function cmpIPv6($baseIP, $list) {
669 $success = false; // Policy default: Deny connection
670 $baseIP = t3lib_div::normalizeIPv6($baseIP);
671
672 $values = t3lib_div::trimExplode(',',$list,1);
673 foreach ($values as $test) {
674 list($test,$mask) = explode('/',$test);
675 if (t3lib_div::validIPv6($test)) {
676 $test = t3lib_div::normalizeIPv6($test);
677 if (intval($mask)) {
678 switch ($mask) { // test on /48 /64
679 case '48':
680 $testBin = substr(t3lib_div::IPv6Hex2Bin($test), 0, 48);
681 $baseIPBin = substr(t3lib_div::IPv6Hex2Bin($baseIP), 0, 48);
682 $success = strcmp($testBin, $baseIPBin)==0 ? true : false;
683 break;
684 case '64':
685 $testBin = substr(t3lib_div::IPv6Hex2Bin($test), 0, 64);
686 $baseIPBin = substr(t3lib_div::IPv6Hex2Bin($baseIP), 0, 64);
687 $success = strcmp($testBin, $baseIPBin)==0 ? true : false;
688 break;
689 default:
690 $success = false;
691 }
692 } else {
693 if (t3lib_div::validIPv6($test)) { // test on full ip address 128 bits
694 $testBin = t3lib_div::IPv6Hex2Bin($test);
695 $baseIPBin = t3lib_div::IPv6Hex2Bin($baseIP);
696 $success = strcmp($testBin, $baseIPBin)==0 ? true : false;
697 }
698 }
699 }
700 if ($success) return true;
701 }
702 return false;
703 }
704
705 /**
706 * [Describe function...]
707 *
708 * @param [type] $hex: ...
709 * @return [type] ...
710 */
711 function IPv6Hex2Bin ($hex) {
712 $bin = '';
713 $hex = str_replace(':', '', $hex); // Replace colon to nothing
714 for ($i=0; $i<strlen($hex); $i=$i+2) {
715 $bin.= chr(hexdec(substr($hex, $i, 2)));
716 }
717 return $bin;
718 }
719
720 /**
721 * Normalize an IPv6 address to full length
722 *
723 * @param string Given IPv6 address
724 * @return string Normalized address
725 */
726 function normalizeIPv6($address) {
727 $normalizedAddress = '';
728 $stageOneAddress = '';
729
730 $chunks = explode('::', $address); // Count 2 if if address has hidden zero blocks
731 if (count($chunks)==2) {
732 $chunksLeft = explode(':', $chunks[0]);
733 $chunksRight = explode(':', $chunks[1]);
734 $left = count($chunksLeft);
735 $right = count($chunksRight);
736
737 // Special case: leading zero-only blocks count to 1, should be 0
738 if ($left==1 && strlen($chunksLeft[0])==0) $left=0;
739
740 $hiddenBlocks = 8 - ($left + $right);
741 $hiddenPart = '';
742 while ($h<$hiddenBlocks) {
743 $hiddenPart .= '0000:';
744 $h++;
745 }
746
747 if ($left == 0) {
748 $stageOneAddress = $hiddenPart . $chunks[1];
749 } else {
750 $stageOneAddress = $chunks[0] . ':' . $hiddenPart . $chunks[1];
751 }
752 } else $stageOneAddress = $address;
753
754 // normalize the blocks:
755 $blocks = explode(':', $stageOneAddress);
756 $divCounter = 0;
757 foreach ($blocks as $block) {
758 $tmpBlock = '';
759 $i = 0;
760 $hiddenZeros = 4 - strlen($block);
761 while ($i < $hiddenZeros) {
762 $tmpBlock .= '0';
763 $i++;
764 }
765 $normalizedAddress .= $tmpBlock . $block;
766 if ($divCounter < 7) {
767 $normalizedAddress .= ':';
768 $divCounter++;
769 }
770 }
771 return $normalizedAddress;
772 }
773
774 /**
775 * Validate a given IP address to the IPv6 address format.
776 *
777 * Example for possible format: 43FB::BB3F:A0A0:0 | ::1
778 *
779 * @param string IP address to be tested
780 * @return boolean True if $ip is of IPv6 format.
781 */
782 function validIPv6($ip) {
783 $uppercaseIP = strtoupper($ip);
784
785 $regex = '/^(';
786 $regex.= '(([\dA-F]{1,4}:){7}[\dA-F]{1,4})|';
787 $regex.= '(([\dA-F]{1,4}){1}::([\dA-F]{1,4}:){1,5}[\dA-F]{1,4})|';
788 $regex.= '(([\dA-F]{1,4}:){2}:([\dA-F]{1,4}:){1,4}[\dA-F]{1,4})|';
789 $regex.= '(([\dA-F]{1,4}:){3}:([\dA-F]{1,4}:){1,3}[\dA-F]{1,4})|';
790 $regex.= '(([\dA-F]{1,4}:){4}:([\dA-F]{1,4}:){1,2}[\dA-F]{1,4})|';
791 $regex.= '(([\dA-F]{1,4}:){5}:([\dA-F]{1,4}:){0,1}[\dA-F]{1,4})|';
792 $regex.= '(::([\dA-F]{1,4}:){0,6}[\dA-F]{1,4})';
793 $regex.= ')$/';
794
795 return preg_match($regex, $uppercaseIP) ? true : false;
796 }
797
798 /**
799 * Match fully qualified domain name with list of strings with wildcard
800 *
801 * @param string The current remote IP address for instance, typ. REMOTE_ADDR
802 * @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)
803 * @return boolean True if a domain name mask from $list matches $baseIP
804 */
805 function cmpFQDN($baseIP, $list) {
806 if (count(explode('.',$baseIP))==4) {
807 $resolvedHostName = explode('.', gethostbyaddr($baseIP));
808 $values = t3lib_div::trimExplode(',',$list,1);
809
810 foreach($values as $test) {
811 $hostNameParts = explode('.',$test);
812 $yes = 1;
813
814 foreach($hostNameParts as $index => $val) {
815 $val = trim($val);
816 if (strcmp($val,'*') && strcmp($resolvedHostName[$index],$val)) {
817 $yes=0;
818 }
819 }
820 if ($yes) return true;
821 }
822 }
823 return false;
824 }
825
826 /**
827 * Check for item in list
828 * Check if an item exists in a comma-separated list of items.
829 * Usage: 163
830 *
831 * @param string comma-separated list of items (string)
832 * @param string item to check for
833 * @return boolean true if $item is in $list
834 */
835 function inList($list,$item) {
836 return strstr(','.$list.',', ','.$item.',') ? true : false;
837 }
838
839 /**
840 * Removes an item from a comma-separated list of items.
841 * Usage: 1
842 *
843 * @param string element to remove
844 * @param string comma-separated list of items (string)
845 * @return string new comma-separated list of items
846 */
847 function rmFromList($element,$list) {
848 $items = explode(',',$list);
849 while(list($k,$v)=each($items)) {
850 if ($v==$element) {unset($items[$k]);}
851 }
852 return implode(',',$items);
853 }
854
855 /**
856 * Expand a comma-separated list of integers with ranges (eg 1,3-5,7 becomes 1,3,4,5,7).
857 * Ranges are limited to 1000 values per range.
858 *
859 * @param string comma-separated list of integers with ranges (string)
860 * @return string new comma-separated list of items
861 * @author Martin Kutschker <martin.kutschker@activesolution.at>
862 */
863 function expandList($list) {
864 $items = explode(',',$list);
865 $list = array();
866 while(list(,$item)=each($items)) {
867 $range = explode('-',$item);
868 if (isset($range[1])) {
869 $runAwayBrake = 1000;
870 for ($n=$range[0]; $n<=$range[1]; $n++) {
871 $list[] = $n;
872
873 $runAwayBrake--;
874 if ($runAwayBrake<=0) break;
875 }
876 } else {
877 $list[] = $item;
878 }
879 }
880
881 return implode(',',$list);
882 }
883
884 /**
885 * Forces the integer $theInt into the boundaries of $min and $max. If the $theInt is 'false' then the $zeroValue is applied.
886 * Usage: 224
887 *
888 * @param integer Input value
889 * @param integer Lower limit
890 * @param integer Higher limit
891 * @param integer Default value if input is false.
892 * @return integer The input value forced into the boundaries of $min and $max
893 */
894 function intInRange($theInt,$min,$max=2000000000,$zeroValue=0) {
895 // Returns $theInt as an integer in the integerspace from $min to $max
896 $theInt = intval($theInt);
897 if ($zeroValue && !$theInt) {$theInt=$zeroValue;} // If the input value is zero after being converted to integer, zeroValue may set another default value for it.
898 if ($theInt<$min){$theInt=$min;}
899 if ($theInt>$max){$theInt=$max;}
900 return $theInt;
901 }
902
903 /**
904 * Returns the $integer if greater than zero, otherwise returns zero.
905 * Usage: 1
906 *
907 * @param integer Integer string to process
908 * @return integer
909 */
910 function intval_positive($theInt) {
911 $theInt = intval($theInt);
912 if ($theInt<0){$theInt=0;}
913 return $theInt;
914 }
915
916 /**
917 * Returns an integer from a three part version number, eg '4.12.3' -> 4012003
918 * Usage: 2
919 *
920 * @param string Version number on format x.x.x
921 * @return integer Integer version of version number (where each part can count to 999)
922 */
923 function int_from_ver($verNumberStr) {
924 $verParts = explode('.',$verNumberStr);
925 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));
926 }
927
928 /**
929 * Returns true if the current TYPO3 version (or compatibility version) is compatible to the input version
930 * Notice that this function compares branches, not versions (4.0.1 would be > 4.0.0 although they use the same compat_version)
931 *
932 * @param string Minimum branch number required (format x.y / e.g. "4.0" NOT "4.0.0"!)
933 * @return boolean Returns true if this setup is compatible with the provided version number
934 * @todo Still needs a function to convert versions to branches
935 */
936 function compat_version($verNumberStr) {
937 global $TYPO3_CONF_VARS;
938 $currVersionStr = $TYPO3_CONF_VARS['SYS']['compat_version'] ? $TYPO3_CONF_VARS['SYS']['compat_version'] : TYPO3_branch;
939
940 if (t3lib_div::int_from_ver($currVersionStr) < t3lib_div::int_from_ver($verNumberStr)) {
941 return FALSE;
942 } else {
943 return TRUE;
944 }
945 }
946
947 /**
948 * Makes a positive integer hash out of the first 7 chars from the md5 hash of the input
949 * Usage: 5
950 *
951 * @param string String to md5-hash
952 * @return integer Returns 28bit integer-hash
953 */
954 function md5int($str) {
955 return hexdec(substr(md5($str),0,7));
956 }
957
958 /**
959 * Returns the first 10 positions of the MD5-hash (changed from 6 to 10 recently)
960 *
961 * Usage: 37
962 *
963 * @param string Input string to be md5-hashed
964 * @param integer The string-length of the output
965 * @return string Substring of the resulting md5-hash, being $len chars long (from beginning)
966 */
967 function shortMD5($input, $len=10) {
968 return substr(md5($input),0,$len);
969 }
970
971 /**
972 * Takes comma-separated lists and arrays and removes all duplicates
973 * If a value in the list is trim(empty), the value is ignored.
974 * Usage: 16
975 *
976 * @param string Accept multiple parameters wich can be comma-separated lists of values and arrays.
977 * @param mixed $secondParameter: Dummy field, which if set will show a warning!
978 * @return string Returns the list without any duplicates of values, space around values are trimmed
979 */
980 function uniqueList($in_list, $secondParameter=NULL) {
981 if (is_array($in_list)) die('t3lib_div::uniqueList() does NOT support array arguments anymore! Only string comma lists!');
982 if (isset($secondParameter)) die('t3lib_div::uniqueList() does NOT support more than a single argument value anymore. You have specified more than one.');
983
984 return implode(',',array_unique(t3lib_div::trimExplode(',',$in_list,1)));
985 }
986
987 /**
988 * Splits a reference to a file in 5 parts
989 * Usage: 43
990 *
991 * @param string Filename/filepath to be analysed
992 * @return array Contains keys [path], [file], [filebody], [fileext], [realFileext]
993 */
994 function split_fileref($fileref) {
995 $reg = array();
996 if ( ereg('(.*/)(.*)$',$fileref,$reg) ) {
997 $info['path'] = $reg[1];
998 $info['file'] = $reg[2];
999 } else {
1000 $info['path'] = '';
1001 $info['file'] = $fileref;
1002 }
1003 $reg='';
1004 if ( ereg('(.*)\.([^\.]*$)',$info['file'],$reg) ) {
1005 $info['filebody'] = $reg[1];
1006 $info['fileext'] = strtolower($reg[2]);
1007 $info['realFileext'] = $reg[2];
1008 } else {
1009 $info['filebody'] = $info['file'];
1010 $info['fileext'] = '';
1011 }
1012 reset($info);
1013 return $info;
1014 }
1015
1016 /**
1017 * Returns the directory part of a path without trailing slash
1018 * If there is no dir-part, then an empty string is returned.
1019 * Behaviour:
1020 *
1021 * '/dir1/dir2/script.php' => '/dir1/dir2'
1022 * '/dir1/' => '/dir1'
1023 * 'dir1/script.php' => 'dir1'
1024 * 'd/script.php' => 'd'
1025 * '/script.php' => ''
1026 * '' => ''
1027 * Usage: 5
1028 *
1029 * @param string Directory name / path
1030 * @return string Processed input value. See function description.
1031 */
1032 function dirname($path) {
1033 $p=t3lib_div::revExplode('/',$path,2);
1034 return count($p)==2?$p[0]:'';
1035 }
1036
1037 /**
1038 * Modifies a HTML Hex color by adding/subtracting $R,$G and $B integers
1039 * Usage: 11
1040 *
1041 * @param string A hexadecimal color code, #xxxxxx
1042 * @param integer Offset value 0-255
1043 * @param integer Offset value 0-255
1044 * @param integer Offset value 0-255
1045 * @return string A hexadecimal color code, #xxxxxx, modified according to input vars
1046 * @see modifyHTMLColorAll()
1047 */
1048 function modifyHTMLColor($color,$R,$G,$B) {
1049 // This takes a hex-color (# included!) and adds $R, $G and $B to the HTML-color (format: #xxxxxx) and returns the new color
1050 $nR = t3lib_div::intInRange(hexdec(substr($color,1,2))+$R,0,255);
1051 $nG = t3lib_div::intInRange(hexdec(substr($color,3,2))+$G,0,255);
1052 $nB = t3lib_div::intInRange(hexdec(substr($color,5,2))+$B,0,255);
1053 return '#'.
1054 substr('0'.dechex($nR),-2).
1055 substr('0'.dechex($nG),-2).
1056 substr('0'.dechex($nB),-2);
1057 }
1058
1059 /**
1060 * Modifies a HTML Hex color by adding/subtracting $all integer from all R/G/B channels
1061 * Usage: 6
1062 *
1063 * @param string A hexadecimal color code, #xxxxxx
1064 * @param integer Offset value 0-255 for all three channels.
1065 * @return string A hexadecimal color code, #xxxxxx, modified according to input vars
1066 * @see modifyHTMLColor()
1067 */
1068 function modifyHTMLColorAll($color,$all) {
1069 return t3lib_div::modifyHTMLColor($color,$all,$all,$all);
1070 }
1071
1072 /**
1073 * Removes comma (if present) in the end of string
1074 * Usage: 2
1075 *
1076 * @param string String from which the comma in the end (if any) will be removed.
1077 * @return string
1078 */
1079 function rm_endcomma($string) {
1080 return ereg_replace(',$','',$string);
1081 }
1082
1083 /**
1084 * strtoupper which converts danish (and other characters) characters as well
1085 * (DEPRECATED, use t3lib_cs::conv_case() instead or for HTML output, wrap your content in <span class="uppercase">...</span>)
1086 * Usage: 0
1087 *
1088 * @param string String to process
1089 * @return string
1090 * @ignore
1091 */
1092 function danish_strtoupper($string) {
1093 $value = strtoupper($string);
1094 return strtr($value, 'áéúíâêûôîæøåäöü', 'ÁÉÚÍÄËÜÖÏÆØÅÄÖÜ');
1095 }
1096
1097 /**
1098 * Change umlaut characters to plain ASCII with normally two character target
1099 * Only known characters will be converted, so don't expect a result for any character.
1100 * (DEPRECATED: Works only for western europe single-byte charsets! Use t3lib_cs::specCharsToASCII() instead!)
1101 *
1102 * ä => ae, Ö => Oe
1103 *
1104 * @param string String to convert.
1105 * @return string
1106 */
1107 function convUmlauts($str) {
1108 $pat = array ( '/ä/', '/Ä/', '/ö/', '/Ö/', '/ü/', '/Ü/', '/ß/', '/å/', '/Å/', '/ø/', '/Ø/', '/æ/', '/Æ/' );
1109 $repl = array ( 'ae', 'Ae', 'oe', 'Oe', 'ue', 'Ue', 'ss', 'aa', 'AA', 'oe', 'OE', 'ae', 'AE' );
1110 return preg_replace($pat,$repl,$str);
1111 }
1112
1113 /**
1114 * Tests if the input is an integer.
1115 * Usage: 77
1116 *
1117 * @param mixed Any input variable to test.
1118 * @return boolean Returns true if string is an integer
1119 */
1120 function testInt($var) {
1121 return !strcmp($var,intval($var));
1122 }
1123
1124 /**
1125 * Returns true if the first part of $str matches the string $partStr
1126 * Usage: 59
1127 *
1128 * @param string Full string to check
1129 * @param string Reference string which must be found as the "first part" of the full string
1130 * @return boolean True if $partStr was found to be equal to the first part of $str
1131 */
1132 function isFirstPartOfStr($str,$partStr) {
1133 // Returns true, if the first part of a $str equals $partStr and $partStr is not ''
1134 $psLen = strlen($partStr);
1135 if ($psLen) {
1136 return substr($str,0,$psLen)==(string)$partStr;
1137 } else return false;
1138 }
1139
1140 /**
1141 * Formats the input integer $sizeInBytes as bytes/kilobytes/megabytes (-/K/M)
1142 * Usage: 53
1143 *
1144 * @param integer Number of bytes to format.
1145 * @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)
1146 * @return string Formatted representation of the byte number, for output.
1147 */
1148 function formatSize($sizeInBytes,$labels='') {
1149
1150 // Set labels:
1151 if (strlen($labels) == 0) {
1152 $labels = ' | K| M| G';
1153 } else {
1154 $labels = str_replace('"','',$labels);
1155 }
1156 $labelArr = explode('|',$labels);
1157
1158 // Find size:
1159 if ($sizeInBytes>900) {
1160 if ($sizeInBytes>900000000) { // GB
1161 $val = $sizeInBytes/(1024*1024*1024);
1162 return number_format($val, (($val<20)?1:0), '.', '').$labelArr[3];
1163 }
1164 elseif ($sizeInBytes>900000) { // MB
1165 $val = $sizeInBytes/(1024*1024);
1166 return number_format($val, (($val<20)?1:0), '.', '').$labelArr[2];
1167 } else { // KB
1168 $val = $sizeInBytes/(1024);
1169 return number_format($val, (($val<20)?1:0), '.', '').$labelArr[1];
1170 }
1171 } else { // Bytes
1172 return $sizeInBytes.$labelArr[0];
1173 }
1174 }
1175
1176 /**
1177 * Returns microtime input to milliseconds
1178 * Usage: 2
1179 *
1180 * @param string Microtime
1181 * @return integer Microtime input string converted to an integer (milliseconds)
1182 */
1183 function convertMicrotime($microtime) {
1184 $parts = explode(' ',$microtime);
1185 return round(($parts[0]+$parts[1])*1000);
1186 }
1187
1188 /**
1189 * This splits a string by the chars in $operators (typical /+-*) and returns an array with them in
1190 * Usage: 2
1191 *
1192 * @param string Input string, eg "123 + 456 / 789 - 4"
1193 * @param string Operators to split by, typically "/+-*"
1194 * @return array Array with operators and operands separated.
1195 * @see tslib_cObj::calc(), tslib_gifBuilder::calcOffset()
1196 */
1197 function splitCalc($string,$operators) {
1198 $res = Array();
1199 $sign='+';
1200 while($string) {
1201 $valueLen=strcspn($string,$operators);
1202 $value=substr($string,0,$valueLen);
1203 $res[] = Array($sign,trim($value));
1204 $sign=substr($string,$valueLen,1);
1205 $string=substr($string,$valueLen+1);
1206 }
1207 reset($res);
1208 return $res;
1209 }
1210
1211 /**
1212 * Calculates the input by +,-,*,/,%,^ with priority to + and -
1213 * Usage: 1
1214 *
1215 * @param string Input string, eg "123 + 456 / 789 - 4"
1216 * @return integer Calculated value. Or error string.
1217 * @see calcParenthesis()
1218 */
1219 function calcPriority($string) {
1220 $string=ereg_replace('[[:space:]]*','',$string); // removing all whitespace
1221 $string='+'.$string; // Ensuring an operator for the first entrance
1222 $qm='\*\/\+-^%';
1223 $regex = '(['.$qm.'])(['.$qm.']?[0-9\.]*)';
1224 // split the expression here:
1225 $reg = array();
1226 preg_match_all('/'.$regex.'/',$string,$reg);
1227
1228 reset($reg[2]);
1229 $number=0;
1230 $Msign='+';
1231 $err='';
1232 $buffer=doubleval(current($reg[2]));
1233 next($reg[2]); // Advance pointer
1234 while(list($k,$v)=each($reg[2])) {
1235 $v=doubleval($v);
1236 $sign = $reg[1][$k];
1237 if ($sign=='+' || $sign=='-') {
1238 $number = $Msign=='-' ? $number-=$buffer : $number+=$buffer;
1239 $Msign = $sign;
1240 $buffer=$v;
1241 } else {
1242 if ($sign=='/') {if ($v) $buffer/=$v; else $err='dividing by zero';}
1243 if ($sign=='%') {if ($v) $buffer%=$v; else $err='dividing by zero';}
1244 if ($sign=='*') {$buffer*=$v;}
1245 if ($sign=='^') {$buffer=pow($buffer,$v);}
1246 }
1247 }
1248 $number = $Msign=='-' ? $number-=$buffer : $number+=$buffer;
1249 return $err ? 'ERROR: '.$err : $number;
1250 }
1251
1252 /**
1253 * Calculates the input with parenthesis levels
1254 * Usage: 2
1255 *
1256 * @param string Input string, eg "(123 + 456) / 789 - 4"
1257 * @return integer Calculated value. Or error string.
1258 * @see calcPriority(), tslib_cObj::stdWrap()
1259 */
1260 function calcParenthesis($string) {
1261 $securC=100;
1262 do {
1263 $valueLenO=strcspn($string,'(');
1264 $valueLenC=strcspn($string,')');
1265 if ($valueLenC==strlen($string) || $valueLenC < $valueLenO) {
1266 $value = t3lib_div::calcPriority(substr($string,0,$valueLenC));
1267 $string = $value.substr($string,$valueLenC+1);
1268 return $string;
1269 } else {
1270 $string = substr($string,0,$valueLenO).t3lib_div::calcParenthesis(substr($string,$valueLenO+1));
1271 }
1272 // Security:
1273 $securC--;
1274 if ($securC<=0) break;
1275 } while($valueLenO<strlen($string));
1276 return $string;
1277 }
1278
1279 /**
1280 * Inverse version of htmlspecialchars()
1281 * Usage: 4
1282 *
1283 * @param string Value where &gt;, &lt;, &quot; and &amp; should be converted to regular chars.
1284 * @return string Converted result.
1285 */
1286 function htmlspecialchars_decode($value) {
1287 $value = str_replace('&gt;','>',$value);
1288 $value = str_replace('&lt;','<',$value);
1289 $value = str_replace('&quot;','"',$value);
1290 $value = str_replace('&amp;','&',$value);
1291 return $value;
1292 }
1293
1294 /**
1295 * Re-converts HTML entities if they have been converted by htmlspecialchars()
1296 * Usage: 10
1297 *
1298 * @param string String which contains eg. "&amp;amp;" which should stay "&amp;". Or "&amp;#1234;" to "&#1234;". Or "&amp;#x1b;" to "&#x1b;"
1299 * @return string Converted result.
1300 */
1301 function deHSCentities($str) {
1302 return ereg_replace('&amp;([#[:alnum:]]*;)','&\1',$str);
1303 }
1304
1305 /**
1306 * This function is used to escape any ' -characters when transferring text to JavaScript!
1307 * Usage: 3
1308 *
1309 * @param string String to escape
1310 * @param boolean If set, also backslashes are escaped.
1311 * @param string The character to escape, default is ' (single-quote)
1312 * @return string Processed input string
1313 */
1314 function slashJS($string,$extended=0,$char="'") {
1315 if ($extended) {$string = str_replace ("\\", "\\\\", $string);}
1316 return str_replace ($char, "\\".$char, $string);
1317 }
1318
1319 /**
1320 * Version of rawurlencode() where all spaces (%20) are re-converted to space-characters.
1321 * Usefull when passing text to JavaScript where you simply url-encode it to get around problems with syntax-errors, linebreaks etc.
1322 * Usage: 4
1323 *
1324 * @param string String to raw-url-encode with spaces preserved
1325 * @return string Rawurlencoded result of input string, but with all %20 (space chars) converted to real spaces.
1326 */
1327 function rawUrlEncodeJS($str) {
1328 return str_replace('%20',' ',rawurlencode($str));
1329 }
1330
1331 /**
1332 * rawurlencode which preserves "/" chars
1333 * Usefull when filepaths should keep the "/" chars, but have all other special chars encoded.
1334 * Usage: 5
1335 *
1336 * @param string Input string
1337 * @return string Output string
1338 */
1339 function rawUrlEncodeFP($str) {
1340 return str_replace('%2F','/',rawurlencode($str));
1341 }
1342
1343 /**
1344 * Checking syntax of input email address
1345 * Usage: 5
1346 *
1347 * @param string Input string to evaluate
1348 * @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.
1349 */
1350 function validEmail($email) {
1351 $email = trim ($email);
1352 if (strstr($email,' ')) return FALSE;
1353 return ereg('^[A-Za-z0-9\._-]+[@][A-Za-z0-9\._-]+[\.].[A-Za-z0-9]+$',$email) ? TRUE : FALSE;
1354 }
1355
1356 /**
1357 * Formats a string for output between <textarea>-tags
1358 * All content outputted in a textarea form should be passed through this function
1359 * 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!
1360 * Usage: 23
1361 *
1362 * @param string Input string to be formatted.
1363 * @return string Formatted for <textarea>-tags
1364 */
1365 function formatForTextarea($content) {
1366 return chr(10).htmlspecialchars($content);
1367 }
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380 /*************************
1381 *
1382 * ARRAY FUNCTIONS
1383 *
1384 *************************/
1385
1386 /**
1387 * Check if an item exists in an array
1388 * Please note that the order of parameters is reverse compared to the php4-function in_array()!!!
1389 * Usage: 3
1390 *
1391 * @param array one-dimensional array of items
1392 * @param string item to check for
1393 * @return boolean true if $item is in the one-dimensional array $in_array
1394 * @internal
1395 */
1396 function inArray($in_array,$item) {
1397 if (is_array($in_array)) {
1398 while (list(,$val)=each($in_array)) {
1399 if (!is_array($val) && !strcmp($val,$item)) return true;
1400 }
1401 }
1402 }
1403
1404 /**
1405 * Explodes a $string delimited by $delim and passes each item in the array through intval().
1406 * Corresponds to explode(), but with conversion to integers for all values.
1407 * Usage: 76
1408 *
1409 * @param string Delimiter string to explode with
1410 * @param string The string to explode
1411 * @return array Exploded values, all converted to integers
1412 */
1413 function intExplode($delim, $string) {
1414 $temp = explode($delim,$string);
1415 while(list($key,$val)=each($temp)) {
1416 $temp[$key]=intval($val);
1417 }
1418 reset($temp);
1419 return $temp;
1420 }
1421
1422 /**
1423 * Reverse explode which explodes the string counting from behind.
1424 * Thus t3lib_div::revExplode(':','my:words:here',2) will return array('my:words','here')
1425 * Usage: 8
1426 *
1427 * @param string Delimiter string to explode with
1428 * @param string The string to explode
1429 * @param integer Number of array entries
1430 * @return array Exploded values
1431 */
1432 function revExplode($delim, $string, $count=0) {
1433 $temp = explode($delim,strrev($string),$count);
1434 while(list($key,$val)=each($temp)) {
1435 $temp[$key]=strrev($val);
1436 }
1437 $temp=array_reverse($temp);
1438 reset($temp);
1439 return $temp;
1440 }
1441
1442 /**
1443 * Explodes a string and trims all values for whitespace in the ends.
1444 * If $onlyNonEmptyValues is set, then all blank ('') values are removed.
1445 * Usage: 256
1446 *
1447 * @param string Delimiter string to explode with
1448 * @param string The string to explode
1449 * @param boolean If set, all empty values (='') will NOT be set in output
1450 * @return array Exploded values
1451 */
1452 function trimExplode($delim, $string, $onlyNonEmptyValues=0) {
1453 $temp = explode($delim,$string);
1454 $newtemp=array();
1455 while(list($key,$val)=each($temp)) {
1456 if (!$onlyNonEmptyValues || strcmp('',trim($val))) {
1457 $newtemp[]=trim($val);
1458 }
1459 }
1460 reset($newtemp);
1461 return $newtemp;
1462 }
1463
1464 /**
1465 * Remove duplicate values from an array
1466 * This function is deprecated, use the PHP function array_unique instead
1467 * Usage: 0
1468 *
1469 * @param array Array of values to make unique
1470 * @return array
1471 * @ignore
1472 * @deprecated
1473 */
1474 function uniqueArray($valueArray) {
1475 return array_unique($valueArray);
1476 }
1477
1478 /**
1479 * Removes the value $cmpValue from the $array if found there. Returns the modified array
1480 * Usage: 3
1481 *
1482 * @param array Array containing the values
1483 * @param string Value to search for and if found remove array entry where found.
1484 * @return array Output array with entries removed if search string is found
1485 */
1486 function removeArrayEntryByValue($array,$cmpValue) {
1487 if (is_array($array)) {
1488 reset($array);
1489 while(list($k,$v)=each($array)) {
1490 if (is_array($v)) {
1491 $array[$k] = t3lib_div::removeArrayEntryByValue($v,$cmpValue);
1492 } else {
1493 if (!strcmp($v,$cmpValue)) {
1494 unset($array[$k]);
1495 }
1496 }
1497 }
1498 }
1499 reset($array);
1500 return $array;
1501 }
1502
1503 /**
1504 * Implodes a multidim-array into GET-parameters (eg. &param[key][key2]=value2&param[key][key3]=value3)
1505 * Usage: 24
1506 *
1507 * @param string Name prefix for entries. Set to blank if you wish none.
1508 * @param array The (multidim) array to implode
1509 * @param string (keep blank)
1510 * @param boolean If set, parameters which were blank strings would be removed.
1511 * @param boolean If set, the param name itself (for example "param[key][key2]") would be rawurlencoded as well.
1512 * @return string Imploded result, fx. &param[key][key2]=value2&param[key][key3]=value3
1513 * @see explodeUrl2Array()
1514 */
1515 function implodeArrayForUrl($name,$theArray,$str='',$skipBlank=0,$rawurlencodeParamName=0) {
1516 if (is_array($theArray)) {
1517 foreach($theArray as $Akey => $AVal) {
1518 $thisKeyName = $name ? $name.'['.$Akey.']' : $Akey;
1519 if (is_array($AVal)) {
1520 $str = t3lib_div::implodeArrayForUrl($thisKeyName,$AVal,$str,$skipBlank,$rawurlencodeParamName);
1521 } else {
1522 if (!$skipBlank || strcmp($AVal,'')) {
1523 $str.='&'.($rawurlencodeParamName ? rawurlencode($thisKeyName) : $thisKeyName).
1524 '='.rawurlencode($AVal);
1525 }
1526 }
1527 }
1528 }
1529 return $str;
1530 }
1531
1532 /**
1533 * Explodes a string with GETvars (eg. "&id=1&type=2&ext[mykey]=3") into an array
1534 *
1535 * @param string GETvars string
1536 * @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())
1537 * @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!
1538 * @see implodeArrayForUrl()
1539 */
1540 function explodeUrl2Array($string,$multidim=FALSE) {
1541 $output = array();
1542 if ($multidim) {
1543 parse_str($string,$output);
1544 } else {
1545 $p = explode('&',$string);
1546 foreach($p as $v) {
1547 if (strlen($v)) {
1548 list($pK,$pV) = explode('=',$v,2);
1549 $output[rawurldecode($pK)] = rawurldecode($pV);
1550 }
1551 }
1552 }
1553 return $output;
1554 }
1555
1556 /**
1557 * Returns an array with selected keys from incoming data.
1558 * (Better read source code if you want to find out...)
1559 * Usage: 3
1560 *
1561 * @param string List of variable/key names
1562 * @param array Array from where to get values based on the keys in $varList
1563 * @param boolean If set, then t3lib_div::_GP() is used to fetch the value if not found (isset) in the $getArray
1564 * @return array Output array with selected variables.
1565 */
1566 function compileSelectedGetVarsFromArray($varList,$getArray,$GPvarAlt=1) {
1567 $keys = t3lib_div::trimExplode(',',$varList,1);
1568 $outArr=array();
1569 foreach($keys as $v) {
1570 if (isset($getArray[$v])) {
1571 $outArr[$v]=$getArray[$v];
1572 } elseif ($GPvarAlt) {
1573 $outArr[$v]=t3lib_div::_GP($v);
1574 }
1575 }
1576 return $outArr;
1577 }
1578
1579 /**
1580 * AddSlash array
1581 * This function traverses a multidimentional array and adds slashes to the values.
1582 * NOTE that the input array is and argument by reference.!!
1583 * Twin-function to stripSlashesOnArray
1584 * Usage: 8
1585 *
1586 * @param array Multidimensional input array, (REFERENCE!)
1587 * @return array
1588 */
1589 function addSlashesOnArray(&$theArray) {
1590 if (is_array($theArray)) {
1591 reset($theArray);
1592 while(list($Akey,$AVal)=each($theArray)) {
1593 if (is_array($AVal)) {
1594 t3lib_div::addSlashesOnArray($theArray[$Akey]);
1595 } else {
1596 $theArray[$Akey] = addslashes($AVal);
1597 }
1598 }
1599 reset($theArray);
1600 }
1601 }
1602
1603 /**
1604 * StripSlash array
1605 * This function traverses a multidimentional array and strips slashes to the values.
1606 * NOTE that the input array is and argument by reference.!!
1607 * Twin-function to addSlashesOnArray
1608 * Usage: 10
1609 *
1610 * @param array Multidimensional input array, (REFERENCE!)
1611 * @return array
1612 */
1613 function stripSlashesOnArray(&$theArray) {
1614 if (is_array($theArray)) {
1615 reset($theArray);
1616 while(list($Akey,$AVal)=each($theArray)) {
1617 if (is_array($AVal)) {
1618 t3lib_div::stripSlashesOnArray($theArray[$Akey]);
1619 } else {
1620 $theArray[$Akey] = stripslashes($AVal);
1621 }
1622 }
1623 reset($theArray);
1624 }
1625 }
1626
1627 /**
1628 * Either slashes ($cmd=add) or strips ($cmd=strip) array $arr depending on $cmd
1629 * Usage: 0
1630 *
1631 * @param array Multidimensional input array
1632 * @param string "add" or "strip", depending on usage you wish.
1633 * @return array
1634 */
1635 function slashArray($arr,$cmd) {
1636 if ($cmd=='strip') t3lib_div::stripSlashesOnArray($arr);
1637 if ($cmd=='add') t3lib_div::addSlashesOnArray($arr);
1638 return $arr;
1639 }
1640
1641 /**
1642 * 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)
1643 * In case of identical keys, ie. keeping the values of the second.
1644 * Usage: 0
1645 *
1646 * @param array First array
1647 * @param array Second array, overruling the first array
1648 * @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.
1649 * @param boolean If set, values from $arr1 will overrule if they are empty. Default: true
1650 * @return array Resulting array where $arr1 values has overruled $arr0 values
1651 */
1652 function array_merge_recursive_overrule($arr0,$arr1,$notAddKeys=0,$includeEmtpyValues=true) {
1653 reset($arr1);
1654 while(list($key,$val) = each($arr1)) {
1655 if(is_array($arr0[$key])) {
1656 if (is_array($arr1[$key])) {
1657 $arr0[$key] = t3lib_div::array_merge_recursive_overrule($arr0[$key],$arr1[$key],$notAddKeys);
1658 }
1659 } else {
1660 if ($notAddKeys) {
1661 if (isset($arr0[$key])) {
1662 if ($includeEmtpyValues OR $val) {
1663 $arr0[$key] = $val;
1664 }
1665 }
1666 } else {
1667 if ($includeEmtpyValues OR $val) {
1668 $arr0[$key] = $val;
1669 }
1670 }
1671 }
1672 }
1673 reset($arr0);
1674 return $arr0;
1675 }
1676
1677 /**
1678 * 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.
1679 * Usage: 16
1680 *
1681 * @param array First array
1682 * @param array Second array
1683 * @return array Merged result.
1684 */
1685 function array_merge($arr1,$arr2) {
1686 return $arr2+$arr1;
1687 }
1688
1689 /**
1690 * Takes a row and returns a CSV string of the values with $delim (default is ,) and $quote (default is ") as separator chars.
1691 * Usage: 5
1692 *
1693 * @param array Input array of values
1694 * @param string Delimited, default is comman
1695 * @param string Quote-character to wrap around the values.
1696 * @return string A single line of CSV
1697 */
1698 function csvValues($row,$delim=',',$quote='"') {
1699 reset($row);
1700 $out=array();
1701 while(list(,$value)=each($row)) {
1702 list($valPart) = explode(chr(10),$value);
1703 $valPart = trim($valPart);
1704 $out[]=str_replace($quote,$quote.$quote,$valPart);
1705 }
1706 $str = $quote.implode($quote.$delim.$quote,$out).$quote;
1707 return $str;
1708 }
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725 /*************************
1726 *
1727 * HTML/XML PROCESSING
1728 *
1729 *************************/
1730
1731 /**
1732 * Returns an array with all attributes of the input HTML tag as key/value pairs. Attributes are only lowercase a-z
1733 * $tag is either a whole tag (eg '<TAG OPTION ATTRIB=VALUE>') or the parameterlist (ex ' OPTION ATTRIB=VALUE>')
1734 * If a attribute is empty (I call it 'an option'), then the value for the key is empty. You can check if it existed with isset()
1735 * Usage: 8
1736 *
1737 * @param string HTML-tag string (or attributes only)
1738 * @return array Array with the attribute values.
1739 */
1740 function get_tag_attributes($tag) {
1741 $components = t3lib_div::split_tag_attributes($tag);
1742 $name = ''; // attribute name is stored here
1743 $valuemode = '';
1744 if (is_array($components)) {
1745 while (list($key,$val) = each ($components)) {
1746 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
1747 if ($valuemode) {
1748 if ($name) {
1749 $attributes[$name] = $val;
1750 $name = '';
1751 }
1752 } else {
1753 if ($key = strtolower(ereg_replace('[^a-zA-Z0-9]','',$val))) {
1754 $attributes[$key] = '';
1755 $name = $key;
1756 }
1757 }
1758 $valuemode = '';
1759 } else {
1760 $valuemode = 'on';
1761 }
1762 }
1763 if (is_array($attributes)) reset($attributes);
1764 return $attributes;
1765 }
1766 }
1767
1768 /**
1769 * Returns an array with the 'components' from an attribute list from an HTML tag. The result is normally analyzed by get_tag_attributes
1770 * Removes tag-name if found
1771 * Usage: 2
1772 *
1773 * @param string HTML-tag string (or attributes only)
1774 * @return array Array with the attribute values.
1775 * @internal
1776 */
1777 function split_tag_attributes($tag) {
1778 $tag_tmp = trim(eregi_replace ('^<[^[:space:]]*','',trim($tag)));
1779 // Removes any > in the end of the string
1780 $tag_tmp = trim(eregi_replace ('>$','',$tag_tmp));
1781
1782 while (strcmp($tag_tmp,'')) { // Compared with empty string instead , 030102
1783 $firstChar=substr($tag_tmp,0,1);
1784 if (!strcmp($firstChar,'"') || !strcmp($firstChar,"'")) {
1785 $reg=explode($firstChar,$tag_tmp,3);
1786 $value[]=$reg[1];
1787 $tag_tmp=trim($reg[2]);
1788 } elseif (!strcmp($firstChar,'=')) {
1789 $value[] = '=';
1790 $tag_tmp = trim(substr($tag_tmp,1)); // Removes = chars.
1791 } else {
1792 // There are '' around the value. We look for the next ' ' or '>'
1793 $reg = split('[[:space:]=]',$tag_tmp,2);
1794 $value[] = trim($reg[0]);
1795 $tag_tmp = trim(substr($tag_tmp,strlen($reg[0]),1).$reg[1]);
1796 }
1797 }
1798 if (is_array($value)) reset($value);
1799 return $value;
1800 }
1801
1802 /**
1803 * Implodes attributes in the array $arr for an attribute list in eg. and HTML tag (with quotes)
1804 * Usage: 14
1805 *
1806 * @param array Array with attribute key/value pairs, eg. "bgcolor"=>"red", "border"=>0
1807 * @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!
1808 * @param boolean If true, don't check if values are blank. Default is to omit attributes with blank values.
1809 * @return string Imploded attributes, eg. 'bgcolor="red" border="0"'
1810 */
1811 function implodeAttributes($arr,$xhtmlSafe=FALSE,$dontOmitBlankAttribs=FALSE) {
1812 if (is_array($arr)) {
1813 if ($xhtmlSafe) {
1814 $newArr=array();
1815 foreach($arr as $p => $v) {
1816 if (!isset($newArr[strtolower($p)])) $newArr[strtolower($p)] = htmlspecialchars($v);
1817 }
1818 $arr = $newArr;
1819 }
1820 $list = array();
1821 foreach($arr as $p => $v) {
1822 if (strcmp($v,'') || $dontOmitBlankAttribs) {$list[]=$p.'="'.$v.'"';}
1823 }
1824 return implode(' ',$list);
1825 }
1826 }
1827
1828 /**
1829 * Implodes attributes in the array $arr for an attribute list in eg. and HTML tag (with quotes)
1830 *
1831 * @param array See implodeAttributes()
1832 * @param boolean See implodeAttributes()
1833 * @param boolean See implodeAttributes()
1834 * @return string See implodeAttributes()
1835 * @deprecated Name was changed into implodeAttributes
1836 * @see implodeAttributes()
1837 */
1838 function implodeParams($arr,$xhtmlSafe=FALSE,$dontOmitBlankAttribs=FALSE) {
1839 return t3lib_div::implodeAttributes($arr,$xhtmlSafe,$dontOmitBlankAttribs);
1840 }
1841
1842 /**
1843 * Wraps JavaScript code XHTML ready with <script>-tags
1844 * Automatic re-identing of the JS code is done by using the first line as ident reference.
1845 * This is nice for identing JS code with PHP code on the same level.
1846 *
1847 * @param string JavaScript code
1848 * @param boolean Wrap script element in linebreaks? Default is TRUE.
1849 * @return string The wrapped JS code, ready to put into a XHTML page
1850 * @author Ingmar Schlecht <ingmars@web.de>
1851 * @author René Fritz <r.fritz@colorcube.de>
1852 */
1853 function wrapJS($string, $linebreak=TRUE) {
1854 if(trim($string)) {
1855 // <script wrapped in nl?
1856 $cr = $linebreak? "\n" : '';
1857
1858 // remove nl from the beginning
1859 $string = preg_replace ('/^\n+/', '', $string);
1860 // re-ident to one tab using the first line as reference
1861 $match = array();
1862 if(preg_match('/^(\t+)/',$string,$match)) {
1863 $string = str_replace($match[1],"\t", $string);
1864 }
1865 $string = $cr.'<script type="text/javascript">
1866 /*<![CDATA[*/
1867 '.$string.'
1868 /*]]>*/
1869 </script>'.$cr;
1870 }
1871 return trim($string);
1872 }
1873
1874
1875 /**
1876 * Parses XML input into a PHP array with associative keys
1877 * Usage: 0
1878 *
1879 * @param string XML data input
1880 * @param integer Number of element levels to resolve the XML into an array. Any further structure will be set as XML.
1881 * @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.
1882 * @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
1883 */
1884 function xml2tree($string,$depth=999) {
1885 $parser = xml_parser_create();
1886 $vals = array();
1887 $index = array();
1888
1889 xml_parser_set_option($parser, XML_OPTION_CASE_FOLDING, 0);
1890 xml_parser_set_option($parser, XML_OPTION_SKIP_WHITE, 0);
1891 xml_parse_into_struct($parser, $string, $vals, $index);
1892
1893 if (xml_get_error_code($parser)) return 'Line '.xml_get_current_line_number($parser).': '.xml_error_string(xml_get_error_code($parser));
1894 xml_parser_free($parser);
1895
1896 $stack = array( array() );
1897 $stacktop = 0;
1898 $startPoint=0;
1899
1900 // FIXME don't use unset() - what does that mean? Use NULL or similar.
1901 unset($tagi);
1902 foreach($vals as $key => $val) {
1903 $type = $val['type'];
1904
1905 // open tag:
1906 if ($type=='open' || $type=='complete') {
1907 $stack[$stacktop++] = $tagi;
1908
1909 if ($depth==$stacktop) {
1910 $startPoint=$key;
1911 }
1912
1913 $tagi = array('tag' => $val['tag']);
1914
1915 if(isset($val['attributes'])) $tagi['attrs'] = $val['attributes'];
1916 if(isset($val['value'])) $tagi['values'][] = $val['value'];
1917 }
1918 // finish tag:
1919 if ($type=='complete' || $type=='close') {
1920 $oldtagi = $tagi;
1921 $tagi = $stack[--$stacktop];
1922 $oldtag = $oldtagi['tag'];
1923 unset($oldtagi['tag']);
1924
1925 if ($depth==($stacktop+1)) {
1926 if ($key-$startPoint > 0) {
1927 $partArray = array_slice(
1928 $vals,
1929 $startPoint+1,
1930 $key-$startPoint-1
1931 );
1932 #$oldtagi=array('XMLvalue'=>t3lib_div::xmlRecompileFromStructValArray($partArray));
1933 $oldtagi['XMLvalue']=t3lib_div::xmlRecompileFromStructValArray($partArray);
1934 } else {
1935 $oldtagi['XMLvalue']=$oldtagi['values'][0];
1936 }
1937 }
1938
1939 $tagi['ch'][$oldtag][] = $oldtagi;
1940 unset($oldtagi);
1941 }
1942 // cdata
1943 if($type=='cdata') {
1944 $tagi['values'][] = $val['value'];
1945 }
1946 }
1947 return $tagi['ch'];
1948 }
1949
1950 /**
1951 * Turns PHP array into XML. See array2xml()
1952 *
1953 * @param array The input PHP array with any kind of data; text, binary, integers. Not objects though.
1954 * @param string Alternative document tag. Default is "phparray".
1955 * @param array Options for the compilation. See array2xml() for description.
1956 * @param string Forced charset to prologue
1957 * @return string An XML string made from the input content in the array.
1958 * @see xml2array(),array2xml()
1959 */
1960 function array2xml_cs($array,$docTag='phparray',$options=array(),$charset='') {
1961
1962 // Figure out charset if not given explicitly:
1963 if (!$charset) {
1964 if ($GLOBALS['TYPO3_CONF_VARS']['BE']['forceCharset']) { // First priority: forceCharset! If set, this will be authoritative!
1965 $charset = $GLOBALS['TYPO3_CONF_VARS']['BE']['forceCharset'];
1966 } elseif (is_object($GLOBALS['LANG'])) {
1967 $charset = $GLOBALS['LANG']->charSet; // If "LANG" is around, that will hold the current charset
1968 } else {
1969 $charset = 'iso-8859-1'; // THIS is just a hopeful guess!
1970 }
1971 }
1972
1973 // Return XML:
1974 return '<?xml version="1.0" encoding="'.htmlspecialchars($charset).'" standalone="yes" ?>'.chr(10).
1975 t3lib_div::array2xml($array,'',0,$docTag,0, $options);
1976 }
1977
1978 /**
1979 * Deprecated to call directly (unless you are aware of using XML prologues)! Use "array2xml_cs" instead (which adds an XML-prologue)
1980 *
1981 * Converts a PHP array into an XML string.
1982 * The XML output is optimized for readability since associative keys are used as tagnames.
1983 * 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.
1984 * Numeric keys are stored with the default tagname "numIndex" but can be overridden to other formats)
1985 * 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
1986 * 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.
1987 * 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!
1988 * 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...
1989 * Usage: 5
1990 *
1991 * @param array The input PHP array with any kind of data; text, binary, integers. Not objects though.
1992 * @param string tag-prefix, eg. a namespace prefix like "T3:"
1993 * @param integer Current recursion level. Don't change, stay at zero!
1994 * @param string Alternative document tag. Default is "phparray".
1995 * @param integer If set, the number of spaces corresponding to this number is used for indenting, otherwise a single chr(9) (TAB) is used
1996 * @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')
1997 * @param string Stack data. Don't touch.
1998 * @return string An XML string made from the input content in the array.
1999 * @see xml2array()
2000 */
2001 function array2xml($array,$NSprefix='',$level=0,$docTag='phparray',$spaceInd=0, $options=array(),$stackData=array()) {
2002 // 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
2003 $binaryChars = chr(0).chr(1).chr(2).chr(3).chr(4).chr(5).chr(6).chr(7).chr(8).
2004 chr(11).chr(12).chr(14).chr(15).chr(16).chr(17).chr(18).chr(19).
2005 chr(20).chr(21).chr(22).chr(23).chr(24).chr(25).chr(26).chr(27).chr(28).chr(29).
2006 chr(30).chr(31);
2007 // Set indenting mode:
2008 $indentChar = $spaceInd ? ' ' : chr(9);
2009 $indentN = $spaceInd>0 ? $spaceInd : 1;
2010
2011 // Init output variable:
2012 $output='';
2013
2014 // Traverse the input array
2015 if (is_array($array)) {
2016 foreach($array as $k=>$v) {
2017 $attr = '';
2018 $tagName = $k;
2019
2020 // Construct the tag name.
2021 if(isset($options['grandParentTagMap'][$stackData['grandParentTagName'].'/'.$stackData['parentTagName']])) { // Use tag based on grand-parent + parent tag name
2022 $attr.=' index="'.htmlspecialchars($tagName).'"';
2023 $tagName = (string)$options['grandParentTagMap'][$stackData['grandParentTagName'].'/'.$stackData['parentTagName']];
2024 }elseif(isset($options['parentTagMap'][$stackData['parentTagName'].':_IS_NUM']) && t3lib_div::testInt($tagName)) { // Use tag based on parent tag name + if current tag is numeric
2025 $attr.=' index="'.htmlspecialchars($tagName).'"';
2026 $tagName = (string)$options['parentTagMap'][$stackData['parentTagName'].':_IS_NUM'];
2027 }elseif(isset($options['parentTagMap'][$stackData['parentTagName'].':'.$tagName])) { // Use tag based on parent tag name + current tag
2028 $attr.=' index="'.htmlspecialchars($tagName).'"';
2029 $tagName = (string)$options['parentTagMap'][$stackData['parentTagName'].':'.$tagName];
2030 } elseif(isset($options['parentTagMap'][$stackData['parentTagName']])) { // Use tag based on parent tag name:
2031 $attr.=' index="'.htmlspecialchars($tagName).'"';
2032 $tagName = (string)$options['parentTagMap'][$stackData['parentTagName']];
2033 } elseif (!strcmp(intval($tagName),$tagName)) { // If integer...;
2034 if ($options['useNindex']) { // If numeric key, prefix "n"
2035 $tagName = 'n'.$tagName;
2036 } else { // Use special tag for num. keys:
2037 $attr.=' index="'.$tagName.'"';
2038 $tagName = $options['useIndexTagForNum'] ? $options['useIndexTagForNum'] : 'numIndex';
2039 }
2040 } elseif($options['useIndexTagForAssoc']) { // Use tag for all associative keys:
2041 $attr.=' index="'.htmlspecialchars($tagName).'"';
2042 $tagName = $options['useIndexTagForAssoc'];
2043 }
2044
2045 // The tag name is cleaned up so only alphanumeric chars (plus - and _) are in there and not longer than 100 chars either.
2046 $tagName = substr(ereg_replace('[^[:alnum:]_-]','',$tagName),0,100);
2047
2048 // If the value is an array then we will call this function recursively:
2049 if (is_array($v)) {
2050
2051 // Sub elements:
2052 if ($options['alt_options'][$stackData['path'].'/'.$tagName]) {
2053 $subOptions = $options['alt_options'][$stackData['path'].'/'.$tagName];
2054 $clearStackPath = $subOptions['clearStackPath'];
2055 } else {
2056 $subOptions = $options;
2057 $clearStackPath = FALSE;
2058 }
2059
2060 $content = chr(10).
2061 t3lib_div::array2xml(
2062 $v,
2063 $NSprefix,
2064 $level+1,
2065 '',
2066 $spaceInd,
2067 $subOptions,
2068 array(
2069 'parentTagName' => $tagName,
2070 'grandParentTagName' => $stackData['parentTagName'],
2071 'path' => $clearStackPath ? '' : $stackData['path'].'/'.$tagName,
2072 )
2073 ).
2074 str_pad('',($level+1)*$indentN,$indentChar);
2075 if ((int)$options['disableTypeAttrib']!=2) { // Do not set "type = array". Makes prettier XML but means that empty arrays are not restored with xml2array
2076 $attr.=' type="array"';
2077 }
2078 } else { // Just a value:
2079
2080 // Look for binary chars:
2081 if (strcspn($v,$binaryChars) != strlen($v)) { // Go for base64 encoding if the initial segment NOT matching any binary char has the same length as the whole string!
2082 // If the value contained binary chars then we base64-encode it an set an attribute to notify this situation:
2083 $content = chr(10).chunk_split(base64_encode($v));
2084 $attr.=' base64="1"';
2085 } else {
2086 // Otherwise, just htmlspecialchar the stuff:
2087 $content = htmlspecialchars($v);
2088 $dType = gettype($v);
2089 if ($dType!='string' && !$options['disableTypeAttrib']) { $attr.=' type="'.$dType.'"'; }
2090 }
2091 }
2092
2093 // Add the element to the output string:
2094 $output.=str_pad('',($level+1)*$indentN,$indentChar).'<'.$NSprefix.$tagName.$attr.'>'.$content.'</'.$NSprefix.$tagName.'>'.chr(10);
2095 }
2096 }
2097
2098 // If we are at the outer-most level, then we finally wrap it all in the document tags and return that as the value:
2099 if (!$level) {
2100 $output =
2101 '<'.$docTag.'>'.chr(10).
2102 $output.
2103 '</'.$docTag.'>';
2104 }
2105
2106 return $output;
2107 }
2108
2109 /**
2110 * Converts an XML string to a PHP array.
2111 * This is the reverse function of array2xml()
2112 * Usage: 17
2113 *
2114 * @param string XML content to convert into an array
2115 * @param string The tag-prefix resolve, eg. a namespace like "T3:"
2116 * @param boolean If set, the document tag will be set in the key "_DOCUMENT_TAG" of the output array
2117 * @return mixed If the parsing had errors, a string with the error message is returned. Otherwise an array with the content.
2118 * @see array2xml()
2119 */
2120 function xml2array($string,$NSprefix='',$reportDocTag=FALSE) {
2121 global $TYPO3_CONF_VARS;
2122
2123 // Create parser:
2124 $parser = xml_parser_create();
2125 $vals = array();
2126 $index = array();
2127
2128 xml_parser_set_option($parser, XML_OPTION_CASE_FOLDING, 0);
2129 xml_parser_set_option($parser, XML_OPTION_SKIP_WHITE, 0);
2130
2131 // PHP5 fix of charset awareness:
2132 // Problem is: PHP5 apparently detects the charset of the XML file (or defaults to utf-8) and will AUTOMATICALLY convert the content to either utf-8, iso-8859-1 or us-ascii. PHP4 just passed the content through without taking action regarding the charset.
2133 // In TYPO3 we expect that the charset of XML content is NOT handled in the parser but internally in TYPO3 instead. Therefore it would be very nice if PHP5 could be configured to NOT process the charset of the files. But this is not possible for now.
2134 // What we do here fixes the problem but ONLY if the charset is utf-8, iso-8859-1 or us-ascii. That should work for most TYPO3 installations, in particular if people use utf-8 which we highly recommend.
2135 if ((double)phpversion()>=5) {
2136 $ereg_result = array();
2137 ereg('^[[:space:]]*<\?xml[^>]*encoding[[:space:]]*=[[:space:]]*"([^"]*)"',substr($string,0,200),$ereg_result);
2138 $theCharset = $ereg_result[1] ? $ereg_result[1] : ($TYPO3_CONF_VARS['BE']['forceCharset'] ? $TYPO3_CONF_VARS['BE']['forceCharset'] : 'iso-8859-1');
2139 xml_parser_set_option($parser, XML_OPTION_TARGET_ENCODING, $theCharset); // us-ascii / utf-8 / iso-8859-1
2140 }
2141
2142 // Parse content:
2143 xml_parse_into_struct($parser, $string, $vals, $index);
2144
2145 // If error, return error message:
2146 if (xml_get_error_code($parser)) {
2147 return 'Line '.xml_get_current_line_number($parser).': '.xml_error_string(xml_get_error_code($parser));
2148 }
2149 xml_parser_free($parser);
2150
2151 // Init vars:
2152 $stack = array(array());
2153 $stacktop = 0;
2154 $current=array();
2155 $tagName = '';
2156 $documentTag = '';
2157
2158 // Traverse the parsed XML structure:
2159 foreach($vals as $key => $val) {
2160
2161 // First, process the tag-name (which is used in both cases, whether "complete" or "close")
2162 $tagName = $val['tag'];
2163 if (!$documentTag) $documentTag = $tagName;
2164
2165 // Test for name space:
2166 $tagName = ($NSprefix && substr($tagName,0,strlen($NSprefix))==$NSprefix) ? substr($tagName,strlen($NSprefix)) : $tagName;
2167
2168 // Test for numeric tag, encoded on the form "nXXX":
2169 $testNtag = substr($tagName,1); // Closing tag.
2170 $tagName = (substr($tagName,0,1)=='n' && !strcmp(intval($testNtag),$testNtag)) ? intval($testNtag) : $tagName;
2171
2172 // Test for alternative index value:
2173 if (strlen($val['attributes']['index'])) { $tagName = $val['attributes']['index']; }
2174
2175 // Setting tag-values, manage stack:
2176 switch($val['type']) {
2177 case 'open': // If open tag it means there is an array stored in sub-elements. Therefore increase the stackpointer and reset the accumulation array:
2178 $current[$tagName] = array(); // Setting blank place holder
2179 $stack[$stacktop++] = $current;
2180 $current = array();
2181 break;
2182 case 'close': // If the tag is "close" then it is an array which is closing and we decrease the stack pointer.
2183 $oldCurrent = $current;
2184 $current = $stack[--$stacktop];
2185 end($current); // Going to the end of array to get placeholder key, key($current), and fill in array next:
2186 $current[key($current)] = $oldCurrent;
2187 unset($oldCurrent);
2188 break;
2189 case 'complete': // If "complete", then it's a value. If the attribute "base64" is set, then decode the value, otherwise just set it.
2190 if ($val['attributes']['base64']) {
2191 $current[$tagName] = base64_decode($val['value']);
2192 } else {
2193 $current[$tagName] = (string)$val['value']; // Had to cast it as a string - otherwise it would be evaluate false if tested with isset()!!
2194
2195 // Cast type:
2196 switch((string)$val['attributes']['type']) {
2197 case 'integer':
2198 $current[$tagName] = (integer)$current[$tagName];
2199 break;
2200 case 'double':
2201 $current[$tagName] = (double)$current[$tagName];
2202 break;
2203 case 'boolean':
2204 $current[$tagName] = (bool)$current[$tagName];
2205 break;
2206 case 'array':
2207 $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...
2208 break;
2209 }
2210 }
2211 break;
2212 }
2213 }
2214
2215 if ($reportDocTag) {
2216 $current[$tagName]['_DOCUMENT_TAG'] = $documentTag;
2217 }
2218
2219 // Finally return the content of the document tag.
2220 return $current[$tagName];
2221 }
2222
2223 /**
2224 * This implodes an array of XML parts (made with xml_parse_into_struct()) into XML again.
2225 * Usage: 2
2226 *
2227 * @param array A array of XML parts, see xml2tree
2228 * @return string Re-compiled XML data.
2229 */
2230 function xmlRecompileFromStructValArray($vals) {
2231 $XMLcontent='';
2232
2233 foreach($vals as $val) {
2234 $type = $val['type'];
2235
2236 // open tag:
2237 if ($type=='open' || $type=='complete') {
2238 $XMLcontent.='<'.$val['tag'];
2239 if(isset($val['attributes'])) {
2240 foreach($val['attributes'] as $k => $v) {
2241 $XMLcontent.=' '.$k.'="'.htmlspecialchars($v).'"';
2242 }
2243 }
2244 if ($type=='complete') {
2245 if(isset($val['value'])) {
2246 $XMLcontent.='>'.htmlspecialchars($val['value']).'</'.$val['tag'].'>';
2247 } else $XMLcontent.='/>';
2248 } else $XMLcontent.='>';
2249
2250 if ($type=='open' && isset($val['value'])) {
2251 $XMLcontent.=htmlspecialchars($val['value']);
2252 }
2253 }
2254 // finish tag:
2255 if ($type=='close') {
2256 $XMLcontent.='</'.$val['tag'].'>';
2257 }
2258 // cdata
2259 if($type=='cdata') {
2260 $XMLcontent.=htmlspecialchars($val['value']);
2261 }
2262 }
2263
2264 return $XMLcontent;
2265 }
2266
2267 /**
2268 * Extract the encoding scheme as found in the first line of an XML document (typically)
2269 * Usage: 1
2270 *
2271 * @param string XML data
2272 * @return string Encoding scheme (lowercase), if found.
2273 */
2274 function xmlGetHeaderAttribs($xmlData) {
2275 $xmlHeader = substr(trim($xmlData),0,200);
2276 $reg=array();
2277 if (eregi('^<\?xml([^>]*)\?\>',$xmlHeader,$reg)) {
2278 return t3lib_div::get_tag_attributes($reg[1]);
2279 }
2280 }
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292 /*************************
2293 *
2294 * FILES FUNCTIONS
2295 *
2296 *************************/
2297
2298 /**
2299 * Reads the file or url $url and returns the content
2300 * 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.
2301 * Usage: 83
2302 *
2303 * @param string Filepath/URL to read
2304 * @param integer Whether the HTTP header should be fetched or not. 0=disable, 1=fetch header+content, 2=fetch header only
2305 * @param array HTTP headers to be used in the request
2306 * @return string The content from the resource given as input.
2307 */
2308 function getURL($url, $includeHeader = 0, $requestHeaders = false) {
2309 $content = false;
2310
2311 // (Proxy support implemented by Arco <arco@appeltaart.mine.nu>)
2312 if ($GLOBALS['TYPO3_CONF_VARS']['SYS']['curlUse'] == '1' && preg_match('/^https?:\/\//', $url)) {
2313 // External URL without error checking.
2314 $ch = curl_init();
2315 if (!$ch) {
2316 return false;
2317 }
2318
2319 curl_setopt($ch, CURLOPT_URL, $url);
2320 curl_setopt($ch, CURLOPT_HEADER, $includeHeader ? 1 : 0);
2321 curl_setopt($ch, CURLOPT_NOBODY, $includeHeader == 2 ? 1 : 0);
2322 curl_setopt($ch, CURLOPT_FOLLOWLOCATION, 1);
2323 curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
2324 if (is_array($requestHeaders)) {
2325 curl_setopt($ch, CURLOPT_HTTPHEADER, $requestHeaders);
2326 }
2327
2328 if ($GLOBALS['TYPO3_CONF_VARS']['SYS']['curlProxyServer']) {
2329 curl_setopt($ch, CURLOPT_PROXY, $GLOBALS['TYPO3_CONF_VARS']['SYS']['curlProxyServer']);
2330
2331 // Not sure if this is needed
2332 if ($GLOBALS['TYPO3_CONF_VARS']['SYS']['curlProxyTunnel']) {
2333 curl_setopt($ch, CURLOPT_HTTPPROXYTUNNEL, $GLOBALS['TYPO3_CONF_VARS']['SYS']['curlProxyTunnel']);
2334 }
2335 if ($GLOBALS['TYPO3_CONF_VARS']['SYS']['curlProxyUserPass']) {
2336 curl_setopt($ch, CURLOPT_PROXYUSERPWD, $GLOBALS['TYPO3_CONF_VARS']['SYS']['curlProxyUserPass']);
2337 }
2338 }
2339 $content = curl_exec($ch);
2340 curl_close($ch);
2341
2342 } elseif ($includeHeader) {
2343 $parsedURL = parse_url($url);
2344 if (!t3lib_div::inList('ftp,ftps,http,https,gopher,telnet', $parsedURL['scheme'])) {
2345 return false;
2346 }
2347
2348 $fp = @fsockopen($parsedURL['host'], ($parsedURL['port'] > 0 ? $parsedURL['port'] : 80), $errno, $errstr, 2.0);
2349 if (!$fp) {
2350 return false;
2351 }
2352
2353 $msg = 'GET ' . $parsedURL['path'] .
2354 ($parsedURL['query'] ? '?' . $parsedURL['query'] : '') .
2355 ' HTTP/1.0' . "\r\n" . 'Host: ' .
2356 $parsedURL['host'] . "\r\n\r\n";
2357 fputs($fp, $msg);
2358 while (!feof($fp)) {
2359 $line = fgets($fp, 2048);
2360 $content.= $line;
2361 if ($includeHeader == 2 && !strlen(trim($line))) {
2362 break; // Stop at the first empty line (= end of header)
2363 }
2364 }
2365 fclose($fp);
2366
2367 } elseif (is_array($requestHeaders) && function_exists('stream_context_create')) {
2368
2369 $ctx = stream_context_create(array(
2370 'http' => array(
2371 'header' => implode("\r\n", $requestHeaders)
2372 )
2373 )
2374 );
2375
2376 if (function_exists('file_get_contents') && version_compare(phpversion(), '5.0', '>=')) {
2377 $content = @file_get_contents($url, false, $ctx);
2378 }
2379 elseif (false !== ($fd = @fopen($url, 'rb', false, $ctx))) {
2380 $content = '';
2381 while (!feof($fd)) {
2382 $content .= fread($fd, 4096);
2383 }
2384 fclose($fd);
2385 }
2386 }
2387 elseif (function_exists('file_get_contents')) {
2388 $content = @file_get_contents($url);
2389 }
2390 elseif (false !== ($fd = @fopen($url, 'rb'))) {
2391 $content = '';
2392 while (!feof($fd)) {
2393 $content .= fread($fd, 4096);
2394 }
2395 fclose($fd);
2396 }
2397
2398 return $content;
2399 }
2400
2401 /**
2402 * Writes $content to the file $file
2403 * Usage: 30
2404 *
2405 * @param string Filepath to write to
2406 * @param string Content to write
2407 * @return boolean True if the file was successfully opened and written to.
2408 */
2409 function writeFile($file,$content) {
2410 if (!@is_file($file)) $changePermissions = true;
2411
2412 if ($fd = fopen($file,'wb')) {
2413 $res = fwrite($fd,$content);
2414 fclose($fd);
2415
2416 if ($res===false) return false;
2417
2418 if ($changePermissions) { // Change the permissions only if the file has just been created
2419 t3lib_div::fixPermissions($file);
2420 }
2421
2422 return true;
2423 }
2424
2425 return false;
2426 }
2427
2428 /**
2429 * Setting file system mode & group ownership of file
2430 *
2431 * @param string Filepath of newly created file
2432 * @return void
2433 */
2434 function fixPermissions($file) {
2435 if (@is_file($file) && TYPO3_OS!='WIN') {
2436 @chmod($file, octdec($GLOBALS['TYPO3_CONF_VARS']['BE']['fileCreateMask'])); // "@" is there because file is not necessarily OWNED by the user
2437 if($GLOBALS['TYPO3_CONF_VARS']['BE']['createGroup']) { // skip this if createGroup is empty
2438 @chgrp($file, $GLOBALS['TYPO3_CONF_VARS']['BE']['createGroup']); // "@" is there because file is not necessarily OWNED by the user
2439 }
2440 }
2441 }
2442
2443 /**
2444 * Writes $content to a filename in the typo3temp/ folder (and possibly one or two subfolders...)
2445 * Accepts an additional subdirectory in the file path!
2446 *
2447 * @param string Absolute filepath to write to inside "typo3temp/". First part of this string must match PATH_site."typo3temp/"
2448 * @param string Content string to write
2449 * @return string Returns false on success, otherwise an error string telling about the problem.
2450 */
2451 function writeFileToTypo3tempDir($filepath,$content) {
2452
2453 // Parse filepath into directory and basename:
2454 $fI = pathinfo($filepath);
2455 $fI['dirname'].= '/';
2456
2457 // Check parts:
2458 if (t3lib_div::validPathStr($filepath) && $fI['basename'] && strlen($fI['basename'])<60) {
2459 if (defined('PATH_site')) {
2460 $dirName = PATH_site.'typo3temp/'; // Setting main temporary directory name (standard)
2461 if (@is_dir($dirName)) {
2462 if (t3lib_div::isFirstPartOfStr($fI['dirname'],$dirName)) {
2463
2464 // Checking if the "subdir" is found:
2465 $subdir = substr($fI['dirname'],strlen($dirName));
2466 if ($subdir) {
2467 if (ereg('^[[:alnum:]_]+\/$',$subdir) || ereg('^[[:alnum:]_]+\/[[:alnum:]_]+\/$',$subdir)) {
2468 $dirName.= $subdir;
2469 if (!@is_dir($dirName)) {
2470 t3lib_div::mkdir_deep(PATH_site.'typo3temp/', $subdir);
2471 }
2472 } else return 'Subdir, "'.$subdir.'", was NOT on the form "[[:alnum:]_]/" or "[[:alnum:]_]/[[:alnum:]_]/"';
2473 }
2474 // Checking dir-name again (sub-dir might have been created):
2475 if (@is_dir($dirName)) {
2476 if ($filepath == $dirName.$fI['basename']) {
2477 t3lib_div::writeFile($filepath, $content);
2478 if (!@is_file($filepath)) return 'File not written to disk! Write permission error in filesystem?';
2479 } else return 'Calculated filelocation didn\'t match input $filepath!';
2480 } else return '"'.$dirName.'" is not a directory!';
2481 } else return '"'.$fI['dirname'].'" was not within directory PATH_site + "typo3temp/"';
2482 } else return 'PATH_site + "typo3temp/" was not a directory!';
2483 } else return 'PATH_site constant was NOT defined!';
2484 } else return 'Input filepath "'.$filepath.'" was generally invalid!';
2485 }
2486
2487 /**
2488 * 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']
2489 * Usage: 6
2490 *
2491 * @param string Absolute path to folder, see PHP mkdir() function. Removes trailing slash internally.
2492 * @return boolean TRUE if @mkdir went well!
2493 */
2494 function mkdir($theNewFolder) {
2495 $theNewFolder = preg_replace('|/$|','',$theNewFolder);
2496 if (mkdir($theNewFolder, octdec($GLOBALS['TYPO3_CONF_VARS']['BE']['folderCreateMask']))){
2497 chmod($theNewFolder, octdec($GLOBALS['TYPO3_CONF_VARS']['BE']['folderCreateMask'])); //added this line, because the mode at 'mkdir' has a strange behaviour sometimes
2498
2499 if($GLOBALS['TYPO3_CONF_VARS']['BE']['createGroup']) { // skip this if createGroup is empty
2500 chgrp($theNewFolder, $GLOBALS['TYPO3_CONF_VARS']['BE']['createGroup']);
2501 }
2502 return TRUE;
2503 }
2504 }
2505
2506 /**
2507 * Creates a directory - including parent directories if necessary - in the file system
2508 *
2509 * @param string Base folder. This must exist! Must have trailing slash! Example "/root/typo3site/"
2510 * @param string Deep directory to create, eg. "xx/yy/" which creates "/root/typo3site/xx/yy/" if $destination is "/root/typo3site/"
2511 * @return string If error, returns error string.
2512 */
2513 function mkdir_deep($destination,$deepDir) {
2514 $allParts = t3lib_div::trimExplode('/',$deepDir,1);
2515 $root = '';
2516 foreach($allParts as $part) {
2517 $root.= $part.'/';
2518 if (!is_dir($destination.$root)) {
2519 t3lib_div::mkdir($destination.$root);
2520 if (!@is_dir($destination.$root)) {
2521 return 'Error: The directory "'.$destination.$root.'" could not be created...';
2522 }
2523 }
2524 }
2525 }
2526
2527 /**
2528 * Returns an array with the names of folders in a specific path
2529 * Will return 'error' (string) if there were an error with reading directory content.
2530 * Usage: 11
2531 *
2532 * @param string Path to list directories from
2533 * @return array Returns an array with the directory entries as values. If no path, the return value is nothing.
2534 */
2535 function get_dirs($path) {
2536 if ($path) {
2537 $d = @dir($path);
2538 if (is_object($d)) {
2539 while($entry=$d->read()) {
2540 if (@is_dir($path.'/'.$entry) && $entry!= '..' && $entry!= '.') {
2541 $filearray[]=$entry;
2542 }
2543 }
2544 $d->close();
2545 } else return 'error';
2546 return $filearray;
2547 }
2548 }
2549
2550 /**
2551 * Returns an array with the names of files in a specific path
2552 * Usage: 18
2553 *
2554 * @param string $path: Is the path to the file
2555 * @param string $extensionList is the comma list of extensions to read only (blank = all)
2556 * @param boolean If set, then the path is prepended the filenames. Otherwise only the filenames are returned in the array
2557 * @param string $order is sorting: 1= sort alphabetically, 'mtime' = sort by modification time.
2558 * @return array Array of the files found
2559 */
2560 function getFilesInDir($path,$extensionList='',$prependPath=0,$order='') {
2561
2562 // Initialize variabels:
2563 $filearray = array();
2564 $sortarray = array();
2565 $path = ereg_replace('\/$','',$path);
2566
2567 // Find files+directories:
2568 if (@is_dir($path)) {
2569 $extensionList = strtolower($extensionList);
2570 $d = dir($path);
2571 if (is_object($d)) {
2572 while($entry=$d->read()) {
2573 if (@is_file($path.'/'.$entry)) {
2574 $fI = pathinfo($entry);
2575 $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)
2576 if (!$extensionList || t3lib_div::inList($extensionList,strtolower($fI['extension']))) {
2577 $filearray[$key]=($prependPath?$path.'/':'').$entry;
2578 if ($order=='mtime') {$sortarray[$key]=filemtime($path.'/'.$entry);}
2579 elseif ($order) {$sortarray[$key]=$entry;}
2580 }
2581 }
2582 }
2583 $d->close();
2584 } else return 'error opening path: "'.$path.'"';
2585 }
2586
2587 // Sort them:
2588 if ($order) {
2589 asort($sortarray);
2590 reset($sortarray);
2591 $newArr=array();
2592 while(list($k,$v)=each($sortarray)) {
2593 $newArr[$k]=$filearray[$k];
2594 }
2595 $filearray=$newArr;
2596 }
2597
2598 // Return result
2599 reset($filearray);
2600 return $filearray;
2601 }
2602
2603 /**
2604 * Recursively gather all files and folders of a path.
2605 * Usage: 5
2606 *
2607 * @param array $fileArr: Empty input array (will have files added to it)
2608 * @param string $path: The path to read recursively from (absolute) (include trailing slash!)
2609 * @param string $extList: Comma list of file extensions: Only files with extensions in this list (if applicable) will be selected.
2610 * @param boolean $regDirs: If set, directories are also included in output.
2611 * @param integer $recursivityLevels: The number of levels to dig down...
2612 * @return array An array with the found files/directories.
2613 */
2614 function getAllFilesAndFoldersInPath($fileArr,$path,$extList='',$regDirs=0,$recursivityLevels=99) {
2615 if ($regDirs) $fileArr[] = $path;
2616 $fileArr = array_merge($fileArr, t3lib_div::getFilesInDir($path,$extList,1,1));
2617
2618 $dirs = t3lib_div::get_dirs($path);
2619 if (is_array($dirs) && $recursivityLevels>0) {
2620 foreach ($dirs as $subdirs) {
2621 if ((string)$subdirs!='') {
2622 $fileArr = t3lib_div::getAllFilesAndFoldersInPath($fileArr,$path.$subdirs.'/',$extList,$regDirs,$recursivityLevels-1);
2623 }
2624 }
2625 }
2626 return $fileArr;
2627 }
2628
2629 /**
2630 * Removes the absolute part of all files/folders in fileArr
2631 * Usage: 2
2632 *
2633 * @param array $fileArr: The file array to remove the prefix from
2634 * @param string $prefixToRemove: The prefix path to remove (if found as first part of string!)
2635 * @return array The input $fileArr processed.
2636 */
2637 function removePrefixPathFromList($fileArr,$prefixToRemove) {
2638 foreach($fileArr as $k => $absFileRef) {
2639 if(t3lib_div::isFirstPartOfStr($absFileRef,$prefixToRemove)) {
2640 $fileArr[$k] = substr($absFileRef,strlen($prefixToRemove));
2641 } else return 'ERROR: One or more of the files was NOT prefixed with the prefix-path!';
2642 }
2643 return $fileArr;
2644 }
2645
2646 /**
2647 * Fixes a path for windows-backslashes and reduces double-slashes to single slashes
2648 * Usage: 2
2649 *
2650 * @param string File path to process
2651 * @return string
2652 */
2653 function fixWindowsFilePath($theFile) {
2654 return str_replace('//','/', str_replace('\\','/', $theFile));
2655 }
2656
2657 /**
2658 * Resolves "../" sections in the input path string.
2659 * For example "fileadmin/directory/../other_directory/" will be resolved to "fileadmin/other_directory/"
2660 * Usage: 2
2661 *
2662 * @param string File path in which "/../" is resolved
2663 * @return string
2664 */
2665 function resolveBackPath($pathStr) {
2666 $parts = explode('/',$pathStr);
2667 $output=array();
2668 $c = 0;
2669 foreach($parts as $pV) {
2670 if ($pV=='..') {
2671 if ($c) {
2672 array_pop($output);
2673 $c--;
2674 } else $output[]=$pV;
2675 } else {
2676 $c++;
2677 $output[]=$pV;
2678 }
2679 }
2680 return implode('/',$output);
2681 }
2682
2683 /**
2684 * Prefixes a URL used with 'header-location' with 'http://...' depending on whether it has it already.
2685 * - If already having a scheme, nothing is prepended
2686 * - If having REQUEST_URI slash '/', then prefixing 'http://[host]' (relative to host)
2687 * - Otherwise prefixed with TYPO3_REQUEST_DIR (relative to current dir / TYPO3_REQUEST_DIR)
2688 * Usage: 30
2689 *
2690 * @param string URL / path to prepend full URL addressing to.
2691 * @return string
2692 */
2693 function locationHeaderUrl($path) {
2694 $uI = parse_url($path);
2695 if (substr($path,0,1)=='/') { // relative to HOST
2696 $path = t3lib_div::getIndpEnv('TYPO3_REQUEST_HOST').$path;
2697 } elseif (!$uI['scheme']) { // No scheme either
2698 $path = t3lib_div::getIndpEnv('TYPO3_REQUEST_DIR').$path;
2699 }
2700 return $path;
2701 }
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718 /*************************
2719 *
2720 * DEBUG helper FUNCTIONS
2721 *
2722 *************************/
2723
2724 /**
2725 * Returns a string with a list of ascii-values for the first $characters characters in $string
2726 * Usage: 0
2727 *
2728 * @param string String to show ASCII value for
2729 * @param integer Number of characters to show
2730 * @return string The string with ASCII values in separated by a space char.
2731 * @internal
2732 */
2733 function debug_ordvalue($string,$characters=100) {
2734 if(strlen($string) < $characters) $characters = strlen($string);
2735 for ($i=0; $i<$characters; $i++) {
2736 $valuestring.=' '.ord(substr($string,$i,1));
2737 }
2738 return trim($valuestring);
2739 }
2740
2741 /**
2742 * Returns HTML-code, which is a visual representation of a multidimensional array
2743 * use t3lib_div::print_array() in order to print an array
2744 * Returns false if $array_in is not an array
2745 * Usage: 31
2746 *
2747 * @param array Array to view
2748 * @return string HTML output
2749 */
2750 function view_array($array_in) {
2751 if (is_array($array_in)) {
2752 $result='<table border="1" cellpadding="1" cellspacing="0" bgcolor="white">';
2753 if (!count($array_in)) {$result.= '<tr><td><font face="Verdana,Arial" size="1"><b>'.htmlspecialchars("EMPTY!").'</b></font></td></tr>';}
2754 while (list($key,$val)=each($array_in)) {
2755 $result.= '<tr><td valign="top"><font face="Verdana,Arial" size="1">'.htmlspecialchars((string)$key).'</font></td><td>';
2756 if (is_array($array_in[$key])) {
2757 $result.=t3lib_div::view_array($array_in[$key]);
2758 } else
2759 $result.= '<font face="Verdana,Arial" size="1" color="red">'.nl2br(htmlspecialchars((string)$val)).'<br /></font>';
2760 $result.= '</td></tr>';
2761 }
2762 $result.= '</table>';
2763 } else {
2764 $result = false;
2765 }
2766 return $result;
2767 }
2768
2769 /**
2770 * Prints an array
2771 * Usage: 6
2772 *
2773 * @param array Array to print visually (in a table).
2774 * @return void
2775 * @internal
2776 * @see view_array()
2777 */
2778 function print_array($array_in) {
2779 echo t3lib_div::view_array($array_in);
2780 }
2781
2782 /**
2783 * Makes debug output
2784 * Prints $var in bold between two vertical lines
2785 * If not $var the word 'debug' is printed
2786 * If $var is an array, the array is printed by t3lib_div::print_array()
2787 * Usage: 8
2788 *
2789 * @param mixed Variable to print
2790 * @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.
2791 * @return void
2792 */
2793 function debug($var="",$brOrHeader=0) {
2794 if ($brOrHeader && !t3lib_div::testInt($brOrHeader)) {
2795 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>';
2796 } elseif ($brOrHeader<0) {
2797 for($a=0;$a<abs(intval($brOrHeader));$a++){echo '<br />';}
2798 }
2799
2800 if (is_array($var)) {
2801 t3lib_div::print_array($var);
2802 } elseif (is_object($var)) {
2803 echo '<b>|Object:<pre>';
2804 print_r($var);
2805 echo '</pre>|</b>';
2806 } elseif ((string)$var!='') {
2807 echo '<b>|'.htmlspecialchars((string)$var).'|</b>';
2808 } else {
2809 echo '<b>| debug |</b>';
2810 }
2811
2812 if ($brOrHeader && !t3lib_div::testInt($brOrHeader)) {
2813 echo '</td></tr></table>';
2814 } elseif ($brOrHeader>0) {
2815 for($a=0;$a<intval($brOrHeader);$a++){echo '<br />';}
2816 }
2817 }
2818
2819 /**
2820 * Displays the "path" of the function call stack in a string, using debug_backtrace
2821 *
2822 * @return string
2823 */
2824 function debug_trail() {
2825 if (function_exists('debug_backtrace')) {
2826 $trail = debug_backtrace();
2827 $trail = array_reverse($trail);
2828 array_pop($trail);
2829
2830 $path = array();
2831 foreach($trail as $dat) {
2832 $path[] = $dat['class'].$dat['type'].$dat['function'];
2833 }
2834
2835 return implode(' // ',$path);
2836 } else return 'N/A';
2837 }
2838
2839 /**
2840 * Displays an array as rows in a table. Useful to debug output like an array of database records.
2841 *
2842 * @param array Array of arrays with similar keys
2843 * @param string Table header
2844 * @return void Outputs to browser.
2845 */
2846 function debugRows($rows,$header='') {
2847 if (is_array($rows)) {
2848 reset($rows);
2849 $firstEl = current($rows);
2850 if (is_array($firstEl)) {
2851 $headerColumns = array_keys($firstEl);
2852 $tRows = array();
2853
2854 // Header:
2855 $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>';
2856 $tCells = array();
2857 foreach($headerColumns as $key) {
2858 $tCells[] = '
2859 <td><font face="Verdana,Arial" size="1"><strong>'.htmlspecialchars($key).'</strong></font></td>';
2860 }
2861 $tRows[] = '
2862 <tr>'.implode('',$tCells).'
2863 </tr>';
2864
2865 // Rows:
2866 foreach($rows as $singleRow) {
2867 $tCells = array();
2868 foreach($headerColumns as $key) {
2869 $tCells[] = '
2870 <td><font face="Verdana,Arial" size="1">'.htmlspecialchars($singleRow[$key]).'</font></td>';
2871 }
2872 $tRows[] = '
2873 <tr>'.implode('',$tCells).'
2874 </tr>';
2875 }
2876
2877 $table = '
2878 <table border="1" cellpadding="1" cellspacing="0" bgcolor="white">'.implode('',$tRows).'
2879 </table>';
2880 echo $table;
2881 } else debug('Empty array of rows',$header);
2882 } else debug('No array of rows',$header);
2883 }
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912 /*************************
2913 *
2914 * SYSTEM INFORMATION
2915 *
2916 *************************/
2917
2918 /**
2919 * Returns the HOST+DIR-PATH of the current script (The URL, but without 'http://' and without script-filename)
2920 * Usage: 1
2921 *
2922 * @return string
2923 */
2924 function getThisUrl() {
2925 $p=parse_url(t3lib_div::getIndpEnv('TYPO3_REQUEST_SCRIPT')); // Url of this script
2926 $dir=t3lib_div::dirname($p['path']).'/'; // Strip file
2927 $url = str_replace('//','/',$p['host'].($p['port']?':'.$p['port']:'').$dir);
2928 return $url;
2929 }
2930
2931 /**
2932 * Returns the link-url to the current script.
2933 * 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.
2934 * REMEMBER to always use htmlspecialchars() for content in href-properties to get ampersands converted to entities (XHTML requirement and XSS precaution)
2935 * Usage: 52
2936 *
2937 * @param array Array of GET parameters to include
2938 * @return string
2939 */
2940 function linkThisScript($getParams=array()) {
2941 $parts = t3lib_div::getIndpEnv('SCRIPT_NAME');
2942 $params = t3lib_div::_GET();
2943
2944 foreach($getParams as $k => $v) {
2945 if (strcmp($v,'')) {
2946 $params[$k]=$v;
2947 } else unset($params[$k]);
2948 }
2949
2950 $pString = t3lib_div::implodeArrayForUrl('',$params);
2951
2952 return $pString ? $parts.'?'.ereg_replace('^&','',$pString) : $parts;
2953 }
2954
2955 /**
2956 * 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.
2957 * So basically it adds the parameters in $getParams to an existing URL, $url
2958 * Usage: 2
2959 *
2960 * @param string URL string
2961 * @param array Array of key/value pairs for get parameters to add/overrule with. Can be multidimensional.
2962 * @return string Output URL with added getParams.
2963 */
2964 function linkThisUrl($url,$getParams=array()) {
2965 $parts = parse_url($url);
2966 $getP = array();
2967 if ($parts['query']) {
2968 parse_str($parts['query'],$getP);
2969 }
2970 $getP = t3lib_div::array_merge_recursive_overrule($getP,$getParams);
2971 $uP = explode('?',$url);
2972
2973 $params = t3lib_div::implodeArrayForUrl('',$getP);
2974 $outurl = $uP[0].($params ? '?'.substr($params, 1) : '');
2975
2976 return $outurl;
2977 }
2978
2979 /**
2980 * Abstraction method which returns System Environment Variables regardless of server OS, CGI/MODULE version etc. Basically this is SERVER variables for most of them.
2981 * This should be used instead of getEnv() and $_SERVER/ENV_VARS to get reliable values for all situations.
2982 * Usage: 221
2983 *
2984 * @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
2985 * @return string Value based on the input key, independent of server/os environment.
2986 */
2987 function getIndpEnv($getEnvName) {
2988 /*
2989 Conventions:
2990 output from parse_url():
2991 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
2992 [scheme] => 'http'
2993 [user] => 'username'
2994 [pass] => 'password'
2995 [host] => '192.168.1.4'
2996 [port] => '8080'
2997 [path] => '/typo3/32/temp/phpcheck/index.php/arg1/arg2/arg3/'
2998 [query] => 'arg1,arg2,arg3&p1=parameter1&p2[key]=value'
2999 [fragment] => 'link1'
3000
3001 Further definition: [path_script] = '/typo3/32/temp/phpcheck/index.php'
3002 [path_dir] = '/typo3/32/temp/phpcheck/'
3003 [path_info] = '/arg1/arg2/arg3/'
3004 [path] = [path_script/path_dir][path_info]
3005
3006
3007 Keys supported:
3008
3009 URI______:
3010 REQUEST_URI = [path]?[query] = /typo3/32/temp/phpcheck/index.php/arg1/arg2/arg3/?arg1,arg2,arg3&p1=parameter1&p2[key]=value
3011 HTTP_HOST = [host][:[port]] = 192.168.1.4:8080
3012 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')!
3013 PATH_INFO = [path_info] = /arg1/arg2/arg3/
3014 QUERY_STRING = [query] = arg1,arg2,arg3&p1=parameter1&p2[key]=value
3015 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
3016 (Notice: NO username/password + NO fragment)
3017
3018 CLIENT____:
3019 REMOTE_ADDR = (client IP)
3020 REMOTE_HOST = (client host)
3021 HTTP_USER_AGENT = (client user agent)
3022 HTTP_ACCEPT_LANGUAGE = (client accept language)
3023
3024 SERVER____:
3025 SCRIPT_FILENAME = Absolute filename of script (Differs between windows/unix). On windows 'C:\\blabla\\blabl\\' will be converted to 'C:/blabla/blabl/'
3026
3027 Special extras:
3028 TYPO3_HOST_ONLY = [host] = 192.168.1.4
3029 TYPO3_PORT = [port] = 8080 (blank if 80, taken from host value)
3030 TYPO3_REQUEST_HOST = [scheme]://[host][:[port]]
3031 TYPO3_REQUEST_URL = [scheme]://[host][:[port]][path]?[query] (sheme will by default be 'http' until we can detect if it's https -
3032 TYPO3_REQUEST_SCRIPT = [scheme]://[host][:[port]][path_script]
3033 TYPO3_REQUEST_DIR = [scheme]://[host][:[port]][path_dir]
3034 TYPO3_SITE_URL = [scheme]://[host][:[port]][path_dir] of the TYPO3 website frontend
3035 TYPO3_SITE_SCRIPT = [script / Speaking URL] of the TYPO3 website
3036 TYPO3_DOCUMENT_ROOT = Absolute path of root of documents: TYPO3_DOCUMENT_ROOT.SCRIPT_NAME = SCRIPT_FILENAME (typically)
3037
3038 Notice: [fragment] is apparently NEVER available to the script!
3039
3040
3041 Testing suggestions:
3042 - Output all the values.
3043 - 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
3044 - ALSO TRY the script from the ROOT of a site (like 'http://www.mytest.com/' and not 'http://www.mytest.com/test/' !!)
3045
3046 */
3047
3048 # if ($getEnvName=='HTTP_REFERER') return '';
3049
3050 $retVal = '';
3051
3052 switch((string)$getEnvName) {
3053 case 'SCRIPT_NAME':
3054 $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']);
3055 break;
3056 case 'SCRIPT_FILENAME':
3057 $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'])));
3058 break;
3059 case 'REQUEST_URI':
3060 // Typical application of REQUEST_URI is return urls, forms submitting to itself etc. Example: returnUrl='.rawurlencode(t3lib_div::getIndpEnv('REQUEST_URI'))
3061 if (!$_SERVER['REQUEST_URI']) { // This is for ISS/CGI which does not have the REQUEST_URI available.
3062 $retVal = '/'.ereg_replace('^/','',t3lib_div::getIndpEnv('SCRIPT_NAME')).
3063 ($_SERVER['QUERY_STRING']?'?'.$_SERVER['QUERY_STRING']:'');
3064 } else $retVal = $_SERVER['REQUEST_URI'];
3065 break;
3066 case 'PATH_INFO':
3067 // $_SERVER['PATH_INFO']!=$_SERVER['SCRIPT_NAME'] is necessary because some servers (Windows/CGI) are seen to set PATH_INFO equal to script_name
3068 // Further, there must be at least one '/' in the path - else the PATH_INFO value does not make sense.
3069 // 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)
3070 // if (strcmp($_SERVER['PATH_INFO'],t3lib_div::getIndpEnv('SCRIPT_NAME')) && count(explode('/',$_SERVER['PATH_INFO']))>1) {
3071 if (php_sapi_name()!='cgi'&&php_sapi_name()!='cgi-fcgi') {
3072 $retVal = $_SERVER['PATH_INFO'];
3073 }
3074 break;
3075 // These are let through without modification
3076 case 'REMOTE_ADDR':
3077 case 'REMOTE_HOST':
3078 case 'HTTP_REFERER':
3079 case 'HTTP_HOST':
3080 case 'HTTP_USER_AGENT':
3081 case 'HTTP_ACCEPT_LANGUAGE':
3082 case 'QUERY_STRING':
3083 $retVal = $_SERVER[$getEnvName];
3084 break;
3085 case 'TYPO3_DOCUMENT_ROOT':
3086 // 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.
3087 // Therefore the DOCUMENT_ROOT is now always calculated as the SCRIPT_FILENAME minus the end part shared with SCRIPT_NAME.
3088 $SFN = t3lib_div::getIndpEnv('SCRIPT_FILENAME');
3089 $SN_A = explode('/',strrev(t3lib_div::getIndpEnv('SCRIPT_NAME')));
3090 $SFN_A = explode('/',strrev($SFN));
3091 $acc = array();
3092 while(list($kk,$vv)=each($SN_A)) {
3093 if (!strcmp($SFN_A[$kk],$vv)) {
3094 $acc[] = $vv;
3095 } else break;
3096 }
3097 $commonEnd=strrev(implode('/',$acc));
3098 if (strcmp($commonEnd,'')) { $DR = substr($SFN,0,-(strlen($commonEnd)+1)); }
3099 $retVal = $DR;
3100 break;
3101 case 'TYPO3_HOST_ONLY':
3102 $p = explode(':',$_SERVER['HTTP_HOST']);
3103 $retVal = $p[0];
3104 break;
3105 case 'TYPO3_PORT':
3106 $p = explode(':',$_SERVER['HTTP_HOST']);
3107 $retVal = $p[1];
3108 break;
3109 case 'TYPO3_REQUEST_HOST':
3110 $retVal = (t3lib_div::getIndpEnv('TYPO3_SSL') ? 'https://' : 'http://').
3111 $_SERVER['HTTP_HOST'];
3112 break;
3113 case 'TYPO3_REQUEST_URL':
3114 $retVal = t3lib_div::getIndpEnv('TYPO3_REQUEST_HOST').t3lib_div::getIndpEnv('REQUEST_URI');
3115 break;
3116 case 'TYPO3_REQUEST_SCRIPT':
3117 $retVal = t3lib_div::getIndpEnv('TYPO3_REQUEST_HOST').t3lib_div::getIndpEnv('SCRIPT_NAME');
3118 break;
3119 case 'TYPO3_REQUEST_DIR':
3120 $retVal = t3lib_div::getIndpEnv('TYPO3_REQUEST_HOST').t3lib_div::dirname(t3lib_div::getIndpEnv('SCRIPT_NAME')).'/';
3121 break;
3122 case 'TYPO3_SITE_URL':
3123 if (defined('PATH_thisScript') && defined('PATH_site')) {
3124 $lPath = substr(dirname(PATH_thisScript),strlen(PATH_site)).'/';
3125 $url = t3lib_div::getIndpEnv('TYPO3_REQUEST_DIR');
3126 $siteUrl = substr($url,0,-strlen($lPath));
3127 if (substr($siteUrl,-1)!='/') $siteUrl.='/';
3128 $retVal = $siteUrl;
3129 }
3130 break;
3131 case 'TYPO3_SITE_SCRIPT':
3132 $retVal = substr(t3lib_div::getIndpEnv('TYPO3_REQUEST_URL'),strlen(t3lib_div::getIndpEnv('TYPO3_SITE_URL')));
3133 break;
3134 case 'TYPO3_SSL':
3135 $retVal = $_SERVER['SSL_SESSION_ID'] || !strcmp($_SERVER['HTTPS'],'on') || !strcmp($_SERVER['HTTPS'],'1') ? TRUE : FALSE; // see http://bugs.typo3.org/view.php?id=3909
3136 break;
3137 case '_ARRAY':
3138 $out = array();
3139 // Here, list ALL possible keys to this function for debug display.
3140 $envTestVars = t3lib_div::trimExplode(',','
3141 HTTP_HOST,
3142 TYPO3_HOST_ONLY,
3143 TYPO3_PORT,
3144 PATH_INFO,
3145 QUERY_STRING,
3146 REQUEST_URI,
3147 HTTP_REFERER,
3148 TYPO3_REQUEST_HOST,
3149 TYPO3_REQUEST_URL,
3150 TYPO3_REQUEST_SCRIPT,
3151 TYPO3_REQUEST_DIR,
3152 TYPO3_SITE_URL,
3153 TYPO3_SITE_SCRIPT,
3154 TYPO3_SSL,
3155 SCRIPT_NAME,
3156 TYPO3_DOCUMENT_ROOT,
3157 SCRIPT_FILENAME,
3158 REMOTE_ADDR,
3159 REMOTE_HOST,
3160 HTTP_USER_AGENT,
3161 HTTP_ACCEPT_LANGUAGE',1);
3162 reset($envTestVars);
3163 while(list(,$v)=each($envTestVars)) {
3164 $out[$v]=t3lib_div::getIndpEnv($v);
3165 }
3166 reset($out);
3167 $retVal = $out;
3168 break;
3169 }
3170 return $retVal;
3171 }
3172
3173 /**
3174 * milliseconds
3175 * microtime recalculated to t3lib_div::milliseconds(1/1000 sec)
3176 * Usage: 20
3177 *
3178 * @return integer
3179 */
3180 function milliseconds() {
3181 $p=explode(' ',microtime());
3182 return round(($p[0]+$p[1])*1000);
3183 }
3184
3185 /**
3186 * Client Browser Information
3187 * Usage: 4
3188 *
3189 * @param string Alternative User Agent string (if empty, t3lib_div::getIndpEnv('HTTP_USER_AGENT') is used)
3190 * @return array Parsed information about the HTTP_USER_AGENT in categories BROWSER, VERSION, SYSTEM and FORMSTYLE
3191 */
3192 function clientInfo($useragent='') {
3193 if (!$useragent) $useragent=t3lib_div::getIndpEnv('HTTP_USER_AGENT');
3194
3195 $bInfo=array();
3196 // Which browser?
3197 if (strstr($useragent,'Konqueror')) {
3198 $bInfo['BROWSER']= 'konqu';
3199 } elseif (strstr($useragent,'Opera')) {
3200 $bInfo['BROWSER']= 'opera';
3201 } elseif (strstr($useragent,'MSIE 4') || strstr($useragent,'MSIE 5') || strstr($useragent,'MSIE 6')) {
3202 $bInfo['BROWSER']= 'msie';
3203 } elseif (strstr($useragent,'Mozilla/4') || strstr($useragent,'Mozilla/5')) {
3204 $bInfo['BROWSER']='net';
3205 }
3206 if ($bInfo['BROWSER']) {
3207 // Browser version
3208 switch($bInfo['BROWSER']) {
3209 case 'net':
3210 $bInfo['VERSION']= doubleval(substr($useragent,8));
3211 if (strstr($useragent,'Netscape6/')) {$bInfo['VERSION']=doubleval(substr(strstr($useragent,'Netscape6/'),10));}
3212 if (strstr($useragent,'Netscape/7')) {$bInfo['VERSION']=doubleval(substr(strstr($useragent,'Netscape/7'),9));}
3213 break;
3214 case 'msie':
3215 $tmp = strstr($useragent,'MSIE');
3216 $bInfo['VERSION'] = doubleval(ereg_replace('^[^0-9]*','',substr($tmp,4)));
3217 break;
3218 case 'opera':
3219 $tmp = strstr($useragent,'Opera');
3220 $bInfo['VERSION'] = doubleval(ereg_replace('^[^0-9]*','',substr($tmp,5)));
3221 break;
3222 case 'konqu':
3223 $tmp = strstr($useragent,'Konqueror/');
3224 $bInfo['VERSION'] = doubleval(substr($tmp,10));
3225 break;
3226 }
3227 // Client system
3228 if (strstr($useragent,'Win')) {
3229 $bInfo['SYSTEM'] = 'win';
3230 } elseif (strstr($useragent,'Mac')) {
3231 $bInfo['SYSTEM'] = 'mac';
3232 } elseif (strstr($useragent,'Linux') || strstr($useragent,'X11') || strstr($useragent,'SGI') || strstr($useragent,' SunOS ') || strstr($useragent,' HP-UX ')) {
3233 $bInfo['SYSTEM'] = 'unix';
3234 }
3235 }
3236 // Is true if the browser supports css to format forms, especially the width
3237 $bInfo['FORMSTYLE']=($bInfo['BROWSER']=='msie' || ($bInfo['BROWSER']=='net'&&$bInfo['VERSION']>=5) || $bInfo['BROWSER']=='opera' || $bInfo['BROWSER']=='konqu');
3238