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