Added $Id$ keywords, cleaned up comment tags
[Packages/TYPO3.CMS.git] / t3lib / class.t3lib_div.php
1 <?php
2 /***************************************************************
3 * Copyright notice
4 *
5 * (c) 1999-2003 Kasper Skaarhoj (kasper@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 <kasper@typo3.com>
36 */
37 /**
38 * [CLASS/FUNCTION INDEX of SCRIPT]
39 *
40 *
41 *
42 * 194: class t3lib_div
43 *
44 * SECTION: BASIC FUNCTIONS
45 * 216: function milliseconds()
46 * 230: function setGPvars($list,$strip=0)
47 * 248: function GPvar($var,$strip=0)
48 * 264: function GParrayMerged($var)
49 * 280: function clientInfo($useragent='')
50 *
51 * SECTION: IMAGE FUNCTIONS
52 * 367: function gif_compress($theFile, $type)
53 * 395: function png_to_gif_by_imagemagick($theFile)
54 * 419: function read_png_gif($theFile,$output_png=0)
55 *
56 * SECTION: STRING FUNCTIONS
57 * 468: function fixed_lgd($string,$chars,$preStr='...')
58 * 490: function fixed_lgd_pre($string,$chars)
59 * 504: function breakTextForEmail($str,$implChar="\n",$charWidth=76)
60 * 524: function breakLinesForEmail($str,$implChar="\n",$charWidth=76)
61 * 560: function cmpIP($baseIP, $list)
62 * 591: function inList($in_list,$item)
63 * 604: function rmFromList($element,$list)
64 * 623: function intInRange($theInt,$min,$max=2000000000,$zeroValue=0)
65 * 640: function intval_positive($theInt)
66 * 654: function int_from_ver($verNumberStr)
67 * 667: function md5int($str)
68 * 679: function uniqueList($in_list)
69 * 692: function split_fileref($fileref)
70 * 729: function dirname($path)
71 * 746: function modifyHTMLColor($color,$R,$G,$B)
72 * 767: function modifyHTMLColorAll($color,$all)
73 * 779: function rm_endcomma($string)
74 * 792: function danish_strtoupper($string)
75 * 806: function convUmlauts($str)
76 * 821: function shortMD5($input, $len=10)
77 * 833: function testInt($var)
78 * 846: function isFirstPartOfStr($str,$partStr)
79 * 862: function formatSize($sizeInBytes)
80 * 884: function convertMicrotime($microtime)
81 * 898: function splitCalc($string,$operators)
82 * 920: function calcPriority($string)
83 * 960: function calcParenthesis($string)
84 * 987: function htmlspecialchars_decode($value)
85 * 1001: function deHSCentities($str)
86 * 1014: function slashJS($string,$extended=0,$char="'")
87 * 1028: function rawUrlEncodeJS($str)
88 * 1040: function validEmail($email)
89 * 1055: function formatForTextarea($content)
90 *
91 * SECTION: ARRAY FUNCTIONS
92 * 1087: function inArray($in_array,$item)
93 * 1105: function intExplode($delim, $string)
94 * 1125: function revExplode($delim, $string, $count=0)
95 * 1146: function trimExplode($delim, $string, $onlyNonEmptyValues=0)
96 * 1171: function uniqueArray($valueArray)
97 * 1194: function removeArrayEntryByValue($array,$cmpValue)
98 * 1223: function implodeArrayForUrl($name,$theArray,$str='',$skipBlank=0,$rawurlencodeParamName=0)
99 * 1251: function compileSelectedGetVarsFromArray($varList,$getArray,$GPvarAlt=1)
100 * 1275: function addSlashesOnArray(&$theArray)
101 * 1300: function stripSlashesOnArray(&$theArray)
102 * 1323: function slashArray($arr,$cmd)
103 * 1340: function array_merge_recursive_overrule ($arr0,$arr1,$notAddKeys=0)
104 * 1370: function array_merge($arr1,$arr2)
105 * 1384: function csvValues($row,$delim=',',$quote='"')
106 *
107 * SECTION: HTML/XML PROCESSING
108 * 1427: function get_tag_attributes($tag)
109 * 1465: function split_tag_attributes($tag)
110 * 1499: function implodeParams($arr,$xhtmlSafe=0)
111 * 1527: function wrapJS($string, $linebreak=TRUE)
112 * 1556: function xml2tree($string,$depth=999)
113 * 1639: function array2xml($array,$NSprefix='',$level=0,$docTag='phparray',$spaceInd=0)
114 * 1697: function xml2array($string,$NSprefix='')
115 * 1756: function xmlRecompileFromStructValArray($vals)
116 * 1799: function xmlGetHeaderAttribs($xmlData)
117 *
118 * SECTION: FILES FUNCTIONS
119 * 1831: function getURL($url)
120 * 1874: function writeFile($file,$content)
121 * 1892: function get_dirs($path)
122 * 1918: function getFilesInDir($path,$extensionList='',$prependPath=0,$order='')
123 * 1963: function getAllFilesAndFoldersInPath($fileArr,$path,$extList='',$regDirs=0,$recursivityLevels=99)
124 * 1985: function removePrefixPathFromList($fileArr,$prefixToRemove)
125 * 2004: function upload_copy_move($source,$destination)
126 * 2022: function fixWindowsFilePath($theFile)
127 * 2032: function resolveBackPath($pathStr)
128 * 2060: function locationHeaderUrl($path)
129 *
130 * SECTION: DEBUG helper FUNCTIONS
131 * 2100: function debug_ordvalue($string,$characters=100)
132 * 2117: function view_array($array_in)
133 * 2144: function print_array($array_in)
134 * 2160: function debug($var="",$brOrHeader=0)
135 *
136 * SECTION: SYSTEM INFORMATION
137 * 2229: function getThisUrl()
138 * 2246: function linkThisScript($getParams=array())
139 * 2268: function linkThisUrl($url,$getParams=array())
140 * 2288: function getIndpEnv($getEnvName)
141 *
142 * SECTION: TYPO3 SPECIFIC FUNCTIONS
143 * 2502: function getFileAbsFileName($filename,$onlyRelative=1,$relToTYPO3_mainDir=0)
144 * 2537: function validPathStr($theFile)
145 * 2549: function isAbsPath($path)
146 * 2561: function isAllowedAbsPath($path)
147 * 2579: function verifyFilenameAgainstDenyPattern($filename)
148 * 2596: function stdAuthCode($uid_or_record,$fields='')
149 * 2630: function loadTCA($table)
150 * 2649: function resolveSheetDefInDS($dataStructArray,$sheet='sDEF')
151 * 2677: function resolveAllSheetsInDS($dataStructArray)
152 * 2706: function callUserFunction($funcName,&$params,&$ref,$checkPrefix='user_',$silent=0)
153 * 2746: function makeInstance($className)
154 * 2764: function makeInstanceService($serviceType, $serviceSubType='', $excludeServiceKeys='')
155 * 2799: function makeInstanceClassName($className)
156 * 2819: function plainMailEncoded($email,$subject,$message,$headers='',$enc='',$charset='ISO-8859-1',$dontEncodeSubject=0)
157 * 2866: function quoted_printable($string,$maxlen=76)
158 * 2908: function substUrlsInPlainText($message,$urlmode='76',$index_script_url='')
159 * 2943: function makeRedirectUrl($inUrl,$l=0,$index_script_url='')
160 * 2966: function freetypeDpiComp($font_size)
161 *
162 * TOTAL FUNCTIONS: 100
163 * (This index is automatically created/updated by the extension "extdeveval")
164 *
165 */
166
167
168
169
170
171
172
173
174
175
176
177
178 /**
179 * The legendary "t3lib_div" class - Miscellaneous functions for general purpose.
180 * Most of the functions does not relate specifically to TYPO3
181 * However a section of functions requires certain TYPO3 features available
182 * See comments in the source.
183 * You are encouraged to use this library in your own scripts!
184 *
185 * USE:
186 * The class is intended to be used without creating an instance of it.
187 * So: Don't instantiate - call functions with "t3lib_div::" prefixed the function name.
188 * So use t3lib_div::[method-name] to refer to the functions, eg. 't3lib_div::milliseconds()'
189 *
190 * @author Kasper Skaarhoj <kasper@typo3.com>
191 * @package TYPO3
192 * @subpackage t3lib
193 */
194 class t3lib_div {
195
196
197
198
199
200 /*************************
201 *
202 * BASIC FUNCTIONS
203 *
204 *************************/
205
206
207 /**
208 * milliseconds
209 *
210 * microtime recalculated to t3lib_div::milliseconds(1/1000 sec)
211 *
212 * Usage: 39
213 *
214 * @return integer
215 */
216 function milliseconds() {
217 $p=explode(' ',microtime());
218 return round(($p[0]+$p[1])*1000);
219 }
220
221 /**
222 * Sets global variables from HTTP_POST_VARS or HTTP_GET_VARS
223 *
224 * Usage: 9
225 *
226 * @param string List of GET/POST var keys to set globally
227 * @param boolean If set, values are passed through stripslashes()
228 * @return void
229 */
230 function setGPvars($list,$strip=0) {
231 $vars = t3lib_div::trimExplode(',',$list,1);
232 while(list(,$var)=each($vars)) {
233 $GLOBALS[$var] = t3lib_div::GPvar($var,$strip);
234 }
235 }
236
237 /**
238 * GET/POST variable
239 * Returns the 'GLOBAL' value of incoming data from POST or GET, with priority to POST (that is equalent to 'GP' order)
240 * Strips slashes of string-outputs, but not arrays UNLESS $strip is set. If $strip is set all output will have escaped characters unescaped.
241 *
242 * Usage: 686
243 *
244 * @param string GET/POST var to return
245 * @param boolean If set, values are stripped of return values that are *arrays!* - string/integer values returned are always strip-slashed()
246 * @return mixed POST var named $var and if not set, the GET var of the same name.
247 */
248 function GPvar($var,$strip=0) {
249 $value = isset($GLOBALS['HTTP_POST_VARS'][$var]) ? $GLOBALS['HTTP_POST_VARS'][$var] : $GLOBALS['HTTP_GET_VARS'][$var];
250 if (isset($value) && is_string($value)) {$value=stripslashes($value);} // Originally check '&& get_magic_quotes_gpc() ' but the values of HTTP_GET_VARS 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.
251 if ($strip && isset($value) && is_array($value)) {t3lib_div::stripSlashesOnArray($value);}
252 return $value;
253 }
254
255 /**
256 * Returns the GET/POST global arrays merged with POST taking precedence.
257 *
258 * Usage: 1
259 *
260 * @param string Key (variable name) from GET or POST vars
261 * @return array Returns the GET vars merged recursively onto the POST vars.
262 * @ignore
263 */
264 function GParrayMerged($var) {
265 $postA = is_array($GLOBALS['HTTP_POST_VARS'][$var]) ? $GLOBALS['HTTP_POST_VARS'][$var] : array();
266 $getA = is_array($GLOBALS['HTTP_GET_VARS'][$var]) ? $GLOBALS['HTTP_GET_VARS'][$var] : array();
267 $mergedA = t3lib_div::array_merge_recursive_overrule($getA,$postA);
268 t3lib_div::stripSlashesOnArray($mergedA);
269 return $mergedA;
270 }
271
272 /**
273 * Client Browser Information
274 *
275 * Usage: 4
276 *
277 * @param string Alternative User Agent string (if empty, t3lib_div::getIndpEnv('HTTP_USER_AGENT') is used)
278 * @return array Parsed information about the HTTP_USER_AGENT in categories BROWSER, VERSION, SYSTEM and FORMSTYLE
279 */
280 function clientInfo($useragent='') {
281 if (!$useragent) $useragent=t3lib_div::getIndpEnv('HTTP_USER_AGENT');
282
283 $bInfo=array();
284 // Which browser?
285 if (strstr($useragent,'Konqueror')) {
286 $bInfo['BROWSER']= 'konqu';
287 } elseif (strstr($useragent,'Opera')) {
288 $bInfo['BROWSER']= 'opera';
289 } elseif (strstr($useragent,'MSIE 4') || strstr($useragent,'MSIE 5') || strstr($useragent,'MSIE 6')) {
290 $bInfo['BROWSER']= 'msie';
291 } elseif (strstr($useragent,'Mozilla/4') || strstr($useragent,'Mozilla/5')) {
292 $bInfo['BROWSER']='net';
293 }
294 if ($bInfo['BROWSER']) {
295 // Browser version
296 switch($bInfo['BROWSER']) {
297 case 'net':
298 $bInfo['VERSION']= doubleval(substr($useragent,8));
299 if (strstr($useragent,'Netscape6/')) {$bInfo['VERSION']=doubleval(substr(strstr($useragent,'Netscape6/'),10));}
300 if (strstr($useragent,'Netscape/7')) {$bInfo['VERSION']=doubleval(substr(strstr($useragent,'Netscape/7'),9));}
301 break;
302 case 'msie':
303 $tmp = strstr($useragent,'MSIE');
304 $bInfo['VERSION'] = doubleval(substr($tmp,4));
305 break;
306 case 'opera':
307 $tmp = strstr($useragent,'Opera');
308 $bInfo['VERSION'] = doubleval(substr($tmp,5));
309 break;
310 case 'konqu':
311 $tmp = strstr($useragent,'Konqueror/');
312 $bInfo['VERSION'] = doubleval(substr($tmp,10));
313 break;
314 }
315 // Client system
316 if (strstr($useragent,'Win')) {
317 $bInfo['SYSTEM'] = 'win';
318 } elseif (strstr($useragent,'Mac')) {
319 $bInfo['SYSTEM'] = 'mac';
320 } elseif (strstr($useragent,'Linux') || strstr($useragent,'X11') || strstr($useragent,'SGI') || strstr($useragent,' SunOS ') || strstr($useragent,' HP-UX ')) {
321 $bInfo['SYSTEM'] = 'unix';
322 }
323 }
324 // Is true if the browser supports css to format forms, especially the width
325 $bInfo['FORMSTYLE']=($bInfo['BROWSER']=='msie' || ($bInfo['BROWSER']=='net'&&$bInfo['VERSION']>=5) || $bInfo['BROWSER']=='opera' || $bInfo['BROWSER']=='konqu');
326
327 return $bInfo;
328 }
329
330
331
332
333
334
335
336
337
338
339 /*************************
340 *
341 * IMAGE FUNCTIONS
342 *
343 *************************/
344
345
346 /**
347 * Compressing a GIF file if not already LZW compressed
348 * 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)
349 *
350 * The function takes a file-reference, $theFile, and saves it again through GD or ImageMagick in order to compress the file
351 * GIF:
352 * 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!)
353 * If $type is set to either 'IM' or 'GD' the compression is done with ImageMagick and GD respectively
354 * PNG:
355 * No changes.
356 *
357 * $theFile is expected to be a valid GIF-file!
358 * The function returns a code for the operation.
359 *
360 * Usage: 11
361 *
362 * @param string Filepath
363 * @param string See description of function
364 * @return string Returns "GD" if GD was used, otherwise "IM" if ImageMagick was used. If nothing done at all, it returns empty string.
365 * @internal
366 */
367 function gif_compress($theFile, $type) {
368 $gfxConf = $GLOBALS['TYPO3_CONF_VARS']['GFX'];
369 $returnCode='';
370 if ($gfxConf['gif_compress'] && strtolower(substr($theFile,-4,4))=='.gif') { // GIF...
371 if (($type=='IM' || !$type) && $GLOBALS['TYPO3_CONF_VARS']['GFX']['im'] && $GLOBALS['TYPO3_CONF_VARS']['GFX']['im_path_lzw']) { // IM
372 exec($GLOBALS['TYPO3_CONF_VARS']['GFX']['im_path_lzw'].'convert "'.$theFile.'" "'.$theFile.'"');
373 $returnCode='IM';
374 } elseif (($type=='GD' || !$type) && $gfxConf['gdlib'] && !$gfxConf['gdlib_png']) { // GD
375 $tempImage = imageCreateFromGif($theFile);
376 imageGif($tempImage, $theFile);
377 imageDestroy($tempImage);
378 $returnCode='GD';
379 }
380 }
381 return $returnCode;
382 }
383
384 /**
385 * Converts a png file to gif
386 *
387 * This converts a png file to gif IF the FLAG $GLOBALS['TYPO3_CONF_VARS']['FE']['png_to_gif'] is set true.
388 *
389 * Usage: 5
390 *
391 * @param string $theFile the filename with path
392 * @return string new filename
393 * @internal
394 */
395 function png_to_gif_by_imagemagick($theFile) {
396 if ($GLOBALS['TYPO3_CONF_VARS']['FE']['png_to_gif']
397 && $GLOBALS['TYPO3_CONF_VARS']['GFX']['im']
398 && $GLOBALS['TYPO3_CONF_VARS']['GFX']['im_path_lzw']
399 && strtolower(substr($theFile,-4,4))=='.png'
400 && @is_file($theFile)) { // IM
401 $newFile = substr($theFile,0,-4).'.gif';
402 exec($GLOBALS['TYPO3_CONF_VARS']['GFX']['im_path_lzw'].'convert "'.$theFile.'" "'.$newFile.'"');
403 $theFile = $newFile;
404 // 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!!
405 }
406 return $theFile;
407 }
408
409 /**
410 * Returns filename of the png/gif version of the input file (which can be png or gif).
411 * If input file type does not match the wanted output type a conversion is made and temp-filename returned.
412 * Usage: 1
413 *
414 * @param string Filepath of image file
415 * @param boolean If set, then input file is converted to PNG, otherwise to GIF
416 * @return string If the new image file exists, it's filepath is returned
417 * @internal
418 */
419 function read_png_gif($theFile,$output_png=0) {
420 if ($GLOBALS['TYPO3_CONF_VARS']['GFX']['im'] && @is_file($theFile)) {
421 $ext = strtolower(substr($theFile,-4,4));
422 if (
423 ((string)$ext=='.png' && $output_png) ||
424 ((string)$ext=='.gif' && !$output_png)
425 ) {
426 return $theFile;
427 } else {
428 $newFile = PATH_site.'typo3temp/readPG_'.md5($theFile.'|'.filemtime($theFile)).($output_png?'.png':'.gif');
429 exec($GLOBALS['TYPO3_CONF_VARS']['GFX']['im_path'].'convert "'.$theFile.'" "'.$newFile.'"');
430 if (@is_file($newFile)) return $newFile;
431 }
432 }
433 }
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449 /*************************
450 *
451 * STRING FUNCTIONS
452 *
453 *************************/
454
455 /**
456 * Truncate string
457 * Returns a new string of max. $chars length.
458 * If the string is longer, it will be truncated and appended with '...'.
459 *
460 * Usage: 119
461 *
462 * @param string $string string to truncate
463 * @param integer $chars must be an integer of at least 4
464 * @param string String to append to the the output if it is truncated, default is '...'
465 * @return string new string
466 * @see fixed_lgd_pre()
467 */
468 function fixed_lgd($string,$chars,$preStr='...') {
469 if ($chars >= 4) {
470 if(strlen($string)>$chars) {
471 return trim(substr($string, 0, $chars-3)).$preStr;
472 }
473 }
474 return $string;
475 }
476
477 /**
478 * Truncate string
479 * Returns a new string of max. $chars length.
480 * If the string is longer, it will be truncated and prepended with '...'.
481 * This works like fixed_lgd, but is truncated in the start of the string instead of the end
482 *
483 * Usage: 19
484 *
485 * @param string $string string to truncate
486 * @param integer $chars must be an integer of at least 4
487 * @return string new string
488 * @see fixed_lgd()
489 */
490 function fixed_lgd_pre($string,$chars) {
491 return strrev(t3lib_div::fixed_lgd(strrev($string),$chars));
492 }
493
494 /**
495 * Breaks up the text for emails
496 *
497 * Usage: 1
498 *
499 * @param string The string to break up
500 * @param string The string to implode the broken lines with (default/typically \n)
501 * @param integer The line length
502 * @return string
503 */
504 function breakTextForEmail($str,$implChar="\n",$charWidth=76) {
505 $lines = explode(chr(10),$str);
506 $outArr=array();
507 while(list(,$lStr)=each($lines)) {
508 $outArr = array_merge($outArr,t3lib_div::breakLinesForEmail($lStr,$implChar,$charWidth));
509 }
510 return implode(chr(10),$outArr);
511 }
512
513 /**
514 * Breaks up a single line of text for emails
515 *
516 * Usage: 3
517 *
518 * @param string The string to break up
519 * @param string The string to implode the broken lines with (default/typically \n)
520 * @param integer The line length
521 * @return string
522 * @see breakTextForEmail()
523 */
524 function breakLinesForEmail($str,$implChar="\n",$charWidth=76) {
525 $lines=array();
526 $l=$charWidth;
527 $p=0;
528 while(strlen($str)>$p) {
529 $substr=substr($str,$p,$l);
530 if (strlen($substr)==$l) {
531 $count = count(explode(' ',trim(strrev($substr))));
532 if ($count>1) { // OK...
533 $parts = explode(' ',strrev($substr),2);
534 $theLine = strrev($parts[1]);
535 } else {
536 $afterParts = explode(' ',substr($str,$l+$p),2);
537 $theLine = $substr.$afterParts[0];
538 }
539 if (!strlen($theLine)) {break; } // Error, because this would keep us in an endless loop.
540 } else {
541 $theLine=$substr;
542 }
543
544 $lines[]=trim($theLine);
545 $p+=strlen($theLine);
546 if (!trim(substr($str,$p,$l))) break; // added...
547 }
548 return implode($implChar,$lines);
549 }
550
551 /**
552 * Match IP number with list of numbers with wildcard
553 *
554 * Usage: 8
555 *
556 * @param string $baseIP is the current remote IP address for instance, typ. REMOTE_ADDR
557 * @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)
558 * @return boolean True if an IP-mask from $list matches $baseIP
559 */
560 function cmpIP($baseIP, $list) {
561 $IPpartsReq = explode('.',$baseIP);
562 if (count($IPpartsReq)==4) {
563 $values = t3lib_div::trimExplode(',',$list,1);
564 reset($values);
565 while(list(,$test)=each($values)) {
566 $IPparts = explode('.',$test);
567 $yes = 1;
568 reset($IPparts);
569 while(list($index,$val)=each($IPparts)) {
570 $val = trim($val);
571 if (strcmp($val,'*') && strcmp($IPpartsReq[$index],$val)) {
572 $yes=0;
573 }
574 }
575 if ($yes) return true;
576 }
577 }
578 }
579
580 /**
581 * Check for item in list
582 *
583 * Check if an item exists in a comma-separated list of items.
584 *
585 * Usage: 166
586 *
587 * @param string $in_list comma-separated list of items (string)
588 * @param string $item item to check for
589 * @return bool true if $item is in $in_list
590 */
591 function inList($in_list,$item) {
592 return strstr(','.$in_list.',', ','.$item.',');
593 }
594
595 /**
596 * Removes an item from a comma-separated list of items.
597 *
598 * Usage: 1
599 *
600 * @param string $element element to remove
601 * @param string $list comma-separated list of items (string)
602 * @return string new comma-separated list of items
603 */
604 function rmFromList($element,$list) {
605 $items = explode(',',$list);
606 while(list($k,$v)=each($items)) {
607 if ($v==$element) {unset($items[$k]);}
608 }
609 return implode($items,',');
610 }
611
612 /**
613 * Forces the integer $theInt into the boundaries of $min and $max. If the $theInt is 'false' then the $zeroValue is applied.
614 *
615 * Usage: 226
616 *
617 * @param integer Input value
618 * @param integer Lower limit
619 * @param integer Higher limit
620 * @param integer Default value if input is false.
621 * @return integer The input value forced into the boundaries of $min and $max
622 */
623 function intInRange($theInt,$min,$max=2000000000,$zeroValue=0) {
624 // Returns $theInt as an integer in the integerspace from $min to $max
625 $theInt = intval($theInt);
626 if ($zeroValue && !$theInt) {$theInt=$zeroValue;} // If the input value is zero after being converted to integer, zeroValue may set another default value for it.
627 if ($theInt<$min){$theInt=$min;}
628 if ($theInt>$max){$theInt=$max;}
629 return $theInt;
630 }
631
632 /**
633 * Returns the $integer if greater than zero, otherwise returns zero.
634 *
635 * Usage: 1
636 *
637 * @param integer
638 * @return integer
639 */
640 function intval_positive($theInt) {
641 $theInt = intval($theInt);
642 if ($theInt<0){$theInt=0;}
643 return $theInt;
644 }
645
646 /**
647 * Returns an integer from a three part version number, eg '4.12.3' -> 4012003
648 *
649 * Usage: 2
650 *
651 * @param string Version number on format x.x.x
652 * @return integer Integer version of version number (where each part can count to 999)
653 */
654 function int_from_ver($verNumberStr) {
655 $verParts = explode('.',$verNumberStr);
656 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));
657 }
658
659 /**
660 * Makes a positive integer hash out of the first 7 chars from the md5 hash of the input
661 *
662 * Usage: 0
663 *
664 * @param string String to md5-hash
665 * @return integer Returns 28bit integer-hash
666 */
667 function md5int($str) {
668 return hexdec(substr(md5($str),0,7));
669 }
670
671 /**
672 * Takes a comma-separated list and removes all duplicates
673 *
674 * Usage: 16
675 *
676 * @param string $in_list is a comma-separated list of values.
677 * @return string Returns the list without any duplicates of values, space around values are trimmed
678 */
679 function uniqueList($in_list) {
680 $theTempArray = explode(',',$in_list);
681 return implode(t3lib_div::uniqueArray($theTempArray),',');
682 }
683
684 /**
685 * Splits a reference to a file in 5 parts
686 *
687 * Usage: 43
688 *
689 * @param string Filename/filepath to be analysed
690 * @return array Contains keys [path], [file], [filebody], [fileext], [realFileext]
691 */
692 function split_fileref($fileref) {
693 if ( ereg('(.*/)(.*)$',$fileref,$reg) ) {
694 $info['path'] = $reg[1];
695 $info['file'] = $reg[2];
696 } else {
697 $info['path'] = '';
698 $info['file'] = $fileref;
699 }
700 $reg='';
701 if ( ereg('(.*)\.([^\.]*$)',$info['file'],$reg) ) {
702 $info['filebody'] = $reg[1];
703 $info['fileext'] = strtolower($reg[2]);
704 $info['realFileext'] = $reg[2];
705 } else {
706 $info['filebody'] = $info['file'];
707 $info['fileext'] = '';
708 }
709 reset($info);
710 return $info;
711 }
712
713 /**
714 * Returns the directory part of a path without trailing slash
715 * If there is no dir-part, then an empty string is returned.
716 * Behaviour:
717 *
718 * '/dir1/dir2/script.php' => '/dir1/dir2'
719 * '/dir1/' => '/dir1'
720 * 'dir1/script.php' => 'dir1'
721 * 'd/script.php' => 'd'
722 * '/script.php' => ''
723 * '' => ''
724 * Usage: 5
725 *
726 * @param string Directory name / path
727 * @return string Processed input value. See function description.
728 */
729 function dirname($path) {
730 $p=t3lib_div::revExplode('/',$path,2);
731 return count($p)==2?$p[0]:'';
732 }
733
734 /**
735 * Modifies a HTML Hex color by adding/subtracting $R,$G and $B integers
736 *
737 * Usage: 37
738 *
739 * @param string A hexadecimal color code, #xxxxxx
740 * @param integer Offset value 0-255
741 * @param integer Offset value 0-255
742 * @param integer Offset value 0-255
743 * @return string A hexadecimal color code, #xxxxxx, modified according to input vars
744 * @see modifyHTMLColorAll()
745 */
746 function modifyHTMLColor($color,$R,$G,$B) {
747 // This takes a hex-color (# included!) and adds $R, $G and $B to the HTML-color (format: #xxxxxx) and returns the new color
748 $nR = t3lib_div::intInRange(hexdec(substr($color,1,2))+$R,0,255);
749 $nG = t3lib_div::intInRange(hexdec(substr($color,3,2))+$G,0,255);
750 $nB = t3lib_div::intInRange(hexdec(substr($color,5,2))+$B,0,255);
751 return '#'.
752 substr('0'.dechex($nR),-2).
753 substr('0'.dechex($nG),-2).
754 substr('0'.dechex($nB),-2);
755 }
756
757 /**
758 * Modifies a HTML Hex color by adding/subtracting $all integer from all R/G/B channels
759 *
760 * Usage: 4
761 *
762 * @param string A hexadecimal color code, #xxxxxx
763 * @param integer Offset value 0-255 for all three channels.
764 * @return string A hexadecimal color code, #xxxxxx, modified according to input vars
765 * @see modifyHTMLColor()
766 */
767 function modifyHTMLColorAll($color,$all) {
768 return t3lib_div::modifyHTMLColor($color,$all,$all,$all);
769 }
770
771 /**
772 * Removes comma (if present) in the end of string
773 *
774 * Usage: 4
775 *
776 * @param string
777 * @return string
778 */
779 function rm_endcomma($string) {
780 return ereg_replace(',$','',$string);
781 }
782
783 /**
784 * strtoupper which converts danish (and other characters) characters as well
785 * (Depreciated, use PHP function with locale settings instead)
786 * Usage: 4
787 *
788 * @param string
789 * @return string
790 * @ignore
791 */
792 function danish_strtoupper($string) {
793 $value = strtoupper($string);
794 return strtr($value, 'áéúíâêûôîæøåäöü', 'ÁÉÚÍÄËÜÖÏÆØÅÄÖÜ');
795 }
796
797 /**
798 * change umlaut characters to plain ASCII with normally two character target
799 * Only known characters will be converted, so don't expect a result for any character.
800 *
801 * ä => ae, Ö => Oe
802 *
803 * @param string
804 * @return string
805 */
806 function convUmlauts($str) {
807 $pat = array ( '/ä/', '/Ä/', '/ö/', '/Ö/', '/ü/', '/Ü/', '/ß/', '/å/', '/Å/', '/ø/', '/Ø/', '/æ/', '/Æ/' );
808 $repl = array ( 'ae', 'Ae', 'oe', 'Oe', 'ue', 'Ue', 'ss', 'aa', 'AA', 'oe', 'OE', 'ae', 'AE' );
809 return preg_replace($pat,$repl,$str);
810 }
811
812 /**
813 * Returns the first 10 positions of the MD5-hash (changed from 6 to 10 recently)
814 *
815 * Usage: 43
816 *
817 * @param string Input string to be md5-hashed
818 * @param integer The string-length of the output
819 * @return string Substring of the resulting md5-hash, being $len chars long (from beginning)
820 */
821 function shortMD5($input, $len=10) {
822 return substr(md5($input),0,$len);
823 }
824
825 /**
826 * Tests if the input is an integer.
827 *
828 * Usage: 74
829 *
830 * @param mixed Any input variable to test.
831 * @return boolean Returns true if string is an integer
832 */
833 function testInt($var) {
834 return !strcmp($var,intval($var));
835 }
836
837 /**
838 * Returns true if the first part of $str matches the string $partStr
839 *
840 * Usage: 58
841 *
842 * @param string Full string to check
843 * @param string Reference string which must be found as the "first part" of the full string
844 * @return boolean True if $partStr was found to be equal to the first part of $str
845 */
846 function isFirstPartOfStr($str,$partStr) {
847 // Returns true, if the first part of a $str equals $partStr and $partStr is not ''
848 $psLen = strlen($partStr);
849 if ($psLen) {
850 return substr($str,0,$psLen)==(string)$partStr;
851 } else return false;
852 }
853
854 /**
855 * Formats the input integer $sizeInBytes as bytes/kilobytes/megabytes (-/K/M)
856 *
857 * Usage: 54
858 *
859 * @param integer Bytes
860 * @return string Formatted representation of the byte number, for output.
861 */
862 function formatSize($sizeInBytes) {
863 if ($sizeInBytes>900) {
864 if ($sizeInBytes>900000) { // MB
865 $val = $sizeInBytes/(1024*1024);
866 return number_format($val, (($val<20)?1:0), '.', '').' M';
867 } else { // KB
868 $val = $sizeInBytes/(1024);
869 return number_format($val, (($val<20)?1:0), '.', '').' K';
870 }
871 } else { // Bytes
872 return $sizeInBytes.'&nbsp;&nbsp;';
873 }
874 }
875
876 /**
877 * Returns microtime input to milliseconds
878 *
879 * Usage: 2
880 *
881 * @param string Microtime
882 * @return integer Microtime input string converted to an integer (milliseconds)
883 */
884 function convertMicrotime($microtime) {
885 $parts = explode(' ',$microtime);
886 return round(($parts[0]+$parts[1])*1000);
887 }
888
889 /**
890 * This splits a string by the chars in $operators (typical /+-*) and returns an array with them in
891 * Usage: 2
892 *
893 * @param string Input string, eg "123 + 456 / 789 - 4"
894 * @param string Operators to split by, typically "/+-*"
895 * @return array Array with operators and operands separated.
896 * @see tslib_cObj::calc(), tslib_gifBuilder::calcOffset()
897 */
898 function splitCalc($string,$operators) {
899 $res = Array();
900 $sign='+';
901 while($string) {
902 $valueLen=strcspn($string,$operators);
903 $value=substr($string,0,$valueLen);
904 $res[] = Array($sign,trim($value));
905 $sign=substr($string,$valueLen,1);
906 $string=substr($string,$valueLen+1);
907 }
908 reset($res);
909 return $res;
910 }
911
912 /**
913 * Calculates the input by +,-,*,/,%,^ with priority to + and -
914 * Usage: 1
915 *
916 * @param string Input string, eg "123 + 456 / 789 - 4"
917 * @return integer Calculated value. Or error string.
918 * @see calcParenthesis()
919 */
920 function calcPriority($string) {
921 $string=ereg_replace('[[:space:]]*','',$string); // removing all whitespace
922 $string='+'.$string; // Ensuring an operator for the first entrance
923 $qm='\*\/\+-^%';
924 $regex = '(['.$qm.'])(['.$qm.']?[0-9\.]*)';
925 // split the expression here:
926 preg_match_all('/'.$regex.'/',$string,$reg);
927
928 reset($reg[2]);
929 $number=0;
930 $Msign='+';
931 $err='';
932 $buffer=doubleval(current($reg[2]));
933 next($reg[2]); // Advance pointer
934 while(list($k,$v)=each($reg[2])) {
935 $v=doubleval($v);
936 $sign = $reg[1][$k];
937 if ($sign=='+' || $sign=='-') {
938 $number = $Msign=='-' ? $number-=$buffer : $number+=$buffer;
939 $Msign = $sign;
940 $buffer=$v;
941 } else {
942 if ($sign=='/') {if ($v) $buffer/=$v; else $err='dividing by zero';}
943 if ($sign=='%') {if ($v) $buffer%=$v; else $err='dividing by zero';}
944 if ($sign=='*') {$buffer*=$v;}
945 if ($sign=='^') {$buffer=pow($buffer,$v);}
946 }
947 }
948 $number = $Msign=='-' ? $number-=$buffer : $number+=$buffer;
949 return $err ? 'ERROR: '.$err : $number;
950 }
951
952 /**
953 * Calculates the input with parenthesis levels
954 * Usage: 2
955 *
956 * @param string Input string, eg "(123 + 456) / 789 - 4"
957 * @return integer Calculated value. Or error string.
958 * @see calcPriority(), tslib_cObj::stdWrap()
959 */
960 function calcParenthesis($string) {
961 $securC=100;
962 do {
963 $valueLenO=strcspn($string,'(');
964 $valueLenC=strcspn($string,')');
965 if ($valueLenC==strlen($string) || $valueLenC < $valueLenO) {
966 $value = t3lib_div::calcPriority(substr($string,0,$valueLenC));
967 $string = $value.substr($string,$valueLenC+1);
968 return $string;
969 } else {
970 $string = substr($string,0,$valueLenO).t3lib_div::calcParenthesis(substr($string,$valueLenO+1));
971 }
972 // Security:
973 $securC--;
974 if ($securC<=0) break;
975 } while($valueLenO<strlen($string));
976 return $string;
977 }
978
979 /**
980 * Inverse version of htmlspecialchars()
981 *
982 * Usage: 2
983 *
984 * @param string Value where &gt;, &lt;, &quot; and &amp; should be converted to regular chars.
985 * @return string Converted result.
986 */
987 function htmlspecialchars_decode($value) {
988 $value = str_replace('&gt;','>',$value);
989 $value = str_replace('&lt;','<',$value);
990 $value = str_replace('&quot;','"',$value);
991 $value = str_replace('&amp;','&',$value);
992 return $value;
993 }
994
995 /**
996 * Re-converts HTML entities if they have been converted by htmlspecialchars()
997 *
998 * @param string String which contains eg. "&amp;amp;" which should stay "&amp;". Or "&amp;#1234;" to "&#1234;". Or "&amp;#x1b;" to "&#x1b;"
999 * @return string Converted result.
1000 */
1001 function deHSCentities($str) {
1002 return ereg_replace('&amp;([#[:alnum:]]*;)','&\1',$str);
1003 }
1004
1005 /**
1006 * This function is used to escape any ' -characters when transferring text to JavaScript!
1007 * Usage: 6
1008 *
1009 * @param string String to escape
1010 * @param boolean If set, also backslashes are escaped.
1011 * @param string The character to escape, default is ' (single-quote)
1012 * @return string Processed input string
1013 */
1014 function slashJS($string,$extended=0,$char="'") {
1015 if ($extended) {$string = str_replace ("\\", "\\\\", $string);}
1016 return str_replace ($char, "\\".$char, $string);
1017 }
1018
1019 /**
1020 * Version of rawurlencode() where all spaces (%20) are re-converted to space-characters.
1021 * Usefull when passing text to JavaScript where you simply url-encode it to get around problems with syntax-errors, linebreaks etc.
1022 *
1023 * Usage: 8
1024 *
1025 * @param string
1026 * @return string Rawurlencoded result of input string, but with all %20 (space chars) converted to real spaces.
1027 */
1028 function rawUrlEncodeJS($str) {
1029 return str_replace('%20',' ',rawurlencode($str));
1030 }
1031
1032 /**
1033 * Checking syntax of input email address
1034 *
1035 * Usage: 4
1036 *
1037 * @param string Input string to evaluate
1038 * @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.
1039 */
1040 function validEmail($email) {
1041 if (strstr($email,' ')) return 0;
1042 return ereg('^[A-Za-z0-9\._-]*[@][A-Za-z0-9\._-]*[\.].[A-Za-z0-9]*$',$email) ? 1 : 0;
1043 }
1044
1045 /**
1046 * Formats a string for output between <textarea>-tags
1047 * All content outputted in a textarea form should be passed through this function
1048 * 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!
1049 *
1050 * Usage: 30
1051 *
1052 * @param string Input string to be formatted.
1053 * @return string Formatted for <textarea>-tags
1054 */
1055 function formatForTextarea($content) {
1056 return chr(10).htmlspecialchars($content);
1057 }
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070 /*************************
1071 *
1072 * ARRAY FUNCTIONS
1073 *
1074 *************************/
1075
1076 /**
1077 * Check if an item exists in an array
1078 * Please note that the order of parameters is reverse compared to the php4-function in_array()!!!
1079 *
1080 * Usage: 3
1081 *
1082 * @param array $in_array one-dimensional array of items
1083 * @param string $item item to check for
1084 * @return boolean true if $item is in the one-dimensional array $in_array
1085 * @internal
1086 */
1087 function inArray($in_array,$item) {
1088 if (is_array($in_array)) {
1089 while (list(,$val)=each($in_array)) {
1090 if (!is_array($val) && !strcmp($val,$item)) return true;
1091 }
1092 }
1093 }
1094
1095 /**
1096 * Explodes a $string delimited by $delim and passes each item in the array through intval().
1097 * Corresponds to explode(), but with conversion to integers for all values.
1098 *
1099 * Usage: 86
1100 *
1101 * @param string Delimiter string to explode with
1102 * @param string The string to explode
1103 * @return array Exploded values, all converted to integers
1104 */
1105 function intExplode($delim, $string) {
1106 $temp = explode($delim,$string);
1107 while(list($key,$val)=each($temp)) {
1108 $temp[$key]=intval($val);
1109 }
1110 reset($temp);
1111 return $temp;
1112 }
1113
1114 /**
1115 * Reverse explode which explodes the string counting from behind.
1116 * Thus t3lib_div::revExplode(':','my:words:here',2) will return array('my:words','here')
1117 *
1118 * Usage: 6
1119 *
1120 * @param string Delimiter string to explode with
1121 * @param string The string to explode
1122 * @param integer Number of array entries
1123 * @return array Exploded values
1124 */
1125 function revExplode($delim, $string, $count=0) {
1126 $temp = explode($delim,strrev($string),$count);
1127 while(list($key,$val)=each($temp)) {
1128 $temp[$key]=strrev($val);
1129 }
1130 $temp=array_reverse($temp);
1131 reset($temp);
1132 return $temp;
1133 }
1134
1135 /**
1136 * Explodes a string and trims all values for whitespace in the ends.
1137 * If $onlyNonEmptyValues is set, then all blank ('') values are removed.
1138 *
1139 * Usage: 239
1140 *
1141 * @param string Delimiter string to explode with
1142 * @param string The string to explode
1143 * @param boolean If set, all empty values (='') will NOT be set in output
1144 * @return array Exploded values
1145 */
1146 function trimExplode($delim, $string, $onlyNonEmptyValues=0) {
1147 $temp = explode($delim,$string);
1148 $newtemp=array();
1149 while(list($key,$val)=each($temp)) {
1150 if (!$onlyNonEmptyValues || strcmp('',trim($val))) {
1151 $newtemp[]=trim($val);
1152 }
1153 }
1154 reset($newtemp);
1155 return $newtemp;
1156 }
1157
1158 /**
1159 * Takes a one-dimensional array and returns an array where the values are unique
1160 * The keys in the array are substituted with some md5-hashes
1161 * If the value is trim(empty), the value is ignored.
1162 * Values are trimmed
1163 * (Depreciated, use PHP function array_unique instead)
1164 * Usage: 2
1165 *
1166 * @param array
1167 * @return array
1168 * @ignore
1169 * @depreciated
1170 */
1171 function uniqueArray($valueArray) {
1172 $array_out=array();
1173 if (is_array($valueArray)) {
1174 while (list($key,$val)=each($valueArray)) {
1175 $val=trim($val);
1176 if ((string)$val!='') {
1177 $array_out[md5($val)]=$val;
1178 }
1179 }
1180 }
1181 reset($array_out);
1182 return $array_out;
1183 }
1184
1185 /**
1186 * Removes the value $cmpValue from the $array if found there. Returns the modified array
1187 *
1188 * Usage: 2
1189 *
1190 * @param array
1191 * @param string Value to search for and if found remove array entry where found.
1192 * @return array Output array with entries removed if search string is found
1193 */
1194 function removeArrayEntryByValue($array,$cmpValue) {
1195 if (is_array($array)) {
1196 reset($array);
1197 while(list($k,$v)=each($array)) {
1198 if (is_array($v)) {
1199 $array[$k] = t3lib_div::removeArrayEntryByValue($v,$cmpValue);
1200 } else {
1201 if (!strcmp($v,$cmpValue)) {
1202 unset($array[$k]);
1203 }
1204 }
1205 }
1206 }
1207 reset($array);
1208 return $array;
1209 }
1210
1211 /**
1212 * Implodes a multidim-array into GET-parameters (eg. &param[key][key2]=value2&param[key][key3]=value3)
1213 *
1214 * Usage: 24
1215 *
1216 * @param string Name prefix for entries. Set to blank if you wish none.
1217 * @param array The (multidim) array to implode
1218 * @param boolean If set, all values that are blank (='') will NOT be imploded
1219 * @param boolean If set, parameters which were blank strings would be removed.
1220 * @param boolean If set, the param name itselt (for example "param[key][key2]") would be rawurlencoded as well.
1221 * @return string Imploded result, fx. &param[key][key2]=value2&param[key][key3]=value3
1222 */
1223 function implodeArrayForUrl($name,$theArray,$str='',$skipBlank=0,$rawurlencodeParamName=0) {
1224 if (is_array($theArray)) {
1225 reset($theArray);
1226 while(list($Akey,$AVal)=each($theArray)) {
1227 $thisKeyName = $name ? $name.'['.$Akey.']' : $Akey;
1228 if (is_array($AVal)) {
1229 $str=t3lib_div::implodeArrayForUrl($thisKeyName,$AVal,$str,$skipBlank,$rawurlencodeParamName);
1230 } else {
1231 if (!$skipBlank || strcmp($AVal,'')) {
1232 $str.='&'.($rawurlencodeParamName ? rawurlencode($thisKeyName) : $thisKeyName).
1233 '='.rawurlencode(stripslashes($AVal)); // strips slashes because HTTP_POST_VARS / GET_VARS input is with slashes...
1234 }
1235 }
1236 }
1237 }
1238 return $str;
1239 }
1240
1241 /**
1242 * Returns an array with selected keys from incoming data.
1243 * (Better read source code if you want to find out...)
1244 * Usage: 3
1245 *
1246 * @param string List of variable/key names
1247 * @param array Array from where to get values based on the keys in $varList
1248 * @param boolean If set, then t3lib_div::GPvar() is used to fetch the value if not found (isset) in the $getArray
1249 * @return array Output array with selected variables.
1250 */
1251 function compileSelectedGetVarsFromArray($varList,$getArray,$GPvarAlt=1) {
1252 $keys = t3lib_div::trimExplode(',',$varList,1);
1253 $outArr=array();
1254 while(list(,$v)=each($keys)) {
1255 if (isset($getArray[$v])) {
1256 $outArr[$v]=$getArray[$v];
1257 } elseif ($GPvarAlt) {
1258 $outArr[$v]=t3lib_div::GPvar($v);
1259 }
1260 }
1261 return $outArr;
1262 }
1263
1264 /**
1265 * AddSlash array
1266 * This function traverses a multidimentional array and adds slashes to the values.
1267 * NOTE that the input array is and argument by reference.!!
1268 * Twin-function to stripSlashesOnArray
1269 *
1270 * Usage: 6
1271 *
1272 * @param array Multidimensional input array, (REFERENCE!)
1273 * @return array
1274 */
1275 function addSlashesOnArray(&$theArray) {
1276 if (is_array($theArray)) {
1277 reset($theArray);
1278 while(list($Akey,$AVal)=each($theArray)) {
1279 if (is_array($AVal)) {
1280 t3lib_div::addSlashesOnArray($theArray[$Akey]);
1281 } else {
1282 $theArray[$Akey] = addslashes($AVal);
1283 }
1284 }
1285 reset($theArray);
1286 }
1287 }
1288
1289 /**
1290 * StripSlash array
1291 * This function traverses a multidimentional array and strips slashes to the values.
1292 * NOTE that the input array is and argument by reference.!!
1293 * Twin-function to addSlashesOnArray
1294 *
1295 * Usage: 7
1296 *
1297 * @param array Multidimensional input array, (REFERENCE!)
1298 * @return array
1299 */
1300 function stripSlashesOnArray(&$theArray) {
1301 if (is_array($theArray)) {
1302 reset($theArray);
1303 while(list($Akey,$AVal)=each($theArray)) {
1304 if (is_array($AVal)) {
1305 t3lib_div::stripSlashesOnArray($theArray[$Akey]);
1306 } else {
1307 $theArray[$Akey] = stripslashes($AVal);
1308 }
1309 }
1310 reset($theArray);
1311 }
1312 }
1313
1314 /**
1315 * Either slashes ($cmd=add) or strips ($cmd=strip) array $arr depending on $cmd
1316 *
1317 * Usage: 6
1318 *
1319 * @param array Multidimensional input array
1320 * @param string "add" or "strip", depending on usage you wish.
1321 * @return array
1322 */
1323 function slashArray($arr,$cmd) {
1324 if ($cmd=='strip') t3lib_div::stripSlashesOnArray($arr);
1325 if ($cmd=='add') t3lib_div::addSlashesOnArray($arr);
1326 return $arr;
1327 }
1328
1329 /**
1330 * Merges two arrays recursively, overruling similar the values in the first array ($arr0) with the values of the second array ($arr1)
1331 * In case of identical keys, ie. keeping the values of the second.
1332 *
1333 * Usage: 26
1334 *
1335 * @param array First array
1336 * @param array Second array, overruling the first array
1337 * @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.
1338 * @return array Resulting array where $arr1 values has overruled $arr0 values
1339 */
1340 function array_merge_recursive_overrule ($arr0,$arr1,$notAddKeys=0) {
1341 reset($arr1);
1342 while(list($key,$val) = each($arr1)) {
1343 if(is_array($arr0[$key])) {
1344 if (is_array($arr1[$key])) {
1345 $arr0[$key] = t3lib_div::array_merge_recursive_overrule($arr0[$key],$arr1[$key],$notAddKeys);
1346 }
1347 } else {
1348 if ($notAddKeys) {
1349 if (isset($arr0[$key])) {
1350 $arr0[$key] = $val;
1351 }
1352 } else {
1353 $arr0[$key] = $val;
1354 }
1355 }
1356 }
1357 reset($arr0);
1358 return $arr0;
1359 }
1360
1361 /**
1362 * An array_merge function where the keys are NOT renumbered as they happen to be with the real php-array_merge function
1363 *
1364 * Usage: 27
1365 *
1366 * @param array First array
1367 * @param array Second array
1368 * @return array Merged result.
1369 */
1370 function array_merge($arr1,$arr2) {
1371 return $arr2+$arr1;
1372 }
1373
1374 /**
1375 * Takes a row and returns a CSV string of the values with $delim (default is ,) and $quote (default is ") as separator chars.
1376 *
1377 * Usage: 5
1378 *
1379 * @param array Input array of values
1380 * @param string Delimited, default is comman
1381 * @param string Quote-character to wrap around the values.
1382 * @return string A single line of CSV
1383 */
1384 function csvValues($row,$delim=',',$quote='"') {
1385 reset($row);
1386 $out=array();
1387 while(list(,$value)=each($row)) {
1388 list($valPart) = explode(chr(10),$value);
1389 $valPart = trim($valPart);
1390 $out[]=str_replace($quote,$quote.$quote,$valPart);
1391 }
1392 $str = $quote.implode($quote.$delim.$quote,$out).$quote;
1393 return $str;
1394 }
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411 /*************************
1412 *
1413 * HTML/XML PROCESSING
1414 *
1415 *************************/
1416
1417 /**
1418 * $tag is either a whole tag (eg '<TAG OPTION ATTRIB=VALUE>') or the parameterlist (ex ' OPTION ATTRIB=VALUE>')
1419 * Returns an array with all attributes as keys. Attributes are only lowercase a-z
1420 * 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()
1421 *
1422 * Usage: 9
1423 *
1424 * @param string HTML-tag string (or attributes only)
1425 * @return array Array with the attribute values.
1426 */
1427 function get_tag_attributes($tag) {
1428 $components = t3lib_div::split_tag_attributes($tag);
1429 $name = ''; // attribute name is stored here
1430 $valuemode = '';
1431 if (is_array($components)) {
1432 while (list($key,$val) = each ($components)) {
1433 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
1434 if ($valuemode) {
1435 if ($name) {
1436 $attributes[$name] = $val;
1437 $name = '';
1438 }
1439 } else {
1440 if ($key = strtolower(ereg_replace('[^a-zA-Z0-9]','',$val))) {
1441 $attributes[$key] = '';
1442 $name = $key;
1443 }
1444 }
1445 $valuemode = '';
1446 } else {
1447 $valuemode = 'on';
1448 }
1449 }
1450 if (is_array($attributes)) reset($attributes);
1451 return $attributes;
1452 }
1453 }
1454
1455 /**
1456 * Returns an array with the 'components' from an attribute list from an HTML tag. The result is normally analyzed by get_tag_attributes
1457 * Removes tag-name if found
1458 *
1459 * Usage: 1
1460 *
1461 * @param string HTML-tag string (or attributes only)
1462 * @return array Array with the attribute values.
1463 * @internal
1464 */
1465 function split_tag_attributes($tag) {
1466 $tag_tmp = trim(eregi_replace ('^[ ]*<[^ ]*','',$tag));
1467 // Removes any > in the end of the string
1468 $tag_tmp = trim(eregi_replace ('>$','',$tag_tmp));
1469
1470 while (strcmp($tag_tmp,'')) { // Compared with empty string instead , 030102
1471 $firstChar=substr($tag_tmp,0,1);
1472 if (!strcmp($firstChar,'"') || !strcmp($firstChar,"'")) {
1473 $reg=explode($firstChar,$tag_tmp,3);
1474 $value[]=$reg[1];
1475 $tag_tmp=trim($reg[2]);
1476 } elseif (!strcmp($firstChar,'=')) {
1477 $value[] = '=';
1478 $tag_tmp = trim(substr($tag_tmp,1)); // Removes = chars.
1479 } else {
1480 // There are '' around the value. We look for the next ' ' or '>'
1481 $reg = split('[[:space:]=]',$tag_tmp,2);
1482 $value[] = trim($reg[0]);
1483 $tag_tmp = trim(substr($tag_tmp,strlen($reg[0]),1).$reg[1]);
1484 }
1485 }
1486 if (is_array($value)) reset($value);
1487 return $value;
1488 }
1489
1490 /**
1491 * Implodes attributes in the array $arr for an attribute list in eg. and HTML tag (with quotes)
1492 *
1493 * Usage: 10
1494 *
1495 * @param array Array with attribute key/value pairs, eg. "bgcolor"=>"red", "border"=>0
1496 * @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!
1497 * @return string Imploded attributes, eg. 'bgcolor="red" border="0"'
1498 */
1499 function implodeParams($arr,$xhtmlSafe=0) {
1500 if (is_array($arr)) {
1501 if ($xhtmlSafe) {
1502 $newArr=array();
1503 foreach($arr as $p => $v) {
1504 if (!isset($newArr[strtolower($p)])) $newArr[strtolower($p)] = htmlspecialchars($v);
1505 }
1506 $arr = $newArr;
1507 }
1508 $list = array();
1509 foreach($arr as $p => $v) {
1510 if (strcmp($v,'')) {$list[]=$p.'="'.$v.'"';}
1511 }
1512 return implode(' ',$list);
1513 }
1514 }
1515
1516 /**
1517 * Wraps JavaScript code XHTML ready with <script>-tags
1518 * Automatic re-identing of the JS code is done by using the first line as ident reference.
1519 * This is nice for identing JS code with PHP code on the same level.
1520 *
1521 * @param string JavaScript code
1522 * @param boolean Wrap script element in linebreaks? Default is TRUE.
1523 * @return string The wrapped JS code, ready to put into a XHTML page
1524 * @author Ingmar Schlecht <ingmars@web.de>
1525 * @author René Fritz <r.fritz@colorcube.de>
1526 */
1527 function wrapJS($string, $linebreak=TRUE) {
1528 if(trim($string)) {
1529 // <script wrapped in nl?
1530 $cr = $linebreak? "\n" : '';
1531
1532 // remove nl from the beginning
1533 $string = preg_replace ('/^\n+/', '', $string);
1534 // re-ident to one tab using the first line as reference
1535 if(preg_match('/^(\t+)/',$string,$match)) {
1536 $string = str_replace($match[1],"\t", $string);
1537 }
1538 $string = $cr.'<script type="text/javascript">
1539 /*<![CDATA[*/
1540 '.$string.'
1541 /*]]>*/
1542 </script>'.$cr;
1543 }
1544 return trim($string);
1545 }
1546
1547
1548 /**
1549 * Parses XML input into a PHP array with associative keys
1550 *
1551 * @param string XML data input
1552 * @param integer Number of element levels to resolve the XML into an array. Any further structure will be set as XML.
1553 * @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.
1554 * @author bisqwit at iki dot fi dot not dot for dot ads dot invalid / http://dk.php.net/xml_parse_into_struct + kasper@typo3.com
1555 */
1556 function xml2tree($string,$depth=999) {
1557 $parser = xml_parser_create();
1558 $vals = array();
1559 $index = array();
1560
1561 xml_parser_set_option($parser, XML_OPTION_CASE_FOLDING, 0);
1562 xml_parser_set_option($parser, XML_OPTION_SKIP_WHITE, 0);
1563 xml_parse_into_struct($parser, $string, $vals, $index);
1564
1565 if (xml_get_error_code($parser)) return 'Line '.xml_get_current_line_number($parser).': '.xml_error_string(xml_get_error_code($parser));
1566 xml_parser_free($parser);
1567
1568 $stack = array( array() );
1569 $stacktop = 0;
1570 $startPoint=0;
1571
1572 unset($tagi);
1573 foreach($vals as $key => $val) {
1574 $type = $val['type'];
1575
1576 // open tag:
1577 if ($type=='open' || $type=='complete') {
1578 $stack[$stacktop++] = $tagi;
1579
1580 if ($depth==$stacktop) {
1581 $startPoint=$key;
1582 }
1583
1584 $tagi = array('tag' => $val['tag']);
1585
1586 if(isset($val['attributes'])) $tagi['attrs'] = $val['attributes'];
1587 if(isset($val['value'])) $tagi['values'][] = $val['value'];
1588 }
1589 // finish tag:
1590 if ($type=='complete' || $type=='close') {
1591 $oldtagi = $tagi;
1592 $tagi = $stack[--$stacktop];
1593 $oldtag = $oldtagi['tag'];
1594 unset($oldtagi['tag']);
1595
1596 if ($depth==($stacktop+1)) {
1597 if ($key-$startPoint > 0) {
1598 $partArray = array_slice(
1599 $vals,
1600 $startPoint+1,
1601 $key-$startPoint-1
1602 );
1603 #$oldtagi=array('XMLvalue'=>t3lib_div::xmlRecompileFromStructValArray($partArray));
1604 $oldtagi['XMLvalue']=t3lib_div::xmlRecompileFromStructValArray($partArray);
1605 } else {
1606 $oldtagi['XMLvalue']=$oldtagi['values'][0];
1607 }
1608 }
1609
1610 $tagi['ch'][$oldtag][] = $oldtagi;
1611 unset($oldtagi);
1612 }
1613 // cdata
1614 if($type=='cdata') {
1615 $tagi['values'][] = $val['value'];
1616 }
1617 }
1618 return $tagi['ch'];
1619 }
1620
1621 /**
1622 * Converts a PHP array into an XML file.
1623 * The XML output is optimized for readability since associative keys are used as fieldnames.
1624 * This also means that only alphanumeric characters are allowed in the tag names
1625 * Numeric keys are converted to "n"+int (which means you should not use this kind of associative key otherwise)
1626 * 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
1627 * The PHP variable type of the data is NOT preserved; integers will become strings, but arrays will stay arrays of course.
1628 * The output XML has been tested with the PHP XML-parser and parses OK under all tested circumstances.
1629 * 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...
1630 *
1631 * @param array The input PHP array with any kind of data; text, binary, integers. Not objects though.
1632 * @param string tag-prefix, eg. a namespace prefix like "T3:"
1633 * @param integer Current recursion level. Don't change, stay at zero!
1634 * @param string Alternative document tag. Default is "phparray".
1635 * @param integer If set, the number of spaces corresponding to this number is used for indenting, otherwise a single chr(9) (TAB) is used
1636 * @return string An XML string made from the input content in the array.
1637 * @see xml2array()
1638 */
1639 function array2xml($array,$NSprefix='',$level=0,$docTag='phparray',$spaceInd=0) {
1640 // 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
1641 $binaryChars = chr(0).chr(1).chr(2).chr(3).chr(4).chr(5).chr(6).chr(7).chr(8).
1642 chr(11).chr(12).chr(14).chr(15).chr(16).chr(17).chr(18).chr(19).
1643 chr(20).chr(21).chr(22).chr(23).chr(24).chr(25).chr(26).chr(27).chr(28).chr(29).
1644 chr(30).chr(31);
1645 $indentChar = $spaceInd ? ' ' : chr(9);
1646 $indentN = $spaceInd>0 ? $spaceInd : 1;
1647
1648 // Init output variable
1649 $output='';
1650 // Traverse the input array
1651 foreach($array as $k=>$v) {
1652 $attr='';
1653 // If the value is an array then we will call this function recursively:
1654 if (is_array($v)) {
1655 // Sub elements:
1656 $content = chr(10).t3lib_div::array2xml($v,$NSprefix,$level+1,'',$spaceInd).
1657 str_pad('',($level+1)*$indentN,$indentChar);
1658 } else { // Just a value:
1659 // Look for binary chars:
1660 if (strspn($v,$binaryChars)) {
1661 // If the value contained binary chars then we base64-encode it an set an attribute to notify this situation:
1662 $content = chr(10).chunk_split(base64_encode($v));
1663 $attr=' base64="1"';
1664 } else {
1665 // Otherwise, just htmlspecialchar the stuff:
1666 $content = htmlspecialchars($v);
1667 }
1668 }
1669 // Construct the tag name. If numeric key, prefix "n". Further the tag name is cleaned up so only alphanumeric chars (plus - and _) are in there and not longer than 100 chars either.
1670 if (!strcmp(intval($k),$k)) $k='n'.$k;
1671 $kn = substr(ereg_replace('[^[:alnum:]_-]','',$k),0,100);
1672
1673 // Add the element to the output string:
1674 $output.=str_pad('',($level+1)*$indentN,$indentChar).'<'.$NSprefix.$kn.$attr.'>'.$content.'</'.$NSprefix.$kn.'>'.chr(10);
1675 }
1676
1677 // If we are at the outer-most level, then we finally wrap it all in the document tags and return that as the value:
1678 if (!$level) {
1679 $output =
1680 '<'.$docTag.'>'.chr(10).
1681 $output.
1682 '</'.$docTag.'>';
1683 }
1684
1685 return $output;
1686 }
1687
1688 /**
1689 * Converts an XML file to a PHP array.
1690 * This is the inverse function of array2xml()
1691 *
1692 * @param string XML content to convert into an array
1693 * @param string The tag-prefix resolve, eg. a namespace like "T3:"
1694 * @return mixed If the parsing had errors, a string with the error message is returned. Otherwise an array with the content.
1695 * @see array2xml()
1696 */
1697 function xml2array($string,$NSprefix='') {
1698 // Create parser:
1699 $parser = xml_parser_create();
1700 $vals = array();
1701 $index = array();
1702
1703 xml_parser_set_option($parser, XML_OPTION_CASE_FOLDING, 0);
1704 xml_parser_set_option($parser, XML_OPTION_SKIP_WHITE, 0);
1705 xml_parse_into_struct($parser, $string, $vals, $index);
1706
1707 // If error, return error message:
1708 if (xml_get_error_code($parser)) return 'Line '.xml_get_current_line_number($parser).': '.xml_error_string(xml_get_error_code($parser));
1709 xml_parser_free($parser);
1710
1711 // Init vars:
1712 $stack = array(array());
1713 $stacktop = 0;
1714 $current=array();
1715 $tagName='';
1716
1717 // Traverse the parsed XML structure:
1718 foreach($vals as $key => $val) {
1719
1720 if ($val['type']=='open') { // If open tag it means there is an array stored in sub-elements. Therefore increase the stackpointer and reset the accumulation array:
1721 $stack[$stacktop++] = $current;
1722 $current=array();
1723
1724 } elseif ($val['type']=='complete' || $val['type']=='close') { // If the tag is "complete" then it's a value and we just have to get it. If the tag is "close" then it is an array which is closing and we decrese the stack pointer.
1725 // First, process the tag-name (which is used in both cases, whether "complete" or "close")
1726 $tagName = $val['tag'];
1727 // Test for name space:
1728 $tagName = ($NSprefix && substr($tagName,0,strlen($NSprefix))==$NSprefix) ? substr($tagName,strlen($NSprefix)) : $tagName;
1729 // Test for numeric tag:
1730 $testNtag = substr($tagName,1); // Closing tag.
1731 $tagName = (substr($tagName,0,1)=='n' && !strcmp(intval($testNtag),$testNtag)) ? intval($testNtag) : $tagName;
1732
1733
1734 if ($val['type']=='complete') { // If "complete", then its a value. If the attribute "base64" is set, then decode the value, otherwise just set it.
1735 if ($val['attributes']['base64']) {
1736 $current[$tagName] = base64_decode($val['value']);
1737 } else $current[$tagName] = $val['value'];
1738 } else { // Implicit "close": Manage the stack...
1739 $oldCurrent = $current;
1740 $current = $stack[--$stacktop];
1741 $current[$tagName]=$oldCurrent;
1742 unset($oldCurrent);
1743 }
1744 }
1745 }
1746 // Finally return the content of the document tag.
1747 return $current[$tagName];
1748 }
1749
1750 /**
1751 * This implodes an array of XML parts (made with xml_parse_into_struct()) into XML again.
1752 *
1753 * @param array A array of XML parts, see xml2tree
1754 * @return string Re-compiled XML data.
1755 */
1756 function xmlRecompileFromStructValArray($vals) {
1757 $XMLcontent='';
1758
1759 foreach($vals as $val) {
1760 $type = $val['type'];
1761
1762 // open tag:
1763 if ($type=='open' || $type=='complete') {
1764 $XMLcontent.='<'.$val['tag'];
1765 if(isset($val['attributes'])) {
1766 foreach($val['attributes'] as $k => $v) {
1767 $XMLcontent.=' '.$k.'="'.htmlspecialchars($v).'"';
1768 }
1769 }
1770 if ($type=='complete') {
1771 if(isset($val['value'])) {
1772 $XMLcontent.='>'.htmlspecialchars($val['value']).'</'.$val['tag'].'>';
1773 } else $XMLcontent.='/>';
1774 } else $XMLcontent.='>';
1775
1776 if ($type=='open' && isset($val['value'])) {
1777 $XMLcontent.=htmlspecialchars($val['value']);
1778 }
1779 }
1780 // finish tag:
1781 if ($type=='close') {
1782 $XMLcontent.='</'.$val['tag'].'>';
1783 }
1784 // cdata
1785 if($type=='cdata') {
1786 $XMLcontent.=htmlspecialchars($val['value']);
1787 }
1788 }
1789
1790 return $XMLcontent;
1791 }
1792
1793 /**
1794 * Extract the encoding scheme as found in the first line of an XML document (typically)
1795 *
1796 * @param string XML data
1797 * @return string Encoding scheme (lowercase), if found.
1798 */
1799 function xmlGetHeaderAttribs($xmlData) {
1800 $xmlHeader = substr(trim($xmlData),0,200);
1801 $reg=array();
1802 if (eregi('^<\?xml([^>]*)\?\>',$xmlHeader,$reg)) {
1803 return t3lib_div::get_tag_attributes($reg[1]);
1804 }
1805 }
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817 /*************************
1818 *
1819 * FILES FUNCTIONS
1820 *
1821 *************************/
1822
1823 /**
1824 * Reads the file or url $url and returns the content
1825 *
1826 * Usage: 79
1827 *
1828 * @param string Filepath/URL to read
1829 * @return string The content from the resource given as input.
1830 */
1831 function getURL($url) {
1832 $content = '';
1833
1834 // (Proxy support implemented by Arco <arco@appeltaart.mine.nu>)
1835 if((substr($url,0,7)=='http://') && ($GLOBALS['TYPO3_CONF_VARS']['SYS']['curlUse']=='1')) {
1836 //external URL without error checking.
1837 $ch = curl_init();
1838 curl_setopt ($ch,CURLOPT_URL, $url);
1839 curl_setopt ($ch,CURLOPT_HEADER, 0);
1840 curl_setopt ($ch,CURLOPT_RETURNTRANSFER, 1);
1841
1842 if ($GLOBALS['TYPO3_CONF_VARS']['SYS']['curlProxyServer']) {
1843 curl_setopt ($ch, CURLOPT_PROXY, $GLOBALS['TYPO3_CONF_VARS']['SYS']['curlProxyServer']);
1844
1845 // I don't know if it will be needed
1846 if ($GLOBALS['TYPO3_CONF_VARS']['SYS']['curlProxyTunnel']) {
1847 curl_setopt ($ch, CURLOPT_HTTPPROXYTUNNEL, $GLOBALS['TYPO3_CONF_VARS']['SYS']['curlProxyTunnel'] );
1848 }
1849 if ($GLOBALS['TYPO3_CONF_VARS']['SYS']['curlProxyUserPass']) {
1850 curl_setopt ($ch, CURLOPT_PROXYUSERPWD, $GLOBALS['TYPO3_CONF_VARS']['SYS']['curlProxyUserPass'] );
1851 }
1852 }
1853 $content=curl_exec ($ch);
1854 curl_close ($ch);
1855 return $content;
1856 } elseif($fd = fopen($url,'rb')) {
1857 while (!feof($fd)) {
1858 $content.=fread($fd, 5000);
1859 }
1860 fclose($fd);
1861 return $content;
1862 }
1863 }
1864
1865 /**
1866 * Writes $content to the file $file
1867 *
1868 * Usage: 31
1869 *
1870 * @param string Filepath to write to
1871 * @param string Content to write
1872 * @return boolean True if the file was successfully opened and written to.
1873 */
1874 function writeFile($file,$content) {
1875 if($fd = fopen($file,'wb')) {
1876 fwrite( $fd, $content);
1877 fclose( $fd );
1878 if (@is_file($file) && TYPO3_OS!='WIN') {@chmod ($file, 0644);}
1879 return true;
1880 }
1881 }
1882
1883 /**
1884 * Returns an array with the names of folders in a specific path
1885 * Will return 'error' (string) if there were an error with reading directory content.
1886 *
1887 * Usage: 13
1888 *
1889 * @param string Path to list directories from
1890 * @return array Returns an array with the directory entries as values. If no path, the return value is nothing.
1891 */
1892 function get_dirs($path) {
1893 if ($path) {
1894 $d = @dir($path);
1895 if (is_object($d)) {
1896 while($entry=$d->read()) {
1897 if (@is_dir($path.'/'.$entry) && $entry!= '..' && $entry!= '.') {
1898 $filearray[]=$entry;
1899 }
1900 }
1901 $d->close();
1902 } else return 'error';
1903 return $filearray;
1904 }
1905 }
1906
1907 /**
1908 * Returns an array with the names of files in a specific path
1909 *
1910 * Usage: 17
1911 *
1912 * @param string $path: Is the path to the file
1913 * @param string $extensionList is the comma list of extensions to read only (blank = all)
1914 * @param boolean If set, then the path is prepended the filenames. Otherwise only the filenames are returned in the array
1915 * @param string $order is sorting: 1= sort alphabetically, 'mtime' = sort by modification time.
1916 * @return array Array of the files found
1917 */
1918 function getFilesInDir($path,$extensionList='',$prependPath=0,$order='') {
1919 $filearray=array();
1920 $sortarray=array();
1921 if ($path) {
1922 $path = ereg_replace('/$','',$path);
1923 $extensionList = strtolower($extensionList);
1924 $d = @dir($path);
1925 if (is_object($d)) {
1926 while($entry=$d->read()) {
1927 if (@is_file($path.'/'.$entry)) {
1928 $fI = pathinfo($entry);
1929 $key = md5($path.'/'.$entry);
1930 if (!$extensionList || t3lib_div::inList($extensionList,strtolower($fI['extension']))) {
1931 $filearray[$key]=($prependPath?$path.'/':'').$entry;
1932 if ($order=='mtime') {$sortarray[$key]=filemtime($path.'/'.$entry);}
1933 elseif ($order) {$sortarray[$key]=$entry;}
1934 }
1935 }
1936 }
1937 $d->close();
1938 } else return 'error';
1939 }
1940 if ($order) {
1941 asort($sortarray);
1942 reset($sortarray);
1943 $newArr=array();
1944 while(list($k,$v)=each($sortarray)) {
1945 $newArr[$k]=$filearray[$k];
1946 }
1947 $filearray=$newArr;
1948 }
1949 reset($filearray);
1950 return $filearray;
1951 }
1952
1953 /**
1954 * Recursively gather all files and folders of a path.
1955 *
1956 * @param array $fileArr: Empty input array (will have files added to it)
1957 * @param string $path: The path to read recursively from (absolute)
1958 * @param string $extList: Comma list of file extensions: Only files with extensions in this list (if applicable) will be selected.
1959 * @param boolean $regDirs: If set, directories are also included in output.
1960 * @param integer $recursivityLevels: The number of levels to dig down...
1961 * @return array An array with the found files/directories.
1962 */
1963 function getAllFilesAndFoldersInPath($fileArr,$path,$extList='',$regDirs=0,$recursivityLevels=99) {
1964 if ($regDirs) $fileArr[]=$path;
1965 $fileArr=array_merge($fileArr,t3lib_div::getFilesInDir($path,$extList,1,1));
1966
1967 $dirs = t3lib_div::get_dirs($path);
1968 if (is_array($dirs) && $recursivityLevels>0) {
1969 foreach ($dirs as $subdirs) {
1970 if ((string)$subdirs!='') {
1971 $fileArr = t3lib_div::getAllFilesAndFoldersInPath($fileArr,$path.$subdirs.'/',$extList,$regDirs,$recursivityLevels-1);
1972 }
1973 }
1974 }
1975 return $fileArr;
1976 }
1977
1978 /**
1979 * Removes the absolute part of all files/folders in fileArr
1980 *
1981 * @param array $fileArr: The file array to remove the prefix from
1982 * @param string $prefixToRemove: The prefix path to remove (if found as first part of string!)
1983 * @return array The input $fileArr processed.
1984 */
1985 function removePrefixPathFromList($fileArr,$prefixToRemove) {
1986 reset($fileArr);
1987 while(list($k,$absFileRef)=each($fileArr)) {
1988 if(t3lib_div::isFirstPartOfStr($absFileRef,$prefixToRemove)) {
1989 $fileArr[$k]=substr($absFileRef,strlen($prefixToRemove));
1990 } else return 'ERROR: One or more of the files was NOT prefixed with the prefix-path!';
1991 }
1992 return $fileArr;
1993 }
1994
1995 /**
1996 * Moves $source file to $destination if uploaded, otherwise try to make a copy
1997 * Usage: 3
1998 *
1999 * @param string Source file, absolute path
2000 * @param string Destination file, absolute path
2001 * @return boolean Returns true if the file was moved.
2002 * @coauthor Dennis Petersen <fessor@software.dk>
2003 */
2004 function upload_copy_move($source,$destination) {
2005 if (is_uploaded_file($source)) {
2006 // Return the value of move_uploaded_file, and if false the temporary $source is still around so the user can use unlink to delete it:
2007 return move_uploaded_file($source, $destination);
2008 } else @copy($source,$destination);
2009 if (@is_file($destination) && TYPO3_OS!='WIN') {@chmod ($destination, 0644);}
2010 // If here the file is copied and the temporary $source is still around, so when returning false the user can try unlink to delete the $source
2011 return false;
2012 }
2013
2014 /**
2015 * Fixes a path for windows-backslashes and reduces double-slashes to single slashes
2016 *
2017 * Usage: 2
2018 *
2019 * @param string
2020 * @return string
2021 */
2022 function fixWindowsFilePath($theFile) {
2023 return str_replace('//','/', str_replace('\\','/', $theFile));
2024 }
2025
2026 /**
2027 * Resolves "../" sections in the input path string
2028 *
2029 * @param string
2030 * @return string
2031 */
2032 function resolveBackPath($pathStr) {
2033 $parts = explode('/',$pathStr);
2034 $output=array();
2035 foreach($parts as $pV) {
2036 if ($pV=='..') {
2037 if ($c) {
2038 array_pop($output);
2039 $c--;
2040 } else $output[]=$pV;
2041 } else {
2042 $c++;
2043 $output[]=$pV;
2044 }
2045 }
2046 return implode('/',$output);
2047 }
2048
2049 /**
2050 * Prefixes a URL used with 'header-location' with 'http://...' depending on whether it has it already.
2051 * - If already having a scheme, nothing is prepended
2052 * - If having REQUEST_URI slash '/', then prefixing 'http://[host]' (relative to host)
2053 * - Otherwise prefixed with TYPO3_REQUEST_DIR (relative to current dir / TYPO3_REQUEST_DIR)
2054 *
2055 * Usage: 31
2056 *
2057 * @param string
2058 * @return string
2059 */
2060 function locationHeaderUrl($path) {
2061 $uI = parse_url($path);
2062 if (substr($path,0,1)=='/') { // relative to HOST
2063 $path = t3lib_div::getIndpEnv('TYPO3_REQUEST_HOST').$path;
2064 } elseif (!$uI['scheme']) { // No scheme either
2065 $path = t3lib_div::getIndpEnv('TYPO3_REQUEST_DIR').$path;
2066 }
2067 return $path;
2068 }
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085 /*************************
2086 *
2087 * DEBUG helper FUNCTIONS
2088 *
2089 *************************/
2090
2091 /**
2092 * Returns a string with a list of ascii-values for the first $characters characters in $string
2093 * Usage: 5
2094 *
2095 * @param string String to show ASCII value for
2096 * @param integer Number of characters to show
2097 * @return string The string with ASCII values in separated by a space char.
2098 * @internal
2099 */
2100 function debug_ordvalue($string,$characters=100) {
2101 if(strlen($string) < $characters) $characters = strlen($string);
2102 for ($i=0; $i<$characters; $i++) {
2103 $valuestring.=' '.ord(substr($string,$i,1));
2104 }
2105 return trim($valuestring);
2106 }
2107
2108 /**
2109 * Returns HTML-code, which is a visual representation of a multidimensional array
2110 * use t3lib_div::print_array() in order to print an array
2111 * Returns false if $array_in is not an array
2112 * Usage: 27
2113 *
2114 * @param array
2115 * @return string HTML output
2116 */
2117 function view_array($array_in) {
2118 if (is_array($array_in)) {
2119 $result='<table border="1" cellpadding="1" cellspacing="0" bgcolor="white">';
2120 if (!count($array_in)) {$result.= '<tr><td><font face="Verdana,Arial" size="1"><b>'.HTMLSpecialChars("EMPTY!").'</b></font></td></tr>';}
2121 while (list($key,$val)=each($array_in)) {
2122 $result.= '<tr><td><font face="Verdana,Arial" size="1">'.HTMLSpecialChars((string)$key).'</font></td><td>';
2123 if (is_array($array_in[$key])) {
2124 $result.=t3lib_div::view_array($array_in[$key]);
2125 } else
2126 $result.= '<font face="Verdana,Arial" size="1" color="red">'.nl2br(HTMLSpecialChars((string)$val)).'<br /></font>';
2127 $result.= '</td></tr>';
2128 }
2129 $result.= '</table>';
2130 } else {
2131 $result = false;
2132 }
2133 return $result;
2134 }
2135
2136 /**
2137 * Prints an array
2138 * Usage: 28
2139 *
2140 * @param array
2141 * @return void
2142 * @internal
2143 */
2144 function print_array($array_in) {
2145 echo t3lib_div::view_array($array_in);
2146 }
2147
2148 /**
2149 * Makes debug output
2150 * Prints $var in bold between two vertical lines
2151 * If not $var the word 'debug' is printed
2152 * If $var is an array, the array is printed by t3lib_div::print_array()
2153 *
2154 * Usage: 8
2155 *
2156 * @param mixed Variable to print
2157 * @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.
2158 * @return void
2159 */
2160 function debug($var="",$brOrHeader=0) {
2161 if ($brOrHeader && !t3lib_div::testInt($brOrHeader)) {
2162 echo '<table border="0" cellpadding="0" cellspacing="0" bgcolor="white" style="border:0px;margin-top:3px;margin-bottom:3px;"><tr><td bgcolor="#bbbbbb"><font face="Verdana,Arial" size="1">&nbsp;<b>'.(string)HTMLSpecialChars($brOrHeader).'</b></font></td></tr><td>';
2163 } elseif ($brOrHeader<0) {
2164 for($a=0;$a<abs(intval($brOrHeader));$a++){echo '<br />';}
2165 }
2166
2167 if (is_array($var)) {
2168 t3lib_div::print_array($var);
2169 } elseif (is_object($var)) {
2170 echo '<b>|Object:<pre>';
2171 print_r($var);
2172 echo '</pre>|</b>';
2173 } elseif ((string)$var!='') {
2174 echo '<b>|'.HTMLSpecialChars((string)$var).'|</b>';
2175 } else {
2176 echo '<b>| debug |</b>';
2177 }
2178
2179 if ($brOrHeader && !t3lib_div::testInt($brOrHeader)) {
2180 echo '</td></tr></table>';
2181 } elseif ($brOrHeader>0) {
2182 for($a=0;$a<intval($brOrHeader);$a++){echo '<br />';}
2183 }
2184 }
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217 /*************************
2218 *
2219 * SYSTEM INFORMATION
2220 *
2221 *************************/
2222
2223 /**
2224 * Returns the HOST+DIR-PATH of the current script (The URL, but without 'http://' and without script-filename)
2225 * Usage: 1
2226 *
2227 * @return string
2228 */
2229 function getThisUrl() {
2230 $p=parse_url(t3lib_div::getIndpEnv('TYPO3_REQUEST_SCRIPT')); // Url of this script
2231 $dir=t3lib_div::dirname($p['path']).'/'; // Strip file
2232 $url = str_replace('//','/',$p['host'].($p['port']?':'.$p['port']:'').$dir);
2233 return $url;
2234 }
2235
2236 /**
2237 * Returns the link-url to the current script.
2238 * 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.
2239 * REMEMBER to always htmlspecialchar() content in href-properties to ampersands get converted to entities (XHTML requirement and XSS precaution)
2240 *
2241 * Usage: 54
2242 *
2243 * @param array Array of GET parameters to include
2244 * @return string
2245 */
2246 function linkThisScript($getParams=array()) {
2247 $parts = t3lib_div::getIndpEnv('SCRIPT_NAME');
2248 $params = $GLOBALS['HTTP_GET_VARS'];
2249 reset($getParams);
2250 while(list($k,$v)=each($getParams)) {
2251 if (strcmp($v,'')) {
2252 $params[$k]=$v;
2253 } else unset($params[$k]);
2254 }
2255 $pString = t3lib_div::implodeArrayForUrl('',$params);
2256 return $pString ? $parts.'?'.ereg_replace('^&','',$pString) : $parts;
2257 }
2258
2259 /**
2260 * 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.
2261 * So basically it adds the parameters in $getParams to an existing URL, $url
2262 * Usage: 2
2263 *
2264 * @param string URL string
2265 * @param array Array of key/value pairs for get parameters to add/overrule with. Can be multidimensional.
2266 * @return string Output URL with added getParams.
2267 */
2268 function linkThisUrl($url,$getParams=array()) {
2269 $parts = parse_url($url);
2270 if ($parts['query']) {
2271 parse_str($parts['query'],$getP);
2272 } else $getP=array();
2273 $getP=t3lib_div::array_merge_recursive_overrule($getP,$getParams);
2274 $uP = explode('?',$url);
2275 $outurl = $uP[0].'?'.t3lib_div::implodeArrayForUrl('',$getP);
2276 return $outurl;
2277 }
2278
2279 /**
2280 * Abstraction method which returns System Environment Variables regardless of server OS, CGI/MODULE version etc. Basically this is SERVER variables for most of them.
2281 * This should be used instead of getEnv() and HTTP_SERVER_VARS/ENV_VARS to get reliable values for all situations.
2282 *
2283 * Usage: 226
2284 *
2285 * @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
2286 * @return string Value based on the input key, independent of server/os environment.
2287 */
2288 function getIndpEnv($getEnvName) {
2289 global $HTTP_SERVER_VARS;
2290 /*
2291 Conventions:
2292 output from parse_url():
2293 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
2294 [scheme] => 'http'
2295 [user] => 'username'
2296 [pass] => 'password'
2297 [host] => '192.168.1.4'
2298 [port] => '8080'
2299 [path] => '/typo3/32/temp/phpcheck/index.php/arg1/arg2/arg3/'
2300 [query] => 'arg1,arg2,arg3&p1=parameter1&p2[key]=value'
2301 [fragment] => 'link1'
2302
2303 Further definition: [path_script] = '/typo3/32/temp/phpcheck/index.php'
2304 [path_dir] = '/typo3/32/temp/phpcheck/'
2305 [path_info] = '/arg1/arg2/arg3/'
2306 [path] = [path_script/path_dir][path_info]
2307
2308
2309 Keys supported:
2310
2311 URI______:
2312 REQUEST_URI = [path]?[query] = /typo3/32/temp/phpcheck/index.php/arg1/arg2/arg3/?arg1,arg2,arg3&p1=parameter1&p2[key]=value
2313 HTTP_HOST = [host][:[port]] = 192.168.1.4:8080
2314 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')!
2315 PATH_INFO = [path_info] = /arg1/arg2/arg3/
2316 QUERY_STRING = [query] = arg1,arg2,arg3&p1=parameter1&p2[key]=value
2317 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
2318 (Notice: NO username/password + NO fragment)
2319
2320 CLIENT____:
2321 REMOTE_ADDR = (client IP)
2322 REMOTE_HOST = (client host)
2323 HTTP_USER_AGENT = (client user agent)
2324 HTTP_ACCEPT_LANGUAGE = (client accept language)
2325
2326 SERVER____:
2327 SCRIPT_FILENAME = Absolute filename of script (Differs between windows/unix). On windows 'C:\\blabla\\blabl\\' will be converted to 'C:/blabla/blabl/'
2328
2329 Special extras:
2330 TYPO3_HOST_ONLY = [host] = 192.168.1.4
2331 TYPO3_PORT = [port] = 8080 (blank if 80, taken from host value)
2332 TYPO3_REQUEST_HOST = [scheme]://[host][:[port]]
2333 TYPO3_REQUEST_URL = [scheme]://[host][:[port]][path]?[query] (sheme will by default be 'http' until we can detect if it's https -
2334 TYPO3_REQUEST_SCRIPT = [scheme]://[host][:[port]][path_script]
2335 TYPO3_REQUEST_DIR = [scheme]://[host][:[port]][path_dir]
2336 TYPO3_SITE_URL = [scheme]://[host][:[port]][path_dir] of the TYPO3 website
2337 TYPO3_DOCUMENT_ROOT = Absolute path of root of documents: TYPO3_DOCUMENT_ROOT.SCRIPT_NAME = SCRIPT_FILENAME (typically)
2338
2339 Notice: [fragment] is apparently NEVER available to the script!
2340
2341
2342 Testing suggestions:
2343 - Output all the values.
2344 - 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
2345 - ALSO TRY the script from the ROOT of a site (like 'http://www.mytest.com/' and not 'http://www.mytest.com/test/' !!)
2346
2347 */
2348
2349 # if ($getEnvName=='HTTP_REFERER') return '';
2350 switch((string)$getEnvName) {
2351 case 'SCRIPT_NAME':
2352 return php_sapi_name()=='cgi' ? $HTTP_SERVER_VARS['PATH_INFO'] : $HTTP_SERVER_VARS['SCRIPT_NAME'];
2353 break;
2354 case 'SCRIPT_FILENAME':
2355 return str_replace('//','/', str_replace('\\','/', php_sapi_name()=='cgi'||php_sapi_name()=='isapi' ? $HTTP_SERVER_VARS['PATH_TRANSLATED']:$HTTP_SERVER_VARS['SCRIPT_FILENAME']));
2356 break;
2357 case 'REQUEST_URI':
2358 // Typical application of REQUEST_URI is return urls, forms submitting to itselt etc. Eg: returnUrl='.rawurlencode(t3lib_div::getIndpEnv('REQUEST_URI'))
2359 if (!$HTTP_SERVER_VARS['REQUEST_URI']) { // This is for ISS/CGI which does not have the REQUEST_URI available.
2360 return '/'.ereg_replace('^/','',t3lib_div::getIndpEnv('SCRIPT_NAME')).
2361 ($HTTP_SERVER_VARS['QUERY_STRING']?'?'.$HTTP_SERVER_VARS['QUERY_STRING']:'');
2362 } else return $HTTP_SERVER_VARS['REQUEST_URI'];
2363 break;
2364 case 'PATH_INFO':
2365 // $HTTP_SERVER_VARS['PATH_INFO']!=$HTTP_SERVER_VARS['SCRIPT_NAME'] is necessary because some servers (Windows/CGI) are seen to set PATH_INFO equal to script_name
2366 // Further, there must be at least one '/' in the path - else the PATH_INFO value does not make sense.
2367 // 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($HTTP_SERVER_VARS['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)
2368 // if (strcmp($HTTP_SERVER_VARS['PATH_INFO'],t3lib_div::getIndpEnv('SCRIPT_NAME')) && count(explode('/',$HTTP_SERVER_VARS['PATH_INFO']))>1) {
2369 if (php_sapi_name()!='cgi') {
2370 return $HTTP_SERVER_VARS['PATH_INFO'];
2371 } else return '';
2372 break;
2373 // These are let through without modification
2374 case 'REMOTE_ADDR':
2375 case 'REMOTE_HOST':
2376 case 'HTTP_REFERER':
2377 case 'HTTP_HOST':
2378 case 'HTTP_USER_AGENT':
2379 case 'HTTP_ACCEPT_LANGUAGE':
2380 case 'QUERY_STRING':
2381 return $HTTP_SERVER_VARS[$getEnvName];
2382 break;
2383 case 'TYPO3_DOCUMENT_ROOT':
2384 // 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.
2385 // Therefore the DOCUMENT_ROOT is now always calculated as the SCRIPT_FILENAME minus the end part shared with SCRIPT_NAME.
2386 $SFN = t3lib_div::getIndpEnv('SCRIPT_FILENAME');
2387 $SN_A = explode('/',strrev(t3lib_div::getIndpEnv('SCRIPT_NAME')));
2388 $SFN_A = explode('/',strrev($SFN));
2389 $acc=array();
2390 while(list($kk,$vv)=each($SN_A)) {
2391 if (!strcmp($SFN_A[$kk],$vv)) {
2392 $acc[]=$vv;
2393 } else break;
2394 }
2395 $commonEnd=strrev(implode('/',$acc));
2396 if (strcmp($commonEnd,'')) $DR = substr($SFN,0,-(strlen($commonEnd)+1));
2397 return $DR;
2398 break;
2399 case 'TYPO3_HOST_ONLY':
2400 $p=explode(':',$HTTP_SERVER_VARS['HTTP_HOST']);
2401 return $p[0];
2402 break;
2403 case 'TYPO3_PORT':
2404 $p=explode(':',$HTTP_SERVER_VARS['HTTP_HOST']);
2405 return $p[1];
2406 break;
2407 case 'TYPO3_REQUEST_HOST':
2408 return 'http'.($HTTP_SERVER_VARS['SSL_SESSION_ID']?'s':'').'://'. // I hope this: ($HTTP_SERVER_VARS['SSL_SESSION_ID']?'s':'') - is sufficient to detect https...
2409 $HTTP_SERVER_VARS['HTTP_HOST'];
2410 break;
2411 case 'TYPO3_REQUEST_URL':
2412 return t3lib_div::getIndpEnv('TYPO3_REQUEST_HOST').t3lib_div::getIndpEnv('REQUEST_URI');
2413 break;
2414 case 'TYPO3_REQUEST_SCRIPT':
2415 return t3lib_div::getIndpEnv('TYPO3_REQUEST_HOST').t3lib_div::getIndpEnv('SCRIPT_NAME');
2416 break;
2417 case 'TYPO3_REQUEST_DIR':
2418 return t3lib_div::getIndpEnv('TYPO3_REQUEST_HOST').t3lib_div::dirname(t3lib_div::getIndpEnv('SCRIPT_NAME')).'/';
2419 break;
2420 case 'TYPO3_SITE_URL':
2421 if (defined('PATH_thisScript') && defined('PATH_site')) {
2422 $lPath = substr(dirname(PATH_thisScript),strlen(PATH_site)).'/';
2423 $url = t3lib_div::getIndpEnv('TYPO3_REQUEST_DIR');
2424 $siteUrl = substr($url,0,-strlen($lPath));
2425 if (substr($siteUrl,-1)!='/') $siteUrl.='/';
2426 return $siteUrl;
2427 } else return '';
2428
2429 break;
2430 case '_ARRAY':
2431 $out=array();
2432 // Here, list ALL possible keys to this function for debug display.
2433 $envTestVars = t3lib_div::trimExplode(',','
2434 HTTP_HOST,
2435 TYPO3_HOST_ONLY,
2436 TYPO3_PORT,
2437 PATH_INFO,
2438 QUERY_STRING,
2439 REQUEST_URI,
2440 HTTP_REFERER,
2441 TYPO3_REQUEST_HOST,
2442 TYPO3_REQUEST_URL,
2443 TYPO3_REQUEST_SCRIPT,
2444 TYPO3_REQUEST_DIR,
2445 TYPO3_SITE_URL,
2446 SCRIPT_NAME,
2447 TYPO3_DOCUMENT_ROOT,
2448 SCRIPT_FILENAME,
2449 REMOTE_ADDR,
2450 REMOTE_HOST,
2451 HTTP_USER_AGENT,
2452 HTTP_ACCEPT_LANGUAGE',1);
2453 reset($envTestVars);
2454 while(list(,$v)=each($envTestVars)) {
2455 $out[$v]=t3lib_div::getIndpEnv($v);
2456 }
2457 reset($out);
2458 return $out;
2459 break;
2460 }
2461 }
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485 /*************************
2486 *
2487 * TYPO3 SPECIFIC FUNCTIONS
2488 *
2489 *************************/
2490
2491 /**
2492 * Returns the absolute filename of $filename.
2493 * Decodes the prefix EXT: for TYPO3 Extensions.
2494 *
2495 * Usage: 9
2496 *
2497 * @param string The input filename/filepath to evaluate
2498 * @param boolean If $onlyRelative is set (which it is by default), then only return values relative to the current PATH_site is accepted.
2499 * @param boolean If $relToTYPO3_mainDir is set, then relative paths are relative to PATH_typo3 constant - otherwise (default) they are relative to PATH_site
2500 * @return string Returns the absolute filename of $filename IF valid, otherwise blank string.
2501 */
2502 function getFileAbsFileName($filename,$onlyRelative=1,$relToTYPO3_mainDir=0) {
2503 if (!strcmp($filename,'')) return '';
2504
2505 if ($relToTYPO3_mainDir) {
2506 if (!defined('PATH_typo3')) return '';
2507 $relPathPrefix = PATH_typo3;
2508 } else {
2509 $relPathPrefix = PATH_site;
2510 }
2511 if (substr($filename,0,4)=='EXT:') { // extension
2512 list($extKey,$local) = explode('/',substr($filename,4),2);
2513 $filename='';
2514 if (strcmp($extKey,'') && t3lib_extMgm::isLoaded($extKey) && strcmp($local,'')) {
2515 $filename = t3lib_extMgm::extPath($extKey).$local;
2516 }
2517 } elseif (!t3lib_div::isAbsPath($filename)) { // relative. Prepended with $relPathPrefix
2518 $filename=$relPathPrefix.$filename;
2519 } elseif ($onlyRelative && !t3lib_div::isFirstPartOfStr($filename,$relPathPrefix)) { // absolute, but set to blank if not allowed
2520 $filename='';
2521 }
2522 if (strcmp($filename,'') && t3lib_div::validPathStr($filename)) { // checks backpath.
2523 return $filename;
2524 }
2525 }
2526
2527 /**
2528 * Returns true if no '//', '..' or '\' is in the $theFile
2529 * This should make sure that the path is not pointing 'backwards' and further doesn't contain double/back slashes.
2530 * So it's compatible with the UNIX style path strings valid for TYPO3 internally.
2531 *
2532 * Usage: 8
2533 *
2534 * @param string Filepath to evaluate
2535 * @return boolean True, if no '//', '..' or '\' is in the $theFile
2536 */
2537 function validPathStr($theFile) {
2538 if (!strstr($theFile,'//') && !strstr($theFile,'..') && !strstr($theFile,'\\')) return true;
2539 }
2540
2541 /**
2542 * Checks if the $path is absolute or relative (detecting either '/' or 'x:/' as first part of string) and returns true if so.
2543 *
2544 * Usage: 9
2545 *
2546 * @param string Filepath to evaluate
2547 * @return boolean
2548 */
2549 function isAbsPath($path) {
2550 return TYPO3_OS=='WIN' ? substr($path,1,2)==':/' : substr($path,0,1)=='/';
2551 }
2552
2553 /**
2554 * Returns true if the path is absolute, without backpath '..' and within the PATH_site OR within the lockRootPath
2555 *
2556 * Usage: 1
2557 *
2558 * @param string Filepath to evaluate
2559 * @return boolean
2560 */
2561 function isAllowedAbsPath($path) {
2562 if (t3lib_div::isAbsPath($path) &&
2563 t3lib_div::validPathStr($path) &&
2564 ( t3lib_div::isFirstPartOfStr($path,PATH_site)
2565 ||
2566 ($GLOBALS['TYPO3_CONF_VARS']['BE']['lockRootPath'] && t3lib_div::isFirstPartOfStr($path,$GLOBALS['TYPO3_CONF_VARS']['BE']['lockRootPath']))
2567 )
2568 ) return true;
2569 }
2570
2571 /**
2572 * Verifies the input filename againts the 'fileDenyPattern'. Returns true if OK.
2573 *
2574 * Usage: 2
2575 *
2576 * @param string Filepath to evaluate
2577 * @return boolean
2578 */
2579 function verifyFilenameAgainstDenyPattern($filename) {
2580 if (strcmp($filename,'') && strcmp($GLOBALS['TYPO3_CONF_VARS']['BE']['fileDenyPattern'],'')) {
2581 $result = eregi($GLOBALS['TYPO3_CONF_VARS']['BE']['fileDenyPattern'],$filename);
2582 if ($result) return false; // so if a matching filename is found, return false;
2583 }
2584 return true;
2585 }
2586
2587 /**
2588 * standard authentication code - can't remember what it's used for.
2589 * Usage: 2
2590 *
2591 * @param mixed Uid (integer) or record (array)
2592 * @param string List of fields from the record if that is given.
2593 * @return string MD5 hash of 8 chars.
2594 * @internal
2595 */
2596 function stdAuthCode($uid_or_record,$fields='') {
2597 if (is_array($uid_or_record)) {
2598 $recCopy_temp=array();
2599 if ($fields) {
2600 $fieldArr = t3lib_div::trimExplode(',',$fields,1);
2601 reset($fieldArr);
2602 while(list($k,$v)=each($fieldArr)) {
2603 $recCopy_temp[$k]=$recCopy[$v];
2604 }
2605 } else {
2606 $recCopy_temp=$recCopy;
2607 }
2608 $preKey = implode('|',$recCopy_temp);
2609 } else {
2610 $preKey = $uid_or_record;
2611 }
2612
2613 $authCode = $preKey.'||'.$GLOBALS['TYPO3_CONF_VARS']['SYS']['encryptionKey'];
2614 $authCode = substr(md5($authCode),0,8);
2615 return $authCode;
2616 }
2617
2618 /**
2619 * Loads the $TCA (Table Configuration Array) for the $table
2620 *
2621 * Requirements:
2622 * 1) must be configured table (the ctrl-section configured),
2623 * 2) columns must not be an array (which it is always if whole table loaded), and
2624 * 3) there is a value for dynamicConfigFile (filename in typo3conf)
2625 * Usage: 92
2626 *
2627 * @param string Table name for which to load the full TCA array part into the global $TCA
2628 * @return void
2629 */
2630 function loadTCA($table) {
2631 global $TCA,$LANG_GENERAL_LABELS;
2632 if (isset($TCA[$table]) && !is_array($TCA[$table]['columns']) && $TCA[$table]['ctrl']['dynamicConfigFile']) {
2633 if (!strcmp(substr($TCA[$table]['ctrl']['dynamicConfigFile'],0,6),'T3LIB:')) {
2634 include(PATH_t3lib.'stddb/'.substr($TCA[$table]['ctrl']['dynamicConfigFile'],6));
2635 } elseif (t3lib_div::isAbsPath($TCA[$table]['ctrl']['dynamicConfigFile']) && @is_file($TCA[$table]['ctrl']['dynamicConfigFile'])) { // Absolute path...
2636 include($TCA[$table]['ctrl']['dynamicConfigFile']);
2637 } else include(PATH_typo3conf.$TCA[$table]['ctrl']['dynamicConfigFile']);
2638 }
2639 }
2640
2641 /**
2642 * Looks for a sheet-definition in the input data structure array. If found it will return the data structure for the sheet given as $sheet (if found).
2643 * If the sheet definition is in an external file that file is parsed and the data structure inside of that is returned.
2644 *
2645 * @param array Input data structure, possibly with a sheet-definition and references to external data source files.
2646 * @param string The sheet to return, preferably.
2647 * @return array An array with two num. keys: key0: The data structure is returned in this key (array) UNLESS an error happend in which case an error string is returned (string). key1: The used sheet key value!
2648 */
2649 function resolveSheetDefInDS($dataStructArray,$sheet='sDEF') {
2650 if (is_array($dataStructArray['sheets'])) {
2651 if (!isset($dataStructArray['sheets'][$sheet])) {
2652 $sheet='sDEF';
2653 }
2654 $dataStruct = $dataStructArray['sheets'][$sheet];
2655
2656 // If not an array, but still set, then regard it as a relative reference to a file:
2657 if ($dataStruct && !is_array($dataStruct)) {
2658 $file = t3lib_div::getFileAbsFileName($dataStruct);
2659 if ($file && @is_file($file)) {
2660 $dataStruct = t3lib_div::xml2array(t3lib_div::getUrl($file));
2661 }
2662 }
2663 } else {
2664 $dataStruct = $dataStructArray;
2665 $sheet = 'sDEF'; // Default sheet
2666 }
2667 return array($dataStruct,$sheet);
2668 }
2669
2670 /**
2671 * Resolves ALL sheet definitions in dataStructArray
2672 * If no sheet is found, then the default "sDEF" will be created with the dataStructure inside.
2673 *
2674 * @param array Input data structure, possibly with a sheet-definition and references to external data source files.
2675 * @return array Output data structure with all sheets resolved as arrays.
2676 */
2677 function resolveAllSheetsInDS($dataStructArray) {
2678 if (is_array($dataStructArray['sheets'])) {
2679 $out=array('sheets'=>array());
2680 foreach($dataStructArray['sheets'] as $sheetId => $sDat) {
2681 list($ds,$aS) = t3lib_div::resolveSheetDefInDS($dataStructArray,$sheetId);
2682 if ($sheetId==$aS) {
2683 $out['sheets'][$aS]=$ds;
2684 }
2685 }
2686 } else {
2687 list($ds) = t3lib_div::resolveSheetDefInDS($dataStructArray);
2688 $out = array('sheets' => array('sDEF' => $ds));
2689 }
2690 return $out;
2691 }
2692
2693 /**
2694 * Calls a userdefined function/method in class
2695 * Such a function/method should look like this: "function proc(&$params, &$ref) {...}"
2696 *
2697 * Usage: 3
2698 *
2699 * @param string Method reference, [class]->[method] or [function]
2700 * @param mixed Parameters to be pass along (typically an array) (REFERENCE!)
2701 * @param mixed Reference to be passed along (typically "$this" - being a reference to the calling object) (REFERENCE!)
2702 * @param string Required prefix of class or function name
2703 * @param boolean If set, not debug() error message is shown if class/function is not present.
2704 * @return mixed Content from method/function call
2705 */
2706 function callUserFunction($funcName,&$params,&$ref,$checkPrefix='user_',$silent=0) {
2707 if ($checkPrefix &&
2708 !t3lib_div::isFirstPartOfStr(trim($funcName),$checkPrefix) &&
2709 !t3lib_div::isFirstPartOfStr(trim($funcName),'tx_')
2710 ) {
2711 if (!$silent) debug("Function '".$funcName."' was not prepended with '".$checkPrefix."'",1);
2712 return $content;
2713 }
2714 $parts = explode('->',$funcName);
2715 if (count($parts)==2) { // Class
2716 if (class_exists($parts[0])) {
2717 $classObj = new $parts[0];
2718 if (method_exists($classObj, $parts[1])) {
2719 $content = call_user_method($parts[1], $classObj, $params, $ref);
2720 } else {
2721 if (!$silent) debug("<strong>ERROR:</strong> No method name '".$parts[1]."' in class ".$parts[0],1);
2722 }
2723 } else {
2724 if (!$silent) debug("<strong>ERROR:</strong> No class named: ".$parts[0],1);
2725 }
2726 } else { // Function
2727 if (function_exists($funcName)) {
2728 $content = call_user_func($funcName, $params, $ref);
2729 } else {
2730 if (!$silent) debug("<strong>ERROR:</strong> No function named: ".$funcName,1);
2731 }
2732 }
2733 return $content;
2734 }
2735
2736 /**
2737 * Make instance of class
2738 * Takes the class-extensions API of TYPO3 into account
2739 * Please USE THIS instead of the PHP "new" keyword. Eg. "$obj = new myclass;" should be "$obj = t3lib_div::makeInstance("myclass")" instead!
2740 *
2741 * Usage: 455
2742 *
2743 * @param string Class name to instantiate
2744 * @return object The object
2745 */
2746 function makeInstance($className) {
2747 if (class_exists('ux_'.$className)) {
2748 return t3lib_div::makeInstance('ux_'.$className);
2749 } else {
2750 return new $className;
2751 }
2752 }
2753
2754 /**
2755 * Find the best service and check if it works.
2756 * Returns object of the service class.
2757 *
2758 * @param string Type of service (service key).
2759 * @param string Sub type like file extensions or similar. Defined by the service.
2760 * @param string List of service keys which should be exluded in the search for a service.
2761 * @return object The service object or an array with error info's.
2762 * @author René Fritz <r.fritz@colorcube.de>
2763 */
2764 function makeInstanceService($serviceType, $serviceSubType='', $excludeServiceKeys='') {
2765 global $T3_SERVICES;
2766
2767 $error = FALSE;
2768
2769 while ($info = t3lib_extMgm::findService($serviceType, $serviceSubType, $excludeServiceKeys)) {
2770
2771 if (@is_file($info['classFile'])) {
2772 require_once ($info['classFile']);
2773 $obj = t3lib_div::makeInstance($info['className']);
2774 if (is_object($obj)) {
2775 if ($obj->init()) { // service available?
2776
2777 $obj->info = $info;
2778 return $obj; // objects are passed always as reference - right?
2779 }
2780 $error = $obj->getLastErrorArray();
2781 unset($obj);
2782 }
2783 // deactivate the service
2784 t3lib_extMgm::deactivateService($info['serviceType'],$info['serviceKey']);
2785 }
2786 }
2787 return $error;
2788 }
2789
2790 /**
2791 * Return classname for new instance
2792 * Takes the class-extensions API of TYPO3 into account
2793 *
2794 * Usage: 18
2795 *
2796 * @param string Base Class name to evaluate
2797 * @return string Final class name to instantiate with "new [classname]"
2798 */
2799 function makeInstanceClassName($className) {
2800 return class_exists('ux_'.$className)?'ux_'.$className:$className;
2801 }
2802
2803 /**
2804 * Simple substitute for the PHP function mail().
2805 * The fifth parameter, $enc, will allow you to specify 'base64' encryption for the output (set $enc=base64)
2806 * Further the output has the charset set to ISO-8859-1 by default.
2807 *
2808 * Usage: 4
2809 *
2810 * @param string Email address to send to. (see PHP function mail())
2811 * @param string Subject line, non-encoded. (see PHP function mail())
2812 * @param string Message content, non-encoded. (see PHP function mail())
2813 * @param string Headers, separated by chr(10)
2814 * @param string Encoding type: "base64", "quoted-printable", "8bit". If blank, no encoding will be used, no encoding headers set.
2815 * @param string Charset used in encoding-headers (only if $enc is set to a valid value which produces such a header)
2816 * @param boolean If set, the content of $subject will not be encoded.
2817 * @return void
2818 */
2819 function plainMailEncoded($email,$subject,$message,$headers='',$enc='',$charset='ISO-8859-1',$dontEncodeSubject=0) {
2820 switch((string)$enc) {
2821 case 'base64':
2822 $headers=trim($headers).chr(10).
2823 'Mime-Version: 1.0'.chr(10).
2824 'Content-Type: text/plain; charset="'.$charset.'"'.chr(10).
2825 'Content-Transfer-Encoding: base64';
2826
2827 $message=trim(chunk_split(base64_encode($message.chr(10)))).chr(10); // Adding chr(10) because I think MS outlook 2002 wants it... may be removed later again.
2828
2829 if (!$dontEncodeSubject) $subject='=?'.$charset.'?B?'.base64_encode($subject).'?=';
2830 break;
2831 case 'quoted-printable':
2832 $headers=trim($headers).chr(10).
2833 'Mime-Version: 1.0'.chr(10).
2834 'Content-Type: text/plain; charset="'.$charset.'"'.chr(10).
2835 'Content-Transfer-Encoding: quoted-printable';
2836
2837 $message=t3lib_div::quoted_printable($message);
2838
2839 if (!$dontEncodeSubject) $subject='=?'.$charset.'?Q?'.trim(t3lib_div::quoted_printable(ereg_replace('[[:space:]]','_',$subject),1000)).'?=';
2840 break;
2841 case '8bit':
2842 $headers=trim($headers).chr(10).
2843 'Mime-Version: 1.0'.chr(10).
2844 'Content-Type: text/plain; charset="'.$charset.'"'.chr(10).
2845 'Content-Transfer-Encoding: 8bit';
2846 break;
2847 }
2848 $headers=trim(implode(chr(10),t3lib_div::trimExplode(chr(10),$headers,1))); // make sure no empty lines are there.
2849 #debug(array($email,$subject,$message,$headers));
2850
2851 mail($email,$subject,$message,$headers);
2852 }
2853
2854 /**
2855 * Implementation of quoted-printable encode.
2856 * This functions is buggy. It seems that in the part where the lines are breaked every 76th character, that it fails if the break happens right in a quoted_printable encode character!
2857 * (Originally taken from class.t3lib_htmlmail.php - which may be updated if this function should ever be improved!
2858 * See RFC 1521, section 5.1 Quoted-Printable Content-Transfer-Encoding
2859 *
2860 * Usage: 2
2861 *
2862 * @param string Content to encode
2863 * @param integer Length of the lines, default is 76
2864 * @return string The QP encoded string
2865 */
2866 function quoted_printable($string,$maxlen=76) {
2867 $newString = '';
2868 $theLines = explode(chr(10),$string); // Break lines. Doesn't work with mac eol's which seems to be 13. But 13-10 or 10 will work
2869 while (list(,$val)=each($theLines)) {
2870 $val = ereg_replace(chr(13).'$','',$val); // removes possible character 13 at the end of line
2871
2872 $newVal = '';
2873 $theValLen = strlen($val);
2874 $len = 0;
2875 for ($index=0;$index<$theValLen;$index++) {
2876 $char = substr($val,$index,1);
2877 $ordVal =Ord($char);
2878 if ($len>($maxlen-4) || ($len>(($maxlen-10)-4)&&$ordVal==32)) {
2879 $len=0;
2880 $newVal.='='.chr(13).chr(10);
2881 }
2882 if (($ordVal>=33 && $ordVal<=60) || ($ordVal>=62 && $ordVal<=126) || $ordVal==9 || $ordVal==32) {
2883 $newVal.=$char;
2884 $len++;
2885 } else {
2886 $newVal.=sprintf('=%02X',$ordVal);
2887 $len+=3;
2888 }
2889 }
2890 $newVal = ereg_replace(chr(32).'$','=20',$newVal); // replaces a possible SPACE-character at the end of a line
2891 $newVal = ereg_replace(chr(9).'$','=09',$newVal); // replaces a possible TAB-character at the end of a line
2892 $newString.=$newVal.chr(13).chr(10);
2893 }
2894 return $newString;
2895 }
2896
2897 /**
2898 * Takes a clear-text message body for a plain text email, finds all 'http://' links and if they are longer than 76 chars they are converted to a shorter URL with a hash parameter. The real parameter is stored in the database and the hash-parameter/URL will be redirected to the real parameter when the link is clicked.
2899 * This function is about preserving long links in messages.
2900 *
2901 * Usage: 3
2902 *
2903 * @param string Message content
2904 * @param string URL mode; "76" or "all"
2905 * @param string
2906 * @return string Processed message content
2907 */
2908 function substUrlsInPlainText($message,$urlmode='76',$index_script_url='') {
2909 // Substitute URLs with shorter links:
2910 $urlSplit=explode('http://',$message);
2911 reset($urlSplit);
2912 while(list($c,$v)=each($urlSplit)) {
2913 if ($c) {
2914 $newParts = split('[[:space:]]|\)|\(',$v,2);
2915 $newURL='http://'.$newParts[0];
2916 switch((string)$urlmode) {
2917 case 'all':
2918 $newURL=t3lib_div::makeRedirectUrl($newURL,0,$index_script_url);
2919 break;
2920 case '76':
2921 $newURL=t3lib_div::makeRedirectUrl($newURL,76,$index_script_url);
2922 break;
2923 }
2924 $urlSplit[$c]=$newURL.substr($v,strlen($newParts[0]));
2925 }
2926 }
2927 #debug($urlSplit);
2928 $message=implode('',$urlSplit);
2929 return $message;
2930 }
2931
2932 /**
2933 * Subfunction for substUrlsInPlainText() above.
2934 *
2935 * Usage: 2
2936 *
2937 * @param string Input URL
2938 * @param integer URL string length limit
2939 * @param string
2940 * @return string Processed URL
2941 * @internal
2942 */
2943 function makeRedirectUrl($inUrl,$l=0,$index_script_url='') {
2944 if (strlen($inUrl)>$l) {
2945 $md5=substr(md5($inUrl),0,20);
2946 $query='SELECT md5hash FROM cache_md5params WHERE md5hash="'.$md5.'"';
2947 $res=mysql(TYPO3_db,$query);
2948 if (!mysql_num_rows($res)) {
2949 $query="INSERT INTO cache_md5params (md5hash,tstamp,type,params) VALUES ('".$md5."',".time().",2,'".addslashes($inUrl)."')";
2950 $res=mysql(TYPO3_db,$query);
2951 }
2952 $inUrl=($index_script_url ? $index_script_url : t3lib_div::getIndpEnv('TYPO3_REQUEST_DIR')).
2953 '?RDCT='.$md5;
2954 }
2955 return $inUrl;
2956 }
2957
2958 /**
2959 * Function to compensate for FreeType2 96 dpi
2960 *
2961 * Usage: 16
2962 *
2963 * @param integer Fontsize for freetype function call
2964 * @return integer Compensated fontsize based on $GLOBALS['TYPO3_CONF_VARS']['GFX']['TTFdpi']
2965 */
2966 function freetypeDpiComp($font_size) {
2967 $dpi = intval($GLOBALS['TYPO3_CONF_VARS']['GFX']['TTFdpi']);
2968 if ($dpi!=72) $font_size = $font_size/$dpi*72;
2969 return $font_size;
2970 }
2971 }
2972
2973
2974 ?>