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