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