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