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