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