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