Fixed bug #15092: Ajax loaded items of inline records are encoded twice (Thanks to...
[Packages/TYPO3.CMS.git] / t3lib / class.t3lib_div.php
1 <?php
2 /***************************************************************
3 * Copyright notice
4 *
5 * (c) 1999-2010 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
1145 $reg = '';
1146 if (!is_dir($fileref) && preg_match('/(.*)\.([^\.]*$)/', $info['file'], $reg)) {
1147 $info['filebody'] = $reg[1];
1148 $info['fileext'] = strtolower($reg[2]);
1149 $info['realFileext'] = $reg[2];
1150 } else {
1151 $info['filebody'] = $info['file'];
1152 $info['fileext'] = '';
1153 }
1154 reset($info);
1155 return $info;
1156 }
1157
1158 /**
1159 * Returns the directory part of a path without trailing slash
1160 * If there is no dir-part, then an empty string is returned.
1161 * Behaviour:
1162 *
1163 * '/dir1/dir2/script.php' => '/dir1/dir2'
1164 * '/dir1/' => '/dir1'
1165 * 'dir1/script.php' => 'dir1'
1166 * 'd/script.php' => 'd'
1167 * '/script.php' => ''
1168 * '' => ''
1169 * Usage: 5
1170 *
1171 * @param string Directory name / path
1172 * @return string Processed input value. See function description.
1173 */
1174 public static function dirname($path) {
1175 $p = self::revExplode('/',$path,2);
1176 return count($p)==2 ? $p[0] : '';
1177 }
1178
1179 /**
1180 * Modifies a HTML Hex color by adding/subtracting $R,$G and $B integers
1181 * Usage: 11
1182 *
1183 * @param string A hexadecimal color code, #xxxxxx
1184 * @param integer Offset value 0-255
1185 * @param integer Offset value 0-255
1186 * @param integer Offset value 0-255
1187 * @return string A hexadecimal color code, #xxxxxx, modified according to input vars
1188 * @see modifyHTMLColorAll()
1189 */
1190 public static function modifyHTMLColor($color,$R,$G,$B) {
1191 // This takes a hex-color (# included!) and adds $R, $G and $B to the HTML-color (format: #xxxxxx) and returns the new color
1192 $nR = self::intInRange(hexdec(substr($color,1,2))+$R,0,255);
1193 $nG = self::intInRange(hexdec(substr($color,3,2))+$G,0,255);
1194 $nB = self::intInRange(hexdec(substr($color,5,2))+$B,0,255);
1195 return '#'.
1196 substr('0'.dechex($nR),-2).
1197 substr('0'.dechex($nG),-2).
1198 substr('0'.dechex($nB),-2);
1199 }
1200
1201 /**
1202 * Modifies a HTML Hex color by adding/subtracting $all integer from all R/G/B channels
1203 * Usage: 6
1204 *
1205 * @param string A hexadecimal color code, #xxxxxx
1206 * @param integer Offset value 0-255 for all three channels.
1207 * @return string A hexadecimal color code, #xxxxxx, modified according to input vars
1208 * @see modifyHTMLColor()
1209 */
1210 public static function modifyHTMLColorAll($color,$all) {
1211 return self::modifyHTMLColor($color,$all,$all,$all);
1212 }
1213
1214 /**
1215 * Removes comma (if present) in the end of string
1216 * Usage: 2
1217 *
1218 * @param string String from which the comma in the end (if any) will be removed.
1219 * @return string
1220 */
1221 public static function rm_endcomma($string) {
1222 return rtrim($string, ',');
1223 }
1224
1225 /**
1226 * strtoupper which converts danish (and other characters) characters as well
1227 * Usage: 0
1228 *
1229 * @param string String to process
1230 * @return string
1231 * @deprecated since TYPO3 3.5 - Use t3lib_cs::conv_case() instead or for HTML output, wrap your content in <span class="uppercase">...</span>)
1232 * @ignore
1233 */
1234 public static function danish_strtoupper($string) {
1235 self::logDeprecatedFunction();
1236
1237 $value = strtoupper($string);
1238 return strtr($value, array(
1239 chr(225) => chr(193),
1240 chr(233) => chr(201),
1241 chr(250) => chr(218),
1242 chr(237) => chr(205),
1243 chr(226) => chr(196),
1244 chr(234) => chr(203),
1245 chr(251) => chr(220),
1246 chr(244) => chr(214),
1247 chr(238) => chr(207),
1248 chr(230) => chr(198),
1249 chr(248) => chr(216),
1250 chr(229) => chr(197),
1251 chr(228) => chr(196),
1252 chr(246) => chr(214),
1253 chr(252) => chr(220),
1254 ));
1255 }
1256
1257 /**
1258 * Change umlaut characters to plain ASCII with normally two character target
1259 * Only known characters will be converted, so don't expect a result for any character.
1260 *
1261 * ä => ae, Ö => Oe
1262 *
1263 * @param string String to convert.
1264 * @deprecated since TYPO3 4.1 - Works only for western europe single-byte charsets! Use t3lib_cs::specCharsToASCII() instead!
1265 * @return string
1266 */
1267 public static function convUmlauts($str) {
1268 self::logDeprecatedFunction();
1269
1270 $pattern = array (chr(228), chr(196), chr(246), chr(214), chr(252), chr(220), chr(223), chr(229), chr(197), chr(248), chr(216), chr(230), chr(198));
1271 $replace = array ('ae', 'Ae', 'oe', 'Oe', 'ue', 'Ue', 'ss', 'aa', 'AA', 'oe', 'OE', 'ae', 'AE');
1272 return str_replace($pattern, $replace, $str);
1273 }
1274
1275 /**
1276 * Tests if the input can be interpreted as integer.
1277 *
1278 * @param mixed Any input variable to test
1279 * @return boolean Returns true if string is an integer
1280 */
1281 public static function testInt($var) {
1282 return (string)intval($var) == $var;
1283 }
1284
1285 /**
1286 * Returns true if the first part of $str matches the string $partStr
1287 * Usage: 59
1288 *
1289 * @param string Full string to check
1290 * @param string Reference string which must be found as the "first part" of the full string
1291 * @return boolean True if $partStr was found to be equal to the first part of $str
1292 */
1293 public static function isFirstPartOfStr($str,$partStr) {
1294 return $partStr != '' && strpos((string) $str, (string) $partStr, 0) === 0;
1295 }
1296
1297 /**
1298 * Formats the input integer $sizeInBytes as bytes/kilobytes/megabytes (-/K/M)
1299 * Usage: 53
1300 *
1301 * @param integer Number of bytes to format.
1302 * @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)
1303 * @return string Formatted representation of the byte number, for output.
1304 */
1305 public static function formatSize($sizeInBytes,$labels='') {
1306
1307 // Set labels:
1308 if (strlen($labels) == 0) {
1309 $labels = ' | K| M| G';
1310 } else {
1311 $labels = str_replace('"','',$labels);
1312 }
1313 $labelArr = explode('|',$labels);
1314
1315 // Find size:
1316 if ($sizeInBytes>900) {
1317 if ($sizeInBytes>900000000) { // GB
1318 $val = $sizeInBytes/(1024*1024*1024);
1319 return number_format($val, (($val<20)?1:0), '.', '').$labelArr[3];
1320 }
1321 elseif ($sizeInBytes>900000) { // MB
1322 $val = $sizeInBytes/(1024*1024);
1323 return number_format($val, (($val<20)?1:0), '.', '').$labelArr[2];
1324 } else { // KB
1325 $val = $sizeInBytes/(1024);
1326 return number_format($val, (($val<20)?1:0), '.', '').$labelArr[1];
1327 }
1328 } else { // Bytes
1329 return $sizeInBytes.$labelArr[0];
1330 }
1331 }
1332
1333 /**
1334 * Returns microtime input to milliseconds
1335 * Usage: 2
1336 *
1337 * @param string Microtime
1338 * @return integer Microtime input string converted to an integer (milliseconds)
1339 */
1340 public static function convertMicrotime($microtime) {
1341 $parts = explode(' ',$microtime);
1342 return round(($parts[0]+$parts[1])*1000);
1343 }
1344
1345 /**
1346 * This splits a string by the chars in $operators (typical /+-*) and returns an array with them in
1347 * Usage: 2
1348 *
1349 * @param string Input string, eg "123 + 456 / 789 - 4"
1350 * @param string Operators to split by, typically "/+-*"
1351 * @return array Array with operators and operands separated.
1352 * @see tslib_cObj::calc(), tslib_gifBuilder::calcOffset()
1353 */
1354 public static function splitCalc($string,$operators) {
1355 $res = Array();
1356 $sign='+';
1357 while($string) {
1358 $valueLen=strcspn($string,$operators);
1359 $value=substr($string,0,$valueLen);
1360 $res[] = Array($sign,trim($value));
1361 $sign=substr($string,$valueLen,1);
1362 $string=substr($string,$valueLen+1);
1363 }
1364 reset($res);
1365 return $res;
1366 }
1367
1368 /**
1369 * Calculates the input by +,-,*,/,%,^ with priority to + and -
1370 * Usage: 1
1371 *
1372 * @param string Input string, eg "123 + 456 / 789 - 4"
1373 * @return integer Calculated value. Or error string.
1374 * @see calcParenthesis()
1375 */
1376 public static function calcPriority($string) {
1377 $string=preg_replace('/[[:space:]]*/','',$string); // removing all whitespace
1378 $string='+'.$string; // Ensuring an operator for the first entrance
1379 $qm='\*\/\+-^%';
1380 $regex = '(['.$qm.'])(['.$qm.']?[0-9\.]*)';
1381 // split the expression here:
1382 $reg = array();
1383 preg_match_all('/'.$regex.'/',$string,$reg);
1384
1385 reset($reg[2]);
1386 $number=0;
1387 $Msign='+';
1388 $err='';
1389 $buffer=doubleval(current($reg[2]));
1390 next($reg[2]); // Advance pointer
1391
1392 while(list($k,$v)=each($reg[2])) {
1393 $v=doubleval($v);
1394 $sign = $reg[1][$k];
1395 if ($sign=='+' || $sign=='-') {
1396 $number = $Msign=='-' ? $number-=$buffer : $number+=$buffer;
1397 $Msign = $sign;
1398 $buffer=$v;
1399 } else {
1400 if ($sign=='/') {if ($v) $buffer/=$v; else $err='dividing by zero';}
1401 if ($sign=='%') {if ($v) $buffer%=$v; else $err='dividing by zero';}
1402 if ($sign=='*') {$buffer*=$v;}
1403 if ($sign=='^') {$buffer=pow($buffer,$v);}
1404 }
1405 }
1406 $number = $Msign=='-' ? $number-=$buffer : $number+=$buffer;
1407 return $err ? 'ERROR: '.$err : $number;
1408 }
1409
1410 /**
1411 * Calculates the input with parenthesis levels
1412 * Usage: 2
1413 *
1414 * @param string Input string, eg "(123 + 456) / 789 - 4"
1415 * @return integer Calculated value. Or error string.
1416 * @see calcPriority(), tslib_cObj::stdWrap()
1417 */
1418 public static function calcParenthesis($string) {
1419 $securC=100;
1420 do {
1421 $valueLenO=strcspn($string,'(');
1422 $valueLenC=strcspn($string,')');
1423 if ($valueLenC==strlen($string) || $valueLenC < $valueLenO) {
1424 $value = self::calcPriority(substr($string,0,$valueLenC));
1425 $string = $value.substr($string,$valueLenC+1);
1426 return $string;
1427 } else {
1428 $string = substr($string,0,$valueLenO).self::calcParenthesis(substr($string,$valueLenO+1));
1429 }
1430 // Security:
1431 $securC--;
1432 if ($securC<=0) break;
1433 } while($valueLenO<strlen($string));
1434 return $string;
1435 }
1436
1437 /**
1438 * Inverse version of htmlspecialchars()
1439 * Usage: 4
1440 *
1441 * @param string Value where &gt;, &lt;, &quot; and &amp; should be converted to regular chars.
1442 * @return string Converted result.
1443 */
1444 public static function htmlspecialchars_decode($value) {
1445 $value = str_replace('&gt;','>',$value);
1446 $value = str_replace('&lt;','<',$value);
1447 $value = str_replace('&quot;','"',$value);
1448 $value = str_replace('&amp;','&',$value);
1449 return $value;
1450 }
1451
1452 /**
1453 * Re-converts HTML entities if they have been converted by htmlspecialchars()
1454 * Usage: 10
1455 *
1456 * @param string String which contains eg. "&amp;amp;" which should stay "&amp;". Or "&amp;#1234;" to "&#1234;". Or "&amp;#x1b;" to "&#x1b;"
1457 * @return string Converted result.
1458 */
1459 public static function deHSCentities($str) {
1460 return preg_replace('/&amp;([#[:alnum:]]*;)/','&\1',$str);
1461 }
1462
1463 /**
1464 * This function is used to escape any ' -characters when transferring text to JavaScript!
1465 * Usage: 3
1466 *
1467 * @param string String to escape
1468 * @param boolean If set, also backslashes are escaped.
1469 * @param string The character to escape, default is ' (single-quote)
1470 * @return string Processed input string
1471 */
1472 public static function slashJS($string,$extended=0,$char="'") {
1473 if ($extended) {$string = str_replace ("\\", "\\\\", $string);}
1474 return str_replace ($char, "\\".$char, $string);
1475 }
1476
1477 /**
1478 * Version of rawurlencode() where all spaces (%20) are re-converted to space-characters.
1479 * Usefull when passing text to JavaScript where you simply url-encode it to get around problems with syntax-errors, linebreaks etc.
1480 * Usage: 4
1481 *
1482 * @param string String to raw-url-encode with spaces preserved
1483 * @return string Rawurlencoded result of input string, but with all %20 (space chars) converted to real spaces.
1484 */
1485 public static function rawUrlEncodeJS($str) {
1486 return str_replace('%20',' ',rawurlencode($str));
1487 }
1488
1489 /**
1490 * rawurlencode which preserves "/" chars
1491 * Usefull when filepaths should keep the "/" chars, but have all other special chars encoded.
1492 * Usage: 5
1493 *
1494 * @param string Input string
1495 * @return string Output string
1496 */
1497 public static function rawUrlEncodeFP($str) {
1498 return str_replace('%2F','/',rawurlencode($str));
1499 }
1500
1501 /**
1502 * Checking syntax of input email address
1503 * Usage: 5
1504 *
1505 * @param string Input string to evaluate
1506 * @return boolean Returns true if the $email address (input string) is valid
1507 */
1508 public static function validEmail($email) {
1509 return (filter_var($email, FILTER_VALIDATE_EMAIL) !== false);
1510 }
1511
1512 /**
1513 * Checks if current e-mail sending method does not accept recipient/sender name
1514 * in a call to PHP mail() function. Windows version of mail() and mini_sendmail
1515 * program are known not to process such input correctly and they cause SMTP
1516 * errors. This function will return true if current mail sending method has
1517 * problem with recipient name in recipient/sender argument for mail().
1518 *
1519 * TODO: 4.3 should have additional configuration variable, which is combined
1520 * by || with the rest in this function.
1521 *
1522 * @return boolean true if mail() does not accept recipient name
1523 */
1524 public static function isBrokenEmailEnvironment() {
1525 return TYPO3_OS == 'WIN' || (false !== strpos(ini_get('sendmail_path'), 'mini_sendmail'));
1526 }
1527
1528 /**
1529 * Changes from/to arguments for mail() function to work in any environment.
1530 *
1531 * @param string $address Address to adjust
1532 * @return string Adjusted address
1533 * @see t3lib_::isBrokenEmailEnvironment()
1534 */
1535 public static function normalizeMailAddress($address) {
1536 if (self::isBrokenEmailEnvironment() && false !== ($pos1 = strrpos($address, '<'))) {
1537 $pos2 = strpos($address, '>', $pos1);
1538 $address = substr($address, $pos1 + 1, ($pos2 ? $pos2 : strlen($address)) - $pos1 - 1);
1539 }
1540 return $address;
1541 }
1542
1543 /**
1544 * Formats a string for output between <textarea>-tags
1545 * All content outputted in a textarea form should be passed through this function
1546 * 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!
1547 * Usage: 23
1548 *
1549 * @param string Input string to be formatted.
1550 * @return string Formatted for <textarea>-tags
1551 */
1552 public static function formatForTextarea($content) {
1553 return LF.htmlspecialchars($content);
1554 }
1555
1556 /**
1557 * Converts string to uppercase
1558 * The function converts all Latin characters (a-z, but no accents, etc) to
1559 * uppercase. It is safe for all supported character sets (incl. utf-8).
1560 * Unlike strtoupper() it does not honour the locale.
1561 *
1562 * @param string Input string
1563 * @return string Uppercase String
1564 */
1565 public static function strtoupper($str) {
1566 return strtr((string)$str, 'abcdefghijklmnopqrstuvwxyz', 'ABCDEFGHIJKLMNOPQRSTUVWXYZ');
1567 }
1568
1569 /**
1570 * Converts string to lowercase
1571 * The function converts all Latin characters (A-Z, but no accents, etc) to
1572 * lowercase. It is safe for all supported character sets (incl. utf-8).
1573 * Unlike strtolower() it does not honour the locale.
1574 *
1575 * @param string Input string
1576 * @return string Lowercase String
1577 */
1578 public static function strtolower($str) {
1579 return strtr((string)$str, 'ABCDEFGHIJKLMNOPQRSTUVWXYZ', 'abcdefghijklmnopqrstuvwxyz');
1580 }
1581
1582 /**
1583 * Returns a string of highly randomized bytes (over the full 8-bit range).
1584 *
1585 * @copyright Drupal CMS
1586 * @license GNU General Public License version 2
1587 * @param integer Number of characters (bytes) to return
1588 * @return string Random Bytes
1589 */
1590 public static function generateRandomBytes($count) {
1591 $output = '';
1592 // /dev/urandom is available on many *nix systems and is considered
1593 // the best commonly available pseudo-random source.
1594 if (TYPO3_OS != 'WIN' && ($fh = @fopen('/dev/urandom', 'rb'))) {
1595 $output = fread($fh, $count);
1596 fclose($fh);
1597 } elseif (TYPO3_OS == 'WIN') {
1598 if (class_exists('COM')) {
1599 try {
1600 $com = new COM('CAPICOM.Utilities.1');
1601 $output = base64_decode($com->GetRandom($count, 0));
1602 } catch(Exception $e) {
1603 // CAPICOM not installed
1604 }
1605 }
1606 if ($output === '' && version_compare(PHP_VERSION, '5.3.0', '>=')) {
1607 if (function_exists('mcrypt_create_iv')) {
1608 $output = mcrypt_create_iv($count, MCRYPT_DEV_URANDOM);
1609 } elseif (function_exists('openssl_random_pseudo_bytes')) {
1610 $isStrong = null;
1611 $output = openssl_random_pseudo_bytes($count, $isStrong);
1612 // skip ssl since it wasn't using the strong algo
1613 if ($isStrong !== TRUE) {
1614 $output = '';
1615 }
1616 }
1617 }
1618 }
1619
1620 // fallback if other random byte generation failed until now
1621 if (!isset($output{$count - 1})) {
1622 // We initialize with the somewhat random.
1623 $randomState = $GLOBALS['TYPO3_CONF_VARS']['SYS']['encryptionKey']
1624 . base_convert(memory_get_usage() % pow(10, 6), 10, 2)
1625 . microtime() . uniqid('') . getmypid();
1626 while (!isset($output{$count - 1})) {
1627 $randomState = sha1(microtime() . mt_rand() . $randomState);
1628 $output .= sha1(mt_rand() . $randomState, true);
1629 }
1630 $output = substr($output, strlen($output) - $count, $count);
1631 }
1632 return $output;
1633 }
1634
1635 /**
1636 * Returns a hex representation of a random byte string.
1637 *
1638 * @param integer Number of hex characters to return
1639 * @return string Random Bytes
1640 */
1641 public static function getRandomHexString($count) {
1642 return substr(bin2hex(self::generateRandomBytes(intval(($count + 1) / 2))), 0, $count);
1643 }
1644
1645 /**
1646 * Returns a given string with underscores as UpperCamelCase.
1647 * Example: Converts blog_example to BlogExample
1648 *
1649 * @param string $string: String to be converted to camel case
1650 * @return string UpperCamelCasedWord
1651 */
1652 public static function underscoredToUpperCamelCase($string) {
1653 $upperCamelCase = str_replace(' ', '', ucwords(str_replace('_', ' ', self::strtolower($string))));
1654 return $upperCamelCase;
1655 }
1656
1657 /**
1658 * Returns a given string with underscores as lowerCamelCase.
1659 * Example: Converts minimal_value to minimalValue
1660 *
1661 * @param string $string: String to be converted to camel case
1662 * @return string lowerCamelCasedWord
1663 */
1664 public static function underscoredToLowerCamelCase($string) {
1665 $upperCamelCase = str_replace(' ', '', ucwords(str_replace('_', ' ', self::strtolower($string))));
1666 $lowerCamelCase = self::lcfirst($upperCamelCase);
1667 return $lowerCamelCase;
1668 }
1669
1670 /**
1671 * Returns a given CamelCasedString as an lowercase string with underscores.
1672 * Example: Converts BlogExample to blog_example, and minimalValue to minimal_value
1673 *
1674 * @param string $string: String to be converted to lowercase underscore
1675 * @return string lowercase_and_underscored_string
1676 */
1677 public static function camelCaseToLowerCaseUnderscored($string) {
1678 return self::strtolower(preg_replace('/(?<=\w)([A-Z])/', '_\\1', $string));
1679 }
1680
1681 /**
1682 * Converts the first char of a string to lowercase if it is a latin character (A-Z).
1683 * Example: Converts "Hello World" to "hello World"
1684 *
1685 * @param string $string: The string to be used to lowercase the first character
1686 * @return string The string with the first character as lowercase
1687 */
1688 public static function lcfirst($string) {
1689 return self::strtolower(substr($string, 0, 1)) . substr($string, 1);
1690 }
1691
1692 /**
1693 * Checks if a given string is a Uniform Resource Locator (URL).
1694 *
1695 * @param string $url: The URL to be validated
1696 * @return boolean Whether the given URL is valid
1697 */
1698 public static function isValidUrl($url) {
1699 return (filter_var($url, FILTER_VALIDATE_URL, FILTER_FLAG_SCHEME_REQUIRED) !== false);
1700 }
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711 /*************************
1712 *
1713 * ARRAY FUNCTIONS
1714 *
1715 *************************/
1716
1717 /**
1718 * Check if an string item exists in an array.
1719 * Please note that the order of function parameters is reverse compared to the PHP function in_array()!!!
1720 *
1721 * Comparison to PHP in_array():
1722 * -> $array = array(0, 1, 2, 3);
1723 * -> variant_a := t3lib_div::inArray($array, $needle)
1724 * -> variant_b := in_array($needle, $array)
1725 * -> variant_c := in_array($needle, $array, true)
1726 * +---------+-----------+-----------+-----------+
1727 * | $needle | variant_a | variant_b | variant_c |
1728 * +---------+-----------+-----------+-----------+
1729 * | '1a' | false | true | false |
1730 * | '' | false | true | false |
1731 * | '0' | true | true | false |
1732 * | 0 | true | true | true |
1733 * +---------+-----------+-----------+-----------+
1734 * Usage: 3
1735 *
1736 * @param array one-dimensional array of items
1737 * @param string item to check for
1738 * @return boolean true if $item is in the one-dimensional array $in_array
1739 */
1740 public static function inArray(array $in_array, $item) {
1741 foreach ($in_array as $val) {
1742 if (!is_array($val) && !strcmp($val, $item)) {
1743 return true;
1744 }
1745 }
1746 return false;
1747 }
1748
1749 /**
1750 * Explodes a $string delimited by $delim and passes each item in the array through intval().
1751 * Corresponds to t3lib_div::trimExplode(), but with conversion to integers for all values.
1752 * Usage: 76
1753 *
1754 * @param string Delimiter string to explode with
1755 * @param string The string to explode
1756 * @param boolean If set, all empty values (='') will NOT be set in output
1757 * @param integer If positive, the result will contain a maximum of limit elements,
1758 * if negative, all components except the last -limit are returned,
1759 * if zero (default), the result is not limited at all
1760 * @return array Exploded values, all converted to integers
1761 */
1762 public static function intExplode($delimiter, $string, $onlyNonEmptyValues = FALSE, $limit = 0) {
1763 $explodedValues = self::trimExplode($delimiter, $string, $onlyNonEmptyValues, $limit);
1764 return array_map('intval', $explodedValues);
1765 }
1766
1767 /**
1768 * Reverse explode which explodes the string counting from behind.
1769 * Thus t3lib_div::revExplode(':','my:words:here',2) will return array('my:words','here')
1770 * Usage: 8
1771 *
1772 * @param string Delimiter string to explode with
1773 * @param string The string to explode
1774 * @param integer Number of array entries
1775 * @return array Exploded values
1776 */
1777 public static function revExplode($delimiter, $string, $count=0) {
1778 $explodedValues = explode($delimiter, strrev($string), $count);
1779 $explodedValues = array_map('strrev', $explodedValues);
1780 return array_reverse($explodedValues);
1781 }
1782
1783 /**
1784 * Explodes a string and trims all values for whitespace in the ends.
1785 * If $onlyNonEmptyValues is set, then all blank ('') values are removed.
1786 * Usage: 256
1787 *
1788 * @param string Delimiter string to explode with
1789 * @param string The string to explode
1790 * @param boolean If set, all empty values will be removed in output
1791 * @param integer If positive, the result will contain a maximum of
1792 * $limit elements, if negative, all components except
1793 * the last -$limit are returned, if zero (default),
1794 * the result is not limited at all. Attention though
1795 * that the use of this parameter can slow down this
1796 * function.
1797 * @return array Exploded values
1798 */
1799 public static function trimExplode($delim, $string, $removeEmptyValues = false, $limit = 0) {
1800 $explodedValues = explode($delim, $string);
1801
1802 $result = array_map('trim', $explodedValues);
1803
1804 if ($removeEmptyValues) {
1805 $temp = array();
1806 foreach($result as $value) {
1807 if ($value !== '') {
1808 $temp[] = $value;
1809 }
1810 }
1811 $result = $temp;
1812 }
1813
1814 if ($limit != 0) {
1815 if ($limit < 0) {
1816 $result = array_slice($result, 0, $limit);
1817 } elseif (count($result) > $limit) {
1818 $lastElements = array_slice($result, $limit - 1);
1819 $result = array_slice($result, 0, $limit - 1);
1820 $result[] = implode($delim, $lastElements);
1821 }
1822 }
1823
1824 return $result;
1825 }
1826
1827 /**
1828 * Remove duplicate values from an array
1829 * Usage: 0
1830 *
1831 * @param array Array of values to make unique
1832 * @return array
1833 * @ignore
1834 * @deprecated since TYPO3 3.5 - Use the PHP function array_unique instead
1835 */
1836 public static function uniqueArray(array $valueArray) {
1837 self::logDeprecatedFunction();
1838
1839 return array_unique($valueArray);
1840 }
1841
1842 /**
1843 * Removes the value $cmpValue from the $array if found there. Returns the modified array
1844 * Usage: 3
1845 *
1846 * @param array Array containing the values
1847 * @param string Value to search for and if found remove array entry where found.
1848 * @return array Output array with entries removed if search string is found
1849 */
1850 public static function removeArrayEntryByValue(array $array, $cmpValue) {
1851 foreach ($array as $k => $v) {
1852 if (is_array($v)) {
1853 $array[$k] = self::removeArrayEntryByValue($v, $cmpValue);
1854 } elseif (!strcmp($v, $cmpValue)) {
1855 unset($array[$k]);
1856 }
1857 }
1858 return $array;
1859 }
1860
1861 /**
1862 * Filters an array to reduce its elements to match the condition.
1863 * The values in $keepItems can be optionally evaluated by a custom callback function.
1864 *
1865 * Example (arguments used to call this function):
1866 * $array = array(
1867 * array('aa' => array('first', 'second'),
1868 * array('bb' => array('third', 'fourth'),
1869 * array('cc' => array('fifth', 'sixth'),
1870 * );
1871 * $keepItems = array('third');
1872 * $getValueFunc = create_function('$value', 'return $value[0];');
1873 *
1874 * Returns:
1875 * array(
1876 * array('bb' => array('third', 'fourth'),
1877 * )
1878 *
1879 * @param array $array: The initial array to be filtered/reduced
1880 * @param mixed $keepItems: The items which are allowed/kept in the array - accepts array or csv string
1881 * @param string $getValueFunc: (optional) Unique function name set by create_function() used to get the value to keep
1882 * @return array The filtered/reduced array with the kept items
1883 */
1884 public static function keepItemsInArray(array $array, $keepItems, $getValueFunc=null) {
1885 if ($array) {
1886 // Convert strings to arrays:
1887 if (is_string($keepItems)) {
1888 $keepItems = self::trimExplode(',', $keepItems);
1889 }
1890 // create_function() returns a string:
1891 if (!is_string($getValueFunc)) {
1892 $getValueFunc = null;
1893 }
1894 // Do the filtering:
1895 if (is_array($keepItems) && count($keepItems)) {
1896 foreach ($array as $key => $value) {
1897 // Get the value to compare by using the callback function:
1898 $keepValue = (isset($getValueFunc) ? $getValueFunc($value) : $value);
1899 if (!in_array($keepValue, $keepItems)) {
1900 unset($array[$key]);
1901 }
1902 }
1903 }
1904 }
1905 return $array;
1906 }
1907
1908 /**
1909 * Implodes a multidim-array into GET-parameters (eg. &param[key][key2]=value2&param[key][key3]=value3)
1910 * Usage: 24
1911 *
1912 * @param string Name prefix for entries. Set to blank if you wish none.
1913 * @param array The (multidim) array to implode
1914 * @param string (keep blank)
1915 * @param boolean If set, parameters which were blank strings would be removed.
1916 * @param boolean If set, the param name itself (for example "param[key][key2]") would be rawurlencoded as well.
1917 * @return string Imploded result, fx. &param[key][key2]=value2&param[key][key3]=value3
1918 * @see explodeUrl2Array()
1919 */
1920 public static function implodeArrayForUrl($name, array $theArray, $str = '', $skipBlank = false, $rawurlencodeParamName = false) {
1921 foreach($theArray as $Akey => $AVal) {
1922 $thisKeyName = $name ? $name.'['.$Akey.']' : $Akey;
1923 if (is_array($AVal)) {
1924 $str = self::implodeArrayForUrl($thisKeyName,$AVal,$str,$skipBlank,$rawurlencodeParamName);
1925 } else {
1926 if (!$skipBlank || strcmp($AVal,'')) {
1927 $str.='&'.($rawurlencodeParamName ? rawurlencode($thisKeyName) : $thisKeyName).
1928 '='.rawurlencode($AVal);
1929 }
1930 }
1931 }
1932 return $str;
1933 }
1934
1935 /**
1936 * Explodes a string with GETvars (eg. "&id=1&type=2&ext[mykey]=3") into an array
1937 *
1938 * @param string GETvars string
1939 * @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())
1940 * @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!
1941 * @see implodeArrayForUrl()
1942 */
1943 public static function explodeUrl2Array($string,$multidim=FALSE) {
1944 $output = array();
1945 if ($multidim) {
1946 parse_str($string,$output);
1947 } else {
1948 $p = explode('&',$string);
1949 foreach($p as $v) {
1950 if (strlen($v)) {
1951 list($pK,$pV) = explode('=',$v,2);
1952 $output[rawurldecode($pK)] = rawurldecode($pV);
1953 }
1954 }
1955 }
1956 return $output;
1957 }
1958
1959 /**
1960 * Returns an array with selected keys from incoming data.
1961 * (Better read source code if you want to find out...)
1962 * Usage: 3
1963 *
1964 * @param string List of variable/key names
1965 * @param array Array from where to get values based on the keys in $varList
1966 * @param boolean If set, then t3lib_div::_GP() is used to fetch the value if not found (isset) in the $getArray
1967 * @return array Output array with selected variables.
1968 */
1969 public static function compileSelectedGetVarsFromArray($varList,array $getArray,$GPvarAlt=1) {
1970 $keys = self::trimExplode(',',$varList,1);
1971 $outArr = array();
1972 foreach($keys as $v) {
1973 if (isset($getArray[$v])) {
1974 $outArr[$v] = $getArray[$v];
1975 } elseif ($GPvarAlt) {
1976 $outArr[$v] = self::_GP($v);
1977 }
1978 }
1979 return $outArr;
1980 }
1981
1982 /**
1983 * AddSlash array
1984 * This function traverses a multidimentional array and adds slashes to the values.
1985 * NOTE that the input array is and argument by reference.!!
1986 * Twin-function to stripSlashesOnArray
1987 * Usage: 8
1988 *
1989 * @param array Multidimensional input array, (REFERENCE!)
1990 * @return array
1991 */
1992 public static function addSlashesOnArray(array &$theArray) {
1993 foreach ($theArray as &$value) {
1994 if (is_array($value)) {
1995 self::addSlashesOnArray($value);
1996 } else {
1997 $value = addslashes($value);
1998 }
1999 unset($value);
2000 }
2001 reset($theArray);
2002 }
2003
2004 /**
2005 * StripSlash array
2006 * This function traverses a multidimentional array and strips slashes to the values.
2007 * NOTE that the input array is and argument by reference.!!
2008 * Twin-function to addSlashesOnArray
2009 * Usage: 10
2010 *
2011 * @param array Multidimensional input array, (REFERENCE!)
2012 * @return array
2013 */
2014 public static function stripSlashesOnArray(array &$theArray) {
2015 foreach ($theArray as &$value) {
2016 if (is_array($value)) {
2017 self::stripSlashesOnArray($value);
2018 } else {
2019 $value = stripslashes($value);
2020 }
2021 unset($value);
2022 }
2023 reset($theArray);
2024 }
2025
2026 /**
2027 * Either slashes ($cmd=add) or strips ($cmd=strip) array $arr depending on $cmd
2028 * Usage: 0
2029 *
2030 * @param array Multidimensional input array
2031 * @param string "add" or "strip", depending on usage you wish.
2032 * @return array
2033 */
2034 public static function slashArray(array $arr,$cmd) {
2035 if ($cmd=='strip') self::stripSlashesOnArray($arr);
2036 if ($cmd=='add') self::addSlashesOnArray($arr);
2037 return $arr;
2038 }
2039
2040 /**
2041 * Rename Array keys with a given mapping table
2042 * @param array Array by reference which should be remapped
2043 * @param array Array with remap information, array/$oldKey => $newKey)
2044 */
2045 function remapArrayKeys(&$array, $mappingTable) {
2046 if (is_array($mappingTable)) {
2047 foreach ($mappingTable as $old => $new) {
2048 if ($new && isset($array[$old])) {
2049 $array[$new] = $array[$old];
2050 unset ($array[$old]);
2051 }
2052 }
2053 }
2054 }
2055
2056
2057 /**
2058 * Merges two arrays recursively and "binary safe" (integer keys are
2059 * overridden as well), overruling similar values in the first array
2060 * ($arr0) with the values of the second array ($arr1)
2061 * In case of identical keys, ie. keeping the values of the second.
2062 * Usage: 0
2063 *
2064 * @param array First array
2065 * @param array Second array, overruling the first array
2066 * @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.
2067 * @param boolean If set, values from $arr1 will overrule if they are empty or zero. Default: true
2068 * @return array Resulting array where $arr1 values has overruled $arr0 values
2069 */
2070 public static function array_merge_recursive_overrule(array $arr0,array $arr1,$notAddKeys=0,$includeEmtpyValues=true) {
2071 foreach ($arr1 as $key => $val) {
2072 if(is_array($arr0[$key])) {
2073 if (is_array($arr1[$key])) {
2074 $arr0[$key] = self::array_merge_recursive_overrule($arr0[$key],$arr1[$key],$notAddKeys,$includeEmtpyValues);
2075 }
2076 } else {
2077 if ($notAddKeys) {
2078 if (isset($arr0[$key])) {
2079 if ($includeEmtpyValues || $val) {
2080 $arr0[$key] = $val;
2081 }
2082 }
2083 } else {
2084 if ($includeEmtpyValues || $val) {
2085 $arr0[$key] = $val;
2086 }
2087 }
2088 }
2089 }
2090 reset($arr0);
2091 return $arr0;
2092 }
2093
2094 /**
2095 * 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.
2096 * Usage: 16
2097 *
2098 * @param array First array
2099 * @param array Second array
2100 * @return array Merged result.
2101 */
2102 public static function array_merge(array $arr1,array $arr2) {
2103 return $arr2+$arr1;
2104 }
2105
2106 /**
2107 * Filters keys off from first array that also exist in second array. Comparision is done by keys.
2108 * This method is a recursive version of php array_diff_assoc()
2109 *
2110 * @param array Source array
2111 * @param array Reduce source array by this array
2112 * @return array Source array reduced by keys also present in second array
2113 */
2114 public static function arrayDiffAssocRecursive(array $array1, array $array2) {
2115 $differenceArray = array();
2116 foreach ($array1 as $key => $value) {
2117 if (!array_key_exists($key, $array2)) {
2118 $differenceArray[$key] = $value;
2119 } elseif (is_array($value)) {
2120 if (is_array($array2[$key])) {
2121 $differenceArray[$key] = self::arrayDiffAssocRecursive($value, $array2[$key]);
2122 }
2123 }
2124 }
2125
2126 return $differenceArray;
2127 }
2128
2129 /**
2130 * Takes a row and returns a CSV string of the values with $delim (default is ,) and $quote (default is ") as separator chars.
2131 * Usage: 5
2132 *
2133 * @param array Input array of values
2134 * @param string Delimited, default is comman
2135 * @param string Quote-character to wrap around the values.
2136 * @return string A single line of CSV
2137 */
2138 public static function csvValues(array $row,$delim=',',$quote='"') {
2139 reset($row);
2140 $out=array();
2141 foreach ($row as $value) {
2142 $out[] = str_replace($quote, $quote.$quote, $value);
2143 }
2144 $str = $quote.implode($quote.$delim.$quote,$out).$quote;
2145 return $str;
2146 }
2147
2148 /**
2149 * Creates recursively a JSON literal from a multidimensional associative array.
2150 * Uses native function of PHP >= 5.2.0
2151 *
2152 * @param array $jsonArray: The array to be transformed to JSON
2153 * @return string JSON string
2154 * @deprecated since TYPO3 4.3, use PHP native function json_encode() instead, will be removed in TYPO3 4.5
2155 */
2156 public static function array2json(array $jsonArray) {
2157 self::logDeprecatedFunction();
2158
2159 return json_encode($jsonArray);
2160 }
2161
2162 /**
2163 * Removes dots "." from end of a key identifier of TypoScript styled array.
2164 * array('key.' => array('property.' => 'value')) --> array('key' => array('property' => 'value'))
2165 *
2166 * @param array $ts: TypoScript configuration array
2167 * @return array TypoScript configuration array without dots at the end of all keys
2168 */
2169 public static function removeDotsFromTS(array $ts) {
2170 $out = array();
2171 foreach ($ts as $key => $value) {
2172 if (is_array($value)) {
2173 $key = rtrim($key, '.');
2174 $out[$key] = self::removeDotsFromTS($value);
2175 } else {
2176 $out[$key] = $value;
2177 }
2178 }
2179 return $out;
2180 }
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197 /*************************
2198 *
2199 * HTML/XML PROCESSING
2200 *
2201 *************************/
2202
2203 /**
2204 * Returns an array with all attributes of the input HTML tag as key/value pairs. Attributes are only lowercase a-z
2205 * $tag is either a whole tag (eg '<TAG OPTION ATTRIB=VALUE>') or the parameterlist (ex ' OPTION ATTRIB=VALUE>')
2206 * If an attribute is empty, then the value for the key is empty. You can check if it existed with isset()
2207 * Usage: 8
2208 *
2209 * @param string HTML-tag string (or attributes only)
2210 * @return array Array with the attribute values.
2211 */
2212 public static function get_tag_attributes($tag) {
2213 $components = self::split_tag_attributes($tag);
2214 $name = ''; // attribute name is stored here
2215 $valuemode = false;
2216 $attributes = array();
2217 foreach ($components as $key => $val) {
2218 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
2219 if ($valuemode) {
2220 if ($name) {
2221 $attributes[$name] = $val;
2222 $name = '';
2223 }
2224 } else {
2225 if ($key = strtolower(preg_replace('/[^a-zA-Z0-9]/','',$val))) {
2226 $attributes[$key] = '';
2227 $name = $key;
2228 }
2229 }
2230 $valuemode = false;
2231 } else {
2232 $valuemode = true;
2233 }
2234 }
2235 return $attributes;
2236 }
2237
2238 /**
2239 * Returns an array with the 'components' from an attribute list from an HTML tag. The result is normally analyzed by get_tag_attributes
2240 * Removes tag-name if found
2241 * Usage: 2
2242 *
2243 * @param string HTML-tag string (or attributes only)
2244 * @return array Array with the attribute values.
2245 */
2246 public static function split_tag_attributes($tag) {
2247 $tag_tmp = trim(preg_replace('/^<[^[:space:]]*/','',trim($tag)));
2248 // Removes any > in the end of the string
2249 $tag_tmp = trim(rtrim($tag_tmp, '>'));
2250
2251 $value = array();
2252 while (strcmp($tag_tmp,'')) { // Compared with empty string instead , 030102
2253 $firstChar=substr($tag_tmp,0,1);
2254 if (!strcmp($firstChar,'"') || !strcmp($firstChar,"'")) {
2255 $reg=explode($firstChar,$tag_tmp,3);
2256 $value[]=$reg[1];
2257 $tag_tmp=trim($reg[2]);
2258 } elseif (!strcmp($firstChar,'=')) {
2259 $value[] = '=';
2260 $tag_tmp = trim(substr($tag_tmp,1)); // Removes = chars.
2261 } else {
2262 // There are '' around the value. We look for the next ' ' or '>'
2263 $reg = preg_split('/[[:space:]=]/', $tag_tmp, 2);
2264 $value[] = trim($reg[0]);
2265 $tag_tmp = trim(substr($tag_tmp,strlen($reg[0]),1).$reg[1]);
2266 }
2267 }
2268 reset($value);
2269 return $value;
2270 }
2271
2272 /**
2273 * Implodes attributes in the array $arr for an attribute list in eg. and HTML tag (with quotes)
2274 * Usage: 14
2275 *
2276 * @param array Array with attribute key/value pairs, eg. "bgcolor"=>"red", "border"=>0
2277 * @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!
2278 * @param boolean If true, don't check if values are blank. Default is to omit attributes with blank values.
2279 * @return string Imploded attributes, eg. 'bgcolor="red" border="0"'
2280 */
2281 public static function implodeAttributes(array $arr,$xhtmlSafe=FALSE,$dontOmitBlankAttribs=FALSE) {
2282 if ($xhtmlSafe) {
2283 $newArr=array();
2284 foreach($arr as $p => $v) {
2285 if (!isset($newArr[strtolower($p)])) $newArr[strtolower($p)] = htmlspecialchars($v);
2286 }
2287 $arr = $newArr;
2288 }
2289 $list = array();
2290 foreach($arr as $p => $v) {
2291 if (strcmp($v,'') || $dontOmitBlankAttribs) {$list[]=$p.'="'.$v.'"';}
2292 }
2293 return implode(' ',$list);
2294 }
2295
2296 /**
2297 * Implodes attributes in the array $arr for an attribute list in eg. and HTML tag (with quotes)
2298 *
2299 * @param array See implodeAttributes()
2300 * @param boolean See implodeAttributes()
2301 * @param boolean See implodeAttributes()
2302 * @return string See implodeAttributes()
2303 * @deprecated since TYPO3 3.7 - Name was changed into implodeAttributes
2304 * @see implodeAttributes()
2305 */
2306 public static function implodeParams(array $arr,$xhtmlSafe=FALSE,$dontOmitBlankAttribs=FALSE) {
2307 self::logDeprecatedFunction();
2308
2309 return self::implodeAttributes($arr,$xhtmlSafe,$dontOmitBlankAttribs);
2310 }
2311
2312 /**
2313 * Wraps JavaScript code XHTML ready with <script>-tags
2314 * Automatic re-identing of the JS code is done by using the first line as ident reference.
2315 * This is nice for identing JS code with PHP code on the same level.
2316 *
2317 * @param string JavaScript code
2318 * @param boolean Wrap script element in linebreaks? Default is TRUE.
2319 * @return string The wrapped JS code, ready to put into a XHTML page
2320 * @author Ingmar Schlecht <ingmars@web.de>
2321 * @author René Fritz <r.fritz@colorcube.de>
2322 */
2323 public static function wrapJS($string, $linebreak=TRUE) {
2324 if(trim($string)) {
2325 // <script wrapped in nl?
2326 $cr = $linebreak? LF : '';
2327
2328 // remove nl from the beginning
2329 $string = preg_replace ('/^\n+/', '', $string);
2330 // re-ident to one tab using the first line as reference
2331 $match = array();
2332 if(preg_match('/^(\t+)/',$string,$match)) {
2333 $string = str_replace($match[1],TAB, $string);
2334 }
2335 $string = $cr.'<script type="text/javascript">
2336 /*<![CDATA[*/
2337 '.$string.'
2338 /*]]>*/
2339 </script>'.$cr;
2340 }
2341 return trim($string);
2342 }
2343
2344
2345 /**
2346 * Parses XML input into a PHP array with associative keys
2347 * Usage: 0
2348 *
2349 * @param string XML data input
2350 * @param integer Number of element levels to resolve the XML into an array. Any further structure will be set as XML.
2351 * @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.
2352 * @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
2353 */
2354 public static function xml2tree($string,$depth=999) {
2355 $parser = xml_parser_create();
2356 $vals = array();
2357 $index = array();
2358
2359 xml_parser_set_option($parser, XML_OPTION_CASE_FOLDING, 0);
2360 xml_parser_set_option($parser, XML_OPTION_SKIP_WHITE, 0);
2361 xml_parse_into_struct($parser, $string, $vals, $index);
2362
2363 if (xml_get_error_code($parser)) return 'Line '.xml_get_current_line_number($parser).': '.xml_error_string(xml_get_error_code($parser));
2364 xml_parser_free($parser);
2365
2366 $stack = array( array() );
2367 $stacktop = 0;
2368 $startPoint=0;
2369
2370 // FIXME don't use unset() - what does that mean? Use NULL or similar.
2371 unset($tagi);
2372 foreach($vals as $key => $val) {
2373 $type = $val['type'];
2374
2375 // open tag:
2376 if ($type=='open' || $type=='complete') {
2377 $stack[$stacktop++] = $tagi;
2378
2379 if ($depth==$stacktop) {
2380 $startPoint=$key;
2381 }
2382
2383 $tagi = array('tag' => $val['tag']);
2384
2385 if(isset($val['attributes'])) $tagi['attrs'] = $val['attributes'];
2386 if(isset($val['value'])) $tagi['values'][] = $val['value'];
2387 }
2388 // finish tag:
2389 if ($type=='complete' || $type=='close') {
2390 $oldtagi = $tagi;
2391 $tagi = $stack[--$stacktop];
2392 $oldtag = $oldtagi['tag'];
2393 unset($oldtagi['tag']);
2394
2395 if ($depth==($stacktop+1)) {
2396 if ($key-$startPoint > 0) {
2397 $partArray = array_slice(
2398 $vals,
2399 $startPoint+1,
2400 $key-$startPoint-1
2401 );
2402 #$oldtagi=array('XMLvalue'=>self::xmlRecompileFromStructValArray($partArray));
2403 $oldtagi['XMLvalue']=self::xmlRecompileFromStructValArray($partArray);
2404 } else {
2405 $oldtagi['XMLvalue']=$oldtagi['values'][0];
2406 }
2407 }
2408
2409 $tagi['ch'][$oldtag][] = $oldtagi;
2410 unset($oldtagi);
2411 }
2412 // cdata
2413 if($type=='cdata') {
2414 $tagi['values'][] = $val['value'];
2415 }
2416 }
2417 return $tagi['ch'];
2418 }
2419
2420 /**
2421 * Turns PHP array into XML. See array2xml()
2422 *
2423 * @param array The input PHP array with any kind of data; text, binary, integers. Not objects though.
2424 * @param string Alternative document tag. Default is "phparray".
2425 * @param array Options for the compilation. See array2xml() for description.
2426 * @param string Forced charset to prologue
2427 * @return string An XML string made from the input content in the array.
2428 * @see xml2array(),array2xml()
2429 */
2430 public static function array2xml_cs(array $array,$docTag='phparray',array $options=array(),$charset='') {
2431
2432 // Figure out charset if not given explicitly:
2433 if (!$charset) {
2434 if ($GLOBALS['TYPO3_CONF_VARS']['BE']['forceCharset']) { // First priority: forceCharset! If set, this will be authoritative!
2435 $charset = $GLOBALS['TYPO3_CONF_VARS']['BE']['forceCharset'];
2436 } elseif (is_object($GLOBALS['LANG'])) {
2437 $charset = $GLOBALS['LANG']->charSet; // If "LANG" is around, that will hold the current charset
2438 } else {
2439 $charset = 'iso-8859-1'; // THIS is just a hopeful guess!
2440 }
2441 }
2442
2443 // Return XML:
2444 return '<?xml version="1.0" encoding="'.htmlspecialchars($charset).'" standalone="yes" ?>'.LF.
2445 self::array2xml($array,'',0,$docTag,0, $options);
2446 }
2447
2448 /**
2449 * Deprecated to call directly (unless you are aware of using XML prologues)! Use "array2xml_cs" instead (which adds an XML-prologue)
2450 *
2451 * Converts a PHP array into an XML string.
2452 * The XML output is optimized for readability since associative keys are used as tagnames.
2453 * 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.
2454 * Numeric keys are stored with the default tagname "numIndex" but can be overridden to other formats)
2455 * 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
2456 * 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.
2457 * 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!
2458 * 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...
2459 * Usage: 5
2460 *
2461 * @param array The input PHP array with any kind of data; text, binary, integers. Not objects though.
2462 * @param string tag-prefix, eg. a namespace prefix like "T3:"
2463 * @param integer Current recursion level. Don't change, stay at zero!
2464 * @param string Alternative document tag. Default is "phparray".
2465 * @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
2466 * @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')
2467 * @param string Stack data. Don't touch.
2468 * @return string An XML string made from the input content in the array.
2469 * @see xml2array()
2470 */
2471 public static function array2xml(array $array,$NSprefix='',$level=0,$docTag='phparray',$spaceInd=0,array $options=array(),array $stackData=array()) {
2472 // 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
2473 $binaryChars = chr(0).chr(1).chr(2).chr(3).chr(4).chr(5).chr(6).chr(7).chr(8).
2474 chr(11).chr(12).chr(14).chr(15).chr(16).chr(17).chr(18).chr(19).
2475 chr(20).chr(21).chr(22).chr(23).chr(24).chr(25).chr(26).chr(27).chr(28).chr(29).
2476 chr(30).chr(31);
2477 // Set indenting mode:
2478 $indentChar = $spaceInd ? ' ' : TAB;
2479 $indentN = $spaceInd>0 ? $spaceInd : 1;
2480 $nl = ($spaceInd >= 0 ? LF : '');
2481
2482 // Init output variable:
2483 $output='';
2484
2485 // Traverse the input array
2486 foreach($array as $k=>$v) {
2487 $attr = '';
2488 $tagName = $k;
2489
2490 // Construct the tag name.
2491 if(isset($options['grandParentTagMap'][$stackData['grandParentTagName'].'/'.$stackData['parentTagName']])) { // Use tag based on grand-parent + parent tag name
2492 $attr.=' index="'.htmlspecialchars($tagName).'"';
2493 $tagName = (string)$options['grandParentTagMap'][$stackData['grandParentTagName'].'/'.$stackData['parentTagName']];
2494 }elseif(isset($options['parentTagMap'][$stackData['parentTagName'].':_IS_NUM']) && self::testInt($tagName)) { // Use tag based on parent tag name + if current tag is numeric
2495 $attr.=' index="'.htmlspecialchars($tagName).'"';
2496 $tagName = (string)$options['parentTagMap'][$stackData['parentTagName'].':_IS_NUM'];
2497 }elseif(isset($options['parentTagMap'][$stackData['parentTagName'].':'.$tagName])) { // Use tag based on parent tag name + current tag
2498 $attr.=' index="'.htmlspecialchars($tagName).'"';
2499 $tagName = (string)$options['parentTagMap'][$stackData['parentTagName'].':'.$tagName];
2500 } elseif(isset($options['parentTagMap'][$stackData['parentTagName']])) { // Use tag based on parent tag name:
2501 $attr.=' index="'.htmlspecialchars($tagName).'"';
2502 $tagName = (string)$options['parentTagMap'][$stackData['parentTagName']];
2503 } elseif (!strcmp(intval($tagName),$tagName)) { // If integer...;
2504 if ($options['useNindex']) { // If numeric key, prefix "n"
2505 $tagName = 'n'.$tagName;
2506 } else { // Use special tag for num. keys:
2507 $attr.=' index="'.$tagName.'"';
2508 $tagName = $options['useIndexTagForNum'] ? $options['useIndexTagForNum'] : 'numIndex';
2509 }
2510 } elseif($options['useIndexTagForAssoc']) { // Use tag for all associative keys:
2511 $attr.=' index="'.htmlspecialchars($tagName).'"';
2512 $tagName = $options['useIndexTagForAssoc'];
2513 }
2514
2515 // The tag name is cleaned up so only alphanumeric chars (plus - and _) are in there and not longer than 100 chars either.
2516 $tagName = substr(preg_replace('/[^[:alnum:]_-]/','',$tagName),0,100);
2517
2518 // If the value is an array then we will call this function recursively:
2519 if (is_array($v)) {
2520
2521 // Sub elements:
2522 if ($options['alt_options'][$stackData['path'].'/'.$tagName]) {
2523 $subOptions = $options['alt_options'][$stackData['path'].'/'.$tagName];
2524 $clearStackPath = $subOptions['clearStackPath'];
2525 } else {
2526 $subOptions = $options;
2527 $clearStackPath = FALSE;
2528 }
2529
2530 $content = $nl .
2531 self::array2xml(
2532 $v,
2533 $NSprefix,
2534 $level+1,
2535 '',
2536 $spaceInd,
2537 $subOptions,
2538 array(
2539 'parentTagName' => $tagName,
2540 'grandParentTagName' => $stackData['parentTagName'],
2541 'path' => $clearStackPath ? '' : $stackData['path'].'/'.$tagName,
2542 )
2543 ).
2544 ($spaceInd >= 0 ? str_pad('',($level+1)*$indentN,$indentChar) : '');
2545 if ((int)$options['disableTypeAttrib']!=2) { // Do not set "type = array". Makes prettier XML but means that empty arrays are not restored with xml2array
2546 $attr.=' type="array"';
2547 }
2548 } else { // Just a value:
2549
2550 // Look for binary chars:
2551 $vLen = strlen($v); // check for length, because PHP 5.2.0 may crash when first argument of strcspn is empty
2552 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!
2553 // If the value contained binary chars then we base64-encode it an set an attribute to notify this situation:
2554 $content = $nl.chunk_split(base64_encode($v));
2555 $attr.=' base64="1"';
2556 } else {
2557 // Otherwise, just htmlspecialchar the stuff:
2558 $content = htmlspecialchars($v);
2559 $dType = gettype($v);
2560 if ($dType == 'string') {
2561 if ($options['useCDATA'] && $content != $v) {
2562 $content = '<![CDATA[' . $v . ']]>';
2563 }
2564 } elseif (!$options['disableTypeAttrib']) {
2565 $attr.= ' type="'.$dType.'"';
2566 }
2567 }
2568 }
2569
2570 // Add the element to the output string:
2571 $output.=($spaceInd >= 0 ? str_pad('',($level+1)*$indentN,$indentChar) : '').'<'.$NSprefix.$tagName.$attr.'>'.$content.'</'.$NSprefix.$tagName.'>'.$nl;
2572 }
2573
2574 // If we are at the outer-most level, then we finally wrap it all in the document tags and return that as the value:
2575 if (!$level) {
2576 $output =
2577 '<'.$docTag.'>'.$nl.
2578 $output.
2579 '</'.$docTag.'>';
2580 }
2581
2582 return $output;
2583 }
2584
2585 /**
2586 * Converts an XML string to a PHP array.
2587 * This is the reverse function of array2xml()
2588 * This is a wrapper for xml2arrayProcess that adds a two-level cache
2589 * Usage: 17
2590 *
2591 * @param string XML content to convert into an array
2592 * @param string The tag-prefix resolve, eg. a namespace like "T3:"
2593 * @param boolean If set, the document tag will be set in the key "_DOCUMENT_TAG" of the output array
2594 * @return mixed If the parsing had errors, a string with the error message is returned. Otherwise an array with the content.
2595 * @see array2xml(),xml2arrayProcess()
2596 * @author Fabrizio Branca <typo3@fabrizio-branca.de> (added caching)
2597 */
2598 public static function xml2array($string,$NSprefix='',$reportDocTag=FALSE) {
2599 static $firstLevelCache = array();
2600
2601 $identifier = md5($string . $NSprefix . ($reportDocTag ? '1' : '0'));
2602
2603 // look up in first level cache
2604 if (!empty($firstLevelCache[$identifier])) {
2605 $array = $firstLevelCache[$identifier];
2606 } else {
2607 // look up in second level cache
2608 $cacheContent = t3lib_pageSelect::getHash($identifier, 0);
2609 $array = unserialize($cacheContent);
2610
2611 if ($array === false) {
2612 $array = self::xml2arrayProcess($string, $NSprefix, $reportDocTag);
2613 t3lib_pageSelect::storeHash($identifier, serialize($array), 'ident_xml2array');
2614 }
2615 // store content in first level cache
2616 $firstLevelCache[$identifier] = $array;
2617 }
2618 return $array;
2619 }
2620
2621 /**
2622 * Converts an XML string to a PHP array.
2623 * This is the reverse function of array2xml()
2624 * Usage: 1
2625 *
2626 * @param string XML content to convert into an array
2627 * @param string The tag-prefix resolve, eg. a namespace like "T3:"
2628 * @param boolean If set, the document tag will be set in the key "_DOCUMENT_TAG" of the output array
2629 * @return mixed If the parsing had errors, a string with the error message is returned. Otherwise an array with the content.
2630 * @see array2xml()
2631 */
2632 protected function xml2arrayProcess($string,$NSprefix='',$reportDocTag=FALSE) {
2633 global $TYPO3_CONF_VARS;
2634
2635 // Create parser:
2636 $parser = xml_parser_create();
2637 $vals = array();
2638 $index = array();
2639
2640 xml_parser_set_option($parser, XML_OPTION_CASE_FOLDING, 0);
2641 xml_parser_set_option($parser, XML_OPTION_SKIP_WHITE, 0);
2642
2643 // default output charset is UTF-8, only ASCII, ISO-8859-1 and UTF-8 are supported!!!
2644 $match = array();
2645 preg_match('/^[[:space:]]*<\?xml[^>]*encoding[[:space:]]*=[[:space:]]*"([^"]*)"/',substr($string,0,200),$match);
2646 $theCharset = $match[1] ? $match[1] : ($TYPO3_CONF_VARS['BE']['forceCharset'] ? $TYPO3_CONF_VARS['BE']['forceCharset'] : 'iso-8859-1');
2647 xml_parser_set_option($parser, XML_OPTION_TARGET_ENCODING, $theCharset); // us-ascii / utf-8 / iso-8859-1
2648
2649 // Parse content:
2650 xml_parse_into_struct($parser, $string, $vals, $index);
2651
2652 // If error, return error message:
2653 if (xml_get_error_code($parser)) {
2654 return 'Line '.xml_get_current_line_number($parser).': '.xml_error_string(xml_get_error_code($parser));
2655 }
2656 xml_parser_free($parser);
2657
2658 // Init vars:
2659 $stack = array(array());
2660 $stacktop = 0;
2661 $current = array();
2662 $tagName = '';
2663 $documentTag = '';
2664
2665 // Traverse the parsed XML structure:
2666 foreach($vals as $key => $val) {
2667
2668 // First, process the tag-name (which is used in both cases, whether "complete" or "close")
2669 $tagName = $val['tag'];
2670 if (!$documentTag) $documentTag = $tagName;
2671
2672 // Test for name space:
2673 $tagName = ($NSprefix && substr($tagName,0,strlen($NSprefix))==$NSprefix) ? substr($tagName,strlen($NSprefix)) : $tagName;
2674
2675 // Test for numeric tag, encoded on the form "nXXX":
2676 $testNtag = substr($tagName,1); // Closing tag.
2677 $tagName = (substr($tagName,0,1)=='n' && !strcmp(intval($testNtag),$testNtag)) ? intval($testNtag) : $tagName;
2678
2679 // Test for alternative index value:
2680 if (strlen($val['attributes']['index'])) { $tagName = $val['attributes']['index']; }
2681
2682 // Setting tag-values, manage stack:
2683 switch($val['type']) {
2684 case 'open': // If open tag it means there is an array stored in sub-elements. Therefore increase the stackpointer and reset the accumulation array:
2685 $current[$tagName] = array(); // Setting blank place holder
2686 $stack[$stacktop++] = $current;
2687 $current = array();
2688 break;
2689 case 'close': // If the tag is "close" then it is an array which is closing and we decrease the stack pointer.
2690 $oldCurrent = $current;
2691 $current = $stack[--$stacktop];
2692 end($current); // Going to the end of array to get placeholder key, key($current), and fill in array next:
2693 $current[key($current)] = $oldCurrent;
2694 unset($oldCurrent);
2695 break;
2696 case 'complete': // If "complete", then it's a value. If the attribute "base64" is set, then decode the value, otherwise just set it.
2697 if ($val['attributes']['base64']) {
2698 $current[$tagName] = base64_decode($val['value']);
2699 } else {
2700 $current[$tagName] = (string)$val['value']; // Had to cast it as a string - otherwise it would be evaluate false if tested with isset()!!
2701
2702 // Cast type:
2703 switch((string)$val['attributes']['type']) {
2704 case 'integer':
2705 $current[$tagName] = (integer)$current[$tagName];
2706 break;
2707 case 'double':
2708 $current[$tagName] = (double)$current[$tagName];
2709 break;
2710 case 'boolean':
2711 $current[$tagName] = (bool)$current[$tagName];
2712 break;
2713 case 'array':
2714 $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...
2715 break;
2716 }
2717 }
2718 break;
2719 }
2720 }
2721
2722 if ($reportDocTag) {
2723 $current[$tagName]['_DOCUMENT_TAG'] = $documentTag;
2724 }
2725
2726 // Finally return the content of the document tag.
2727 return $current[$tagName];
2728 }
2729
2730 /**
2731 * This implodes an array of XML parts (made with xml_parse_into_struct()) into XML again.
2732 * Usage: 2
2733 *
2734 * @param array A array of XML parts, see xml2tree
2735 * @return string Re-compiled XML data.
2736 */
2737 public static function xmlRecompileFromStructValArray(array $vals) {
2738 $XMLcontent='';
2739
2740 foreach($vals as $val) {
2741 $type = $val['type'];
2742
2743 // open tag:
2744 if ($type=='open' || $type=='complete') {
2745 $XMLcontent.='<'.$val['tag'];
2746 if(isset($val['attributes'])) {
2747 foreach($val['attributes'] as $k => $v) {
2748 $XMLcontent.=' '.$k.'="'.htmlspecialchars($v).'"';
2749 }
2750 }
2751 if ($type=='complete') {
2752 if(isset($val['value'])) {
2753 $XMLcontent.='>'.htmlspecialchars($val['value']).'</'.$val['tag'].'>';
2754 } else $XMLcontent.='/>';
2755 } else $XMLcontent.='>';
2756
2757 if ($type=='open' && isset($val['value'])) {
2758 $XMLcontent.=htmlspecialchars($val['value']);
2759 }
2760 }
2761 // finish tag:
2762 if ($type=='close') {
2763 $XMLcontent.='</'.$val['tag'].'>';
2764 }
2765 // cdata
2766 if($type=='cdata') {
2767 $XMLcontent.=htmlspecialchars($val['value']);
2768 }
2769 }
2770
2771 return $XMLcontent;
2772 }
2773
2774 /**
2775 * Extracts the attributes (typically encoding and version) of an XML prologue (header).
2776 * Usage: 1
2777 *
2778 * @param string XML data
2779 * @return array Attributes of the xml prologue (header)
2780 */
2781 public static function xmlGetHeaderAttribs($xmlData) {
2782 $match = array();
2783 if (preg_match('/^\s*<\?xml([^>]*)\?\>/', $xmlData, $match)) {
2784 return self::get_tag_attributes($match[1]);
2785 }
2786 }
2787
2788 /**
2789 * Minifies JavaScript
2790 *
2791 * @param string $script Script to minify
2792 * @param string $error Error message (if any)
2793 * @return string Minified script or source string if error happened
2794 */
2795 public static function minifyJavaScript($script, &$error = '') {
2796 require_once(PATH_typo3 . 'contrib/jsmin/jsmin.php');
2797 try {
2798 $error = '';
2799 $script = trim(JSMin::minify(str_replace(CR, '', $script)));
2800 }
2801 catch(JSMinException $e) {
2802 $error = 'Error while minifying JavaScript: ' . $e->getMessage();
2803 self::devLog($error, 't3lib_div', 2,
2804 array('JavaScript' => $script, 'Stack trace' => $e->getTrace()));
2805 }
2806 return $script;
2807 }
2808
2809
2810
2811
2812
2813
2814
2815
2816 /*************************
2817 *
2818 * FILES FUNCTIONS
2819 *
2820 *************************/
2821
2822 /**
2823 * Reads the file or url $url and returns the content
2824 * 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.
2825 * Usage: 83
2826 *
2827 * @param string File/URL to read
2828 * @param integer Whether the HTTP header should be fetched or not. 0=disable, 1=fetch header+content, 2=fetch header only
2829 * @param array HTTP headers to be used in the request
2830 * @param array Error code/message and, if $includeHeader is 1, response meta data (HTTP status and content type)
2831 * @return string The content from the resource given as input. FALSE if an error has occured.
2832 */
2833 public static function getURL($url, $includeHeader = 0, $requestHeaders = false, &$report = NULL) {
2834 $content = false;
2835
2836 if (isset($report)) {
2837 $report['error'] = 0;
2838 $report['message'] = '';
2839 }
2840
2841 // use cURL for: http, https, ftp, ftps, sftp and scp
2842 if ($GLOBALS['TYPO3_CONF_VARS']['SYS']['curlUse'] == '1' && preg_match('/^(?:http|ftp)s?|s(?:ftp|cp):/', $url)) {
2843 if (isset($report)) {
2844 $report['lib'] = 'cURL';
2845 }
2846
2847 // External URL without error checking.
2848 $ch = curl_init();
2849 if (!$ch) {
2850 if (isset($report)) {
2851 $report['error'] = -1;
2852 $report['message'] = 'Couldn\'t initialize cURL.';
2853 }
2854 return false;
2855 }
2856
2857 curl_setopt($ch, CURLOPT_URL, $url);
2858 curl_setopt($ch, CURLOPT_HEADER, $includeHeader ? 1 : 0);
2859 curl_setopt($ch, CURLOPT_NOBODY, $includeHeader == 2 ? 1 : 0);
2860 curl_setopt($ch, CURLOPT_HTTPGET, $includeHeader == 2 ? 'HEAD' : 'GET');
2861 curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
2862 curl_setopt($ch, CURLOPT_FAILONERROR, 1);
2863 curl_setopt($ch, CURLOPT_CONNECTTIMEOUT, max(0, intval($GLOBALS['TYPO3_CONF_VARS']['SYS']['curlTimeout'])));
2864
2865 // may fail (PHP 5.2.0+ and 5.1.5+) when open_basedir or safe_mode are enabled
2866 $followLocation = @curl_setopt($ch, CURLOPT_FOLLOWLOCATION, 1);
2867
2868 if (is_array($requestHeaders)) {
2869 curl_setopt($ch, CURLOPT_HTTPHEADER, $requestHeaders);
2870 }
2871
2872 // (Proxy support implemented by Arco <arco@appeltaart.mine.nu>)
2873 if ($GLOBALS['TYPO3_CONF_VARS']['SYS']['curlProxyServer']) {
2874 curl_setopt($ch, CURLOPT_PROXY, $GLOBALS['TYPO3_CONF_VARS']['SYS']['curlProxyServer']);
2875
2876 if ($GLOBALS['TYPO3_CONF_VARS']['SYS']['curlProxyTunnel']) {
2877 curl_setopt($ch, CURLOPT_HTTPPROXYTUNNEL, $GLOBALS['TYPO3_CONF_VARS']['SYS']['curlProxyTunnel']);
2878 }
2879 if ($GLOBALS['TYPO3_CONF_VARS']['SYS']['curlProxyUserPass']) {
2880 curl_setopt($ch, CURLOPT_PROXYUSERPWD, $GLOBALS['TYPO3_CONF_VARS']['SYS']['curlProxyUserPass']);
2881 }
2882 }
2883 $content = curl_exec($ch);
2884 if (isset($report)) {
2885 if ($content===FALSE) {
2886 $report['error'] = curl_errno($ch);
2887 $report['message'] = curl_error($ch);
2888 } else {
2889 $curlInfo = curl_getinfo($ch);
2890 // We hit a redirection but we couldn't follow it
2891 if (!$followLocation && $curlInfo['status'] >= 300 && $curlInfo['status'] < 400) {
2892 $report['error'] = -1;
2893 $report['message'] = 'Couldn\'t follow location redirect (either PHP configuration option safe_mode or open_basedir is in effect).';
2894 } elseif($includeHeader) {
2895 // Set only for $includeHeader to work exactly like PHP variant
2896 $report['http_code'] = $curlInfo['http_code'];
2897 $report['content_type'] = $curlInfo['content_type'];
2898 }
2899 }
2900 }
2901 curl_close($ch);
2902
2903 } elseif ($includeHeader) {
2904 if (isset($report)) {
2905 $report['lib'] = 'socket';
2906 }
2907 $parsedURL = parse_url($url);
2908 if (!preg_match('/^https?/', $parsedURL['scheme'])) {
2909 if (isset($report)) {
2910 $report['error'] = -1;
2911 $report['message'] = 'Reading headers is not allowed for this protocol.';
2912 }
2913 return false;
2914 }
2915 $port = intval($parsedURL['port']);
2916 if ($port < 1) {
2917 if ($parsedURL['scheme'] == 'http') {
2918 $port = ($port>0 ? $port : 80);
2919 $scheme = '';
2920 } else {
2921 $port = ($port>0 ? $port : 443);
2922 $scheme = 'ssl://';
2923 }
2924 }
2925 $errno = 0;
2926 // $errstr = '';
2927 $fp = @fsockopen($scheme.$parsedURL['host'], $port, $errno, $errstr, 2.0);
2928 if (!$fp || $errno > 0) {
2929 if (isset($report)) {
2930 $report['error'] = $errno ? $errno : -1;
2931 $report['message'] = $errno ? ($errstr ? $errstr : 'Socket error.') : 'Socket initialization error.';
2932 }
2933 return false;
2934 }
2935 $method = ($includeHeader == 2) ? 'HEAD' : 'GET';
2936 $msg = $method . ' ' . $parsedURL['path'] .
2937 ($parsedURL['query'] ? '?' . $parsedURL['query'] : '') .
2938 ' HTTP/1.0' . CRLF . 'Host: ' .
2939 $parsedURL['host'] . "\r\nConnection: close\r\n";
2940 if (is_array($requestHeaders)) {
2941 $msg .= implode(CRLF, $requestHeaders) . CRLF;
2942 }
2943 $msg .= CRLF;
2944
2945 fputs($fp, $msg);
2946 while (!feof($fp)) {
2947 $line = fgets($fp, 2048);
2948 if (isset($report)) {
2949 if (preg_match('|^HTTP/\d\.\d +(\d+)|', $line, $status)) {
2950 $report['http_code'] = $status[1];
2951 }
2952 elseif (preg_match('/^Content-Type: *(.*)/i', $line, $type)) {
2953 $report['content_type'] = $type[1];
2954 }
2955 }
2956 $content .= $line;
2957 if (!strlen(trim($line))) {
2958 break; // Stop at the first empty line (= end of header)
2959 }
2960 }
2961 if ($includeHeader != 2) {
2962 $content .= stream_get_contents($fp);
2963 }
2964 fclose($fp);
2965
2966 } elseif (is_array($requestHeaders)) {
2967 if (isset($report)) {
2968 $report['lib'] = 'file/context';
2969 }
2970 $parsedURL = parse_url($url);
2971 if (!preg_match('/^https?/', $parsedURL['scheme'])) {
2972 if (isset($report)) {
2973 $report['error'] = -1;
2974 $report['message'] = 'Sending request headers is not allowed for this protocol.';
2975 }
2976 return false;
2977 }
2978 $ctx = stream_context_create(array(
2979 'http' => array(
2980 'header' => implode(CRLF, $requestHeaders)
2981 )
2982 )
2983 );
2984 $content = @file_get_contents($url, false, $ctx);
2985 if ($content === false && isset($report)) {
2986 $phpError = error_get_last();
2987 $report['error'] = $phpError['type'];
2988 $report['message'] = $phpError['message'];
2989 }
2990 } else {
2991 if (isset($report)) {
2992 $report['lib'] = 'file';
2993 }
2994 $content = @file_get_contents($url);
2995 if ($content === false && isset($report)) {
2996 if (function_exists('error_get_last')) {
2997 $phpError = error_get_last();
2998 $report['error'] = $phpError['type'];
2999 $report['message'] = $phpError['message'];
3000 } else {
3001 $report['error'] = -1;
3002 $report['message'] = 'Couldn\'t get URL.';
3003 }
3004 }
3005 }
3006
3007 return $content;
3008 }
3009
3010 /**
3011 * Writes $content to the file $file
3012 * Usage: 30
3013 *
3014 * @param string Filepath to write to
3015 * @param string Content to write
3016 * @return boolean True if the file was successfully opened and written to.
3017 */
3018 public static function writeFile($file,$content) {
3019 if (!@is_file($file)) $changePermissions = true;
3020
3021 if ($fd = fopen($file,'wb')) {
3022 $res = fwrite($fd,$content);
3023 fclose($fd);
3024
3025 if ($res===false) return false;
3026
3027 if ($changePermissions) { // Change the permissions only if the file has just been created
3028 self::fixPermissions($file);
3029 }
3030
3031 return true;
3032 }
3033
3034 return false;
3035 }
3036
3037 /**
3038 * Sets the file system mode and group ownership of a file or a folder.
3039 *
3040 * @param string Absolute filepath of file or folder, must not be escaped.
3041 * @param boolean If set, also fixes permissions of files and folders in the folder (if $path is a folder)
3042 * @return mixed TRUE on success, FALSE on error, always TRUE on Windows OS
3043 */
3044 public static function fixPermissions($path, $recursive = FALSE) {
3045 if (TYPO3_OS != 'WIN') {
3046 $result = FALSE;
3047 if (self::isAllowedAbsPath($path)) {
3048 if (@is_file($path)) {
3049 // "@" is there because file is not necessarily OWNED by the user
3050 $result = @chmod($path, octdec($GLOBALS['TYPO3_CONF_VARS']['BE']['fileCreateMask']));
3051 } elseif (@is_dir($path)) {
3052 $path = preg_replace('|/$|', '', $path);
3053 // "@" is there because file is not necessarily OWNED by the user
3054 $result = @chmod($path, octdec($GLOBALS['TYPO3_CONF_VARS']['BE']['folderCreateMask']));
3055 }
3056
3057 // Set createGroup if not empty
3058 if($GLOBALS['TYPO3_CONF_VARS']['BE']['createGroup']) {
3059 // "@" is there because file is not necessarily OWNED by the user
3060 $changeGroupResult = @chgrp($path, $GLOBALS['TYPO3_CONF_VARS']['BE']['createGroup']);
3061 $result = $changeGroupResult ? $result : FALSE;
3062 }
3063
3064 // Call recursive if recursive flag if set and $path is directory
3065 if ($recursive && @is_dir($path)) {
3066 $handle = opendir($path);
3067 while (($file = readdir($handle)) !== FALSE) {
3068 unset($recursionResult);
3069 if ($file !== '.' && $file !== '..') {
3070 if (@is_file($path . '/' . $file)) {
3071 $recursionResult = self::fixPermissions($path . '/' . $file);
3072 } elseif (@is_dir($path . '/' . $file)) {
3073 $recursionResult = self::fixPermissions($path . '/' . $file, TRUE);
3074 }
3075 if (isset($recursionResult) && !$recursionResult) {
3076 $result = FALSE;
3077 }
3078 }
3079 }
3080 closedir($handle);
3081 }
3082 }
3083 } else {
3084 $result = TRUE;
3085 }
3086 return $result;
3087 }
3088
3089 /**
3090 * Writes $content to a filename in the typo3temp/ folder (and possibly one or two subfolders...)
3091 * Accepts an additional subdirectory in the file path!
3092 *
3093 * @param string Absolute filepath to write to inside "typo3temp/". First part of this string must match PATH_site."typo3temp/"
3094 * @param string Content string to write
3095 * @return string Returns false on success, otherwise an error string telling about the problem.
3096 */
3097 public static function writeFileToTypo3tempDir($filepath,$content) {
3098
3099 // Parse filepath into directory and basename:
3100 $fI = pathinfo($filepath);
3101 $fI['dirname'].= '/';
3102
3103 // Check parts:
3104 if (self::validPathStr($filepath) && $fI['basename'] && strlen($fI['basename'])<60) {
3105 if (defined('PATH_site')) {
3106 $dirName = PATH_site.'typo3temp/'; // Setting main temporary directory name (standard)
3107 if (@is_dir($dirName)) {
3108 if (self::isFirstPartOfStr($fI['dirname'],$dirName)) {
3109
3110 // Checking if the "subdir" is found:
3111 $subdir = substr($fI['dirname'],strlen($dirName));
3112 if ($subdir) {
3113 if (preg_match('/^[[:alnum:]_]+\/$/',$subdir) || preg_match('/^[[:alnum:]_]+\/[[:alnum:]_]+\/$/',$subdir)) {
3114 $dirName.= $subdir;
3115 if (!@is_dir($dirName)) {
3116 self::mkdir_deep(PATH_site.'typo3temp/', $subdir);
3117 }
3118 } else return 'Subdir, "'.$subdir.'", was NOT on the form "[[:alnum:]_]/" or "[[:alnum:]_]/[[:alnum:]_]/"';
3119 }
3120 // Checking dir-name again (sub-dir might have been created):
3121 if (@is_dir($dirName)) {
3122 if ($filepath == $dirName.$fI['basename']) {
3123 self::writeFile($filepath, $content);
3124 if (!@is_file($filepath)) return 'File not written to disk! Write permission error in filesystem?';
3125 } else return 'Calculated filelocation didn\'t match input $filepath!';
3126 } else return '"'.$dirName.'" is not a directory!';
3127 } else return '"'.$fI['dirname'].'" was not within directory PATH_site + "typo3temp/"';
3128 } else return 'PATH_site + "typo3temp/" was not a directory!';
3129 } else return 'PATH_site constant was NOT defined!';
3130 } else return 'Input filepath "'.$filepath.'" was generally invalid!';
3131 }
3132
3133 /**
3134 * Wrapper function for mkdir.
3135 * Sets folder permissions according to $GLOBALS['TYPO3_CONF_VARS']['BE']['folderCreateMask']
3136 * and group ownership according to $GLOBALS['TYPO3_CONF_VARS']['BE']['createGroup']
3137 *
3138 * @param string Absolute path to folder, see PHP mkdir() function. Removes trailing slash internally.
3139 * @return boolean TRUE if @mkdir went well!
3140 */
3141 public static function mkdir($newFolder) {
3142 $newFolder = preg_replace('|/$|', '', $newFolder);
3143 $result = @mkdir($newFolder, octdec($GLOBALS['TYPO3_CONF_VARS']['BE']['folderCreateMask']));
3144 if ($result) {
3145 self::fixPermissions($newFolder);
3146 }
3147 return $result;
3148 }
3149
3150 /**
3151 * Creates a directory - including parent directories if necessary - in the file system
3152 *
3153 * @param string Base folder. This must exist! Must have trailing slash! Example "/root/typo3site/"
3154 * @param string Deep directory to create, eg. "xx/yy/" which creates "/root/typo3site/xx/yy/" if $destination is "/root/typo3site/"
3155 * @return string If error, returns error string.
3156 */
3157 public static function mkdir_deep($destination,$deepDir) {
3158 $allParts = self::trimExplode('/',$deepDir,1);
3159 $root = '';
3160 foreach($allParts as $part) {
3161 $root.= $part.'/';
3162 if (!is_dir($destination.$root)) {
3163 self::mkdir($destination.$root);
3164 if (!@is_dir($destination.$root)) {
3165 return 'Error: The directory "'.$destination.$root.'" could not be created...';
3166 }
3167 }
3168 }
3169 }
3170
3171 /**
3172 * Wrapper function for rmdir, allowing recursive deletion of folders and files
3173 *
3174 * @param string Absolute path to folder, see PHP rmdir() function. Removes trailing slash internally.
3175 * @param boolean Allow deletion of non-empty directories
3176 * @return boolean true if @rmdir went well!
3177 */
3178 public static function rmdir($path,$removeNonEmpty=false) {
3179 $OK = false;
3180 $path = preg_replace('|/$|','',$path); // Remove trailing slash
3181
3182 if (file_exists($path)) {
3183 $OK = true;
3184
3185 if (is_dir($path)) {
3186 if ($removeNonEmpty==true && $handle = opendir($path)) {
3187 while ($OK && false !== ($file = readdir($handle))) {
3188 if ($file=='.' || $file=='..') continue;
3189 $OK = self::rmdir($path.'/'.$file,$removeNonEmpty);
3190 }
3191 closedir($handle);
3192 }
3193 if ($OK) { $OK = rmdir($path); }
3194
3195 } else { // If $dirname is a file, simply remove it
3196 $OK = unlink($path);
3197 }
3198
3199 clearstatcache();
3200 }
3201
3202 return $OK;
3203 }
3204
3205 /**
3206 * Returns an array with the names of folders in a specific path
3207 * Will return 'error' (string) if there were an error with reading directory content.
3208 * Usage: 11
3209 *
3210 * @param string Path to list directories from
3211 * @return array Returns an array with the directory entries as values. If no path, the return value is nothing.
3212 */
3213 public static function get_dirs($path) {
3214 if ($path) {
3215 if (is_dir($path)) {
3216 $dir = scandir($path);
3217 $dirs = array();
3218 foreach ($dir as $entry) {
3219 if (is_dir($path . '/' . $entry) && $entry != '..' && $entry != '.') {
3220 $dirs[] = $entry;
3221 }
3222 }
3223 } else {
3224 $dirs = 'error';
3225 }
3226 }
3227 return $dirs;
3228 }
3229
3230 /**
3231 * Returns an array with the names of files in a specific path
3232 * Usage: 18
3233 *
3234 * @param string $path: Is the path to the file
3235 * @param string $extensionList is the comma list of extensions to read only (blank = all)
3236 * @param boolean If set, then the path is prepended the filenames. Otherwise only the filenames are returned in the array
3237 * @param string $order is sorting: 1= sort alphabetically, 'mtime' = sort by modification time.
3238 * @param string A comma seperated list of filenames to exclude, no wildcards
3239 * @return array Array of the files found
3240 */
3241 public static function getFilesInDir($path,$extensionList='',$prependPath=0,$order='',$excludePattern='') {
3242
3243 // Initialize variabels:
3244 $filearray = array();
3245 $sortarray = array();
3246 $path = rtrim($path, '/');
3247
3248 // Find files+directories:
3249 if (@is_dir($path)) {
3250 $extensionList = strtolower($extensionList);
3251 $d = dir($path);
3252 if (is_object($d)) {
3253 while($entry=$d->read()) {
3254 if (@is_file($path.'/'.$entry)) {
3255 $fI = pathinfo($entry);
3256 $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)
3257 if ((!strlen($extensionList) || self::inList($extensionList,