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