Tons of changes made to the CORE. All scripts has more a less been modified. Primaril...
[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 * 807: function convUmlauts($str)
76 * 822: function shortMD5($input, $len=10)
77 * 834: function testInt($var)
78 * 847: function isFirstPartOfStr($str,$partStr)
79 * 863: function formatSize($sizeInBytes)
80 * 885: function convertMicrotime($microtime)
81 * 899: function splitCalc($string,$operators)
82 * 921: function calcPriority($string)
83 * 961: function calcParenthesis($string)
84 * 988: function htmlspecialchars_decode($value)
85 * 1002: function deHSCentities($str)
86 * 1015: function slashJS($string,$extended=0,$char="'")
87 * 1029: function rawUrlEncodeJS($str)
88 * 1041: function validEmail($email)
89 * 1056: function formatForTextarea($content)
90 *
91 * SECTION: ARRAY FUNCTIONS
92 * 1088: function inArray($in_array,$item)
93 * 1106: function intExplode($delim, $string)
94 * 1126: function revExplode($delim, $string, $count=0)
95 * 1147: function trimExplode($delim, $string, $onlyNonEmptyValues=0)
96 * 1172: function uniqueArray($valueArray)
97 * 1195: function removeArrayEntryByValue($array,$cmpValue)
98 * 1224: function implodeArrayForUrl($name,$theArray,$str='',$skipBlank=0,$rawurlencodeParamName=0)
99 * 1252: function compileSelectedGetVarsFromArray($varList,$getArray,$GPvarAlt=1)
100 * 1276: function addSlashesOnArray(&$theArray)
101 * 1301: function stripSlashesOnArray(&$theArray)
102 * 1324: function slashArray($arr,$cmd)
103 * 1341: function array_merge_recursive_overrule ($arr0,$arr1,$notAddKeys=0)
104 * 1371: function array_merge($arr1,$arr2)
105 * 1385: function csvValues($row,$delim=',',$quote='"')
106 *
107 * SECTION: HTML/XML PROCESSING
108 * 1428: function get_tag_attributes($tag)
109 * 1466: function split_tag_attributes($tag)
110 * 1500: function implodeParams($arr,$xhtmlSafe=0)
111 * 1528: function wrapJS($string, $linebreak=TRUE)
112 * 1557: function xml2tree($string,$depth=999)
113 * 1640: function array2xml($array,$NSprefix='',$level=0,$docTag='phparray',$spaceInd=0)
114 * 1698: function xml2array($string,$NSprefix='')
115 * 1757: function xmlRecompileFromStructValArray($vals)
116 * 1800: function xmlGetHeaderAttribs($xmlData)
117 *
118 * SECTION: FILES FUNCTIONS
119 * 1832: function getURL($url)
120 * 1875: function writeFile($file,$content)
121 * 1893: function get_dirs($path)
122 * 1919: function getFilesInDir($path,$extensionList='',$prependPath=0,$order='')
123 * 1964: function getAllFilesAndFoldersInPath($fileArr,$path,$extList='',$regDirs=0,$recursivityLevels=99)
124 * 1986: function removePrefixPathFromList($fileArr,$prefixToRemove)
125 * 2005: function upload_copy_move($source,$destination)
126 * 2023: function fixWindowsFilePath($theFile)
127 * 2033: function resolveBackPath($pathStr)
128 * 2061: function locationHeaderUrl($path)
129 *
130 * SECTION: DEBUG helper FUNCTIONS
131 * 2101: function debug_ordvalue($string,$characters=100)
132 * 2118: function view_array($array_in)
133 * 2146: function print_array($array_in)
134 * 2162: function debug($var="",$brOrHeader=0)
135 *
136 * SECTION: SYSTEM INFORMATION
137 * 2231: function getThisUrl()
138 * 2248: function linkThisScript($getParams=array())
139 * 2270: function linkThisUrl($url,$getParams=array())
140 * 2290: function getIndpEnv($getEnvName)
141 *
142 * SECTION: TYPO3 SPECIFIC FUNCTIONS
143 * 2504: function getFileAbsFileName($filename,$onlyRelative=1,$relToTYPO3_mainDir=0)
144 * 2539: function validPathStr($theFile)
145 * 2551: function isAbsPath($path)
146 * 2563: function isAllowedAbsPath($path)
147 * 2581: function verifyFilenameAgainstDenyPattern($filename)
148 * 2598: function stdAuthCode($uid_or_record,$fields='')
149 * 2632: function loadTCA($table)
150 * 2651: function resolveSheetDefInDS($dataStructArray,$sheet='sDEF')
151 * 2679: function resolveAllSheetsInDS($dataStructArray)
152 * 2708: function callUserFunction($funcName,&$params,&$ref,$checkPrefix='user_',$silent=0)
153 * 2748: function makeInstance($className)
154 * 2766: function makeInstanceService($serviceType, $serviceSubType='', $excludeServiceKeys='')
155 * 2801: function makeInstanceClassName($className)
156 * 2821: function plainMailEncoded($email,$subject,$message,$headers='',$enc='',$charset='ISO-8859-1',$dontEncodeSubject=0)
157 * 2868: function quoted_printable($string,$maxlen=76)
158 * 2911: function substUrlsInPlainText($message,$urlmode='76',$index_script_url='')
159 * 2946: function makeRedirectUrl($inUrl,$l=0,$index_script_url='')
160 * 2969: 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 boolean 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 Integer string to process
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 String from which the comma in the end (if any) will be removed.
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 or for HTML output, wrap your content in <span class="uppercase">...</span>)
786 * Usage: 4
787 *
788 * @param string String to process
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 * Works only for western europe single-byte charsets!
801 *
802 * ä => ae, Ö => Oe
803 *
804 * @param string String to convert.
805 * @return string
806 */
807 function convUmlauts($str) {
808 $pat = array ( '/ä/', '/Ä/', '/ö/', '/Ö/', '/ü/', '/Ü/', '/ß/', '/å/', '/Å/', '/ø/', '/Ø/', '/æ/', '/Æ/' );
809 $repl = array ( 'ae', 'Ae', 'oe', 'Oe', 'ue', 'Ue', 'ss', 'aa', 'AA', 'oe', 'OE', 'ae', 'AE' );
810 return preg_replace($pat,$repl,$str);
811 }
812
813 /**
814 * Returns the first 10 positions of the MD5-hash (changed from 6 to 10 recently)
815 *
816 * Usage: 43
817 *
818 * @param string Input string to be md5-hashed
819 * @param integer The string-length of the output
820 * @return string Substring of the resulting md5-hash, being $len chars long (from beginning)
821 */
822 function shortMD5($input, $len=10) {
823 return substr(md5($input),0,$len);
824 }
825
826 /**
827 * Tests if the input is an integer.
828 *
829 * Usage: 74
830 *
831 * @param mixed Any input variable to test.
832 * @return boolean Returns true if string is an integer
833 */
834 function testInt($var) {
835 return !strcmp($var,intval($var));
836 }
837
838 /**
839 * Returns true if the first part of $str matches the string $partStr
840 *
841 * Usage: 58
842 *
843 * @param string Full string to check
844 * @param string Reference string which must be found as the "first part" of the full string
845 * @return boolean True if $partStr was found to be equal to the first part of $str
846 */
847 function isFirstPartOfStr($str,$partStr) {
848 // Returns true, if the first part of a $str equals $partStr and $partStr is not ''
849 $psLen = strlen($partStr);
850 if ($psLen) {
851 return substr($str,0,$psLen)==(string)$partStr;
852 } else return false;
853 }
854
855 /**
856 * Formats the input integer $sizeInBytes as bytes/kilobytes/megabytes (-/K/M)
857 *
858 * Usage: 54
859 *
860 * @param integer Number of bytes to format.
861 * @return string Formatted representation of the byte number, for output.
862 */
863 function formatSize($sizeInBytes) {
864 if ($sizeInBytes>900) {
865 if ($sizeInBytes>900000) { // MB
866 $val = $sizeInBytes/(1024*1024);
867 return number_format($val, (($val<20)?1:0), '.', '').' M';
868 } else { // KB
869 $val = $sizeInBytes/(1024);
870 return number_format($val, (($val<20)?1:0), '.', '').' K';
871 }
872 } else { // Bytes
873 return $sizeInBytes.'&nbsp;&nbsp;';
874 }
875 }
876
877 /**
878 * Returns microtime input to milliseconds
879 *
880 * Usage: 2
881 *
882 * @param string Microtime
883 * @return integer Microtime input string converted to an integer (milliseconds)
884 */
885 function convertMicrotime($microtime) {
886 $parts = explode(' ',$microtime);
887 return round(($parts[0]+$parts[1])*1000);
888 }
889
890 /**
891 * This splits a string by the chars in $operators (typical /+-*) and returns an array with them in
892 * Usage: 2
893 *
894 * @param string Input string, eg "123 + 456 / 789 - 4"
895 * @param string Operators to split by, typically "/+-*"
896 * @return array Array with operators and operands separated.
897 * @see tslib_cObj::calc(), tslib_gifBuilder::calcOffset()
898 */
899 function splitCalc($string,$operators) {
900 $res = Array();
901 $sign='+';
902 while($string) {
903 $valueLen=strcspn($string,$operators);
904 $value=substr($string,0,$valueLen);
905 $res[] = Array($sign,trim($value));
906 $sign=substr($string,$valueLen,1);
907 $string=substr($string,$valueLen+1);
908 }
909 reset($res);
910 return $res;
911 }
912
913 /**
914 * Calculates the input by +,-,*,/,%,^ with priority to + and -
915 * Usage: 1
916 *
917 * @param string Input string, eg "123 + 456 / 789 - 4"
918 * @return integer Calculated value. Or error string.
919 * @see calcParenthesis()
920 */
921 function calcPriority($string) {
922 $string=ereg_replace('[[:space:]]*','',$string); // removing all whitespace
923 $string='+'.$string; // Ensuring an operator for the first entrance
924 $qm='\*\/\+-^%';
925 $regex = '(['.$qm.'])(['.$qm.']?[0-9\.]*)';
926 // split the expression here:
927 preg_match_all('/'.$regex.'/',$string,$reg);
928
929 reset($reg[2]);
930 $number=0;
931 $Msign='+';
932 $err='';
933 $buffer=doubleval(current($reg[2]));
934 next($reg[2]); // Advance pointer
935 while(list($k,$v)=each($reg[2])) {
936 $v=doubleval($v);
937 $sign = $reg[1][$k];
938 if ($sign=='+' || $sign=='-') {
939 $number = $Msign=='-' ? $number-=$buffer : $number+=$buffer;
940 $Msign = $sign;
941 $buffer=$v;
942 } else {
943 if ($sign=='/') {if ($v) $buffer/=$v; else $err='dividing by zero';}
944 if ($sign=='%') {if ($v) $buffer%=$v; else $err='dividing by zero';}
945 if ($sign=='*') {$buffer*=$v;}
946 if ($sign=='^') {$buffer=pow($buffer,$v);}
947 }
948 }
949 $number = $Msign=='-' ? $number-=$buffer : $number+=$buffer;
950 return $err ? 'ERROR: '.$err : $number;
951 }
952
953 /**
954 * Calculates the input with parenthesis levels
955 * Usage: 2
956 *
957 * @param string Input string, eg "(123 + 456) / 789 - 4"
958 * @return integer Calculated value. Or error string.
959 * @see calcPriority(), tslib_cObj::stdWrap()
960 */
961 function calcParenthesis($string) {
962 $securC=100;
963 do {
964 $valueLenO=strcspn($string,'(');
965 $valueLenC=strcspn($string,')');
966 if ($valueLenC==strlen($string) || $valueLenC < $valueLenO) {
967 $value = t3lib_div::calcPriority(substr($string,0,$valueLenC));
968 $string = $value.substr($string,$valueLenC+1);
969 return $string;
970 } else {
971 $string = substr($string,0,$valueLenO).t3lib_div::calcParenthesis(substr($string,$valueLenO+1));
972 }
973 // Security:
974 $securC--;
975 if ($securC<=0) break;
976 } while($valueLenO<strlen($string));
977 return $string;
978 }
979
980 /**
981 * Inverse version of htmlspecialchars()
982 *
983 * Usage: 2
984 *
985 * @param string Value where &gt;, &lt;, &quot; and &amp; should be converted to regular chars.
986 * @return string Converted result.
987 */
988 function htmlspecialchars_decode($value) {
989 $value = str_replace('&gt;','>',$value);
990 $value = str_replace('&lt;','<',$value);
991 $value = str_replace('&quot;','"',$value);
992 $value = str_replace('&amp;','&',$value);
993 return $value;
994 }
995
996 /**
997 * Re-converts HTML entities if they have been converted by htmlspecialchars()
998 *
999 * @param string String which contains eg. "&amp;amp;" which should stay "&amp;". Or "&amp;#1234;" to "&#1234;". Or "&amp;#x1b;" to "&#x1b;"
1000 * @return string Converted result.
1001 */
1002 function deHSCentities($str) {
1003 return ereg_replace('&amp;([#[:alnum:]]*;)','&\1',$str);
1004 }
1005
1006 /**
1007 * This function is used to escape any ' -characters when transferring text to JavaScript!
1008 * Usage: 6
1009 *
1010 * @param string String to escape
1011 * @param boolean If set, also backslashes are escaped.
1012 * @param string The character to escape, default is ' (single-quote)
1013 * @return string Processed input string
1014 */
1015 function slashJS($string,$extended=0,$char="'") {
1016 if ($extended) {$string = str_replace ("\\", "\\\\", $string);}
1017 return str_replace ($char, "\\".$char, $string);
1018 }
1019
1020 /**
1021 * Version of rawurlencode() where all spaces (%20) are re-converted to space-characters.
1022 * Usefull when passing text to JavaScript where you simply url-encode it to get around problems with syntax-errors, linebreaks etc.
1023 *
1024 * Usage: 8
1025 *
1026 * @param string String to raw-url-encode with spaces preserved
1027 * @return string Rawurlencoded result of input string, but with all %20 (space chars) converted to real spaces.
1028 */
1029 function rawUrlEncodeJS($str) {
1030 return str_replace('%20',' ',rawurlencode($str));
1031 }
1032
1033 /**
1034 * Checking syntax of input email address
1035 *
1036 * Usage: 4
1037 *
1038 * @param string Input string to evaluate
1039 * @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.
1040 */
1041 function validEmail($email) {
1042 if (strstr($email,' ')) return 0;
1043 return ereg('^[A-Za-z0-9\._-]*[@][A-Za-z0-9\._-]*[\.].[A-Za-z0-9]*$',$email) ? 1 : 0;
1044 }
1045
1046 /**
1047 * Formats a string for output between <textarea>-tags
1048 * All content outputted in a textarea form should be passed through this function
1049 * 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!
1050 *
1051 * Usage: 30
1052 *
1053 * @param string Input string to be formatted.
1054 * @return string Formatted for <textarea>-tags
1055 */
1056 function formatForTextarea($content) {
1057 return chr(10).htmlspecialchars($content);
1058 }
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071 /*************************
1072 *
1073 * ARRAY FUNCTIONS
1074 *
1075 *************************/
1076
1077 /**
1078 * Check if an item exists in an array
1079 * Please note that the order of parameters is reverse compared to the php4-function in_array()!!!
1080 *
1081 * Usage: 3
1082 *
1083 * @param array $in_array one-dimensional array of items
1084 * @param string $item item to check for
1085 * @return boolean true if $item is in the one-dimensional array $in_array
1086 * @internal
1087 */
1088 function inArray($in_array,$item) {
1089 if (is_array($in_array)) {
1090 while (list(,$val)=each($in_array)) {
1091 if (!is_array($val) && !strcmp($val,$item)) return true;
1092 }
1093 }
1094 }
1095
1096 /**
1097 * Explodes a $string delimited by $delim and passes each item in the array through intval().
1098 * Corresponds to explode(), but with conversion to integers for all values.
1099 *
1100 * Usage: 86
1101 *
1102 * @param string Delimiter string to explode with
1103 * @param string The string to explode
1104 * @return array Exploded values, all converted to integers
1105 */
1106 function intExplode($delim, $string) {
1107 $temp = explode($delim,$string);
1108 while(list($key,$val)=each($temp)) {
1109 $temp[$key]=intval($val);
1110 }
1111 reset($temp);
1112 return $temp;
1113 }
1114
1115 /**
1116 * Reverse explode which explodes the string counting from behind.
1117 * Thus t3lib_div::revExplode(':','my:words:here',2) will return array('my:words','here')
1118 *
1119 * Usage: 6
1120 *
1121 * @param string Delimiter string to explode with
1122 * @param string The string to explode
1123 * @param integer Number of array entries
1124 * @return array Exploded values
1125 */
1126 function revExplode($delim, $string, $count=0) {
1127 $temp = explode($delim,strrev($string),$count);
1128 while(list($key,$val)=each($temp)) {
1129 $temp[$key]=strrev($val);
1130 }
1131 $temp=array_reverse($temp);
1132 reset($temp);
1133 return $temp;
1134 }
1135
1136 /**
1137 * Explodes a string and trims all values for whitespace in the ends.
1138 * If $onlyNonEmptyValues is set, then all blank ('') values are removed.
1139 *
1140 * Usage: 239
1141 *
1142 * @param string Delimiter string to explode with
1143 * @param string The string to explode
1144 * @param boolean If set, all empty values (='') will NOT be set in output
1145 * @return array Exploded values
1146 */
1147 function trimExplode($delim, $string, $onlyNonEmptyValues=0) {
1148 $temp = explode($delim,$string);
1149 $newtemp=array();
1150 while(list($key,$val)=each($temp)) {
1151 if (!$onlyNonEmptyValues || strcmp('',trim($val))) {
1152 $newtemp[]=trim($val);
1153 }
1154 }
1155 reset($newtemp);
1156 return $newtemp;
1157 }
1158
1159 /**
1160 * Takes a one-dimensional array and returns an array where the values are unique
1161 * The keys in the array are substituted with some md5-hashes
1162 * If the value is trim(empty), the value is ignored.
1163 * Values are trimmed
1164 * (Depreciated, use PHP function array_unique instead)
1165 * Usage: 2
1166 *
1167 * @param array Array of values to make unique
1168 * @return array
1169 * @ignore
1170 * @depreciated
1171 */
1172 function uniqueArray($valueArray) {
1173 $array_out=array();
1174 if (is_array($valueArray)) {
1175 while (list($key,$val)=each($valueArray)) {
1176 $val=trim($val);
1177 if ((string)$val!='') {
1178 $array_out[md5($val)]=$val;
1179 }
1180 }
1181 }
1182 reset($array_out);
1183 return $array_out;
1184 }
1185
1186 /**
1187 * Removes the value $cmpValue from the $array if found there. Returns the modified array
1188 *
1189 * Usage: 2
1190 *
1191 * @param array Array containing the values
1192 * @param string Value to search for and if found remove array entry where found.
1193 * @return array Output array with entries removed if search string is found
1194 */
1195 function removeArrayEntryByValue($array,$cmpValue) {
1196 if (is_array($array)) {
1197 reset($array);
1198 while(list($k,$v)=each($array)) {
1199 if (is_array($v)) {
1200 $array[$k] = t3lib_div::removeArrayEntryByValue($v,$cmpValue);
1201 } else {
1202 if (!strcmp($v,$cmpValue)) {
1203 unset($array[$k]);
1204 }
1205 }
1206 }
1207 }
1208 reset($array);
1209 return $array;
1210 }
1211
1212 /**
1213 * Implodes a multidim-array into GET-parameters (eg. &param[key][key2]=value2&param[key][key3]=value3)
1214 *
1215 * Usage: 24
1216 *
1217 * @param string Name prefix for entries. Set to blank if you wish none.
1218 * @param array The (multidim) array to implode
1219 * @param boolean If set, all values that are blank (='') will NOT be imploded
1220 * @param boolean If set, parameters which were blank strings would be removed.
1221 * @param boolean If set, the param name itselt (for example "param[key][key2]") would be rawurlencoded as well.
1222 * @return string Imploded result, fx. &param[key][key2]=value2&param[key][key3]=value3
1223 */
1224 function implodeArrayForUrl($name,$theArray,$str='',$skipBlank=0,$rawurlencodeParamName=0) {
1225 if (is_array($theArray)) {
1226 reset($theArray);
1227 while(list($Akey,$AVal)=each($theArray)) {
1228 $thisKeyName = $name ? $name.'['.$Akey.']' : $Akey;
1229 if (is_array($AVal)) {
1230 $str=t3lib_div::implodeArrayForUrl($thisKeyName,$AVal,$str,$skipBlank,$rawurlencodeParamName);
1231 } else {
1232 if (!$skipBlank || strcmp($AVal,'')) {
1233 $str.='&'.($rawurlencodeParamName ? rawurlencode($thisKeyName) : $thisKeyName).
1234 '='.rawurlencode(stripslashes($AVal)); // strips slashes because HTTP_POST_VARS / GET_VARS input is with slashes...
1235 }
1236 }
1237 }
1238 }
1239 return $str;
1240 }
1241
1242 /**
1243 * Returns an array with selected keys from incoming data.
1244 * (Better read source code if you want to find out...)
1245 * Usage: 3
1246 *
1247 * @param string List of variable/key names
1248 * @param array Array from where to get values based on the keys in $varList
1249 * @param boolean If set, then t3lib_div::GPvar() is used to fetch the value if not found (isset) in the $getArray
1250 * @return array Output array with selected variables.
1251 */
1252 function compileSelectedGetVarsFromArray($varList,$getArray,$GPvarAlt=1) {
1253 $keys = t3lib_div::trimExplode(',',$varList,1);
1254 $outArr=array();
1255 while(list(,$v)=each($keys)) {
1256 if (isset($getArray[$v])) {
1257 $outArr[$v]=$getArray[$v];
1258 } elseif ($GPvarAlt) {
1259 $outArr[$v]=t3lib_div::GPvar($v);
1260 }
1261 }
1262 return $outArr;
1263 }
1264
1265 /**
1266 * AddSlash array
1267 * This function traverses a multidimentional array and adds slashes to the values.
1268 * NOTE that the input array is and argument by reference.!!
1269 * Twin-function to stripSlashesOnArray
1270 *
1271 * Usage: 6
1272 *
1273 * @param array Multidimensional input array, (REFERENCE!)
1274 * @return array
1275 */
1276 function addSlashesOnArray(&$theArray) {
1277 if (is_array($theArray)) {
1278 reset($theArray);
1279 while(list($Akey,$AVal)=each($theArray)) {
1280 if (is_array($AVal)) {
1281 t3lib_div::addSlashesOnArray($theArray[$Akey]);
1282 } else {
1283 $theArray[$Akey] = addslashes($AVal);
1284 }
1285 }
1286 reset($theArray);
1287 }
1288 }
1289
1290 /**
1291 * StripSlash array
1292 * This function traverses a multidimentional array and strips slashes to the values.
1293 * NOTE that the input array is and argument by reference.!!
1294 * Twin-function to addSlashesOnArray
1295 *
1296 * Usage: 7
1297 *
1298 * @param array Multidimensional input array, (REFERENCE!)
1299 * @return array
1300 */
1301 function stripSlashesOnArray(&$theArray) {
1302 if (is_array($theArray)) {
1303 reset($theArray);
1304 while(list($Akey,$AVal)=each($theArray)) {
1305 if (is_array($AVal)) {
1306 t3lib_div::stripSlashesOnArray($theArray[$Akey]);
1307 } else {
1308 $theArray[$Akey] = stripslashes($AVal);
1309 }
1310 }
1311 reset($theArray);
1312 }
1313 }
1314
1315 /**
1316 * Either slashes ($cmd=add) or strips ($cmd=strip) array $arr depending on $cmd
1317 *
1318 * Usage: 6
1319 *
1320 * @param array Multidimensional input array
1321 * @param string "add" or "strip", depending on usage you wish.
1322 * @return array
1323 */
1324 function slashArray($arr,$cmd) {
1325 if ($cmd=='strip') t3lib_div::stripSlashesOnArray($arr);
1326 if ($cmd=='add') t3lib_div::addSlashesOnArray($arr);
1327 return $arr;
1328 }
1329
1330 /**
1331 * Merges two arrays recursively, overruling similar the values in the first array ($arr0) with the values of the second array ($arr1)
1332 * In case of identical keys, ie. keeping the values of the second.
1333 *
1334 * Usage: 26
1335 *
1336 * @param array First array
1337 * @param array Second array, overruling the first array
1338 * @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.
1339 * @return array Resulting array where $arr1 values has overruled $arr0 values
1340 */
1341 function array_merge_recursive_overrule ($arr0,$arr1,$notAddKeys=0) {
1342 reset($arr1);
1343 while(list($key,$val) = each($arr1)) {
1344 if(is_array($arr0[$key])) {
1345 if (is_array($arr1[$key])) {
1346 $arr0[$key] = t3lib_div::array_merge_recursive_overrule($arr0[$key],$arr1[$key],$notAddKeys);
1347 }
1348 } else {
1349 if ($notAddKeys) {
1350 if (isset($arr0[$key])) {
1351 $arr0[$key] = $val;
1352 }
1353 } else {
1354 $arr0[$key] = $val;
1355 }
1356 }
1357 }
1358 reset($arr0);
1359 return $arr0;
1360 }
1361
1362 /**
1363 * An array_merge function where the keys are NOT renumbered as they happen to be with the real php-array_merge function
1364 *
1365 * Usage: 27
1366 *
1367 * @param array First array
1368 * @param array Second array
1369 * @return array Merged result.
1370 */
1371 function array_merge($arr1,$arr2) {
1372 return $arr2+$arr1;
1373 }
1374
1375 /**
1376 * Takes a row and returns a CSV string of the values with $delim (default is ,) and $quote (default is ") as separator chars.
1377 *
1378 * Usage: 5
1379 *
1380 * @param array Input array of values
1381 * @param string Delimited, default is comman
1382 * @param string Quote-character to wrap around the values.
1383 * @return string A single line of CSV
1384 */
1385 function csvValues($row,$delim=',',$quote='"') {
1386 reset($row);
1387 $out=array();
1388 while(list(,$value)=each($row)) {
1389 list($valPart) = explode(chr(10),$value);
1390 $valPart = trim($valPart);
1391 $out[]=str_replace($quote,$quote.$quote,$valPart);
1392 }
1393 $str = $quote.implode($quote.$delim.$quote,$out).$quote;
1394 return $str;
1395 }
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412 /*************************
1413 *
1414 * HTML/XML PROCESSING
1415 *
1416 *************************/
1417
1418 /**
1419 * $tag is either a whole tag (eg '<TAG OPTION ATTRIB=VALUE>') or the parameterlist (ex ' OPTION ATTRIB=VALUE>')
1420 * Returns an array with all attributes as keys. Attributes are only lowercase a-z
1421 * 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()
1422 *
1423 * Usage: 9
1424 *
1425 * @param string HTML-tag string (or attributes only)
1426 * @return array Array with the attribute values.
1427 */
1428 function get_tag_attributes($tag) {
1429 $components = t3lib_div::split_tag_attributes($tag);
1430 $name = ''; // attribute name is stored here
1431 $valuemode = '';
1432 if (is_array($components)) {
1433 while (list($key,$val) = each ($components)) {
1434 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
1435 if ($valuemode) {
1436 if ($name) {
1437 $attributes[$name] = $val;
1438 $name = '';
1439 }
1440 } else {
1441 if ($key = strtolower(ereg_replace('[^a-zA-Z0-9]','',$val))) {
1442 $attributes[$key] = '';
1443 $name = $key;
1444 }
1445 }
1446 $valuemode = '';
1447 } else {
1448 $valuemode = 'on';
1449 }
1450 }
1451 if (is_array($attributes)) reset($attributes);
1452 return $attributes;
1453 }
1454 }
1455
1456 /**
1457 * Returns an array with the 'components' from an attribute list from an HTML tag. The result is normally analyzed by get_tag_attributes
1458 * Removes tag-name if found
1459 *
1460 * Usage: 1
1461 *
1462 * @param string HTML-tag string (or attributes only)
1463 * @return array Array with the attribute values.
1464 * @internal
1465 */
1466 function split_tag_attributes($tag) {
1467 $tag_tmp = trim(eregi_replace ('^<[^[:space:]]*','',trim($tag)));
1468 // Removes any > in the end of the string
1469 $tag_tmp = trim(eregi_replace ('>$','',$tag_tmp));
1470
1471 while (strcmp($tag_tmp,'')) { // Compared with empty string instead , 030102
1472 $firstChar=substr($tag_tmp,0,1);
1473 if (!strcmp($firstChar,'"') || !strcmp($firstChar,"'")) {
1474 $reg=explode($firstChar,$tag_tmp,3);
1475 $value[]=$reg[1];
1476 $tag_tmp=trim($reg[2]);
1477 } elseif (!strcmp($firstChar,'=')) {
1478 $value[] = '=';
1479 $tag_tmp = trim(substr($tag_tmp,1)); // Removes = chars.
1480 } else {
1481 // There are '' around the value. We look for the next ' ' or '>'
1482 $reg = split('[[:space:]=]',$tag_tmp,2);
1483 $value[] = trim($reg[0]);
1484 $tag_tmp = trim(substr($tag_tmp,strlen($reg[0]),1).$reg[1]);
1485 }
1486 }
1487 if (is_array($value)) reset($value);
1488 return $value;
1489 }
1490
1491 /**
1492 * Implodes attributes in the array $arr for an attribute list in eg. and HTML tag (with quotes)
1493 *
1494 * Usage: 10
1495 *
1496 * @param array Array with attribute key/value pairs, eg. "bgcolor"=>"red", "border"=>0
1497 * @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!
1498 * @return string Imploded attributes, eg. 'bgcolor="red" border="0"'
1499 */
1500 function implodeParams($arr,$xhtmlSafe=0) {
1501 if (is_array($arr)) {
1502 if ($xhtmlSafe) {
1503 $newArr=array();
1504 foreach($arr as $p => $v) {
1505 if (!isset($newArr[strtolower($p)])) $newArr[strtolower($p)] = htmlspecialchars($v);
1506 }
1507 $arr = $newArr;
1508 }
1509 $list = array();
1510 foreach($arr as $p => $v) {
1511 if (strcmp($v,'')) {$list[]=$p.'="'.$v.'"';}
1512 }
1513 return implode(' ',$list);
1514 }
1515 }
1516
1517 /**
1518 * Wraps JavaScript code XHTML ready with <script>-tags
1519 * Automatic re-identing of the JS code is done by using the first line as ident reference.
1520 * This is nice for identing JS code with PHP code on the same level.
1521 *
1522 * @param string JavaScript code
1523 * @param boolean Wrap script element in linebreaks? Default is TRUE.
1524 * @return string The wrapped JS code, ready to put into a XHTML page
1525 * @author Ingmar Schlecht <ingmars@web.de>
1526 * @author René Fritz <r.fritz@colorcube.de>
1527 */
1528 function wrapJS($string, $linebreak=TRUE) {
1529 if(trim($string)) {
1530 // <script wrapped in nl?
1531 $cr = $linebreak? "\n" : '';
1532
1533 // remove nl from the beginning
1534 $string = preg_replace ('/^\n+/', '', $string);
1535 // re-ident to one tab using the first line as reference
1536 if(preg_match('/^(\t+)/',$string,$match)) {
1537 $string = str_replace($match[1],"\t", $string);
1538 }
1539 $string = $cr.'<script type="text/javascript">
1540 /*<![CDATA[*/
1541 '.$string.'
1542 /*]]>*/
1543 </script>'.$cr;
1544 }
1545 return trim($string);
1546 }
1547
1548
1549 /**
1550 * Parses XML input into a PHP array with associative keys
1551 *
1552 * @param string XML data input
1553 * @param integer Number of element levels to resolve the XML into an array. Any further structure will be set as XML.
1554 * @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.
1555 * @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
1556 */
1557 function xml2tree($string,$depth=999) {
1558 $parser = xml_parser_create();
1559 $vals = array();
1560 $index = array();
1561
1562 xml_parser_set_option($parser, XML_OPTION_CASE_FOLDING, 0);
1563 xml_parser_set_option($parser, XML_OPTION_SKIP_WHITE, 0);
1564 xml_parse_into_struct($parser, $string, $vals, $index);
1565
1566 if (xml_get_error_code($parser)) return 'Line '.xml_get_current_line_number($parser).': '.xml_error_string(xml_get_error_code($parser));
1567 xml_parser_free($parser);
1568
1569 $stack = array( array() );
1570 $stacktop = 0;
1571 $startPoint=0;
1572
1573 unset($tagi);
1574 foreach($vals as $key => $val) {
1575 $type = $val['type'];
1576
1577 // open tag:
1578 if ($type=='open' || $type=='complete') {
1579 $stack[$stacktop++] = $tagi;
1580
1581 if ($depth==$stacktop) {
1582 $startPoint=$key;
1583 }
1584
1585 $tagi = array('tag' => $val['tag']);
1586
1587 if(isset($val['attributes'])) $tagi['attrs'] = $val['attributes'];
1588 if(isset($val['value'])) $tagi['values'][] = $val['value'];
1589 }
1590 // finish tag:
1591 if ($type=='complete' || $type=='close') {
1592 $oldtagi = $tagi;
1593 $tagi = $stack[--$stacktop];
1594 $oldtag = $oldtagi['tag'];
1595 unset($oldtagi['tag']);
1596
1597 if ($depth==($stacktop+1)) {
1598 if ($key-$startPoint > 0) {
1599 $partArray = array_slice(
1600 $vals,
1601 $startPoint+1,
1602 $key-$startPoint-1
1603 );
1604 #$oldtagi=array('XMLvalue'=>t3lib_div::xmlRecompileFromStructValArray($partArray));
1605 $oldtagi['XMLvalue']=t3lib_div::xmlRecompileFromStructValArray($partArray);
1606 } else {
1607 $oldtagi['XMLvalue']=$oldtagi['values'][0];
1608 }
1609 }
1610
1611 $tagi['ch'][$oldtag][] = $oldtagi;
1612 unset($oldtagi);
1613 }
1614 // cdata
1615 if($type=='cdata') {
1616 $tagi['values'][] = $val['value'];
1617 }
1618 }
1619 return $tagi['ch'];
1620 }
1621
1622 /**
1623 * Converts a PHP array into an XML file.
1624 * The XML output is optimized for readability since associative keys are used as fieldnames.
1625 * This also means that only alphanumeric characters are allowed in the tag names AND only keys NOT starting with numbers (so watch your usage of keys!)
1626 * Numeric keys are converted to "n"+int (which means you should not use this kind of associative key otherwise)
1627 * 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
1628 * The PHP variable type of the data is NOT preserved; integers will become strings, but arrays will stay arrays of course.
1629 * The output XML has been tested with the PHP XML-parser and parses OK under all tested circumstances.
1630 * 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...
1631 *
1632 * @param array The input PHP array with any kind of data; text, binary, integers. Not objects though.
1633 * @param string tag-prefix, eg. a namespace prefix like "T3:"
1634 * @param integer Current recursion level. Don't change, stay at zero!
1635 * @param string Alternative document tag. Default is "phparray".
1636 * @param integer If set, the number of spaces corresponding to this number is used for indenting, otherwise a single chr(9) (TAB) is used
1637 * @return string An XML string made from the input content in the array.
1638 * @see xml2array()
1639 */
1640 function array2xml($array,$NSprefix='',$level=0,$docTag='phparray',$spaceInd=0) {
1641 // 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
1642 $binaryChars = chr(0).chr(1).chr(2).chr(3).chr(4).chr(5).chr(6).chr(7).chr(8).
1643 chr(11).chr(12).chr(14).chr(15).chr(16).chr(17).chr(18).chr(19).
1644 chr(20).chr(21).chr(22).chr(23).chr(24).chr(25).chr(26).chr(27).chr(28).chr(29).
1645 chr(30).chr(31);
1646 $indentChar = $spaceInd ? ' ' : chr(9);
1647 $indentN = $spaceInd>0 ? $spaceInd : 1;
1648
1649 // Init output variable
1650 $output='';
1651 // Traverse the input array
1652 foreach($array as $k=>$v) {
1653 $attr='';
1654 // If the value is an array then we will call this function recursively:
1655 if (is_array($v)) {
1656 // Sub elements:
1657 $content = chr(10).t3lib_div::array2xml($v,$NSprefix,$level+1,'',$spaceInd).
1658 str_pad('',($level+1)*$indentN,$indentChar);
1659 } else { // Just a value:
1660 // Look for binary chars:
1661 if (strspn($v,$binaryChars)) {
1662 // If the value contained binary chars then we base64-encode it an set an attribute to notify this situation:
1663 $content = chr(10).chunk_split(base64_encode($v));
1664 $attr=' base64="1"';
1665 } else {
1666 // Otherwise, just htmlspecialchar the stuff:
1667 $content = htmlspecialchars($v);
1668 }
1669 }
1670 // 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.
1671 if (!strcmp(intval($k),$k)) $k='n'.$k;
1672 $kn = substr(ereg_replace('[^[:alnum:]_-]','',$k),0,100);
1673
1674 // Add the element to the output string:
1675 $output.=str_pad('',($level+1)*$indentN,$indentChar).'<'.$NSprefix.$kn.$attr.'>'.$content.'</'.$NSprefix.$kn.'>'.chr(10);
1676 }
1677
1678 // If we are at the outer-most level, then we finally wrap it all in the document tags and return that as the value:
1679 if (!$level) {
1680 $output =
1681 '<'.$docTag.'>'.chr(10).
1682 $output.
1683 '</'.$docTag.'>';
1684 }
1685
1686 return $output;
1687 }
1688
1689 /**
1690 * Converts an XML file to a PHP array.
1691 * This is the inverse function of array2xml()
1692 *
1693 * @param string XML content to convert into an array
1694 * @param string The tag-prefix resolve, eg. a namespace like "T3:"
1695 * @return mixed If the parsing had errors, a string with the error message is returned. Otherwise an array with the content.
1696 * @see array2xml()
1697 */
1698 function xml2array($string,$NSprefix='') {
1699 // Create parser:
1700 $parser = xml_parser_create();
1701 $vals = array();
1702 $index = array();
1703
1704 xml_parser_set_option($parser, XML_OPTION_CASE_FOLDING, 0);
1705 xml_parser_set_option($parser, XML_OPTION_SKIP_WHITE, 0);
1706 xml_parse_into_struct($parser, $string, $vals, $index);
1707
1708 // If error, return error message:
1709 if (xml_get_error_code($parser)) return 'Line '.xml_get_current_line_number($parser).': '.xml_error_string(xml_get_error_code($parser));
1710 xml_parser_free($parser);
1711
1712 // Init vars:
1713 $stack = array(array());
1714 $stacktop = 0;
1715 $current=array();
1716 $tagName='';
1717
1718 // Traverse the parsed XML structure:
1719 foreach($vals as $key => $val) {
1720
1721 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:
1722 $stack[$stacktop++] = $current;
1723 $current=array();
1724
1725 } 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.
1726 // First, process the tag-name (which is used in both cases, whether "complete" or "close")
1727 $tagName = $val['tag'];
1728 // Test for name space:
1729 $tagName = ($NSprefix && substr($tagName,0,strlen($NSprefix))==$NSprefix) ? substr($tagName,strlen($NSprefix)) : $tagName;
1730 // Test for numeric tag:
1731 $testNtag = substr($tagName,1); // Closing tag.
1732 $tagName = (substr($tagName,0,1)=='n' && !strcmp(intval($testNtag),$testNtag)) ? intval($testNtag) : $tagName;
1733
1734
1735 if ($val['type']=='complete') { // If "complete", then its a value. If the attribute "base64" is set, then decode the value, otherwise just set it.
1736 if ($val['attributes']['base64']) {
1737 $current[$tagName] = base64_decode($val['value']);
1738 } else $current[$tagName] = $val['value'];
1739 } else { // Implicit "close": Manage the stack...
1740 $oldCurrent = $current;
1741 $current = $stack[--$stacktop];
1742 $current[$tagName]=$oldCurrent;
1743 unset($oldCurrent);
1744 }
1745 }
1746 }
1747 // Finally return the content of the document tag.
1748 return $current[$tagName];
1749 }
1750
1751 /**
1752 * This implodes an array of XML parts (made with xml_parse_into_struct()) into XML again.
1753 *
1754 * @param array A array of XML parts, see xml2tree
1755 * @return string Re-compiled XML data.
1756 */
1757 function xmlRecompileFromStructValArray($vals) {
1758 $XMLcontent='';
1759
1760 foreach($vals as $val) {
1761 $type = $val['type'];
1762
1763 // open tag:
1764 if ($type=='open' || $type=='complete') {
1765 $XMLcontent.='<'.$val['tag'];
1766 if(isset($val['attributes'])) {
1767 foreach($val['attributes'] as $k => $v) {
1768 $XMLcontent.=' '.$k.'="'.htmlspecialchars($v).'"';
1769 }
1770 }
1771 if ($type=='complete') {
1772 if(isset($val['value'])) {
1773 $XMLcontent.='>'.htmlspecialchars($val['value']).'</'.$val['tag'].'>';
1774 } else $XMLcontent.='/>';
1775 } else $XMLcontent.='>';
1776
1777 if ($type=='open' && isset($val['value'])) {
1778 $XMLcontent.=htmlspecialchars($val['value']);
1779 }
1780 }
1781 // finish tag:
1782 if ($type=='close') {
1783 $XMLcontent.='</'.$val['tag'].'>';
1784 }
1785 // cdata
1786 if($type=='cdata') {
1787 $XMLcontent.=htmlspecialchars($val['value']);
1788 }
1789 }
1790
1791 return $XMLcontent;
1792 }
1793
1794 /**
1795 * Extract the encoding scheme as found in the first line of an XML document (typically)
1796 *
1797 * @param string XML data
1798 * @return string Encoding scheme (lowercase), if found.
1799 */
1800 function xmlGetHeaderAttribs($xmlData) {
1801 $xmlHeader = substr(trim($xmlData),0,200);
1802 $reg=array();
1803 if (eregi('^<\?xml([^>]*)\?\>',$xmlHeader,$reg)) {
1804 return t3lib_div::get_tag_attributes($reg[1]);
1805 }
1806 }
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818 /*************************
1819 *
1820 * FILES FUNCTIONS
1821 *
1822 *************************/
1823
1824 /**
1825 * Reads the file or url $url and returns the content
1826 *
1827 * Usage: 79
1828 *
1829 * @param string Filepath/URL to read
1830 * @return string The content from the resource given as input.
1831 */
1832 function getURL($url) {
1833 $content = '';
1834
1835 // (Proxy support implemented by Arco <arco@appeltaart.mine.nu>)
1836 if((substr($url,0,7)=='http://') && ($GLOBALS['TYPO3_CONF_VARS']['SYS']['curlUse']=='1')) {
1837 //external URL without error checking.
1838 $ch = curl_init();
1839 curl_setopt ($ch,CURLOPT_URL, $url);
1840 curl_setopt ($ch,CURLOPT_HEADER, 0);
1841 curl_setopt ($ch,CURLOPT_RETURNTRANSFER, 1);
1842
1843 if ($GLOBALS['TYPO3_CONF_VARS']['SYS']['curlProxyServer']) {
1844 curl_setopt ($ch, CURLOPT_PROXY, $GLOBALS['TYPO3_CONF_VARS']['SYS']['curlProxyServer']);
1845
1846 // I don't know if it will be needed
1847 if ($GLOBALS['TYPO3_CONF_VARS']['SYS']['curlProxyTunnel']) {
1848 curl_setopt ($ch, CURLOPT_HTTPPROXYTUNNEL, $GLOBALS['TYPO3_CONF_VARS']['SYS']['curlProxyTunnel'] );
1849 }
1850 if ($GLOBALS['TYPO3_CONF_VARS']['SYS']['curlProxyUserPass']) {
1851 curl_setopt ($ch, CURLOPT_PROXYUSERPWD, $GLOBALS['TYPO3_CONF_VARS']['SYS']['curlProxyUserPass'] );
1852 }
1853 }
1854 $content=curl_exec ($ch);
1855 curl_close ($ch);
1856 return $content;
1857 } elseif($fd = fopen($url,'rb')) {
1858 while (!feof($fd)) {
1859 $content.=fread($fd, 5000);
1860 }
1861 fclose($fd);
1862 return $content;
1863 }
1864 }
1865
1866 /**
1867 * Writes $content to the file $file
1868 *
1869 * Usage: 31
1870 *
1871 * @param string Filepath to write to
1872 * @param string Content to write
1873 * @return boolean True if the file was successfully opened and written to.
1874 */
1875 function writeFile($file,$content) {
1876 if($fd = fopen($file,'wb')) {
1877 fwrite( $fd, $content);
1878 fclose( $fd );
1879 if (@is_file($file) && TYPO3_OS!='WIN') {@chmod ($file, 0644);}
1880 return true;
1881 }
1882 }
1883
1884 /**
1885 * Returns an array with the names of folders in a specific path
1886 * Will return 'error' (string) if there were an error with reading directory content.
1887 *
1888 * Usage: 13
1889 *
1890 * @param string Path to list directories from
1891 * @return array Returns an array with the directory entries as values. If no path, the return value is nothing.
1892 */
1893 function get_dirs($path) {
1894 if ($path) {
1895 $d = @dir($path);
1896 if (is_object($d)) {
1897 while($entry=$d->read()) {
1898 if (@is_dir($path.'/'.$entry) && $entry!= '..' && $entry!= '.') {
1899 $filearray[]=$entry;
1900 }
1901 }
1902 $d->close();
1903 } else return 'error';
1904 return $filearray;
1905 }
1906 }
1907
1908 /**
1909 * Returns an array with the names of files in a specific path
1910 *
1911 * Usage: 17
1912 *
1913 * @param string $path: Is the path to the file
1914 * @param string $extensionList is the comma list of extensions to read only (blank = all)
1915 * @param boolean If set, then the path is prepended the filenames. Otherwise only the filenames are returned in the array
1916 * @param string $order is sorting: 1= sort alphabetically, 'mtime' = sort by modification time.
1917 * @return array Array of the files found
1918 */
1919 function getFilesInDir($path,$extensionList='',$prependPath=0,$order='') {
1920 $filearray=array();
1921 $sortarray=array();
1922 if ($path) {
1923 $path = ereg_replace('/$','',$path);
1924 $extensionList = strtolower($extensionList);
1925 $d = @dir($path);
1926 if (is_object($d)) {
1927 while($entry=$d->read()) {
1928 if (@is_file($path.'/'.$entry)) {
1929 $fI = pathinfo($entry);
1930 $key = md5($path.'/'.$entry);
1931 if (!$extensionList || t3lib_div::inList($extensionList,strtolower($fI['extension']))) {
1932 $filearray[$key]=($prependPath?$path.'/':'').$entry;
1933 if ($order=='mtime') {$sortarray[$key]=filemtime($path.'/'.$entry);}
1934 elseif ($order) {$sortarray[$key]=$entry;}
1935 }
1936 }
1937 }
1938 $d->close();
1939 } else return 'error';
1940 }
1941 if ($order) {
1942 asort($sortarray);
1943 reset($sortarray);
1944 $newArr=array();
1945 while(list($k,$v)=each($sortarray)) {
1946 $newArr[$k]=$filearray[$k];
1947 }
1948 $filearray=$newArr;
1949 }
1950 reset($filearray);
1951 return $filearray;
1952 }
1953
1954 /**
1955 * Recursively gather all files and folders of a path.
1956 *
1957 * @param array $fileArr: Empty input array (will have files added to it)
1958 * @param string $path: The path to read recursively from (absolute)
1959 * @param string $extList: Comma list of file extensions: Only files with extensions in this list (if applicable) will be selected.
1960 * @param boolean $regDirs: If set, directories are also included in output.
1961 * @param integer $recursivityLevels: The number of levels to dig down...
1962 * @return array An array with the found files/directories.
1963 */
1964 function getAllFilesAndFoldersInPath($fileArr,$path,$extList='',$regDirs=0,$recursivityLevels=99) {
1965 if ($regDirs) $fileArr[]=$path;
1966 $fileArr=array_merge($fileArr,t3lib_div::getFilesInDir($path,$extList,1,1));
1967
1968 $dirs = t3lib_div::get_dirs($path);
1969 if (is_array($dirs) && $recursivityLevels>0) {
1970 foreach ($dirs as $subdirs) {
1971 if ((string)$subdirs!='') {
1972 $fileArr = t3lib_div::getAllFilesAndFoldersInPath($fileArr,$path.$subdirs.'/',$extList,$regDirs,$recursivityLevels-1);
1973 }
1974 }
1975 }
1976 return $fileArr;
1977 }
1978
1979 /**
1980 * Removes the absolute part of all files/folders in fileArr
1981 *
1982 * @param array $fileArr: The file array to remove the prefix from
1983 * @param string $prefixToRemove: The prefix path to remove (if found as first part of string!)
1984 * @return array The input $fileArr processed.
1985 */
1986 function removePrefixPathFromList($fileArr,$prefixToRemove) {
1987 reset($fileArr);
1988 while(list($k,$absFileRef)=each($fileArr)) {
1989 if(t3lib_div::isFirstPartOfStr($absFileRef,$prefixToRemove)) {
1990 $fileArr[$k]=substr($absFileRef,strlen($prefixToRemove));
1991 } else return 'ERROR: One or more of the files was NOT prefixed with the prefix-path!';
1992 }
1993 return $fileArr;
1994 }
1995
1996 /**
1997 * Moves $source file to $destination if uploaded, otherwise try to make a copy
1998 * Usage: 3
1999 *
2000 * @param string Source file, absolute path
2001 * @param string Destination file, absolute path
2002 * @return boolean Returns true if the file was moved.
2003 * @coauthor Dennis Petersen <fessor@software.dk>
2004 */
2005 function upload_copy_move($source,$destination) {
2006 if (is_uploaded_file($source)) {
2007 // 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:
2008 return move_uploaded_file($source, $destination);
2009 } else @copy($source,$destination);
2010 if (@is_file($destination) && TYPO3_OS!='WIN') {@chmod ($destination, 0644);}
2011 // 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
2012 return false;
2013 }
2014
2015 /**
2016 * Fixes a path for windows-backslashes and reduces double-slashes to single slashes
2017 *
2018 * Usage: 2
2019 *
2020 * @param string File path to process
2021 * @return string
2022 */
2023 function fixWindowsFilePath($theFile) {
2024 return str_replace('//','/', str_replace('\\','/', $theFile));
2025 }
2026
2027 /**
2028 * Resolves "../" sections in the input path string
2029 *
2030 * @param string File path in which "/../" is resolved
2031 * @return string
2032 */
2033 function resolveBackPath($pathStr) {
2034 $parts = explode('/',$pathStr);
2035 $output=array();
2036 foreach($parts as $pV) {
2037 if ($pV=='..') {
2038 if ($c) {
2039 array_pop($output);
2040 $c--;
2041 } else $output[]=$pV;
2042 } else {
2043 $c++;
2044 $output[]=$pV;
2045 }
2046 }
2047 return implode('/',$output);
2048 }
2049
2050 /**
2051 * Prefixes a URL used with 'header-location' with 'http://...' depending on whether it has it already.
2052 * - If already having a scheme, nothing is prepended
2053 * - If having REQUEST_URI slash '/', then prefixing 'http://[host]' (relative to host)
2054 * - Otherwise prefixed with TYPO3_REQUEST_DIR (relative to current dir / TYPO3_REQUEST_DIR)
2055 *
2056 * Usage: 31
2057 *
2058 * @param string URL / path to prepend full URL addressing to.
2059 * @return string
2060 */
2061 function locationHeaderUrl($path) {
2062 $uI = parse_url($path);
2063 if (substr($path,0,1)=='/') { // relative to HOST
2064 $path = t3lib_div::getIndpEnv('TYPO3_REQUEST_HOST').$path;
2065 } elseif (!$uI['scheme']) { // No scheme either
2066 $path = t3lib_div::getIndpEnv('TYPO3_REQUEST_DIR').$path;
2067 }
2068 return $path;
2069 }
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086 /*************************
2087 *
2088 * DEBUG helper FUNCTIONS
2089 *
2090 *************************/
2091
2092 /**
2093 * Returns a string with a list of ascii-values for the first $characters characters in $string
2094 * Usage: 5
2095 *
2096 * @param string String to show ASCII value for
2097 * @param integer Number of characters to show
2098 * @return string The string with ASCII values in separated by a space char.
2099 * @internal
2100 */
2101 function debug_ordvalue($string,$characters=100) {
2102 if(strlen($string) < $characters) $characters = strlen($string);
2103 for ($i=0; $i<$characters; $i++) {
2104 $valuestring.=' '.ord(substr($string,$i,1));
2105 }
2106 return trim($valuestring);
2107 }
2108
2109 /**
2110 * Returns HTML-code, which is a visual representation of a multidimensional array
2111 * use t3lib_div::print_array() in order to print an array
2112 * Returns false if $array_in is not an array
2113 * Usage: 27
2114 *
2115 * @param array Array to view
2116 * @return string HTML output
2117 */
2118 function view_array($array_in) {
2119 if (is_array($array_in)) {
2120 $result='<table border="1" cellpadding="1" cellspacing="0" bgcolor="white">';
2121 if (!count($array_in)) {$result.= '<tr><td><font face="Verdana,Arial" size="1"><b>'.HTMLSpecialChars("EMPTY!").'</b></font></td></tr>';}
2122 while (list($key,$val)=each($array_in)) {
2123 $result.= '<tr><td><font face="Verdana,Arial" size="1">'.HTMLSpecialChars((string)$key).'</font></td><td>';
2124 if (is_array($array_in[$key])) {
2125 $result.=t3lib_div::view_array($array_in[$key]);
2126 } else
2127 $result.= '<font face="Verdana,Arial" size="1" color="red">'.nl2br(HTMLSpecialChars((string)$val)).'<br /></font>';
2128 $result.= '</td></tr>';
2129 }
2130 $result.= '</table>';
2131 } else {
2132 $result = false;
2133 }
2134 return $result;
2135 }
2136
2137 /**
2138 * Prints an array
2139 * Usage: 28
2140 *
2141 * @param array Array to print visually (in a table).
2142 * @return void
2143 * @internal
2144 * @see view_array()
2145 */
2146 function print_array($array_in) {
2147 echo t3lib_div::view_array($array_in);
2148 }
2149
2150 /**
2151 * Makes debug output
2152 * Prints $var in bold between two vertical lines
2153 * If not $var the word 'debug' is printed
2154 * If $var is an array, the array is printed by t3lib_div::print_array()
2155 *
2156 * Usage: 8
2157 *
2158 * @param mixed Variable to print
2159 * @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.
2160 * @return void
2161 */
2162 function debug($var="",$brOrHeader=0) {
2163 if ($brOrHeader && !t3lib_div::testInt($brOrHeader)) {
2164 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>';
2165 } elseif ($brOrHeader<0) {
2166 for($a=0;$a<abs(intval($brOrHeader));$a++){echo '<br />';}
2167 }
2168
2169 if (is_array($var)) {
2170 t3lib_div::print_array($var);
2171 } elseif (is_object($var)) {
2172 echo '<b>|Object:<pre>';
2173 print_r($var);
2174 echo '</pre>|</b>';
2175 } elseif ((string)$var!='') {
2176 echo '<b>|'.HTMLSpecialChars((string)$var).'|</b>';
2177 } else {
2178 echo '<b>| debug |</b>';
2179 }
2180
2181 if ($brOrHeader && !t3lib_div::testInt($brOrHeader)) {
2182 echo '</td></tr></table>';
2183 } elseif ($brOrHeader>0) {
2184 for($a=0;$a<intval($brOrHeader);$a++){echo '<br />';}
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 /*************************
2220 *
2221 * SYSTEM INFORMATION
2222 *
2223 *************************/
2224
2225 /**
2226 * Returns the HOST+DIR-PATH of the current script (The URL, but without 'http://' and without script-filename)
2227 * Usage: 1
2228 *
2229 * @return string
2230 */
2231 function getThisUrl() {
2232 $p=parse_url(t3lib_div::getIndpEnv('TYPO3_REQUEST_SCRIPT')); // Url of this script
2233 $dir=t3lib_div::dirname($p['path']).'/'; // Strip file
2234 $url = str_replace('//','/',$p['host'].($p['port']?':'.$p['port']:'').$dir);
2235 return $url;
2236 }
2237
2238 /**
2239 * Returns the link-url to the current script.
2240 * 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.
2241 * REMEMBER to always htmlspecialchar() content in href-properties to ampersands get converted to entities (XHTML requirement and XSS precaution)
2242 *
2243 * Usage: 54
2244 *
2245 * @param array Array of GET parameters to include
2246 * @return string
2247 */
2248 function linkThisScript($getParams=array()) {
2249 $parts = t3lib_div::getIndpEnv('SCRIPT_NAME');
2250 $params = $GLOBALS['HTTP_GET_VARS'];
2251 reset($getParams);
2252 while(list($k,$v)=each($getParams)) {
2253 if (strcmp($v,'')) {
2254 $params[$k]=$v;
2255 } else unset($params[$k]);
2256 }
2257 $pString = t3lib_div::implodeArrayForUrl('',$params);
2258 return $pString ? $parts.'?'.ereg_replace('^&','',$pString) : $parts;
2259 }
2260
2261 /**
2262 * 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.
2263 * So basically it adds the parameters in $getParams to an existing URL, $url
2264 * Usage: 2
2265 *
2266 * @param string URL string
2267 * @param array Array of key/value pairs for get parameters to add/overrule with. Can be multidimensional.
2268 * @return string Output URL with added getParams.
2269 */
2270 function linkThisUrl($url,$getParams=array()) {
2271 $parts = parse_url($url);
2272 if ($parts['query']) {
2273 parse_str($parts['query'],$getP);
2274 } else $getP=array();
2275 $getP=t3lib_div::array_merge_recursive_overrule($getP,$getParams);
2276 $uP = explode('?',$url);
2277 $outurl = $uP[0].'?'.t3lib_div::implodeArrayForUrl('',$getP);
2278 return $outurl;
2279 }
2280
2281 /**
2282 * Abstraction method which returns System Environment Variables regardless of server OS, CGI/MODULE version etc. Basically this is SERVER variables for most of them.
2283 * This should be used instead of getEnv() and HTTP_SERVER_VARS/ENV_VARS to get reliable values for all situations.
2284 *
2285 * Usage: 226
2286 *
2287 * @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
2288 * @return string Value based on the input key, independent of server/os environment.
2289 */
2290 function getIndpEnv($getEnvName) {
2291 global $HTTP_SERVER_VARS;
2292 /*
2293 Conventions:
2294 output from parse_url():
2295 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
2296 [scheme] => 'http'
2297 [user] => 'username'
2298 [pass] => 'password'
2299 [host] => '192.168.1.4'
2300 [port] => '8080'
2301 [path] => '/typo3/32/temp/phpcheck/index.php/arg1/arg2/arg3/'
2302 [query] => 'arg1,arg2,arg3&p1=parameter1&p2[key]=value'
2303 [fragment] => 'link1'
2304
2305 Further definition: [path_script] = '/typo3/32/temp/phpcheck/index.php'
2306 [path_dir] = '/typo3/32/temp/phpcheck/'
2307 [path_info] = '/arg1/arg2/arg3/'
2308 [path] = [path_script/path_dir][path_info]
2309
2310
2311 Keys supported:
2312
2313 URI______:
2314 REQUEST_URI = [path]?[query] = /typo3/32/temp/phpcheck/index.php/arg1/arg2/arg3/?arg1,arg2,arg3&p1=parameter1&p2[key]=value
2315 HTTP_HOST = [host][:[port]] = 192.168.1.4:8080
2316 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')!
2317 PATH_INFO = [path_info] = /arg1/arg2/arg3/
2318 QUERY_STRING = [query] = arg1,arg2,arg3&p1=parameter1&p2[key]=value
2319 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
2320 (Notice: NO username/password + NO fragment)
2321
2322 CLIENT____:
2323 REMOTE_ADDR = (client IP)
2324 REMOTE_HOST = (client host)
2325 HTTP_USER_AGENT = (client user agent)
2326 HTTP_ACCEPT_LANGUAGE = (client accept language)
2327
2328 SERVER____:
2329 SCRIPT_FILENAME = Absolute filename of script (Differs between windows/unix). On windows 'C:\\blabla\\blabl\\' will be converted to 'C:/blabla/blabl/'
2330
2331 Special extras:
2332 TYPO3_HOST_ONLY = [host] = 192.168.1.4
2333 TYPO3_PORT = [port] = 8080 (blank if 80, taken from host value)
2334 TYPO3_REQUEST_HOST = [scheme]://[host][:[port]]
2335 TYPO3_REQUEST_URL = [scheme]://[host][:[port]][path]?[query] (sheme will by default be 'http' until we can detect if it's https -
2336 TYPO3_REQUEST_SCRIPT = [scheme]://[host][:[port]][path_script]
2337 TYPO3_REQUEST_DIR = [scheme]://[host][:[port]][path_dir]
2338 TYPO3_SITE_URL = [scheme]://[host][:[port]][path_dir] of the TYPO3 website
2339 TYPO3_DOCUMENT_ROOT = Absolute path of root of documents: TYPO3_DOCUMENT_ROOT.SCRIPT_NAME = SCRIPT_FILENAME (typically)
2340
2341 Notice: [fragment] is apparently NEVER available to the script!
2342
2343
2344 Testing suggestions:
2345 - Output all the values.
2346 - 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
2347 - ALSO TRY the script from the ROOT of a site (like 'http://www.mytest.com/' and not 'http://www.mytest.com/test/' !!)
2348
2349 */
2350
2351 # if ($getEnvName=='HTTP_REFERER') return '';
2352 switch((string)$getEnvName) {
2353 case 'SCRIPT_NAME':
2354 return php_sapi_name()=='cgi' ? $HTTP_SERVER_VARS['PATH_INFO'] : $HTTP_SERVER_VARS['SCRIPT_NAME'];
2355 break;
2356 case 'SCRIPT_FILENAME':
2357 return str_replace('//','/', str_replace('\\','/', php_sapi_name()=='cgi'||php_sapi_name()=='isapi' ? $HTTP_SERVER_VARS['PATH_TRANSLATED']:$HTTP_SERVER_VARS['SCRIPT_FILENAME']));
2358 break;
2359 case 'REQUEST_URI':
2360 // Typical application of REQUEST_URI is return urls, forms submitting to itselt etc. Eg: returnUrl='.rawurlencode(t3lib_div::getIndpEnv('REQUEST_URI'))
2361 if (!$HTTP_SERVER_VARS['REQUEST_URI']) { // This is for ISS/CGI which does not have the REQUEST_URI available.
2362 return '/'.ereg_replace('^/','',t3lib_div::getIndpEnv('SCRIPT_NAME')).
2363 ($HTTP_SERVER_VARS['QUERY_STRING']?'?'.$HTTP_SERVER_VARS['QUERY_STRING']:'');
2364 } else return $HTTP_SERVER_VARS['REQUEST_URI'];
2365 break;
2366 case 'PATH_INFO':
2367 // $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
2368 // Further, there must be at least one '/' in the path - else the PATH_INFO value does not make sense.
2369 // 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)
2370 // if (strcmp($HTTP_SERVER_VARS['PATH_INFO'],t3lib_div::getIndpEnv('SCRIPT_NAME')) && count(explode('/',$HTTP_SERVER_VARS['PATH_INFO']))>1) {
2371 if (php_sapi_name()!='cgi') {
2372 return $HTTP_SERVER_VARS['PATH_INFO'];
2373 } else return '';
2374 break;
2375 // These are let through without modification
2376 case 'REMOTE_ADDR':
2377 case 'REMOTE_HOST':
2378 case 'HTTP_REFERER':
2379 case 'HTTP_HOST':
2380 case 'HTTP_USER_AGENT':
2381 case 'HTTP_ACCEPT_LANGUAGE':
2382 case 'QUERY_STRING':
2383 return $HTTP_SERVER_VARS[$getEnvName];
2384 break;
2385 case 'TYPO3_DOCUMENT_ROOT':
2386 // 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.
2387 // Therefore the DOCUMENT_ROOT is now always calculated as the SCRIPT_FILENAME minus the end part shared with SCRIPT_NAME.
2388 $SFN = t3lib_div::getIndpEnv('SCRIPT_FILENAME');
2389 $SN_A = explode('/',strrev(t3lib_div::getIndpEnv('SCRIPT_NAME')));
2390 $SFN_A = explode('/',strrev($SFN));
2391 $acc=array();
2392 while(list($kk,$vv)=each($SN_A)) {
2393 if (!strcmp($SFN_A[$kk],$vv)) {
2394 $acc[]=$vv;
2395 } else break;
2396 }
2397 $commonEnd=strrev(implode('/',$acc));
2398 if (strcmp($commonEnd,'')) $DR = substr($SFN,0,-(strlen($commonEnd)+1));
2399 return $DR;
2400 break;
2401 case 'TYPO3_HOST_ONLY':
2402 $p=explode(':',$HTTP_SERVER_VARS['HTTP_HOST']);
2403 return $p[0];
2404 break;
2405 case 'TYPO3_PORT':
2406 $p=explode(':',$HTTP_SERVER_VARS['HTTP_HOST']);
2407 return $p[1];
2408 break;
2409 case 'TYPO3_REQUEST_HOST':
2410 return 'http'.($HTTP_SERVER_VARS['SSL_SESSION_ID']?'s':'').'://'. // I hope this: ($HTTP_SERVER_VARS['SSL_SESSION_ID']?'s':'') - is sufficient to detect https...
2411 $HTTP_SERVER_VARS['HTTP_HOST'];
2412 break;
2413 case 'TYPO3_REQUEST_URL':
2414 return t3lib_div::getIndpEnv('TYPO3_REQUEST_HOST').t3lib_div::getIndpEnv('REQUEST_URI');
2415 break;
2416 case 'TYPO3_REQUEST_SCRIPT':
2417 return t3lib_div::getIndpEnv('TYPO3_REQUEST_HOST').t3lib_div::getIndpEnv('SCRIPT_NAME');
2418 break;
2419 case 'TYPO3_REQUEST_DIR':
2420 return t3lib_div::getIndpEnv('TYPO3_REQUEST_HOST').t3lib_div::dirname(t3lib_div::getIndpEnv('SCRIPT_NAME')).'/';
2421 break;
2422 case 'TYPO3_SITE_URL':
2423 if (defined('PATH_thisScript') && defined('PATH_site')) {
2424 $lPath = substr(dirname(PATH_thisScript),strlen(PATH_site)).'/';
2425 $url = t3lib_div::getIndpEnv('TYPO3_REQUEST_DIR');
2426 $siteUrl = substr($url,0,-strlen($lPath));
2427 if (substr($siteUrl,-1)!='/') $siteUrl.='/';
2428 return $siteUrl;
2429 } else return '';
2430
2431 break;
2432 case '_ARRAY':
2433 $out=array();
2434 // Here, list ALL possible keys to this function for debug display.
2435 $envTestVars = t3lib_div::trimExplode(',','
2436 HTTP_HOST,
2437 TYPO3_HOST_ONLY,
2438 TYPO3_PORT,
2439 PATH_INFO,
2440 QUERY_STRING,
2441 REQUEST_URI,
2442 HTTP_REFERER,
2443 TYPO3_REQUEST_HOST,
2444 TYPO3_REQUEST_URL,
2445 TYPO3_REQUEST_SCRIPT,
2446 TYPO3_REQUEST_DIR,
2447 TYPO3_SITE_URL,
2448 SCRIPT_NAME,
2449 TYPO3_DOCUMENT_ROOT,
2450 SCRIPT_FILENAME,
2451 REMOTE_ADDR,
2452 REMOTE_HOST,
2453 HTTP_USER_AGENT,
2454 HTTP_ACCEPT_LANGUAGE',1);
2455 reset($envTestVars);
2456 while(list(,$v)=each($envTestVars)) {
2457 $out[$v]=t3lib_div::getIndpEnv($v);
2458 }
2459 reset($out);
2460 return $out;
2461 break;
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 /*************************
2488 *
2489 * TYPO3 SPECIFIC FUNCTIONS
2490 *
2491 *************************/
2492
2493 /**
2494 * Returns the absolute filename of $filename.
2495 * Decodes the prefix EXT: for TYPO3 Extensions.
2496 *
2497 * Usage: 9
2498 *
2499 * @param string The input filename/filepath to evaluate
2500 * @param boolean If $onlyRelative is set (which it is by default), then only return values relative to the current PATH_site is accepted.
2501 * @param boolean If $relToTYPO3_mainDir is set, then relative paths are relative to PATH_typo3 constant - otherwise (default) they are relative to PATH_site
2502 * @return string Returns the absolute filename of $filename IF valid, otherwise blank string.
2503 */
2504 function getFileAbsFileName($filename,$onlyRelative=1,$relToTYPO3_mainDir=0) {
2505 if (!strcmp($filename,'')) return '';
2506
2507 if ($relToTYPO3_mainDir) {
2508 if (!defined('PATH_typo3')) return '';
2509 $relPathPrefix = PATH_typo3;
2510 } else {
2511 $relPathPrefix = PATH_site;
2512 }
2513 if (substr($filename,0,4)=='EXT:') { // extension
2514 list($extKey,$local) = explode('/',substr($filename,4),2);
2515 $filename='';
2516 if (strcmp($extKey,'') && t3lib_extMgm::isLoaded($extKey) && strcmp($local,'')) {
2517 $filename = t3lib_extMgm::extPath($extKey).$local;
2518 }
2519 } elseif (!t3lib_div::isAbsPath($filename)) { // relative. Prepended with $relPathPrefix
2520 $filename=$relPathPrefix.$filename;
2521 } elseif ($onlyRelative && !t3lib_div::isFirstPartOfStr($filename,$relPathPrefix)) { // absolute, but set to blank if not allowed
2522 $filename='';
2523 }
2524 if (strcmp($filename,'') && t3lib_div::validPathStr($filename)) { // checks backpath.
2525 return $filename;
2526 }
2527 }
2528
2529 /**
2530 * Returns true if no '//', '..' or '\' is in the $theFile
2531 * This should make sure that the path is not pointing 'backwards' and further doesn't contain double/back slashes.
2532 * So it's compatible with the UNIX style path strings valid for TYPO3 internally.
2533 *
2534 * Usage: 8
2535 *
2536 * @param string Filepath to evaluate
2537 * @return boolean True, if no '//', '..' or '\' is in the $theFile
2538 */
2539 function validPathStr($theFile) {
2540 if (!strstr($theFile,'//') && !strstr($theFile,'..') && !strstr($theFile,'\\')) return true;
2541 }
2542
2543 /**
2544 * Checks if the $path is absolute or relative (detecting either '/' or 'x:/' as first part of string) and returns true if so.
2545 *
2546 * Usage: 9
2547 *
2548 * @param string Filepath to evaluate
2549 * @return boolean
2550 */
2551 function isAbsPath($path) {
2552 return TYPO3_OS=='WIN' ? substr($path,1,2)==':/' : substr($path,0,1)=='/';
2553 }
2554
2555 /**
2556 * Returns true if the path is absolute, without backpath '..' and within the PATH_site OR within the lockRootPath
2557 *
2558 * Usage: 1
2559 *
2560 * @param string Filepath to evaluate
2561 * @return boolean
2562 */
2563 function isAllowedAbsPath($path) {
2564 if (t3lib_div::isAbsPath($path) &&
2565 t3lib_div::validPathStr($path) &&
2566 ( t3lib_div::isFirstPartOfStr($path,PATH_site)
2567 ||
2568 ($GLOBALS['TYPO3_CONF_VARS']['BE']['lockRootPath'] && t3lib_div::isFirstPartOfStr($path,$GLOBALS['TYPO3_CONF_VARS']['BE']['lockRootPath']))
2569 )
2570 ) return true;
2571 }
2572
2573 /**
2574 * Verifies the input filename againts the 'fileDenyPattern'. Returns true if OK.
2575 *
2576 * Usage: 2
2577 *
2578 * @param string Filepath to evaluate
2579 * @return boolean
2580 */
2581 function verifyFilenameAgainstDenyPattern($filename) {
2582 if (strcmp($filename,'') && strcmp($GLOBALS['TYPO3_CONF_VARS']['BE']['fileDenyPattern'],'')) {
2583 $result = eregi($GLOBALS['TYPO3_CONF_VARS']['BE']['fileDenyPattern'],$filename);
2584 if ($result) return false; // so if a matching filename is found, return false;
2585 }
2586 return true;
2587 }
2588
2589 /**
2590 * standard authentication code - can't remember what it's used for.
2591 * Usage: 2
2592 *
2593 * @param mixed Uid (integer) or record (array)
2594 * @param string List of fields from the record if that is given.
2595 * @return string MD5 hash of 8 chars.
2596 * @internal
2597 */
2598 function stdAuthCode($uid_or_record,$fields='') {
2599 if (is_array($uid_or_record)) {
2600 $recCopy_temp=array();
2601 if ($fields) {
2602 $fieldArr = t3lib_div::trimExplode(',',$fields,1);
2603 reset($fieldArr);
2604 while(list($k,$v)=each($fieldArr)) {
2605 $recCopy_temp[$k]=$recCopy[$v];
2606 }
2607 } else {
2608 $recCopy_temp=$recCopy;
2609 }
2610 $preKey = implode('|',$recCopy_temp);
2611 } else {
2612 $preKey = $uid_or_record;
2613 }
2614
2615 $authCode = $preKey.'||'.$GLOBALS['TYPO3_CONF_VARS']['SYS']['encryptionKey'];
2616 $authCode = substr(md5($authCode),0,8);
2617 return $authCode;
2618 }
2619
2620 /**
2621 * Loads the $TCA (Table Configuration Array) for the $table
2622 *
2623 * Requirements:
2624 * 1) must be configured table (the ctrl-section configured),
2625 * 2) columns must not be an array (which it is always if whole table loaded), and
2626 * 3) there is a value for dynamicConfigFile (filename in typo3conf)
2627 * Usage: 92
2628 *
2629 * @param string Table name for which to load the full TCA array part into the global $TCA
2630 * @return void
2631 */
2632 function loadTCA($table) {
2633 global $TCA,$LANG_GENERAL_LABELS;
2634 if (isset($TCA[$table]) && !is_array($TCA[$table]['columns']) && $TCA[$table]['ctrl']['dynamicConfigFile']) {
2635 if (!strcmp(substr($TCA[$table]['ctrl']['dynamicConfigFile'],0,6),'T3LIB:')) {
2636 include(PATH_t3lib.'stddb/'.substr($TCA[$table]['ctrl']['dynamicConfigFile'],6));
2637 } elseif (t3lib_div::isAbsPath($TCA[$table]['ctrl']['dynamicConfigFile']) && @is_file($TCA[$table]['ctrl']['dynamicConfigFile'])) { // Absolute path...
2638 include($TCA[$table]['ctrl']['dynamicConfigFile']);
2639 } else include(PATH_typo3conf.$TCA[$table]['ctrl']['dynamicConfigFile']);
2640 }
2641 }
2642
2643 /**
2644 * 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).
2645 * If the sheet definition is in an external file that file is parsed and the data structure inside of that is returned.
2646 *
2647 * @param array Input data structure, possibly with a sheet-definition and references to external data source files.
2648 * @param string The sheet to return, preferably.
2649 * @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!
2650 */
2651 function resolveSheetDefInDS($dataStructArray,$sheet='sDEF') {
2652 if (is_array($dataStructArray['sheets'])) {
2653 if (!isset($dataStructArray['sheets'][$sheet])) {
2654 $sheet='sDEF';
2655 }
2656 $dataStruct = $dataStructArray['sheets'][$sheet];
2657
2658 // If not an array, but still set, then regard it as a relative reference to a file:
2659 if ($dataStruct && !is_array($dataStruct)) {
2660 $file = t3lib_div::getFileAbsFileName($dataStruct);
2661 if ($file && @is_file($file)) {
2662 $dataStruct = t3lib_div::xml2array(t3lib_div::getUrl($file));
2663 }
2664 }
2665 } else {
2666 $dataStruct = $dataStructArray;
2667 $sheet = 'sDEF'; // Default sheet
2668 }
2669 return array($dataStruct,$sheet);
2670 }
2671
2672 /**
2673 * Resolves ALL sheet definitions in dataStructArray
2674 * If no sheet is found, then the default "sDEF" will be created with the dataStructure inside.
2675 *
2676 * @param array Input data structure, possibly with a sheet-definition and references to external data source files.
2677 * @return array Output data structure with all sheets resolved as arrays.
2678 */
2679 function resolveAllSheetsInDS($dataStructArray) {
2680 if (is_array($dataStructArray['sheets'])) {
2681 $out=array('sheets'=>array());
2682 foreach($dataStructArray['sheets'] as $sheetId => $sDat) {
2683 list($ds,$aS) = t3lib_div::resolveSheetDefInDS($dataStructArray,$sheetId);
2684 if ($sheetId==$aS) {
2685 $out['sheets'][$aS]=$ds;
2686 }
2687 }
2688 } else {
2689 list($ds) = t3lib_div::resolveSheetDefInDS($dataStructArray);
2690 $out = array('sheets' => array('sDEF' => $ds));
2691 }
2692 return $out;
2693 }
2694
2695 /**
2696 * Calls a userdefined function/method in class
2697 * Such a function/method should look like this: "function proc(&$params, &$ref) {...}"
2698 *
2699 * Usage: 3
2700 *
2701 * @param string Method reference, [class]->[method] or [function]
2702 * @param mixed Parameters to be pass along (typically an array) (REFERENCE!)
2703 * @param mixed Reference to be passed along (typically "$this" - being a reference to the calling object) (REFERENCE!)
2704 * @param string Required prefix of class or function name
2705 * @param boolean If set, not debug() error message is shown if class/function is not present.
2706 * @return mixed Content from method/function call
2707 */
2708 function callUserFunction($funcName,&$params,&$ref,$checkPrefix='user_',$silent=0) {
2709 if ($checkPrefix &&
2710 !t3lib_div::isFirstPartOfStr(trim($funcName),$checkPrefix) &&
2711 !t3lib_div::isFirstPartOfStr(trim($funcName),'tx_')
2712 ) {
2713 if (!$silent) debug("Function '".$funcName."' was not prepended with '".$checkPrefix."'",1);
2714 return $content;
2715 }
2716 $parts = explode('->',$funcName);
2717 if (count($parts)==2) { // Class
2718 if (class_exists($parts[0])) {
2719 $classObj = new $parts[0];
2720 if (method_exists($classObj, $parts[1])) {
2721 $content = call_user_method($parts[1], $classObj, $params, $ref);
2722 } else {
2723 if (!$silent) debug("<strong>ERROR:</strong> No method name '".$parts[1]."' in class ".$parts[0],1);
2724 }
2725 } else {
2726 if (!$silent) debug("<strong>ERROR:</strong> No class named: ".$parts[0],1);
2727 }
2728 } else { // Function
2729 if (function_exists($funcName)) {
2730 $content = call_user_func($funcName, $params, $ref);
2731 } else {
2732 if (!$silent) debug("<strong>ERROR:</strong> No function named: ".$funcName,1);
2733 }
2734 }
2735 return $content;
2736 }
2737
2738 /**
2739 * Make instance of class
2740 * Takes the class-extensions API of TYPO3 into account
2741 * Please USE THIS instead of the PHP "new" keyword. Eg. "$obj = new myclass;" should be "$obj = t3lib_div::makeInstance("myclass")" instead!
2742 *
2743 * Usage: 455
2744 *
2745 * @param string Class name to instantiate
2746 * @return object The object
2747 */
2748 function makeInstance($className) {
2749 if (class_exists('ux_'.$className)) {
2750 return t3lib_div::makeInstance('ux_'.$className);
2751 } else {
2752 return new $className;
2753 }
2754 }
2755
2756 /**
2757 * Find the best service and check if it works.
2758 * Returns object of the service class.
2759 *
2760 * @param string Type of service (service key).
2761 * @param string Sub type like file extensions or similar. Defined by the service.
2762 * @param string List of service keys which should be exluded in the search for a service.
2763 * @return object The service object or an array with error info's.
2764 * @author René Fritz <r.fritz@colorcube.de>
2765 */
2766 function makeInstanceService($serviceType, $serviceSubType='', $excludeServiceKeys='') {
2767 global $T3_SERVICES;
2768
2769 $error = FALSE;
2770
2771 while ($info = t3lib_extMgm::findService($serviceType, $serviceSubType, $excludeServiceKeys)) {
2772
2773 if (@is_file($info['classFile'])) {
2774 require_once ($info['classFile']);
2775 $obj = t3lib_div::makeInstance($info['className']);
2776 if (is_object($obj)) {
2777 if ($obj->init()) { // service available?
2778
2779 $obj->info = $info;
2780 return $obj; // objects are passed always as reference - right?
2781 }
2782 $error = $obj->getLastErrorArray();
2783 unset($obj);
2784 }
2785 // deactivate the service
2786 t3lib_extMgm::deactivateService($info['serviceType'],$info['serviceKey']);
2787 }
2788 }
2789 return $error;
2790 }
2791
2792 /**
2793 * Return classname for new instance
2794 * Takes the class-extensions API of TYPO3 into account
2795 *
2796 * Usage: 18
2797 *
2798 * @param string Base Class name to evaluate
2799 * @return string Final class name to instantiate with "new [classname]"
2800 */
2801 function makeInstanceClassName($className) {
2802 return class_exists('ux_'.$className)?t3lib_div::makeInstanceClassName('ux_'.$className):$className;
2803 }
2804
2805 /**
2806 * Simple substitute for the PHP function mail().
2807 * The fifth parameter, $enc, will allow you to specify 'base64' encryption for the output (set $enc=base64)
2808 * Further the output has the charset set to ISO-8859-1 by default.
2809 *
2810 * Usage: 4
2811 *
2812 * @param string Email address to send to. (see PHP function mail())
2813 * @param string Subject line, non-encoded. (see PHP function mail())
2814 * @param string Message content, non-encoded. (see PHP function mail())
2815 * @param string Headers, separated by chr(10)
2816 * @param string Encoding type: "base64", "quoted-printable", "8bit". If blank, no encoding will be used, no encoding headers set.
2817 * @param string Charset used in encoding-headers (only if $enc is set to a valid value which produces such a header)
2818 * @param boolean If set, the content of $subject will not be encoded.
2819 * @return void
2820 */
2821 function plainMailEncoded($email,$subject,$message,$headers='',$enc='',$charset='ISO-8859-1',$dontEncodeSubject=0) {
2822 switch((string)$enc) {
2823 case 'base64':
2824 $headers=trim($headers).chr(10).
2825 'Mime-Version: 1.0'.chr(10).
2826 'Content-Type: text/plain; charset="'.$charset.'"'.chr(10).
2827 'Content-Transfer-Encoding: base64';
2828
2829 $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.
2830
2831 if (!$dontEncodeSubject) $subject='=?'.$charset.'?B?'.base64_encode($subject).'?=';
2832 break;
2833 case 'quoted-printable':
2834 $headers=trim($headers).chr(10).
2835 'Mime-Version: 1.0'.chr(10).
2836 'Content-Type: text/plain; charset="'.$charset.'"'.chr(10).
2837 'Content-Transfer-Encoding: quoted-printable';
2838
2839 $message=t3lib_div::quoted_printable($message);
2840
2841 if (!$dontEncodeSubject) $subject='=?'.$charset.'?Q?'.trim(t3lib_div::quoted_printable(ereg_replace('[[:space:]]','_',$subject),1000)).'?=';
2842 break;
2843 case '8bit':
2844 $headers=trim($headers).chr(10).
2845 'Mime-Version: 1.0'.chr(10).
2846 'Content-Type: text/plain; charset="'.$charset.'"'.chr(10).
2847 'Content-Transfer-Encoding: 8bit';
2848 break;
2849 }
2850 $headers=trim(implode(chr(10),t3lib_div::trimExplode(chr(10),$headers,1))); // make sure no empty lines are there.
2851 #debug(array($email,$subject,$message,$headers));
2852
2853 mail($email,$subject,$message,$headers);
2854 }
2855
2856 /**
2857 * Implementation of quoted-printable encode.
2858 * 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!
2859 * (Originally taken from class.t3lib_htmlmail.php - which may be updated if this function should ever be improved!
2860 * See RFC 1521, section 5.1 Quoted-Printable Content-Transfer-Encoding
2861 *
2862 * Usage: 2
2863 *
2864 * @param string Content to encode
2865 * @param integer Length of the lines, default is 76
2866 * @return string The QP encoded string
2867 */
2868 function quoted_printable($string,$maxlen=76) {
2869 $newString = '';
2870 $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
2871 while (list(,$val)=each($theLines)) {
2872 $val = ereg_replace(chr(13).'$','',$val); // removes possible character 13 at the end of line
2873
2874 $newVal = '';
2875 $theValLen = strlen($val);
2876 $len = 0;
2877 for ($index=0;$index<$theValLen;$index++) {
2878 $char = substr($val,$index,1);
2879 $ordVal =Ord($char);
2880 if ($len>($maxlen-4) || ($len>(($maxlen-10)-4)&&$ordVal==32)) {
2881 $len=0;
2882 $newVal.='='.chr(13).chr(10);
2883 }
2884 if (($ordVal>=33 && $ordVal<=60) || ($ordVal>=62 && $ordVal<=126) || $ordVal==9 || $ordVal==32) {
2885 $newVal.=$char;
2886 $len++;
2887 } else {
2888 $newVal.=sprintf('=%02X',$ordVal);
2889 $len+=3;
2890 }
2891 }
2892 $newVal = ereg_replace(chr(32).'$','=20',$newVal); // replaces a possible SPACE-character at the end of a line
2893 $newVal = ereg_replace(chr(9).'$','=09',$newVal); // replaces a possible TAB-character at the end of a line
2894 $newString.=$newVal.chr(13).chr(10);
2895 }
2896 return ereg_replace(chr(13).chr(10).'$','',$newString);
2897 }
2898
2899 /**
2900 * 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.
2901 * This function is about preserving long links in messages.
2902 *
2903 * Usage: 3
2904 *
2905 * @param string Message content
2906 * @param string URL mode; "76" or "all"
2907 * @param string URL of index script (see makeRedirectUrl())
2908 * @return string Processed message content
2909 * @see makeRedirectUrl()
2910 */
2911 function substUrlsInPlainText($message,$urlmode='76',$index_script_url='') {
2912 // Substitute URLs with shorter links:
2913 $urlSplit=explode('http://',$message);
2914 reset($urlSplit);
2915 while(list($c,$v)=each($urlSplit)) {
2916 if ($c) {
2917 $newParts = split('[[:space:]]|\)|\(',$v,2);
2918 $newURL='http://'.$newParts[0];
2919 switch((string)$urlmode) {
2920 case 'all':
2921 $newURL=t3lib_div::makeRedirectUrl($newURL,0,$index_script_url);
2922 break;
2923 case '76':
2924 $newURL=t3lib_div::makeRedirectUrl($newURL,76,$index_script_url);
2925 break;
2926 }
2927 $urlSplit[$c]=$newURL.substr($v,strlen($newParts[0]));
2928 }
2929 }
2930
2931 $message=implode('',$urlSplit);
2932 return $message;
2933 }
2934
2935 /**
2936 * Subfunction for substUrlsInPlainText() above.
2937 *
2938 * Usage: 2
2939 *
2940 * @param string Input URL
2941 * @param integer URL string length limit
2942 * @param string URL of "index script" - the prefix of the "?RDCT=..." parameter. If not supplyed it will default to t3lib_div::getIndpEnv('TYPO3_REQUEST_DIR')
2943 * @return string Processed URL
2944 * @internal
2945 */
2946 function makeRedirectUrl($inUrl,$l=0,$index_script_url='') {
2947 if (strlen($inUrl)>$l) {
2948 $md5=substr(md5($inUrl),0,20);
2949 $query='SELECT md5hash FROM cache_md5params WHERE md5hash="'.$md5.'"';
2950 $res=mysql(TYPO3_db,$query);
2951 if (!mysql_num_rows($res)) {
2952 $query="INSERT INTO cache_md5params (md5hash,tstamp,type,params) VALUES ('".$md5."',".time().",2,'".addslashes($inUrl)."')";
2953 $res=mysql(TYPO3_db,$query);
2954 }
2955 $inUrl=($index_script_url ? $index_script_url : t3lib_div::getIndpEnv('TYPO3_REQUEST_DIR')).
2956 '?RDCT='.$md5;
2957 }
2958 return $inUrl;
2959 }
2960
2961 /**
2962 * Function to compensate for FreeType2 96 dpi
2963 *
2964 * Usage: 16
2965 *
2966 * @param integer Fontsize for freetype function call
2967 * @return integer Compensated fontsize based on $GLOBALS['TYPO3_CONF_VARS']['GFX']['TTFdpi']
2968 */
2969 function freetypeDpiComp($font_size) {
2970 $dpi = intval($GLOBALS['TYPO3_CONF_VARS']['GFX']['TTFdpi']);
2971 if ($dpi!=72) $font_size = $font_size/$dpi*72;
2972 return $font_size;
2973 }
2974 }
2975
2976
2977 ?>