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