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