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