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