2728f23f0a7b6ab9ceaa9f8874063e898036d43d
[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 * Usage: 16
744 *
745 * @param string Accept multiple parameters wich can be comma-separated lists of values and arrays.
746 * @return string Returns the list without any duplicates of values, space around values are trimmed
747 */
748 function uniqueList() {
749 $listArray = array();
750
751 $arg_list = func_get_args();
752 foreach ($arg_list as $in_list) {
753 if (!is_array($in_list)) {
754 $in_list = explode(',',$in_list);
755 }
756 $listArray = array_merge($listArray,$in_list);
757 }
758 return implode(',',t3lib_div::uniqueArray($listArray));
759 }
760
761 /**
762 * Splits a reference to a file in 5 parts
763 * Usage: 43
764 *
765 * @param string Filename/filepath to be analysed
766 * @return array Contains keys [path], [file], [filebody], [fileext], [realFileext]
767 */
768 function split_fileref($fileref) {
769 if ( ereg('(.*/)(.*)$',$fileref,$reg) ) {
770 $info['path'] = $reg[1];
771 $info['file'] = $reg[2];
772 } else {
773 $info['path'] = '';
774 $info['file'] = $fileref;
775 }
776 $reg='';
777 if ( ereg('(.*)\.([^\.]*$)',$info['file'],$reg) ) {
778 $info['filebody'] = $reg[1];
779 $info['fileext'] = strtolower($reg[2]);
780 $info['realFileext'] = $reg[2];
781 } else {
782 $info['filebody'] = $info['file'];
783 $info['fileext'] = '';
784 }
785 reset($info);
786 return $info;
787 }
788
789 /**
790 * Returns the directory part of a path without trailing slash
791 * If there is no dir-part, then an empty string is returned.
792 * Behaviour:
793 *
794 * '/dir1/dir2/script.php' => '/dir1/dir2'
795 * '/dir1/' => '/dir1'
796 * 'dir1/script.php' => 'dir1'
797 * 'd/script.php' => 'd'
798 * '/script.php' => ''
799 * '' => ''
800 * Usage: 5
801 *
802 * @param string Directory name / path
803 * @return string Processed input value. See function description.
804 */
805 function dirname($path) {
806 $p=t3lib_div::revExplode('/',$path,2);
807 return count($p)==2?$p[0]:'';
808 }
809
810 /**
811 * Modifies a HTML Hex color by adding/subtracting $R,$G and $B integers
812 * Usage: 11
813 *
814 * @param string A hexadecimal color code, #xxxxxx
815 * @param integer Offset value 0-255
816 * @param integer Offset value 0-255
817 * @param integer Offset value 0-255
818 * @return string A hexadecimal color code, #xxxxxx, modified according to input vars
819 * @see modifyHTMLColorAll()
820 */
821 function modifyHTMLColor($color,$R,$G,$B) {
822 // This takes a hex-color (# included!) and adds $R, $G and $B to the HTML-color (format: #xxxxxx) and returns the new color
823 $nR = t3lib_div::intInRange(hexdec(substr($color,1,2))+$R,0,255);
824 $nG = t3lib_div::intInRange(hexdec(substr($color,3,2))+$G,0,255);
825 $nB = t3lib_div::intInRange(hexdec(substr($color,5,2))+$B,0,255);
826 return '#'.
827 substr('0'.dechex($nR),-2).
828 substr('0'.dechex($nG),-2).
829 substr('0'.dechex($nB),-2);
830 }
831
832 /**
833 * Modifies a HTML Hex color by adding/subtracting $all integer from all R/G/B channels
834 * Usage: 6
835 *
836 * @param string A hexadecimal color code, #xxxxxx
837 * @param integer Offset value 0-255 for all three channels.
838 * @return string A hexadecimal color code, #xxxxxx, modified according to input vars
839 * @see modifyHTMLColor()
840 */
841 function modifyHTMLColorAll($color,$all) {
842 return t3lib_div::modifyHTMLColor($color,$all,$all,$all);
843 }
844
845 /**
846 * Removes comma (if present) in the end of string
847 * Usage: 2
848 *
849 * @param string String from which the comma in the end (if any) will be removed.
850 * @return string
851 */
852 function rm_endcomma($string) {
853 return ereg_replace(',$','',$string);
854 }
855
856 /**
857 * strtoupper which converts danish (and other characters) characters as well
858 * (DEPRECIATED, use t3lib_cs::conv_case() instead or for HTML output, wrap your content in <span class="uppercase">...</span>)
859 * Usage: 0
860 *
861 * @param string String to process
862 * @return string
863 * @ignore
864 */
865 function danish_strtoupper($string) {
866 $value = strtoupper($string);
867 return strtr($value, 'áéúíâêûôîæøåäöü', 'ÁÉÚÍÄËÜÖÏÆØÅÄÖÜ');
868 }
869
870 /**
871 * Change umlaut characters to plain ASCII with normally two character target
872 * Only known characters will be converted, so don't expect a result for any character.
873 * (DEPRECIATED: Works only for western europe single-byte charsets! Use t3lib_cs::specCharsToASCII() instead!)
874 *
875 * ä => ae, Ö => Oe
876 *
877 * @param string String to convert.
878 * @return string
879 */
880 function convUmlauts($str) {
881 $pat = array ( '/ä/', '/Ä/', '/ö/', '/Ö/', '/ü/', '/Ü/', '/ß/', '/å/', '/Å/', '/ø/', '/Ø/', '/æ/', '/Æ/' );
882 $repl = array ( 'ae', 'Ae', 'oe', 'Oe', 'ue', 'Ue', 'ss', 'aa', 'AA', 'oe', 'OE', 'ae', 'AE' );
883 return preg_replace($pat,$repl,$str);
884 }
885
886 /**
887 * Tests if the input is an integer.
888 * Usage: 77
889 *
890 * @param mixed Any input variable to test.
891 * @return boolean Returns true if string is an integer
892 */
893 function testInt($var) {
894 return !strcmp($var,intval($var));
895 }
896
897 /**
898 * Returns true if the first part of $str matches the string $partStr
899 * Usage: 59
900 *
901 * @param string Full string to check
902 * @param string Reference string which must be found as the "first part" of the full string
903 * @return boolean True if $partStr was found to be equal to the first part of $str
904 */
905 function isFirstPartOfStr($str,$partStr) {
906 // Returns true, if the first part of a $str equals $partStr and $partStr is not ''
907 $psLen = strlen($partStr);
908 if ($psLen) {
909 return substr($str,0,$psLen)==(string)$partStr;
910 } else return false;
911 }
912
913 /**
914 * Formats the input integer $sizeInBytes as bytes/kilobytes/megabytes (-/K/M)
915 * Usage: 53
916 *
917 * @param integer Number of bytes to format.
918 * @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)
919 * @return string Formatted representation of the byte number, for output.
920 */
921 function formatSize($sizeInBytes,$labels='') {
922
923 // Set labels:
924 if (strlen($labels) == 0) {
925 $labels = ' | K| M| G';
926 } else {
927 $labels = str_replace('"','',$labels);
928 }
929 $labelArr = explode('|',$labels);
930
931 // Find size:
932 if ($sizeInBytes>900) {
933 if ($sizeInBytes>900000000) { // GB
934 $val = $sizeInBytes/(1024*1024*1024);
935 return number_format($val, (($val<20)?1:0), '.', '').$labelArr[3];
936 }
937 elseif ($sizeInBytes>900000) { // MB
938 $val = $sizeInBytes/(1024*1024);
939 return number_format($val, (($val<20)?1:0), '.', '').$labelArr[2];
940 } else { // KB
941 $val = $sizeInBytes/(1024);
942 return number_format($val, (($val<20)?1:0), '.', '').$labelArr[1];
943 }
944 } else { // Bytes
945 return $sizeInBytes.$labelArr[0];
946 }
947 }
948
949 /**
950 * Returns microtime input to milliseconds
951 * Usage: 2
952 *
953 * @param string Microtime
954 * @return integer Microtime input string converted to an integer (milliseconds)
955 */
956 function convertMicrotime($microtime) {
957 $parts = explode(' ',$microtime);
958 return round(($parts[0]+$parts[1])*1000);
959 }
960
961 /**
962 * This splits a string by the chars in $operators (typical /+-*) and returns an array with them in
963 * Usage: 2
964 *
965 * @param string Input string, eg "123 + 456 / 789 - 4"
966 * @param string Operators to split by, typically "/+-*"
967 * @return array Array with operators and operands separated.
968 * @see tslib_cObj::calc(), tslib_gifBuilder::calcOffset()
969 */
970 function splitCalc($string,$operators) {
971 $res = Array();
972 $sign='+';
973 while($string) {
974 $valueLen=strcspn($string,$operators);
975 $value=substr($string,0,$valueLen);
976 $res[] = Array($sign,trim($value));
977 $sign=substr($string,$valueLen,1);
978 $string=substr($string,$valueLen+1);
979 }
980 reset($res);
981 return $res;
982 }
983
984 /**
985 * Calculates the input by +,-,*,/,%,^ with priority to + and -
986 * Usage: 1
987 *
988 * @param string Input string, eg "123 + 456 / 789 - 4"
989 * @return integer Calculated value. Or error string.
990 * @see calcParenthesis()
991 */
992 function calcPriority($string) {
993 $string=ereg_replace('[[:space:]]*','',$string); // removing all whitespace
994 $string='+'.$string; // Ensuring an operator for the first entrance
995 $qm='\*\/\+-^%';
996 $regex = '(['.$qm.'])(['.$qm.']?[0-9\.]*)';
997 // split the expression here:
998 preg_match_all('/'.$regex.'/',$string,$reg);
999
1000 reset($reg[2]);
1001 $number=0;
1002 $Msign='+';
1003 $err='';
1004 $buffer=doubleval(current($reg[2]));
1005 next($reg[2]); // Advance pointer
1006 while(list($k,$v)=each($reg[2])) {
1007 $v=doubleval($v);
1008 $sign = $reg[1][$k];
1009 if ($sign=='+' || $sign=='-') {
1010 $number = $Msign=='-' ? $number-=$buffer : $number+=$buffer;
1011 $Msign = $sign;
1012 $buffer=$v;
1013 } else {
1014 if ($sign=='/') {if ($v) $buffer/=$v; else $err='dividing by zero';}
1015 if ($sign=='%') {if ($v) $buffer%=$v; else $err='dividing by zero';}
1016 if ($sign=='*') {$buffer*=$v;}
1017 if ($sign=='^') {$buffer=pow($buffer,$v);}
1018 }
1019 }
1020 $number = $Msign=='-' ? $number-=$buffer : $number+=$buffer;
1021 return $err ? 'ERROR: '.$err : $number;
1022 }
1023
1024 /**
1025 * Calculates the input with parenthesis levels
1026 * Usage: 2
1027 *
1028 * @param string Input string, eg "(123 + 456) / 789 - 4"
1029 * @return integer Calculated value. Or error string.
1030 * @see calcPriority(), tslib_cObj::stdWrap()
1031 */
1032 function calcParenthesis($string) {
1033 $securC=100;
1034 do {
1035 $valueLenO=strcspn($string,'(');
1036 $valueLenC=strcspn($string,')');
1037 if ($valueLenC==strlen($string) || $valueLenC < $valueLenO) {
1038 $value = t3lib_div::calcPriority(substr($string,0,$valueLenC));
1039 $string = $value.substr($string,$valueLenC+1);
1040 return $string;
1041 } else {
1042 $string = substr($string,0,$valueLenO).t3lib_div::calcParenthesis(substr($string,$valueLenO+1));
1043 }
1044 // Security:
1045 $securC--;
1046 if ($securC<=0) break;
1047 } while($valueLenO<strlen($string));
1048 return $string;
1049 }
1050
1051 /**
1052 * Inverse version of htmlspecialchars()
1053 * Usage: 4
1054 *
1055 * @param string Value where &gt;, &lt;, &quot; and &amp; should be converted to regular chars.
1056 * @return string Converted result.
1057 */
1058 function htmlspecialchars_decode($value) {
1059 $value = str_replace('&gt;','>',$value);
1060 $value = str_replace('&lt;','<',$value);
1061 $value = str_replace('&quot;','"',$value);
1062 $value = str_replace('&amp;','&',$value);
1063 return $value;
1064 }
1065
1066 /**
1067 * Re-converts HTML entities if they have been converted by htmlspecialchars()
1068 * Usage: 10
1069 *
1070 * @param string String which contains eg. "&amp;amp;" which should stay "&amp;". Or "&amp;#1234;" to "&#1234;". Or "&amp;#x1b;" to "&#x1b;"
1071 * @return string Converted result.
1072 */
1073 function deHSCentities($str) {
1074 return ereg_replace('&amp;([#[:alnum:]]*;)','&\1',$str);
1075 }
1076
1077 /**
1078 * This function is used to escape any ' -characters when transferring text to JavaScript!
1079 * Usage: 3
1080 *
1081 * @param string String to escape
1082 * @param boolean If set, also backslashes are escaped.
1083 * @param string The character to escape, default is ' (single-quote)
1084 * @return string Processed input string
1085 */
1086 function slashJS($string,$extended=0,$char="'") {
1087 if ($extended) {$string = str_replace ("\\", "\\\\", $string);}
1088 return str_replace ($char, "\\".$char, $string);
1089 }
1090
1091 /**
1092 * Version of rawurlencode() where all spaces (%20) are re-converted to space-characters.
1093 * Usefull when passing text to JavaScript where you simply url-encode it to get around problems with syntax-errors, linebreaks etc.
1094 * Usage: 4
1095 *
1096 * @param string String to raw-url-encode with spaces preserved
1097 * @return string Rawurlencoded result of input string, but with all %20 (space chars) converted to real spaces.
1098 */
1099 function rawUrlEncodeJS($str) {
1100 return str_replace('%20',' ',rawurlencode($str));
1101 }
1102
1103 /**
1104 * rawurlencode which preserves "/" chars
1105 * Usefull when filepaths should keep the "/" chars, but have all other special chars encoded.
1106 * Usage: 5
1107 *
1108 * @param string Input string
1109 * @return string Output string
1110 */
1111 function rawUrlEncodeFP($str) {
1112 return str_replace('%2F','/',rawurlencode($str));
1113 }
1114
1115 /**
1116 * Checking syntax of input email address
1117 * Usage: 5
1118 *
1119 * @param string Input string to evaluate
1120 * @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.
1121 */
1122 function validEmail($email) {
1123 $email = trim ($email);
1124 if (strstr($email,' ')) return FALSE;
1125 return ereg('^[A-Za-z0-9\._-]+[@][A-Za-z0-9\._-]+[\.].[A-Za-z0-9]+$',$email) ? TRUE : FALSE;
1126 }
1127
1128 /**
1129 * Formats a string for output between <textarea>-tags
1130 * All content outputted in a textarea form should be passed through this function
1131 * 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!
1132 * Usage: 23
1133 *
1134 * @param string Input string to be formatted.
1135 * @return string Formatted for <textarea>-tags
1136 */
1137 function formatForTextarea($content) {
1138 return chr(10).htmlspecialchars($content);
1139 }
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152 /*************************
1153 *
1154 * ARRAY FUNCTIONS
1155 *
1156 *************************/
1157
1158 /**
1159 * Check if an item exists in an array
1160 * Please note that the order of parameters is reverse compared to the php4-function in_array()!!!
1161 * Usage: 3
1162 *
1163 * @param array $in_array one-dimensional array of items
1164 * @param string $item item to check for
1165 * @return boolean true if $item is in the one-dimensional array $in_array
1166 * @internal
1167 */
1168 function inArray($in_array,$item) {
1169 if (is_array($in_array)) {
1170 while (list(,$val)=each($in_array)) {
1171 if (!is_array($val) && !strcmp($val,$item)) return true;
1172 }
1173 }
1174 }
1175
1176 /**
1177 * Explodes a $string delimited by $delim and passes each item in the array through intval().
1178 * Corresponds to explode(), but with conversion to integers for all values.
1179 * Usage: 76
1180 *
1181 * @param string Delimiter string to explode with
1182 * @param string The string to explode
1183 * @return array Exploded values, all converted to integers
1184 */
1185 function intExplode($delim, $string) {
1186 $temp = explode($delim,$string);
1187 while(list($key,$val)=each($temp)) {
1188 $temp[$key]=intval($val);
1189 }
1190 reset($temp);
1191 return $temp;
1192 }
1193
1194 /**
1195 * Reverse explode which explodes the string counting from behind.
1196 * Thus t3lib_div::revExplode(':','my:words:here',2) will return array('my:words','here')
1197 * Usage: 8
1198 *
1199 * @param string Delimiter string to explode with
1200 * @param string The string to explode
1201 * @param integer Number of array entries
1202 * @return array Exploded values
1203 */
1204 function revExplode($delim, $string, $count=0) {
1205 $temp = explode($delim,strrev($string),$count);
1206 while(list($key,$val)=each($temp)) {
1207 $temp[$key]=strrev($val);
1208 }
1209 $temp=array_reverse($temp);
1210 reset($temp);
1211 return $temp;
1212 }
1213
1214 /**
1215 * Explodes a string and trims all values for whitespace in the ends.
1216 * If $onlyNonEmptyValues is set, then all blank ('') values are removed.
1217 * Usage: 256
1218 *
1219 * @param string Delimiter string to explode with
1220 * @param string The string to explode
1221 * @param boolean If set, all empty values (='') will NOT be set in output
1222 * @return array Exploded values
1223 */
1224 function trimExplode($delim, $string, $onlyNonEmptyValues=0) {
1225 $temp = explode($delim,$string);
1226 $newtemp=array();
1227 while(list($key,$val)=each($temp)) {
1228 if (!$onlyNonEmptyValues || strcmp('',trim($val))) {
1229 $newtemp[]=trim($val);
1230 }
1231 }
1232 reset($newtemp);
1233 return $newtemp;
1234 }
1235
1236 /**
1237 * Takes a one-dimensional array and returns an array where the values are unique
1238 * The keys in the array are substituted with some md5-hashes
1239 * If the value is trim(empty), the value is ignored.
1240 * Values are trimmed
1241 * (Deprecated, use PHP function array_unique instead)
1242 * Usage: 1
1243 *
1244 * @param array Array of values to make unique
1245 * @return array
1246 * @ignore
1247 * @deprecated
1248 */
1249 function uniqueArray($valueArray) {
1250 $array_out=array();
1251 if (is_array($valueArray)) {
1252 while (list($key,$val)=each($valueArray)) {
1253 $val=trim($val);
1254 if ((string)$val!='') {
1255 $array_out[md5($val)]=$val;
1256 }
1257 }
1258 }
1259 reset($array_out);
1260 return $array_out;
1261 }
1262
1263 /**
1264 * Removes the value $cmpValue from the $array if found there. Returns the modified array
1265 * Usage: 3
1266 *
1267 * @param array Array containing the values
1268 * @param string Value to search for and if found remove array entry where found.
1269 * @return array Output array with entries removed if search string is found
1270 */
1271 function removeArrayEntryByValue($array,$cmpValue) {
1272 if (is_array($array)) {
1273 reset($array);
1274 while(list($k,$v)=each($array)) {
1275 if (is_array($v)) {
1276 $array[$k] = t3lib_div::removeArrayEntryByValue($v,$cmpValue);
1277 } else {
1278 if (!strcmp($v,$cmpValue)) {
1279 unset($array[$k]);
1280 }
1281 }
1282 }
1283 }
1284 reset($array);
1285 return $array;
1286 }
1287
1288 /**
1289 * Implodes a multidim-array into GET-parameters (eg. &param[key][key2]=value2&param[key][key3]=value3)
1290 * Usage: 24
1291 *
1292 * @param string Name prefix for entries. Set to blank if you wish none.
1293 * @param array The (multidim) array to implode
1294 * @param boolean If set, all values that are blank (='') will NOT be imploded
1295 * @param boolean If set, parameters which were blank strings would be removed.
1296 * @param boolean If set, the param name itselt (for example "param[key][key2]") would be rawurlencoded as well.
1297 * @return string Imploded result, fx. &param[key][key2]=value2&param[key][key3]=value3
1298 */
1299 function implodeArrayForUrl($name,$theArray,$str='',$skipBlank=0,$rawurlencodeParamName=0) {
1300 if (is_array($theArray)) {
1301 foreach($theArray as $Akey => $AVal) {
1302 $thisKeyName = $name ? $name.'['.$Akey.']' : $Akey;
1303 if (is_array($AVal)) {
1304 $str = t3lib_div::implodeArrayForUrl($thisKeyName,$AVal,$str,$skipBlank,$rawurlencodeParamName);
1305 } else {
1306 if (!$skipBlank || strcmp($AVal,'')) {
1307 $str.='&'.($rawurlencodeParamName ? rawurlencode($thisKeyName) : $thisKeyName).
1308 '='.rawurlencode($AVal); // strips slashes because _POST / _GET input is with slashes...
1309 }
1310 }
1311 }
1312 }
1313 return $str;
1314 }
1315
1316 /**
1317 * Returns an array with selected keys from incoming data.
1318 * (Better read source code if you want to find out...)
1319 * Usage: 3
1320 *
1321 * @param string List of variable/key names
1322 * @param array Array from where to get values based on the keys in $varList
1323 * @param boolean If set, then t3lib_div::_GP() is used to fetch the value if not found (isset) in the $getArray
1324 * @return array Output array with selected variables.
1325 */
1326 function compileSelectedGetVarsFromArray($varList,$getArray,$GPvarAlt=1) {
1327 $keys = t3lib_div::trimExplode(',',$varList,1);
1328 $outArr=array();
1329 foreach($keys as $v) {
1330 if (isset($getArray[$v])) {
1331 $outArr[$v]=$getArray[$v];
1332 } elseif ($GPvarAlt) {
1333 $outArr[$v]=t3lib_div::_GP($v);
1334 }
1335 }
1336 return $outArr;
1337 }
1338
1339 /**
1340 * AddSlash array
1341 * This function traverses a multidimentional array and adds slashes to the values.
1342 * NOTE that the input array is and argument by reference.!!
1343 * Twin-function to stripSlashesOnArray
1344 * Usage: 8
1345 *
1346 * @param array Multidimensional input array, (REFERENCE!)
1347 * @return array
1348 */
1349 function addSlashesOnArray(&$theArray) {
1350 if (is_array($theArray)) {
1351 reset($theArray);
1352 while(list($Akey,$AVal)=each($theArray)) {
1353 if (is_array($AVal)) {
1354 t3lib_div::addSlashesOnArray($theArray[$Akey]);
1355 } else {
1356 $theArray[$Akey] = addslashes($AVal);
1357 }
1358 }
1359 reset($theArray);
1360 }
1361 }
1362
1363 /**
1364 * StripSlash array
1365 * This function traverses a multidimentional array and strips slashes to the values.
1366 * NOTE that the input array is and argument by reference.!!
1367 * Twin-function to addSlashesOnArray
1368 * Usage: 10
1369 *
1370 * @param array Multidimensional input array, (REFERENCE!)
1371 * @return array
1372 */
1373 function stripSlashesOnArray(&$theArray) {
1374 if (is_array($theArray)) {
1375 reset($theArray);
1376 while(list($Akey,$AVal)=each($theArray)) {
1377 if (is_array($AVal)) {
1378 t3lib_div::stripSlashesOnArray($theArray[$Akey]);
1379 } else {
1380 $theArray[$Akey] = stripslashes($AVal);
1381 }
1382 }
1383 reset($theArray);
1384 }
1385 }
1386
1387 /**
1388 * Either slashes ($cmd=add) or strips ($cmd=strip) array $arr depending on $cmd
1389 * Usage: 0
1390 *
1391 * @param array Multidimensional input array
1392 * @param string "add" or "strip", depending on usage you wish.
1393 * @return array
1394 */
1395 function slashArray($arr,$cmd) {
1396 if ($cmd=='strip') t3lib_div::stripSlashesOnArray($arr);
1397 if ($cmd=='add') t3lib_div::addSlashesOnArray($arr);
1398 return $arr;
1399 }
1400
1401 /**
1402 * 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)
1403 * In case of identical keys, ie. keeping the values of the second.
1404 * Usage: 0
1405 *
1406 * @param array First array
1407 * @param array Second array, overruling the first array
1408 * @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.
1409 * @param boolean If set, values from $arr1 will overrule if they are empty. Default: true
1410 * @return array Resulting array where $arr1 values has overruled $arr0 values
1411 */
1412 function array_merge_recursive_overrule($arr0,$arr1,$notAddKeys=0,$includeEmtpyValues=true) {
1413 reset($arr1);
1414 while(list($key,$val) = each($arr1)) {
1415 if(is_array($arr0[$key])) {
1416 if (is_array($arr1[$key])) {
1417 $arr0[$key] = t3lib_div::array_merge_recursive_overrule($arr0[$key],$arr1[$key],$notAddKeys);
1418 }
1419 } else {
1420 if ($notAddKeys) {
1421 if (isset($arr0[$key])) {
1422 if ($includeEmtpyValues OR $val) {
1423 $arr0[$key] = $val;
1424 }
1425 }
1426 } else {
1427 if ($includeEmtpyValues OR $val) {
1428 $arr0[$key] = $val;
1429 }
1430 }
1431 }
1432 }
1433 reset($arr0);
1434 return $arr0;
1435 }
1436
1437 /**
1438 * 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.
1439 * Usage: 16
1440 *
1441 * @param array First array
1442 * @param array Second array
1443 * @return array Merged result.
1444 */
1445 function array_merge($arr1,$arr2) {
1446 return $arr2+$arr1;
1447 }
1448
1449 /**
1450 * Takes a row and returns a CSV string of the values with $delim (default is ,) and $quote (default is ") as separator chars.
1451 * Usage: 5
1452 *
1453 * @param array Input array of values
1454 * @param string Delimited, default is comman
1455 * @param string Quote-character to wrap around the values.
1456 * @return string A single line of CSV
1457 */
1458 function csvValues($row,$delim=',',$quote='"') {
1459 reset($row);
1460 $out=array();
1461 while(list(,$value)=each($row)) {
1462 list($valPart) = explode(chr(10),$value);
1463 $valPart = trim($valPart);
1464 $out[]=str_replace($quote,$quote.$quote,$valPart);
1465 }
1466 $str = $quote.implode($quote.$delim.$quote,$out).$quote;
1467 return $str;
1468 }
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485 /*************************
1486 *
1487 * HTML/XML PROCESSING
1488 *
1489 *************************/
1490
1491 /**
1492 * Returns an array with all attributes of the input HTML tag as key/value pairs. Attributes are only lowercase a-z
1493 * $tag is either a whole tag (eg '<TAG OPTION ATTRIB=VALUE>') or the parameterlist (ex ' OPTION ATTRIB=VALUE>')
1494 * 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()
1495 * Usage: 8
1496 *
1497 * @param string HTML-tag string (or attributes only)
1498 * @return array Array with the attribute values.
1499 */
1500 function get_tag_attributes($tag) {
1501 $components = t3lib_div::split_tag_attributes($tag);
1502 $name = ''; // attribute name is stored here
1503 $valuemode = '';
1504 if (is_array($components)) {
1505 while (list($key,$val) = each ($components)) {
1506 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
1507 if ($valuemode) {
1508 if ($name) {
1509 $attributes[$name] = $val;
1510 $name = '';
1511 }
1512 } else {
1513 if ($key = strtolower(ereg_replace('[^a-zA-Z0-9]','',$val))) {
1514 $attributes[$key] = '';
1515 $name = $key;
1516 }
1517 }
1518 $valuemode = '';
1519 } else {
1520 $valuemode = 'on';
1521 }
1522 }
1523 if (is_array($attributes)) reset($attributes);
1524 return $attributes;
1525 }
1526 }
1527
1528 /**
1529 * Returns an array with the 'components' from an attribute list from an HTML tag. The result is normally analyzed by get_tag_attributes
1530 * Removes tag-name if found
1531 * Usage: 2
1532 *
1533 * @param string HTML-tag string (or attributes only)
1534 * @return array Array with the attribute values.
1535 * @internal
1536 */
1537 function split_tag_attributes($tag) {
1538 $tag_tmp = trim(eregi_replace ('^<[^[:space:]]*','',trim($tag)));
1539 // Removes any > in the end of the string
1540 $tag_tmp = trim(eregi_replace ('>$','',$tag_tmp));
1541
1542 while (strcmp($tag_tmp,'')) { // Compared with empty string instead , 030102
1543 $firstChar=substr($tag_tmp,0,1);
1544 if (!strcmp($firstChar,'"') || !strcmp($firstChar,"'")) {
1545 $reg=explode($firstChar,$tag_tmp,3);
1546 $value[]=$reg[1];
1547 $tag_tmp=trim($reg[2]);
1548 } elseif (!strcmp($firstChar,'=')) {
1549 $value[] = '=';
1550 $tag_tmp = trim(substr($tag_tmp,1)); // Removes = chars.
1551 } else {
1552 // There are '' around the value. We look for the next ' ' or '>'
1553 $reg = split('[[:space:]=]',$tag_tmp,2);
1554 $value[] = trim($reg[0]);
1555 $tag_tmp = trim(substr($tag_tmp,strlen($reg[0]),1).$reg[1]);
1556 }
1557 }
1558 if (is_array($value)) reset($value);
1559 return $value;
1560 }
1561
1562 /**
1563 * Implodes attributes in the array $arr for an attribute list in eg. and HTML tag (with quotes)
1564 * Usage: 14
1565 *
1566 * @param array Array with attribute key/value pairs, eg. "bgcolor"=>"red", "border"=>0
1567 * @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!
1568 * @param boolean If true, don't check if values are blank. Default is to omit attributes with blank values.
1569 * @return string Imploded attributes, eg. 'bgcolor="red" border="0"'
1570 */
1571 function implodeAttributes($arr,$xhtmlSafe=FALSE,$dontOmitBlankAttribs=FALSE) {
1572 if (is_array($arr)) {
1573 if ($xhtmlSafe) {
1574 $newArr=array();
1575 foreach($arr as $p => $v) {
1576 if (!isset($newArr[strtolower($p)])) $newArr[strtolower($p)] = htmlspecialchars($v);
1577 }
1578 $arr = $newArr;
1579 }
1580 $list = array();
1581 foreach($arr as $p => $v) {
1582 if (strcmp($v,'') || $dontOmitBlankAttribs) {$list[]=$p.'="'.$v.'"';}
1583 }
1584 return implode(' ',$list);
1585 }
1586 }
1587
1588 /**
1589 * Implodes attributes in the array $arr for an attribute list in eg. and HTML tag (with quotes)
1590 *
1591 * @param array See implodeAttributes()
1592 * @param boolean See implodeAttributes()
1593 * @param boolean See implodeAttributes()
1594 * @return string See implodeAttributes()
1595 * @deprecated Name was changed into implodeAttributes
1596 * @see implodeAttributes()
1597 */
1598 function implodeParams($arr,$xhtmlSafe=FALSE,$dontOmitBlankAttribs=FALSE) {
1599 return t3lib_div::implodeAttributes($arr,$xhtmlSafe,$dontOmitBlankAttribs);
1600 }
1601
1602 /**
1603 * Wraps JavaScript code XHTML ready with <script>-tags
1604 * Automatic re-identing of the JS code is done by using the first line as ident reference.
1605 * This is nice for identing JS code with PHP code on the same level.
1606 *
1607 * @param string JavaScript code
1608 * @param boolean Wrap script element in linebreaks? Default is TRUE.
1609 * @return string The wrapped JS code, ready to put into a XHTML page
1610 * @author Ingmar Schlecht <ingmars@web.de>
1611 * @author René Fritz <r.fritz@colorcube.de>
1612 */
1613 function wrapJS($string, $linebreak=TRUE) {
1614 if(trim($string)) {
1615 // <script wrapped in nl?
1616 $cr = $linebreak? "\n" : '';
1617
1618 // remove nl from the beginning
1619 $string = preg_replace ('/^\n+/', '', $string);
1620 // re-ident to one tab using the first line as reference
1621 if(preg_match('/^(\t+)/',$string,$match)) {
1622 $string = str_replace($match[1],"\t", $string);
1623 }
1624 $string = $cr.'<script type="text/javascript">
1625 /*<![CDATA[*/
1626 '.$string.'
1627 /*]]>*/
1628 </script>'.$cr;
1629 }
1630 return trim($string);
1631 }
1632
1633
1634 /**
1635 * Parses XML input into a PHP array with associative keys
1636 * Usage: 0
1637 *
1638 * @param string XML data input
1639 * @param integer Number of element levels to resolve the XML into an array. Any further structure will be set as XML.
1640 * @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.
1641 * @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
1642 */
1643 function xml2tree($string,$depth=999) {
1644 $parser = xml_parser_create();
1645 $vals = array();
1646 $index = array();
1647
1648 xml_parser_set_option($parser, XML_OPTION_CASE_FOLDING, 0);
1649 xml_parser_set_option($parser, XML_OPTION_SKIP_WHITE, 0);
1650 xml_parse_into_struct($parser, $string, $vals, $index);
1651
1652 if (xml_get_error_code($parser)) return 'Line '.xml_get_current_line_number($parser).': '.xml_error_string(xml_get_error_code($parser));
1653 xml_parser_free($parser);
1654
1655 $stack = array( array() );
1656 $stacktop = 0;
1657 $startPoint=0;
1658
1659 unset($tagi);
1660 foreach($vals as $key => $val) {
1661 $type = $val['type'];
1662
1663 // open tag:
1664 if ($type=='open' || $type=='complete') {
1665 $stack[$stacktop++] = $tagi;
1666
1667 if ($depth==$stacktop) {
1668 $startPoint=$key;
1669 }
1670
1671 $tagi = array('tag' => $val['tag']);
1672
1673 if(isset($val['attributes'])) $tagi['attrs'] = $val['attributes'];
1674 if(isset($val['value'])) $tagi['values'][] = $val['value'];
1675 }
1676 // finish tag:
1677 if ($type=='complete' || $type=='close') {
1678 $oldtagi = $tagi;
1679 $tagi = $stack[--$stacktop];
1680 $oldtag = $oldtagi['tag'];
1681 unset($oldtagi['tag']);
1682
1683 if ($depth==($stacktop+1)) {
1684 if ($key-$startPoint > 0) {
1685 $partArray = array_slice(
1686 $vals,
1687 $startPoint+1,
1688 $key-$startPoint-1
1689 );
1690 #$oldtagi=array('XMLvalue'=>t3lib_div::xmlRecompileFromStructValArray($partArray));
1691 $oldtagi['XMLvalue']=t3lib_div::xmlRecompileFromStructValArray($partArray);
1692 } else {
1693 $oldtagi['XMLvalue']=$oldtagi['values'][0];
1694 }
1695 }
1696
1697 $tagi['ch'][$oldtag][] = $oldtagi;
1698 unset($oldtagi);
1699 }
1700 // cdata
1701 if($type=='cdata') {
1702 $tagi['values'][] = $val['value'];
1703 }
1704 }
1705 return $tagi['ch'];
1706 }
1707
1708 /**
1709 * Converts a PHP array into an XML string.
1710 * The XML output is optimized for readability since associative keys are used as tagnames.
1711 * 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.
1712 * Numeric keys are stored with the default tagname "numIndex" but can be overridden to other formats)
1713 * 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
1714 * 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.
1715 * The output XML has been tested with the PHP XML-parser and parses OK under all tested circumstances.
1716 * 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...
1717 * Usage: 5
1718 *
1719 * @param array The input PHP array with any kind of data; text, binary, integers. Not objects though.
1720 * @param string tag-prefix, eg. a namespace prefix like "T3:"
1721 * @param integer Current recursion level. Don't change, stay at zero!
1722 * @param string Alternative document tag. Default is "phparray".
1723 * @param integer If set, the number of spaces corresponding to this number is used for indenting, otherwise a single chr(9) (TAB) is used
1724 * @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')
1725 * @param string Parent tag name. Don't touch.
1726 * @return string An XML string made from the input content in the array.
1727 * @see xml2array()
1728 */
1729 function array2xml($array,$NSprefix='',$level=0,$docTag='phparray',$spaceInd=0, $options=array(),$parentTagName='') {
1730 // 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
1731 $binaryChars = chr(0).chr(1).chr(2).chr(3).chr(4).chr(5).chr(6).chr(7).chr(8).
1732 chr(11).chr(12).chr(14).chr(15).chr(16).chr(17).chr(18).chr(19).
1733 chr(20).chr(21).chr(22).chr(23).chr(24).chr(25).chr(26).chr(27).chr(28).chr(29).
1734 chr(30).chr(31);
1735 // Set indenting mode:
1736 $indentChar = $spaceInd ? ' ' : chr(9);
1737 $indentN = $spaceInd>0 ? $spaceInd : 1;
1738
1739 // Init output variable:
1740 $output='';
1741
1742 // Traverse the input array
1743 if (is_array($array)) {
1744 foreach($array as $k=>$v) {
1745 $attr = '';
1746 $tagName = $k;
1747
1748 // Construct the tag name.
1749 if (!strcmp(intval($tagName),$tagName)) { // If integer...;
1750 if ($options['useNindex']) { // If numeric key, prefix "n"
1751 $tagName = 'n'.$tagName;
1752 } else { // Use special tag for num. keys:
1753 $attr.=' index="'.$tagName.'"';
1754 $tagName = $options['useIndexTagForNum'] ? $options['useIndexTagForNum'] : 'numIndex';
1755 }
1756 } elseif($options['useIndexTagForAssoc']) { // Use tag for all associative keys:
1757 $attr.=' index="'.htmlspecialchars($tagName).'"';
1758 $tagName = $options['useIndexTagForAssoc'];
1759 } elseif(isset($options['parentTagMap'][$parentTagName])) { // Use tag based on parent tag name:
1760 $attr.=' index="'.htmlspecialchars($tagName).'"';
1761 $tagName = (string)$options['parentTagMap'][$parentTagName];
1762 }
1763
1764 // The tag name is cleaned up so only alphanumeric chars (plus - and _) are in there and not longer than 100 chars either.
1765 $tagName = substr(ereg_replace('[^[:alnum:]_-]','',$tagName),0,100);
1766
1767 // If the value is an array then we will call this function recursively:
1768 if (is_array($v)) {
1769 // Sub elements:
1770 $content = chr(10).t3lib_div::array2xml($v,$NSprefix,$level+1,'',$spaceInd,$options,$tagName).
1771 str_pad('',($level+1)*$indentN,$indentChar);
1772 $attr.=' type="array"';
1773 } else { // Just a value:
1774
1775 // Look for binary chars:
1776 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!
1777 // If the value contained binary chars then we base64-encode it an set an attribute to notify this situation:
1778 $content = chr(10).chunk_split(base64_encode($v));
1779 $attr.=' base64="1"';
1780 } else {
1781 // Otherwise, just htmlspecialchar the stuff:
1782 $content = htmlspecialchars($v);
1783 $dType = gettype($v);
1784 if ($dType!='string') { $attr.=' type="'.$dType.'"'; }
1785 }
1786 }
1787
1788 // Add the element to the output string:
1789 $output.=str_pad('',($level+1)*$indentN,$indentChar).'<'.$NSprefix.$tagName.$attr.'>'.$content.'</'.$NSprefix.$tagName.'>'.chr(10);
1790 }
1791 }
1792
1793 // If we are at the outer-most level, then we finally wrap it all in the document tags and return that as the value:
1794 if (!$level) {
1795 $output =
1796 '<'.$docTag.'>'.chr(10).
1797 $output.
1798 '</'.$docTag.'>';
1799 }
1800
1801 return $output;
1802 }
1803
1804 /**
1805 * Converts an XML string to a PHP array.
1806 * This is the reverse function of array2xml()
1807 * Usage: 17
1808 *
1809 * @param string XML content to convert into an array
1810 * @param string The tag-prefix resolve, eg. a namespace like "T3:"
1811 * @return mixed If the parsing had errors, a string with the error message is returned. Otherwise an array with the content.
1812 * @see array2xml()
1813 */
1814 function xml2array($string,$NSprefix='') {
1815 global $TYPO3_CONF_VARS;
1816
1817 // Create parser:
1818 $parser = xml_parser_create();
1819 $vals = array();
1820 $index = array();
1821
1822 xml_parser_set_option($parser, XML_OPTION_CASE_FOLDING, 0);
1823 xml_parser_set_option($parser, XML_OPTION_SKIP_WHITE, 0);
1824
1825 // PHP5 fix of charset awareness:
1826 // 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.
1827 // 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.
1828 // 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.
1829 if ((double)phpversion()>=5) {
1830 unset($ereg_result);
1831 ereg('^[[:space:]]*<\?xml[^>]*encoding[[:space:]]*=[[:space:]]*"([^"]*)"',substr($string,0,200),$ereg_result);
1832 $theCharset = $ereg_result[1] ? $ereg_result[1] : ($TYPO3_CONF_VARS['BE']['forceCharset'] ? $TYPO3_CONF_VARS['BE']['forceCharset'] : 'iso-8859-1');
1833 xml_parser_set_option($parser, XML_OPTION_TARGET_ENCODING, $theCharset); // us-ascii / utf-8 / iso-8859-1
1834 }
1835
1836 // Parse content:
1837 xml_parse_into_struct($parser, $string, $vals, $index);
1838
1839 // If error, return error message:
1840 if (xml_get_error_code($parser)) return 'Line '.xml_get_current_line_number($parser).': '.xml_error_string(xml_get_error_code($parser));
1841 xml_parser_free($parser);
1842
1843 // Init vars:
1844 $stack = array(array());
1845 $stacktop = 0;
1846 $current=array();
1847 $tagName='';
1848
1849 // Traverse the parsed XML structure:
1850 foreach($vals as $key => $val) {
1851
1852 // First, process the tag-name (which is used in both cases, whether "complete" or "close")
1853 $tagName = $val['tag'];
1854
1855 // Test for name space:
1856 $tagName = ($NSprefix && substr($tagName,0,strlen($NSprefix))==$NSprefix) ? substr($tagName,strlen($NSprefix)) : $tagName;
1857
1858 // Test for numeric tag, encoded on the form "nXXX":
1859 $testNtag = substr($tagName,1); // Closing tag.
1860 $tagName = (substr($tagName,0,1)=='n' && !strcmp(intval($testNtag),$testNtag)) ? intval($testNtag) : $tagName;
1861
1862 // Test for alternative index value:
1863 if (strlen($val['attributes']['index'])) { $tagName = $val['attributes']['index']; }
1864
1865 // Setting tag-values, manage stack:
1866 switch($val['type']) {
1867 case 'open': // If open tag it means there is an array stored in sub-elements. Therefore increase the stackpointer and reset the accumulation array:
1868 $current[$tagName] = array(); // Setting blank place holder
1869 $stack[$stacktop++] = $current;
1870 $current = array();
1871 break;
1872 case 'close': // If the tag is "close" then it is an array which is closing and we decrease the stack pointer.
1873 $oldCurrent = $current;
1874 $current = $stack[--$stacktop];
1875 end($current); // Going to the end of array to get placeholder key, key($current), and fill in array next:
1876 $current[key($current)] = $oldCurrent;
1877 unset($oldCurrent);
1878 break;
1879 case 'complete': // If "complete", then it's a value. If the attribute "base64" is set, then decode the value, otherwise just set it.
1880 if ($val['attributes']['base64']) {
1881 $current[$tagName] = base64_decode($val['value']);
1882 } else {
1883 $current[$tagName] = (string)$val['value']; // Had to cast it as a string - otherwise it would be evaluate false if tested with isset()!!
1884
1885 // Cast type:
1886 switch((string)$val['attributes']['type']) {
1887 case 'integer':
1888 $current[$tagName] = (integer)$current[$tagName];
1889 break;
1890 case 'double':
1891 $current[$tagName] = (double)$current[$tagName];
1892 break;
1893 case 'boolean':
1894 $current[$tagName] = (bool)$current[$tagName];
1895 break;
1896 case 'array':
1897 $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...
1898 break;
1899 }
1900 }
1901 break;
1902 }
1903 }
1904
1905 // Finally return the content of the document tag.
1906 return $current[$tagName];
1907 }
1908
1909 /**
1910 * This implodes an array of XML parts (made with xml_parse_into_struct()) into XML again.
1911 * Usage: 2
1912 *
1913 * @param array A array of XML parts, see xml2tree
1914 * @return string Re-compiled XML data.
1915 */
1916 function xmlRecompileFromStructValArray($vals) {
1917 $XMLcontent='';
1918
1919 foreach($vals as $val) {
1920 $type = $val['type'];
1921
1922 // open tag:
1923 if ($type=='open' || $type=='complete') {
1924 $XMLcontent.='<'.$val['tag'];
1925 if(isset($val['attributes'])) {
1926 foreach($val['attributes'] as $k => $v) {
1927 $XMLcontent.=' '.$k.'="'.htmlspecialchars($v).'"';
1928 }
1929 }
1930 if ($type=='complete') {
1931 if(isset($val['value'])) {
1932 $XMLcontent.='>'.htmlspecialchars($val['value']).'</'.$val['tag'].'>';
1933 } else $XMLcontent.='/>';
1934 } else $XMLcontent.='>';
1935
1936 if ($type=='open' && isset($val['value'])) {
1937 $XMLcontent.=htmlspecialchars($val['value']);
1938 }
1939 }
1940 // finish tag:
1941 if ($type=='close') {
1942 $XMLcontent.='</'.$val['tag'].'>';
1943 }
1944 // cdata
1945 if($type=='cdata') {
1946 $XMLcontent.=htmlspecialchars($val['value']);
1947 }
1948 }
1949
1950 return $XMLcontent;
1951 }
1952
1953 /**
1954 * Extract the encoding scheme as found in the first line of an XML document (typically)
1955 * Usage: 1
1956 *
1957 * @param string XML data
1958 * @return string Encoding scheme (lowercase), if found.
1959 */
1960 function xmlGetHeaderAttribs($xmlData) {
1961 $xmlHeader = substr(trim($xmlData),0,200);
1962 $reg=array();
1963 if (eregi('^<\?xml([^>]*)\?\>',$xmlHeader,$reg)) {
1964 return t3lib_div::get_tag_attributes($reg[1]);
1965 }
1966 }
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978 /*************************
1979 *
1980 * FILES FUNCTIONS
1981 *
1982 *************************/
1983
1984 /**
1985 * Reads the file or url $url and returns the content
1986 * 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.
1987 * Usage: 83
1988 *
1989 * @param string Filepath/URL to read
1990 * @return string The content from the resource given as input.
1991 */
1992 function getURL($url) {
1993 $content = '';
1994
1995 // (Proxy support implemented by Arco <arco@appeltaart.mine.nu>)
1996 if((substr($url,0,7)=='http://') && ($GLOBALS['TYPO3_CONF_VARS']['SYS']['curlUse']=='1')) {
1997 //external URL without error checking.
1998 $ch = curl_init();
1999 curl_setopt ($ch,CURLOPT_URL, $url);
2000 curl_setopt ($ch,CURLOPT_HEADER, 0);
2001 curl_setopt ($ch,CURLOPT_RETURNTRANSFER, 1);
2002
2003 if ($GLOBALS['TYPO3_CONF_VARS']['SYS']['curlProxyServer']) {
2004 curl_setopt ($ch, CURLOPT_PROXY, $GLOBALS['TYPO3_CONF_VARS']['SYS']['curlProxyServer']);
2005
2006 // I don't know if it will be needed
2007 if ($GLOBALS['TYPO3_CONF_VARS']['SYS']['curlProxyTunnel']) {
2008 curl_setopt ($ch, CURLOPT_HTTPPROXYTUNNEL, $GLOBALS['TYPO3_CONF_VARS']['SYS']['curlProxyTunnel'] );
2009 }
2010 if ($GLOBALS['TYPO3_CONF_VARS']['SYS']['curlProxyUserPass']) {
2011 curl_setopt ($ch, CURLOPT_PROXYUSERPWD, $GLOBALS['TYPO3_CONF_VARS']['SYS']['curlProxyUserPass'] );
2012 }
2013 }
2014 $content=curl_exec ($ch);
2015 curl_close ($ch);
2016 return $content;
2017 } elseif($fd = fopen($url,'rb')) {
2018 while (!feof($fd)) {
2019 $content.=fread($fd, 5000);
2020 }
2021 fclose($fd);
2022 return $content;
2023 }
2024 }
2025
2026 /**
2027 * Writes $content to the file $file
2028 * Usage: 30
2029 *
2030 * @param string Filepath to write to
2031 * @param string Content to write
2032 * @return boolean True if the file was successfully opened and written to.
2033 */
2034 function writeFile($file,$content) {
2035 if($fd = fopen($file,'wb')) {
2036 fwrite( $fd, $content);
2037 fclose( $fd );
2038
2039 // Setting file system mode & group ownership of file:
2040 if (@is_file($file) && TYPO3_OS!='WIN') {
2041 @chmod($file, octdec($GLOBALS['TYPO3_CONF_VARS']['BE']['fileCreateMask'])); // "@" is there because file is not necessarily OWNED by the user
2042 if($GLOBALS['TYPO3_CONF_VARS']['BE']['createGroup']) { // skip this if createGroup is empty
2043 @chgrp($file, $GLOBALS['TYPO3_CONF_VARS']['BE']['createGroup']); // "@" is there because file is not necessarily OWNED by the user
2044 }
2045 }
2046
2047 return true;
2048 }
2049 }
2050
2051 /**
2052 * Writes $content to a filename in the typo3temp/ folder (and possibly a subfolder...)
2053 * Accepts an additional subdirectory in the file path!
2054 *
2055 * @param string Absolute filepath to write to inside "typo3temp/". First part of this string must match PATH_site."typo3temp/"
2056 * @param string Content string to write
2057 * @return string Returns false on success, otherwise an error string telling about the problem.
2058 */
2059 function writeFileToTypo3tempDir($filepath,$content) {
2060
2061 // Parse filepath into directory and basename:
2062 $fI = pathinfo($filepath);
2063 $fI['dirname'].= '/';
2064
2065 // Check parts:
2066 if (t3lib_div::validPathStr($filepath) && $fI['basename'] && strlen($fI['basename'])<60) {
2067 if (defined('PATH_site')) {
2068 $dirName = PATH_site.'typo3temp/'; // Setting main temporary directory name (standard)
2069 if (@is_dir($dirName)) {
2070 if (t3lib_div::isFirstPartOfStr($fI['dirname'],$dirName)) {
2071
2072 // Checking if the "subdir" is found:
2073 $subdir = substr($fI['dirname'],strlen($dirName));
2074 if ($subdir) {
2075 if (ereg('^[[:alnum:]_]+\/$',$subdir)) {
2076 $dirName.= $subdir;
2077 if (!@is_dir($dirName)) {
2078 t3lib_div::mkdir($dirName);
2079 }
2080 } else return 'Subdir, "'.$subdir.'", was NOT on the form "[a-z]/"';
2081 }
2082 // Checking dir-name again (sub-dir might have been created):
2083 if (@is_dir($dirName)) {
2084 if ($filepath == $dirName.$fI['basename']) {
2085 t3lib_div::writeFile($filepath, $content);
2086 if (!@is_file($filepath)) return 'File not written to disk! Write permission error in filesystem?';
2087 } else return 'Calculated filelocation didn\'t match input $filepath!';
2088 } else return '"'.$dirName.'" is not a directory!';
2089 } else return '"'.$fI['dirname'].'" was not within directory PATH_site + "typo3temp/"';
2090 } else return 'PATH_site + "typo3temp/" was not a directory!';
2091 } else return 'PATH_site constant was NOT defined!';
2092 } else return 'Input filepath "'.$filepath.'" was generally invalid!';
2093 }
2094
2095 /**
2096 * 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']
2097 * Usage: 6
2098 *
2099 * @param string Absolute path to folder, see PHP mkdir() function. Removes trailing slash internally.
2100 * @return boolean TRUE if @mkdir went well!
2101 */
2102 function mkdir($theNewFolder) {
2103 $theNewFolder = ereg_replace('\/$','',$theNewFolder);
2104 if (mkdir($theNewFolder, octdec($GLOBALS['TYPO3_CONF_VARS']['BE']['folderCreateMask']))){
2105 chmod($theNewFolder, octdec($GLOBALS['TYPO3_CONF_VARS']['BE']['folderCreateMask'])); //added this line, because the mode at 'mkdir' has a strange behaviour sometimes
2106
2107 if($GLOBALS['TYPO3_CONF_VARS']['BE']['createGroup']) { // skip this if createGroup is empty
2108 chgrp($theNewFolder, $GLOBALS['TYPO3_CONF_VARS']['BE']['createGroup']);
2109 }
2110 return TRUE;
2111 }
2112 }
2113
2114 /**
2115 * Returns an array with the names of folders in a specific path
2116 * Will return 'error' (string) if there were an error with reading directory content.
2117 * Usage: 11
2118 *
2119 * @param string Path to list directories from
2120 * @return array Returns an array with the directory entries as values. If no path, the return value is nothing.
2121 */
2122 function get_dirs($path) {
2123 if ($path) {
2124 $d = @dir($path);
2125 if (is_object($d)) {
2126 while($entry=$d->read()) {
2127 if (@is_dir($path.'/'.$entry) && $entry!= '..' && $entry!= '.') {
2128 $filearray[]=$entry;
2129 }
2130 }
2131 $d->close();
2132 } else return 'error';
2133 return $filearray;
2134 }
2135 }
2136
2137 /**
2138 * Returns an array with the names of files in a specific path
2139 * Usage: 18
2140 *
2141 * @param string $path: Is the path to the file
2142 * @param string $extensionList is the comma list of extensions to read only (blank = all)
2143 * @param boolean If set, then the path is prepended the filenames. Otherwise only the filenames are returned in the array
2144 * @param string $order is sorting: 1= sort alphabetically, 'mtime' = sort by modification time.
2145 * @return array Array of the files found
2146 */
2147 function getFilesInDir($path,$extensionList='',$prependPath=0,$order='') {
2148
2149 // Initialize variabels:
2150 $filearray = array();
2151 $sortarray = array();
2152 $path = ereg_replace('\/$','',$path);
2153
2154 // Find files+directories:
2155 if (@is_dir($path)) {
2156 $extensionList = strtolower($extensionList);
2157 $d = dir($path);
2158 if (is_object($d)) {
2159 while($entry=$d->read()) {
2160 if (@is_file($path.'/'.$entry)) {
2161 $fI = pathinfo($entry);
2162 $key = md5($path.'/'.$entry);
2163 if (!$extensionList || t3lib_div::inList($extensionList,strtolower($fI['extension']))) {
2164 $filearray[$key]=($prependPath?$path.'/':'').$entry;
2165 if ($order=='mtime') {$sortarray[$key]=filemtime($path.'/'.$entry);}
2166 elseif ($order) {$sortarray[$key]=$entry;}
2167 }
2168 }
2169 }
2170 $d->close();
2171 } else return 'error opening path: "'.$path.'"';
2172 }
2173
2174 // Sort them:
2175 if ($order) {
2176 asort($sortarray);
2177 reset($sortarray);
2178 $newArr=array();
2179 while(list($k,$v)=each($sortarray)) {
2180 $newArr[$k]=$filearray[$k];
2181 }
2182 $filearray=$newArr;
2183 }
2184
2185 // Return result
2186 reset($filearray);
2187 return $filearray;
2188 }
2189
2190 /**
2191 * Recursively gather all files and folders of a path.
2192 * Usage: 5
2193 *
2194 * @param array $fileArr: Empty input array (will have files added to it)
2195 * @param string $path: The path to read recursively from (absolute) (include trailing slash!)
2196 * @param string $extList: Comma list of file extensions: Only files with extensions in this list (if applicable) will be selected.
2197 * @param boolean $regDirs: If set, directories are also included in output.
2198 * @param integer $recursivityLevels: The number of levels to dig down...
2199 * @return array An array with the found files/directories.
2200 */
2201 function getAllFilesAndFoldersInPath($fileArr,$path,$extList='',$regDirs=0,$recursivityLevels=99) {
2202 if ($regDirs) $fileArr[] = $path;
2203 $fileArr = array_merge($fileArr, t3lib_div::getFilesInDir($path,$extList,1,1));
2204
2205 $dirs = t3lib_div::get_dirs($path);
2206 if (is_array($dirs) && $recursivityLevels>0) {
2207 foreach ($dirs as $subdirs) {
2208 if ((string)$subdirs!='') {
2209 $fileArr = t3lib_div::getAllFilesAndFoldersInPath($fileArr,$path.$subdirs.'/',$extList,$regDirs,$recursivityLevels-1);
2210 }
2211 }
2212 }
2213 return $fileArr;
2214 }
2215
2216 /**
2217 * Removes the absolute part of all files/folders in fileArr
2218 * Usage: 2
2219 *
2220 * @param array $fileArr: The file array to remove the prefix from
2221 * @param string $prefixToRemove: The prefix path to remove (if found as first part of string!)
2222 * @return array The input $fileArr processed.
2223 */
2224 function removePrefixPathFromList($fileArr,$prefixToRemove) {
2225 foreach($fileArr as $k => $absFileRef) {
2226 if(t3lib_div::isFirstPartOfStr($absFileRef,$prefixToRemove)) {
2227 $fileArr[$k] = substr($absFileRef,strlen($prefixToRemove));
2228 } else return 'ERROR: One or more of the files was NOT prefixed with the prefix-path!';
2229 }
2230 return $fileArr;
2231 }
2232
2233 /**
2234 * Fixes a path for windows-backslashes and reduces double-slashes to single slashes
2235 * Usage: 2
2236 *
2237 * @param string File path to process
2238 * @return string
2239 */
2240 function fixWindowsFilePath($theFile) {
2241 return str_replace('//','/', str_replace('\\','/', $theFile));
2242 }
2243
2244 /**
2245 * Resolves "../" sections in the input path string.
2246 * For example "fileadmin/directory/../other_directory/" will be resolved to "fileadmin/other_directory/"
2247 * Usage: 2
2248 *
2249 * @param string File path in which "/../" is resolved
2250 * @return string
2251 */
2252 function resolveBackPath($pathStr) {
2253 $parts = explode('/',$pathStr);
2254 $output=array();
2255 foreach($parts as $pV) {
2256 if ($pV=='..') {
2257 if ($c) {
2258 array_pop($output);
2259 $c--;
2260 } else $output[]=$pV;
2261 } else {
2262 $c++;
2263 $output[]=$pV;
2264 }
2265 }
2266 return implode('/',$output);
2267 }
2268
2269 /**
2270 * Prefixes a URL used with 'header-location' with 'http://...' depending on whether it has it already.
2271 * - If already having a scheme, nothing is prepended
2272 * - If having REQUEST_URI slash '/', then prefixing 'http://[host]' (relative to host)
2273 * - Otherwise prefixed with TYPO3_REQUEST_DIR (relative to current dir / TYPO3_REQUEST_DIR)
2274 * Usage: 30
2275 *
2276 * @param string URL / path to prepend full URL addressing to.
2277 * @return string
2278 */
2279 function locationHeaderUrl($path) {
2280 $uI = parse_url($path);
2281 if (substr($path,0,1)=='/') { // relative to HOST
2282 $path = t3lib_div::getIndpEnv('TYPO3_REQUEST_HOST').$path;
2283 } elseif (!$uI['scheme']) { // No scheme either
2284 $path = t3lib_div::getIndpEnv('TYPO3_REQUEST_DIR').$path;
2285 }
2286 return $path;
2287 }
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304 /*************************
2305 *
2306 * DEBUG helper FUNCTIONS
2307 *
2308 *************************/
2309
2310 /**
2311 * Returns a string with a list of ascii-values for the first $characters characters in $string
2312 * Usage: 0
2313 *
2314 * @param string String to show ASCII value for
2315 * @param integer Number of characters to show
2316 * @return string The string with ASCII values in separated by a space char.
2317 * @internal
2318 */
2319 function debug_ordvalue($string,$characters=100) {
2320 if(strlen($string) < $characters) $characters = strlen($string);
2321 for ($i=0; $i<$characters; $i++) {
2322 $valuestring.=' '.ord(substr($string,$i,1));
2323 }
2324 return trim($valuestring);
2325 }
2326
2327 /**
2328 * Returns HTML-code, which is a visual representation of a multidimensional array
2329 * use t3lib_div::print_array() in order to print an array
2330 * Returns false if $array_in is not an array
2331 * Usage: 31
2332 *
2333 * @param array Array to view
2334 * @return string HTML output
2335 */
2336 function view_array($array_in) {
2337 if (is_array($array_in)) {
2338 $result='<table border="1" cellpadding="1" cellspacing="0" bgcolor="white">';
2339 if (!count($array_in)) {$result.= '<tr><td><font face="Verdana,Arial" size="1"><b>'.htmlspecialchars("EMPTY!").'</b></font></td></tr>';}
2340 while (list($key,$val)=each($array_in)) {
2341 $result.= '<tr><td><font face="Verdana,Arial" size="1">'.htmlspecialchars((string)$key).'</font></td><td>';
2342 if (is_array($array_in[$key])) {
2343 $result.=t3lib_div::view_array($array_in[$key]);
2344 } else
2345 $result.= '<font face="Verdana,Arial" size="1" color="red">'.nl2br(htmlspecialchars((string)$val)).'<br /></font>';
2346 $result.= '</td></tr>';
2347 }
2348 $result.= '</table>';
2349 } else {
2350 $result = false;
2351 }
2352 return $result;
2353 }
2354
2355 /**
2356 * Prints an array
2357 * Usage: 6
2358 *
2359 * @param array Array to print visually (in a table).
2360 * @return void
2361 * @internal
2362 * @see view_array()
2363 */
2364 function print_array($array_in) {
2365 echo t3lib_div::view_array($array_in);
2366 }
2367
2368 /**
2369 * Makes debug output
2370 * Prints $var in bold between two vertical lines
2371 * If not $var the word 'debug' is printed
2372 * If $var is an array, the array is printed by t3lib_div::print_array()
2373 * Usage: 8
2374 *
2375 * @param mixed Variable to print
2376 * @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.
2377 * @return void
2378 */
2379 function debug($var="",$brOrHeader=0) {
2380 if ($brOrHeader && !t3lib_div::testInt($brOrHeader)) {
2381 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>';
2382 } elseif ($brOrHeader<0) {
2383 for($a=0;$a<abs(intval($brOrHeader));$a++){echo '<br />';}
2384 }
2385
2386 if (is_array($var)) {
2387 t3lib_div::print_array($var);
2388 } elseif (is_object($var)) {
2389 echo '<b>|Object:<pre>';
2390 print_r($var);
2391 echo '</pre>|</b>';
2392 } elseif ((string)$var!='') {
2393 echo '<b>|'.htmlspecialchars((string)$var).'|</b>';
2394 } else {
2395 echo '<b>| debug |</b>';
2396 }
2397
2398 if ($brOrHeader && !t3lib_div::testInt($brOrHeader)) {
2399 echo '</td></tr></table>';
2400 } elseif ($brOrHeader>0) {
2401 for($a=0;$a<intval($brOrHeader);$a++){echo '<br />';}
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
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436 /*************************
2437 *
2438 * SYSTEM INFORMATION
2439 *
2440 *************************/
2441
2442 /**
2443 * Returns the HOST+DIR-PATH of the current script (The URL, but without 'http://' and without script-filename)
2444 * Usage: 1
2445 *
2446 * @return string
2447 */
2448 function getThisUrl() {
2449 $p=parse_url(t3lib_div::getIndpEnv('TYPO3_REQUEST_SCRIPT')); // Url of this script
2450 $dir=t3lib_div::dirname($p['path']).'/'; // Strip file
2451 $url = str_replace('//','/',$p['host'].($p['port']?':'.$p['port']:'').$dir);
2452 return $url;
2453 }
2454
2455 /**
2456 * Returns the link-url to the current script.
2457 * 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.
2458 * REMEMBER to always htmlspecialchar() content in href-properties to ampersands get converted to entities (XHTML requirement and XSS precaution)
2459 * Usage: 52
2460 *
2461 * @param array Array of GET parameters to include
2462 * @return string
2463 */
2464 function linkThisScript($getParams=array()) {
2465 $parts = t3lib_div::getIndpEnv('SCRIPT_NAME');
2466 $params = t3lib_div::_GET();
2467
2468 foreach($getParams as $k => $v) {
2469 if (strcmp($v,'')) {
2470 $params[$k]=$v;
2471 } else unset($params[$k]);
2472 }
2473
2474 $pString = t3lib_div::implodeArrayForUrl('',$params);
2475
2476 return $pString ? $parts.'?'.ereg_replace('^&','',$pString) : $parts;
2477 }
2478
2479 /**
2480 * 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.
2481 * So basically it adds the parameters in $getParams to an existing URL, $url
2482 * Usage: 2
2483 *
2484 * @param string URL string
2485 * @param array Array of key/value pairs for get parameters to add/overrule with. Can be multidimensional.
2486 * @return string Output URL with added getParams.
2487 */
2488 function linkThisUrl($url,$getParams=array()) {
2489 $parts = parse_url($url);
2490 if ($parts['query']) {
2491 parse_str($parts['query'],$getP);
2492 } else {
2493 $getP = array();
2494 }
2495
2496 $getP = t3lib_div::array_merge_recursive_overrule($getP,$getParams);
2497 $uP = explode('?',$url);
2498
2499 $params = t3lib_div::implodeArrayForUrl('',$getP);
2500 $outurl = $uP[0].($params ? '?'.substr($params, 1) : '');
2501
2502 return $outurl;
2503 }
2504
2505 /**
2506 * Abstraction method which returns System Environment Variables regardless of server OS, CGI/MODULE version etc. Basically this is SERVER variables for most of them.
2507 * This should be used instead of getEnv() and $_SERVER/ENV_VARS to get reliable values for all situations.
2508 * Usage: 221
2509 *
2510 * @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
2511 * @return string Value based on the input key, independent of server/os environment.
2512 */
2513 function getIndpEnv($getEnvName) {
2514 /*
2515 Conventions:
2516 output from parse_url():
2517 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
2518 [scheme] => 'http'
2519 [user] => 'username'
2520 [pass] => 'password'
2521 [host] => '192.168.1.4'
2522 [port] => '8080'
2523 [path] => '/typo3/32/temp/phpcheck/index.php/arg1/arg2/arg3/'
2524 [query] => 'arg1,arg2,arg3&p1=parameter1&p2[key]=value'
2525 [fragment] => 'link1'
2526
2527 Further definition: [path_script] = '/typo3/32/temp/phpcheck/index.php'
2528 [path_dir] = '/typo3/32/temp/phpcheck/'
2529 [path_info] = '/arg1/arg2/arg3/'
2530 [path] = [path_script/path_dir][path_info]
2531
2532
2533 Keys supported:
2534
2535 URI______:
2536 REQUEST_URI = [path]?[query] = /typo3/32/temp/phpcheck/index.php/arg1/arg2/arg3/?arg1,arg2,arg3&p1=parameter1&p2[key]=value
2537 HTTP_HOST = [host][:[port]] = 192.168.1.4:8080
2538 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')!
2539 PATH_INFO = [path_info] = /arg1/arg2/arg3/
2540 QUERY_STRING = [query] = arg1,arg2,arg3&p1=parameter1&p2[key]=value
2541 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
2542 (Notice: NO username/password + NO fragment)
2543
2544 CLIENT____:
2545 REMOTE_ADDR = (client IP)
2546 REMOTE_HOST = (client host)
2547 HTTP_USER_AGENT = (client user agent)
2548 HTTP_ACCEPT_LANGUAGE = (client accept language)
2549
2550 SERVER____:
2551 SCRIPT_FILENAME = Absolute filename of script (Differs between windows/unix). On windows 'C:\\blabla\\blabl\\' will be converted to 'C:/blabla/blabl/'
2552
2553 Special extras:
2554 TYPO3_HOST_ONLY = [host] = 192.168.1.4
2555 TYPO3_PORT = [port] = 8080 (blank if 80, taken from host value)
2556 TYPO3_REQUEST_HOST = [scheme]://[host][:[port]]
2557 TYPO3_REQUEST_URL = [scheme]://[host][:[port]][path]?[query] (sheme will by default be 'http' until we can detect if it's https -
2558 TYPO3_REQUEST_SCRIPT = [scheme]://[host][:[port]][path_script]
2559 TYPO3_REQUEST_DIR = [scheme]://[host][:[port]][path_dir]
2560 TYPO3_SITE_URL = [scheme]://[host][:[port]][path_dir] of the TYPO3 website frontend
2561 TYPO3_SITE_SCRIPT = [script / Speaking URL] of the TYPO3 website
2562 TYPO3_DOCUMENT_ROOT = Absolute path of root of documents: TYPO3_DOCUMENT_ROOT.SCRIPT_NAME = SCRIPT_FILENAME (typically)
2563
2564 Notice: [fragment] is apparently NEVER available to the script!
2565
2566
2567 Testing suggestions:
2568 - Output all the values.
2569 - 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
2570 - ALSO TRY the script from the ROOT of a site (like 'http://www.mytest.com/' and not 'http://www.mytest.com/test/' !!)
2571
2572 */
2573
2574 # if ($getEnvName=='HTTP_REFERER') return '';
2575 switch((string)$getEnvName) {
2576 case 'SCRIPT_NAME':
2577 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']);
2578 break;
2579 case 'SCRIPT_FILENAME':
2580 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'])));
2581 break;
2582 case 'REQUEST_URI':
2583 // Typical application of REQUEST_URI is return urls, forms submitting to itselt etc. Eg: returnUrl='.rawurlencode(t3lib_div::getIndpEnv('REQUEST_URI'))
2584 if (!$_SERVER['REQUEST_URI']) { // This is for ISS/CGI which does not have the REQUEST_URI available.
2585 return '/'.ereg_replace('^/','',t3lib_div::getIndpEnv('SCRIPT_NAME')).
2586 ($_SERVER['QUERY_STRING']?'?'.$_SERVER['QUERY_STRING']:'');
2587 } else return $_SERVER['REQUEST_URI'];
2588 break;
2589 case 'PATH_INFO':
2590 // $_SERVER['PATH_INFO']!=$_SERVER['SCRIPT_NAME'] is necessary because some servers (Windows/CGI) are seen to set PATH_INFO equal to script_name
2591 // Further, there must be at least one '/' in the path - else the PATH_INFO value does not make sense.
2592 // 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)
2593 // if (strcmp($_SERVER['PATH_INFO'],t3lib_div::getIndpEnv('SCRIPT_NAME')) && count(explode('/',$_SERVER['PATH_INFO']))>1) {
2594 if (php_sapi_name()!='cgi'&&php_sapi_name()!='cgi-fcgi') {
2595 return $_SERVER['PATH_INFO'];
2596 } else return '';
2597 break;
2598 // These are let through without modification
2599 case 'REMOTE_ADDR':
2600 case 'REMOTE_HOST':
2601 case 'HTTP_REFERER':
2602 case 'HTTP_HOST':
2603 case 'HTTP_USER_AGENT':
2604 case 'HTTP_ACCEPT_LANGUAGE':
2605 case 'QUERY_STRING':
2606 return $_SERVER[$getEnvName];
2607 break;
2608 case 'TYPO3_DOCUMENT_ROOT':
2609 // 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.
2610 // Therefore the DOCUMENT_ROOT is now always calculated as the SCRIPT_FILENAME minus the end part shared with SCRIPT_NAME.
2611 $SFN = t3lib_div::getIndpEnv('SCRIPT_FILENAME');
2612 $SN_A = explode('/',strrev(t3lib_div::getIndpEnv('SCRIPT_NAME')));
2613 $SFN_A = explode('/',strrev($SFN));
2614 $acc = array();
2615 while(list($kk,$vv)=each($SN_A)) {
2616 if (!strcmp($SFN_A[$kk],$vv)) {
2617 $acc[] = $vv;
2618 } else break;
2619 }
2620 $commonEnd=strrev(implode('/',$acc));
2621 if (strcmp($commonEnd,'')) $DR = substr($SFN,0,-(strlen($commonEnd)+1));
2622 return $DR;
2623 break;
2624 case 'TYPO3_HOST_ONLY':
2625 $p = explode(':',$_SERVER['HTTP_HOST']);
2626 return $p[0];
2627 break;
2628 case 'TYPO3_PORT':
2629 $p = explode(':',$_SERVER['HTTP_HOST']);
2630 return $p[1];
2631 break;
2632 case 'TYPO3_REQUEST_HOST':
2633 return (t3lib_div::getIndpEnv('TYPO3_SSL') ? 'https://' : 'http://').
2634 $_SERVER['HTTP_HOST'];
2635 break;
2636 case 'TYPO3_REQUEST_URL':
2637 return t3lib_div::getIndpEnv('TYPO3_REQUEST_HOST').t3lib_div::getIndpEnv('REQUEST_URI');
2638 break;
2639 case 'TYPO3_REQUEST_SCRIPT':
2640 return t3lib_div::getIndpEnv('TYPO3_REQUEST_HOST').t3lib_div::getIndpEnv('SCRIPT_NAME');
2641 break;
2642 case 'TYPO3_REQUEST_DIR':
2643 return t3lib_div::getIndpEnv('TYPO3_REQUEST_HOST').t3lib_div::dirname(t3lib_div::getIndpEnv('SCRIPT_NAME')).'/';
2644 break;
2645 case 'TYPO3_SITE_URL':
2646 if (defined('PATH_thisScript') && defined('PATH_site')) {
2647 $lPath = substr(dirname(PATH_thisScript),strlen(PATH_site)).'/';
2648 $url = t3lib_div::getIndpEnv('TYPO3_REQUEST_DIR');
2649 $siteUrl = substr($url,0,-strlen($lPath));
2650 if (substr($siteUrl,-1)!='/') $siteUrl.='/';
2651 return $siteUrl;
2652 } else return '';
2653 break;
2654 case 'TYPO3_SITE_SCRIPT':
2655 return substr(t3lib_div::getIndpEnv('TYPO3_REQUEST_URL'),strlen(t3lib_div::getIndpEnv('TYPO3_SITE_URL')));
2656 break;
2657 case 'TYPO3_SSL':
2658 return $_SERVER['SSL_SESSION_ID'] || !strcmp($_SERVER['HTTPS'],'on') ? TRUE : FALSE;
2659 break;
2660 case '_ARRAY':
2661 $out = array();
2662 // Here, list ALL possible keys to this function for debug display.
2663 $envTestVars = t3lib_div::trimExplode(',','
2664 HTTP_HOST,
2665 TYPO3_HOST_ONLY,
2666 TYPO3_PORT,
2667 PATH_INFO,
2668 QUERY_STRING,
2669 REQUEST_URI,
2670 HTTP_REFERER,
2671 TYPO3_REQUEST_HOST,
2672 TYPO3_REQUEST_URL,
2673 TYPO3_REQUEST_SCRIPT,
2674 TYPO3_REQUEST_DIR,
2675 TYPO3_SITE_URL,
2676 TYPO3_SITE_SCRIPT,
2677 TYPO3_SSL,
2678 SCRIPT_NAME,
2679 TYPO3_DOCUMENT_ROOT,
2680 SCRIPT_FILENAME,
2681 REMOTE_ADDR,
2682 REMOTE_HOST,
2683 HTTP_USER_AGENT,
2684 HTTP_ACCEPT_LANGUAGE',1);
2685 reset($envTestVars);
2686 while(list(,$v)=each($envTestVars)) {
2687 $out[$v]=t3lib_div::getIndpEnv($v);
2688 }
2689 reset($out);
2690 return $out;
2691 break;
2692 }
2693 }
2694
2695 /**
2696 * milliseconds
2697 * microtime recalculated to t3lib_div::milliseconds(1/1000 sec)
2698 * Usage: 20
2699 *
2700 * @return integer
2701 */
2702 function milliseconds() {
2703 $p=explode(' ',microtime());
2704 return round(($p[0]+$p[1])*1000);
2705 }
2706
2707 /**
2708 * Client Browser Information
2709 * Usage: 4
2710 *
2711 * @param string Alternative User Agent string (if empty, t3lib_div::getIndpEnv('HTTP_USER_AGENT') is used)
2712 * @return array Parsed information about the HTTP_USER_AGENT in categories BROWSER, VERSION, SYSTEM and FORMSTYLE
2713 */
2714 function clientInfo($useragent='') {
2715 if (!$useragent) $useragent=t3lib_div::getIndpEnv('HTTP_USER_AGENT');
2716
2717 $bInfo=array();
2718 // Which browser?
2719 if (strstr($useragent,'Konqueror')) {
2720 $bInfo['BROWSER']= 'konqu';
2721 } elseif (strstr($useragent,'Opera')) {
2722 $bInfo['BROWSER']= 'opera';
2723 } elseif (strstr($useragent,'MSIE 4') || strstr($useragent,'MSIE 5') || strstr($useragent,'MSIE 6')) {
2724 $bInfo['BROWSER']= 'msie';
2725 } elseif (strstr($useragent,'Mozilla/4') || strstr($useragent,'Mozilla/5')) {
2726 $bInfo['BROWSER']='net';
2727 }
2728 if ($bInfo['BROWSER']) {
2729 // Browser version
2730 switch($bInfo['BROWSER']) {
2731 case 'net':
2732 $bInfo['VERSION']= doubleval(substr($useragent,8));
2733 if (strstr($useragent,'Netscape6/')) {$bInfo['VERSION']=doubleval(substr(strstr($useragent,'Netscape6/'),10));}
2734 if (strstr($useragent,'Netscape/7')) {$bInfo['VERSION']=doubleval(substr(strstr($useragent,'Netscape/7'),9));}
2735 break;
2736 case 'msie':
2737 $tmp = strstr($useragent,'MSIE');
2738 $bInfo['VERSION'] = doubleval(ereg_replace('^[^0-9]*','',substr($tmp,4)));
2739 break;
2740 case 'opera':
2741 $tmp = strstr($useragent,'Opera');
2742 $bInfo['VERSION'] = doubleval(ereg_replace('^[^0-9]*','',substr($tmp,5)));
2743 break;
2744 case 'konqu':
2745 $tmp = strstr($useragent,'Konqueror/');
2746 $bInfo['VERSION'] = doubleval(substr($tmp,10));
2747 break;
2748 }
2749 // Client system
2750 if (strstr($useragent,'Win')) {
2751 $bInfo['SYSTEM'] = 'win';
2752 } elseif (strstr($useragent,'Mac')) {
2753 $bInfo['SYSTEM'] = 'mac';
2754 } elseif (strstr($useragent,'Linux') || strstr($useragent,'X11') || strstr($useragent,'SGI') || strstr($useragent,' SunOS ') || strstr($useragent,' HP-UX ')) {
2755 $bInfo['SYSTEM'] = 'unix';
2756 }
2757 }
2758 // Is true if the browser supports css to format forms, especially the width
2759 $bInfo['FORMSTYLE']=($bInfo['BROWSER']=='msie' || ($bInfo['BROWSER']=='net'&&$bInfo['VERSION']>=5) || $bInfo['BROWSER']=='opera' || $bInfo['BROWSER']=='konqu');
2760
2761 return $bInfo;
2762 }
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786 /*************************
2787 *
2788 * TYPO3 SPECIFIC FUNCTIONS
2789 *
2790 *************************/
2791
2792 /**
2793 * 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.
2794 * Usage: 24
2795 *
2796 * @param string The input filename/filepath to evaluate
2797 * @param boolean If $onlyRelative is set (which it is by default), then only return values relative to the current PATH_site is accepted.
2798 * @param boolean If $relToTYPO3_mainDir is set, then relative paths are relative to PATH_typo3 constant - otherwise (default) they are relative to PATH_site
2799 * @return string Returns the absolute filename of $filename IF valid, otherwise blank string.
2800 */
2801 function getFileAbsFileName($filename,$onlyRelative=1,$relToTYPO3_mainDir=0) {
2802 if (!strcmp($filename,'')) return '';
2803
2804 if ($relToTYPO3_mainDir) {
2805 if (!defined('PATH_typo3')) return '';
2806 $relPathPrefix = PATH_typo3;
2807 } else {
2808 $relPathPrefix = PATH_site;
2809 }
2810 if (substr($filename,0,4)=='EXT:') { // extension
2811 list($extKey,$local) = explode('/',substr($filename,4),2);
2812 $filename='';
2813 if (strcmp($extKey,'') && t3lib_extMgm::isLoaded($extKey) && strcmp($local,'')) {
2814 $filename = t3lib_extMgm::extPath($extKey).$local;
2815 }
2816 } elseif (!t3lib_div::isAbsPath($filename)) { // relative. Prepended with $relPathPrefix
2817 $filename=$relPathPrefix.$filename;
2818 } elseif ($onlyRelative && !t3lib_div::isFirstPartOfStr($filename,$relPathPrefix)) { // absolute, but set to blank if not allowed
2819 $filename='';
2820 }
2821 if (strcmp($filename,'') && t3lib_div::validPathStr($filename)) { // checks backpath.
2822 return $filename;
2823 }
2824 }
2825
2826 /**
2827 * Checks for malicious file paths.
2828 * Returns true if no '//', '..' or '\' is in the $theFile
2829 * This should make sure that the path is not pointing 'backwards' and further doesn't contain double/back slashes.
2830 * So it's compatible with the UNIX style path strings valid for TYPO3 internally.
2831 * Usage: 14
2832 *
2833 * @param string Filepath to evaluate
2834 * @return boolean True, if no '//', '..' or '\' is in the $theFile
2835 * @todo Possible improvement: Should it rawurldecode the string first to check if any of these characters is encoded ?
2836 */
2837 function validPathStr($theFile) {
2838 if (!strstr($theFile,'//') && !strstr($theFile,'..') && !strstr($theFile,'\\')) return true;
2839 }
2840
2841 /**
2842 * Checks if the $path is absolute or relative (detecting either '/' or 'x:/' as first part of string) and returns true if so.
2843 * Usage: 8
2844 *
2845 * @param string Filepath to evaluate
2846 * @return boolean
2847 */
2848 function isAbsPath($path) {
2849 return TYPO3_OS=='WIN' ? substr($path,1,2)==':/' : substr($path,0,1)=='/';
2850 }
2851
2852 /**
2853 * Returns true if the path is absolute, without backpath '..' and within the PATH_site OR within the lockRootPath
2854 * Usage: 5
2855 *
2856 * @param string Filepath to evaluate
2857 * @return boolean
2858 */
2859 function isAllowedAbsPath($path) {
2860 if (t3lib_div::isAbsPath($path) &&
2861 t3lib_div::validPathStr($path) &&
2862 ( t3lib_div::isFirstPartOfStr($path,PATH_site)
2863 ||
2864 ($GLOBALS['TYPO3_CONF_VARS']['BE']['lockRootPath'] && t3lib_div::isFirstPartOfStr($path,$GLOBALS['TYPO3_CONF_VARS']['BE']['lockRootPath']))
2865 )
2866 ) return true;
2867 }
2868
2869 /**
2870 * Verifies the input filename againts the 'fileDenyPattern'. Returns true if OK.
2871 * Usage: 2
2872 *
2873 * @param string Filepath to evaluate
2874 * @return boolean
2875 */
2876 function verifyFilenameAgainstDenyPattern($filename) {
2877 if (strcmp($filename,'') && strcmp($GLOBALS['TYPO3_CONF_VARS']['BE']['fileDenyPattern'],'')) {
2878 $result = eregi($GLOBALS['TYPO3_CONF_VARS']['BE']['fileDenyPattern'],$filename);
2879 if ($result) return false; // so if a matching filename is found, return false;
2880 }
2881 return true;
2882 }
2883
2884 /**
2885 * Moves $source file to $destination if uploaded, otherwise try to make a copy
2886 * Usage: 4
2887 *
2888 * @param string Source file, absolute path
2889 * @param string Destination file, absolute path
2890 * @return boolean Returns true if the file was moved.
2891 * @coauthor Dennis Petersen <fessor@software.dk>
2892 * @see upload_to_tempfile()
2893 */
2894 function upload_copy_move($source,$destination) {
2895 if (is_uploaded_file($source)) {
2896 $uploaded = TRUE;
2897 // 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:
2898 $uploadedResult = move_uploaded_file($source, $destination);
2899 } else {
2900 $uploaded = FALSE;
2901 @copy($source,$destination);
2902 }
2903
2904 // Setting file system mode & group ownership of file:
2905 if (@is_file($destination) && TYPO3_OS!='WIN') {
2906 chmod($destination, octdec($GLOBALS['TYPO3_CONF_VARS']['BE']['fileCreateMask']));
2907 if($GLOBALS['TYPO3_CONF_VARS']['BE']['createGroup']) { // skip this if createGroup is empty
2908 chgrp($destination, $GLOBALS['TYPO3_CONF_VARS']['BE']['createGroup']);
2909 }
2910 }
2911
2912 // 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
2913 return $uploaded ? $uploadedResult : FALSE;
2914 }
2915
2916 /**
2917 * 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.
2918 * Use this function to move uploaded files to where you can work on them.
2919 * REMEMBER to use t3lib_div::unlink_tempfile() afterwards - otherwise temp-files will build up! They are NOT automatically deleted in PATH_site."typo3temp/"!
2920 * Usage: 6
2921 *
2922 * @param string The temporary uploaded filename, eg. $_FILES['[upload field name here]']['tmp_name']
2923 * @return string If a new file was successfully created, return its filename, otherwise blank string.
2924 * @see unlink_tempfile(), upload_copy_move()
2925 */
2926 function upload_to_tempfile($uploadedFileName) {
2927 if (is_uploaded_file($uploadedFileName)) {
2928 $tempFile = t3lib_div::tempnam('upload_temp_');
2929 move_uploaded_file($uploadedFileName, $tempFile);
2930 return @is_file($tempFile) ? $tempFile : '';
2931 }
2932 }
2933
2934 /**
2935 * Deletes (unlink) a temporary filename in 'PATH_site."typo3temp/"' given as input.
2936 * 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.
2937 * Use this after upload_to_tempfile() or tempnam() from this class!
2938 * Usage: 9
2939 *
2940 * @param string Filepath for a file in PATH_site."typo3temp/". Must be absolute.
2941 * @return boolean Returns true if the file was unlink()'ed
2942 * @see upload_to_tempfile(), tempnam()
2943 */
2944 function unlink_tempfile($uploadedTempFileName) {
2945 if ($uploadedTempFileName && t3lib_div::validPathStr($uploadedTempFileName) && t3lib_div::isFirstPartOfStr($uploadedTempFileName,PATH_site.'typo3temp/') && @is_file($uploadedTempFileName)) {
2946 if (unlink($uploadedTempFileName)) return TRUE;
2947 }
2948 }
2949
2950 /**
2951 * Create temporary filename (Create file with unique file name)
2952 * This function should be used for getting temporary filenames - will make your applications safe for open_basedir = on
2953 * REMEMBER to delete the temporary files after use! This is done by t3lib_div::unlink_tempfile()
2954 * Usage: 7
2955 *
2956 * @param string Prefix to temp file (which will have no extension btw)
2957 * @return string result from PHP function tempnam() with PATH_site.'typo3temp/' set for temp path.
2958 * @see unlink_tempfile(), upload_to_tempfile()
2959 */
2960 function tempnam($filePrefix) {
2961 return tempnam(PATH_site.'typo3temp/',$filePrefix);
2962 }
2963
2964 /**
2965 * standard authentication code - can't remember what it's used for.
2966 * Usage: 2
2967 *
2968 * @param mixed Uid (integer) or record (array)
2969 * @param string List of fields from the record if that is given.
2970 * @return string MD5 hash of 8 chars.
2971 * @internal
2972 */
2973 function stdAuthCode($uid_or_record,$fields='') {
2974 if (is_array($uid_or_record)) {
2975 $recCopy_temp=array();
2976 if ($fields) {
2977 $fieldArr = t3lib_div::trimExplode(',',$fields,1);
2978 reset($fieldArr);
2979 while(list($k,$v)=each($fieldArr)) {
2980 $recCopy_temp[$k]=$recCopy[$v];
2981 }
2982 } else {
2983 $recCopy_temp=$recCopy;
2984 }
2985 $preKey = implode('|',$recCopy_temp);
2986 } else {
2987 $preKey = $uid_or_record;
2988 }
2989
2990 $authCode = $preKey.'||'.$GLOBALS['TYPO3_CONF_VARS']['SYS']['encryptionKey'];
2991 $authCode = substr(md5($authCode),0,8);
2992 return $authCode;
2993 }
2994
2995 /**
2996 * Loads the $TCA (Table Configuration Array) for the $table
2997 *
2998 * Requirements:
2999 * 1) must be configured table (the ctrl-section configured),
3000 * 2) columns must not be an array (which it is always if whole table loaded), and
3001 * 3) there is a value for dynamicConfigFile (filename in typo3conf)
3002 * Usage: 84
3003 *
3004 * @param string Table name for which to load the full TCA array part into the global $TCA
3005 * @return void
3006 */
3007 function loadTCA($table) {
3008 global $TCA,$LANG_GENERAL_LABELS;
3009 if (isset($TCA[$table]) && !is_array($TCA[$table]['columns']) && $TCA[$table]['ctrl']['dynamicConfigFile']) {
3010 if (!strcmp(substr($TCA[$table]['ctrl']['dynamicConfigFile'],0,6),'T3LIB:')) {
3011 include(PATH_t3lib.'stddb/'.substr($TCA[$table]['ctrl']['dynamicConfigFile'],6));
3012 } elseif (t3lib_div::isAbsPath($TCA[$table]['ctrl']['dynamicConfigFile']) && @is_file($TCA[$table]['ctrl']['dynamicConfigFile'])) { // Absolute path...
3013 include($TCA[$table]['ctrl']['dynamicConfigFile']);
3014 } else include(PATH_typo3conf.$TCA[$table]['ctrl']['dynamicConfigFile']);
3015 }
3016 }
3017
3018 /**
3019 * 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).
3020 * If the sheet definition is in an external file that file is parsed and the data structure inside of that is returned.
3021 * Usage: 5
3022 *
3023 * @param array Input data structure, possibly with a sheet-definition and references to external data source files.
3024 * @param string The sheet to return, preferably.
3025 * @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!
3026 */
3027 function resolveSheetDefInDS($dataStructArray,$sheet='sDEF') {
3028 if (is_array($dataStructArray['sheets'])) {
3029 $singleSheet = FALSE;
3030 if (!isset($dataStructArray['sheets'][$sheet])) {
3031 $sheet='sDEF';
3032 }
3033 $dataStruct = $dataStructArray['sheets'][$sheet];
3034
3035 // If not an array, but still set, then regard it as a relative reference to a file:
3036 if ($dataStruct && !is_array($dataStruct)) {
3037 $file = t3lib_div::getFileAbsFileName($dataStruct);
3038 if ($file && @is_file($file)) {
3039 $dataStruct = t3lib_div::xml2array(t3lib_div::getUrl($file));
3040 }
3041 }
3042 } else {
3043 $singleSheet = TRUE;
3044 $dataStruct = $dataStructArray;
3045 $sheet = 'sDEF'; // Default sheet
3046 }
3047 return array($dataStruct,$sheet,$singleSheet);
3048 }
3049
3050 /**
3051 * Resolves ALL sheet definitions in dataStructArray
3052 * If no sheet is found, then the default "sDEF" will be created with the dataStructure inside.
3053 *
3054 * @param array Input data structure, possibly with a sheet-definition and references to external data source files.
3055 * @return array Output data structure with all sheets resolved as arrays.
3056 */
3057 function resolveAllSheetsInDS($dataStructArray) {
3058 if (is_array($dataStructArray['sheets'])) {
3059 $out=array('sheets'=>array());
3060 foreach($dataStructArray['sheets'] as $sheetId => $sDat) {
3061 list($ds,$aS) = t3lib_div::resolveSheetDefInDS($dataStructArray,$sheetId);
3062 if ($sheetId==$aS) {
3063 $out['sheets'][$aS]=$ds;
3064 }
3065 }
3066 } else {
3067 list($ds) = t3lib_div::resolveSheetDefInDS($dataStructArray);
3068 $out = array('sheets' => array('sDEF' => $ds));
3069 }
3070 return $out;
3071 }
3072
3073 /**
3074 * Calls a userdefined function/method in class
3075 * Such a function/method should look like this: "function proc(&$params, &$ref) {...}"
3076 * Usage: 17
3077 *
3078 * @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").
3079 * @param mixed Parameters to be pass along (typically an array) (REFERENCE!)
3080 * @param mixed Reference to be passed along (typically "$this" - being a reference to the calling object) (REFERENCE!)
3081 * @param string Required prefix of class or function name
3082 * @param boolean If set, no debug() error message is shown if class/function is not present.
3083 * @return mixed Content from method/function call
3084 * @see getUserObj()
3085 */
3086 function callUserFunction($funcName,&$params,&$ref,$checkPrefix='user_',$silent=0) {
3087 global $TYPO3_CONF_VARS;
3088
3089 // Check persistent object and if found, call directly and exit.
3090 if (is_array($GLOBALS['T3_VAR']['callUserFunction'][$funcName])) {
3091 return call_user_method(
3092 $GLOBALS['T3_VAR']['callUserFunction'][$funcName]['method'],
3093 $GLOBALS['T3_VAR']['callUserFunction'][$funcName]['obj'],
3094 $params,
3095 $ref
3096 );
3097 }
3098
3099 // Check file-reference prefix; if found, require_once() the file (should be library of code)
3100 if (strstr($funcName,':')) {
3101 list($file,$funcRef) = t3lib_div::revExplode(':',$funcName,2);
3102 $requireFile = t3lib_div::getFileAbsFileName($file);
3103 if ($requireFile) require_once($requireFile);
3104 } else {
3105 $funcRef = $funcName;
3106 }
3107
3108 // Check for persistent object token, "&"
3109 if (substr($funcRef,0,1)=='&') {
3110 $funcRef = substr($funcRef,1);
3111 $storePersistentObject = TRUE;
3112 } else {
3113 $storePersistentObject = FALSE;
3114 }
3115
3116 // Check prefix is valid:
3117 if ($checkPrefix &&
3118 !t3lib_div::isFirstPartOfStr(trim($funcRef),$checkPrefix) &&
3119 !t3lib_div::isFirstPartOfStr(trim($funcRef),'tx_')
3120 ) {
3121 if (!$silent) debug("Function/Class '".$funcRef."' was not prepended with '".$checkPrefix."'",1);
3122 return FALSE;
3123 }
3124
3125 // Call function or method:
3126 $parts = explode('->',$funcRef);
3127 if (count($parts)==2) { // Class
3128
3129 // Check if class/method exists:
3130 if (class_exists($parts[0])) {
3131
3132 // Get/Create object of class:
3133 if ($storePersistentObject) { // Get reference to current instance of class:
3134 if (!is_object($GLOBALS['T3_VAR']['callUserFunction_classPool'][$parts[0]])) {
3135 $GLOBALS['T3_VAR']['callUserFunction_classPool'][$parts[0]] = &t3lib_div::makeInstance($parts[0]);
3136 }
3137 $classObj = &$GLOBALS['T3_VAR']['callUserFunction_classPool'][$parts[0]];
3138 } else { // Create new object:
3139 $classObj = &t3lib_div::makeInstance($parts[0]);
3140 }
3141
3142 if (method_exists($classObj, $parts[1])) {
3143
3144 // If persistent object should be created, set reference:
3145 if ($storePersistentObject) {
3146 $GLOBALS['T3_VAR']['callUserFunction'][$funcName] = array (
3147 'method' => $parts[1],
3148 'obj' => &$classObj
3149 );
3150 }
3151 // Call method:
3152 $content = call_user_method(
3153 $parts[1],
3154 $classObj,
3155 $params,
3156 $ref
3157 );
3158 } else {
3159 if (!$silent) debug("<strong>ERROR:</strong> No method name '".$parts[1]."' in class ".$parts[0],1);
3160 }
3161 } else {
3162 if (!$silent) debug("<strong>ERROR:</strong> No class named: ".$parts[0],1);
3163 }
3164 } else { // Function
3165 if (function_exists($funcRef)) {
3166 $content = call_user_func($funcRef, $params, $ref);
3167 } else {
3168 if (!$silent) debug("<strong>ERROR:</strong> No function named: ".$funcRef,1);
3169 }
3170 }
3171 return $content;
3172 }
3173
3174 /**
3175 * Creates and returns reference to a user defined object.
3176 * 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.
3177 * Usage: 5
3178 *
3179 * @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!).
3180 * @param string Required prefix of class name. By default "tx_" is allowed.
3181 * @param boolean If set, no debug() error message is shown if class/function is not present.
3182 * @return object The instance of the class asked for. Instance is created with t3lib_div::makeInstance
3183 * @see callUserFunction()
3184 */
3185 function &getUserObj($classRef,$checkPrefix='user_',$silent=0) {
3186 global $TYPO3_CONF_VARS;
3187 // Check persistent object and if found, call directly and exit.
3188 if (is_object($GLOBALS['T3_VAR']['getUserObj'][$classRef])) {
3189 return $GLOBALS['T3_VAR']['getUserObj'][$classRef];
3190 } else {
3191
3192 // Check file-reference prefix; if found, require_once() the file (should be library of code)
3193 if (strstr($classRef,':')) {
3194 list($file,$class) = t3lib_div::revExplode(':',$classRef,2);
3195 $requireFile = t3lib_div::getFileAbsFileName($file);
3196 if ($requireFile) require_once($requireFile);
3197 } else {
3198 $class = $classRef;
3199 }
3200
3201 // Check for persistent object token, "&"
3202 if (substr($class,0,1)=='&') {
3203 $class = substr($class,1);
3204 $storePersistentObject = TRUE;
3205 } else {
3206 $storePersistentObject = FALSE;
3207 }
3208
3209 // Check prefix is valid:
3210 if ($checkPrefix &&
3211 !t3lib_div::isFirstPartOfStr(trim($class),$checkPrefix) &&
3212 !t3lib_div::isFirstPartOfStr(trim($class),'tx_')
3213 ) {
3214 if (!$silent) debug("Class '".$class."' was not prepended with '".$checkPrefix."'",1);
3215 return FALSE;
3216 }
3217
3218 // Check if class exists:
3219 if (class_exists($class)) {
3220 $classObj = &t3lib_div::makeInstance($class);
3221
3222 // If persistent object should be created, set reference:
3223 if ($storePersistentObject) {
3224 $GLOBALS['T3_VAR']['getUserObj'][$classRef] = &$classObj;
3225 }
3226
3227 return $classObj;
3228 } else {
3229 if (!$silent) debug("<strong>ERROR:</strong> No class named: ".$class,1);
3230 }
3231 }
3232 }
3233
3234 /**
3235 * Make instance of class
3236 * Takes the class-extensions API of TYPO3 into account
3237 * Please USE THIS instead of the PHP "new" keyword. Eg. "$obj = new myclass;" should be "$obj = t3lib_div::makeInstance("myclass")" instead!
3238 * Usage: 447
3239 *
3240 * @param string Class name to instantiate
3241 * @return object The object
3242 */
3243 function &makeInstance($className) {
3244 return class_exists('ux_'.$className) ? t3lib_div::makeInstance('ux_'.$className) : new $className;
3245 }
3246
3247 /**
3248 * Return classname for new instance
3249 * Takes the class-extensions API of TYPO3 into account
3250 * Usage: 17
3251 *
3252 * @param string Base Class name to evaluate
3253 * @return string Final class name to instantiate with "new [classname]&