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