[BUGFIX] Unused TDParams in ColumnsContentObject()
[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 $items = explode(',', $list);
719 foreach ($items as $k => $v) {
720 if ($v == $element) {
721 unset($items[$k]);
722 }
723 }
724 return implode(',', $items);
725 }
726
727 /**
728 * Expand a comma-separated list of integers with ranges (eg 1,3-5,7 becomes 1,3,4,5,7).
729 * Ranges are limited to 1000 values per range.
730 *
731 * @param string $list Comma-separated list of integers with ranges (string)
732 * @return string New comma-separated list of items
733 */
734 static public function expandList($list) {
735 $items = explode(',', $list);
736 $list = array();
737 foreach ($items as $item) {
738 $range = explode('-', $item);
739 if (isset($range[1])) {
740 $runAwayBrake = 1000;
741 for ($n = $range[0]; $n <= $range[1]; $n++) {
742 $list[] = $n;
743 $runAwayBrake--;
744 if ($runAwayBrake <= 0) {
745 break;
746 }
747 }
748 } else {
749 $list[] = $item;
750 }
751 }
752 return implode(',', $list);
753 }
754
755 /**
756 * Returns an integer from a three part version number, eg '4.12.3' -> 4012003
757 *
758 * @param string $verNumberStr Version number on format x.x.x
759 * @return integer Integer version of version number (where each part can count to 999)
760 * @deprecated Use VersionNumberUtility::convertVersionNumberToInteger instead, will be removed after 6.2
761 */
762 static public function int_from_ver($verNumberStr) {
763 self::logDeprecatedFunction();
764 return VersionNumberUtility::convertVersionNumberToInteger($verNumberStr);
765 }
766
767 /**
768 * Returns TRUE if the current TYPO3 version (or compatibility version) is compatible to the input version
769 * Notice that this function compares branches, not versions (4.0.1 would be > 4.0.0 although they use the same compat_version)
770 *
771 * @param string $verNumberStr Minimum branch number required (format x.y / e.g. "4.0" NOT "4.0.0"!)
772 * @return boolean Returns TRUE if this setup is compatible with the provided version number
773 * @todo Still needs a function to convert versions to branches
774 */
775 static public function compat_version($verNumberStr) {
776 $currVersionStr = $GLOBALS['TYPO3_CONF_VARS']['SYS']['compat_version'] ? $GLOBALS['TYPO3_CONF_VARS']['SYS']['compat_version'] : TYPO3_branch;
777 if (\TYPO3\CMS\Core\Utility\VersionNumberUtility::convertVersionNumberToInteger($currVersionStr) < \TYPO3\CMS\Core\Utility\VersionNumberUtility::convertVersionNumberToInteger($verNumberStr)) {
778 return FALSE;
779 } else {
780 return TRUE;
781 }
782 }
783
784 /**
785 * Makes a positive integer hash out of the first 7 chars from the md5 hash of the input
786 *
787 * @param string $str String to md5-hash
788 * @return integer Returns 28bit integer-hash
789 */
790 static public function md5int($str) {
791 return hexdec(substr(md5($str), 0, 7));
792 }
793
794 /**
795 * Returns the first 10 positions of the MD5-hash (changed from 6 to 10 recently)
796 *
797 * @param string $input Input string to be md5-hashed
798 * @param integer $len The string-length of the output
799 * @return string Substring of the resulting md5-hash, being $len chars long (from beginning)
800 */
801 static public function shortMD5($input, $len = 10) {
802 return substr(md5($input), 0, $len);
803 }
804
805 /**
806 * Returns a proper HMAC on a given input string and secret TYPO3 encryption key.
807 *
808 * @param string $input Input string to create HMAC from
809 * @param string $additionalSecret additionalSecret to prevent hmac beeing used in a different context
810 * @return string resulting (hexadecimal) HMAC currently with a length of 40 (HMAC-SHA-1)
811 */
812 static public function hmac($input, $additionalSecret = '') {
813 $hashAlgorithm = 'sha1';
814 $hashBlocksize = 64;
815 $hmac = '';
816 $secret = $GLOBALS['TYPO3_CONF_VARS']['SYS']['encryptionKey'] . $additionalSecret;
817 if (extension_loaded('hash') && function_exists('hash_hmac') && function_exists('hash_algos') && in_array($hashAlgorithm, hash_algos())) {
818 $hmac = hash_hmac($hashAlgorithm, $input, $secret);
819 } else {
820 // Outer padding
821 $opad = str_repeat(chr(92), $hashBlocksize);
822 // Inner padding
823 $ipad = str_repeat(chr(54), $hashBlocksize);
824 if (strlen($secret) > $hashBlocksize) {
825 // Keys longer than block size are shorten
826 $key = str_pad(pack('H*', call_user_func($hashAlgorithm, $secret)), $hashBlocksize, chr(0));
827 } else {
828 // Keys shorter than block size are zero-padded
829 $key = str_pad($secret, $hashBlocksize, chr(0));
830 }
831 $hmac = call_user_func($hashAlgorithm, ($key ^ $opad) . pack('H*', call_user_func($hashAlgorithm, (($key ^ $ipad) . $input))));
832 }
833 return $hmac;
834 }
835
836 /**
837 * Takes comma-separated lists and arrays and removes all duplicates
838 * If a value in the list is trim(empty), the value is ignored.
839 *
840 * @param string $in_list Accept multiple parameters which can be comma-separated lists of values and arrays.
841 * @param mixed $secondParameter Dummy field, which if set will show a warning!
842 * @return string Returns the list without any duplicates of values, space around values are trimmed
843 */
844 static public function uniqueList($in_list, $secondParameter = NULL) {
845 if (is_array($in_list)) {
846 throw new \InvalidArgumentException('TYPO3 Fatal Error: TYPO3\\CMS\\Core\\Utility\\GeneralUtility::uniqueList() does NOT support array arguments anymore! Only string comma lists!', 1270853885);
847 }
848 if (isset($secondParameter)) {
849 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);
850 }
851 return implode(',', array_unique(self::trimExplode(',', $in_list, TRUE)));
852 }
853
854 /**
855 * Splits a reference to a file in 5 parts
856 *
857 * @param string $fileref Filename/filepath to be analysed
858 * @return array Contains keys [path], [file], [filebody], [fileext], [realFileext]
859 */
860 static public function split_fileref($fileref) {
861 $reg = array();
862 if (preg_match('/(.*\\/)(.*)$/', $fileref, $reg)) {
863 $info['path'] = $reg[1];
864 $info['file'] = $reg[2];
865 } else {
866 $info['path'] = '';
867 $info['file'] = $fileref;
868 }
869 $reg = '';
870 if (!is_dir($fileref) && preg_match('/(.*)\\.([^\\.]*$)/', $info['file'], $reg)) {
871 $info['filebody'] = $reg[1];
872 $info['fileext'] = strtolower($reg[2]);
873 $info['realFileext'] = $reg[2];
874 } else {
875 $info['filebody'] = $info['file'];
876 $info['fileext'] = '';
877 }
878 reset($info);
879 return $info;
880 }
881
882 /**
883 * Returns the directory part of a path without trailing slash
884 * If there is no dir-part, then an empty string is returned.
885 * Behaviour:
886 *
887 * '/dir1/dir2/script.php' => '/dir1/dir2'
888 * '/dir1/' => '/dir1'
889 * 'dir1/script.php' => 'dir1'
890 * 'd/script.php' => 'd'
891 * '/script.php' => ''
892 * '' => ''
893 *
894 * @param string $path Directory name / path
895 * @return string Processed input value. See function description.
896 */
897 static public function dirname($path) {
898 $p = self::revExplode('/', $path, 2);
899 return count($p) == 2 ? $p[0] : '';
900 }
901
902 /**
903 * Modifies a HTML Hex color by adding/subtracting $R,$G and $B integers
904 *
905 * @param string $color A hexadecimal color code, #xxxxxx
906 * @param integer $R Offset value 0-255
907 * @param integer $G Offset value 0-255
908 * @param integer $B Offset value 0-255
909 * @return string A hexadecimal color code, #xxxxxx, modified according to input vars
910 * @see modifyHTMLColorAll()
911 */
912 static public function modifyHTMLColor($color, $R, $G, $B) {
913 // This takes a hex-color (# included!) and adds $R, $G and $B to the HTML-color (format: #xxxxxx) and returns the new color
914 $nR = \TYPO3\CMS\Core\Utility\MathUtility::forceIntegerInRange(hexdec(substr($color, 1, 2)) + $R, 0, 255);
915 $nG = \TYPO3\CMS\Core\Utility\MathUtility::forceIntegerInRange(hexdec(substr($color, 3, 2)) + $G, 0, 255);
916 $nB = \TYPO3\CMS\Core\Utility\MathUtility::forceIntegerInRange(hexdec(substr($color, 5, 2)) + $B, 0, 255);
917 return '#' . substr(('0' . dechex($nR)), -2) . substr(('0' . dechex($nG)), -2) . substr(('0' . dechex($nB)), -2);
918 }
919
920 /**
921 * Modifies a HTML Hex color by adding/subtracting $all integer from all R/G/B channels
922 *
923 * @param string $color A hexadecimal color code, #xxxxxx
924 * @param integer $all Offset value 0-255 for all three channels.
925 * @return string A hexadecimal color code, #xxxxxx, modified according to input vars
926 * @see modifyHTMLColor()
927 */
928 static public function modifyHTMLColorAll($color, $all) {
929 return self::modifyHTMLColor($color, $all, $all, $all);
930 }
931
932 /**
933 * Returns TRUE if the first part of $str matches the string $partStr
934 *
935 * @param string $str Full string to check
936 * @param string $partStr Reference string which must be found as the "first part" of the full string
937 * @return boolean TRUE if $partStr was found to be equal to the first part of $str
938 */
939 static public function isFirstPartOfStr($str, $partStr) {
940 return $partStr != '' && strpos((string) $str, (string) $partStr, 0) === 0;
941 }
942
943 /**
944 * Formats the input integer $sizeInBytes as bytes/kilobytes/megabytes (-/K/M)
945 *
946 * @param integer $sizeInBytes Number of bytes to format.
947 * @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)
948 * @return string Formatted representation of the byte number, for output.
949 */
950 static public function formatSize($sizeInBytes, $labels = '') {
951 // Set labels:
952 if (strlen($labels) == 0) {
953 $labels = ' | K| M| G';
954 } else {
955 $labels = str_replace('"', '', $labels);
956 }
957 $labelArr = explode('|', $labels);
958 // Find size:
959 if ($sizeInBytes > 900) {
960 // GB
961 if ($sizeInBytes > 900000000) {
962 $val = $sizeInBytes / (1024 * 1024 * 1024);
963 return number_format($val, ($val < 20 ? 1 : 0), '.', '') . $labelArr[3];
964 } elseif ($sizeInBytes > 900000) {
965 // MB
966 $val = $sizeInBytes / (1024 * 1024);
967 return number_format($val, ($val < 20 ? 1 : 0), '.', '') . $labelArr[2];
968 } else {
969 // KB
970 $val = $sizeInBytes / 1024;
971 return number_format($val, ($val < 20 ? 1 : 0), '.', '') . $labelArr[1];
972 }
973 } else {
974 // Bytes
975 return $sizeInBytes . $labelArr[0];
976 }
977 }
978
979 /**
980 * Returns microtime input to milliseconds
981 *
982 * @param string $microtime Microtime
983 * @return integer Microtime input string converted to an integer (milliseconds)
984 */
985 static public function convertMicrotime($microtime) {
986 $parts = explode(' ', $microtime);
987 return round(($parts[0] + $parts[1]) * 1000);
988 }
989
990 /**
991 * This splits a string by the chars in $operators (typical /+-*) and returns an array with them in
992 *
993 * @param string $string Input string, eg "123 + 456 / 789 - 4
994 * @param string $operators Operators to split by, typically "/+-*
995 * @return array Array with operators and operands separated.
996 * @see \TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::calc(), \TYPO3\CMS\Frontend\Imaging\GifBuilder::calcOffset()
997 */
998 static public function splitCalc($string, $operators) {
999 $res = array();
1000 $sign = '+';
1001 while ($string) {
1002 $valueLen = strcspn($string, $operators);
1003 $value = substr($string, 0, $valueLen);
1004 $res[] = array($sign, trim($value));
1005 $sign = substr($string, $valueLen, 1);
1006 $string = substr($string, $valueLen + 1);
1007 }
1008 reset($res);
1009 return $res;
1010 }
1011
1012 /**
1013 * Inverse version of htmlspecialchars()
1014 *
1015 * @param string $value Value where &gt;, &lt;, &quot; and &amp; should be converted to regular chars.
1016 * @return string Converted result.
1017 */
1018 static public function htmlspecialchars_decode($value) {
1019 return str_replace(
1020 array('&gt;', '&lt;', '&quot;', '&amp;'),
1021 array('>', '<', '"', '&'),
1022 $value
1023 );
1024
1025 }
1026
1027 /**
1028 * Re-converts HTML entities if they have been converted by htmlspecialchars()
1029 *
1030 * @param string $str String which contains eg. "&amp;amp;" which should stay "&amp;". Or "&amp;#1234;" to "&#1234;". Or "&amp;#x1b;" to "&#x1b;
1031 * @return string Converted result.
1032 */
1033 static public function deHSCentities($str) {
1034 return preg_replace('/&amp;([#[:alnum:]]*;)/', '&\\1', $str);
1035 }
1036
1037 /**
1038 * This function is used to escape any ' -characters when transferring text to JavaScript!
1039 *
1040 * @param string $string String to escape
1041 * @param boolean $extended If set, also backslashes are escaped.
1042 * @param string $char The character to escape, default is ' (single-quote)
1043 * @return string Processed input string
1044 */
1045 static public function slashJS($string, $extended = FALSE, $char = '\'') {
1046 if ($extended) {
1047 $string = str_replace('\\', '\\\\', $string);
1048 }
1049 return str_replace($char, '\\' . $char, $string);
1050 }
1051
1052 /**
1053 * Version of rawurlencode() where all spaces (%20) are re-converted to space-characters.
1054 * Useful when passing text to JavaScript where you simply url-encode it to get around problems with syntax-errors, linebreaks etc.
1055 *
1056 * @param string $str String to raw-url-encode with spaces preserved
1057 * @return string Rawurlencoded result of input string, but with all %20 (space chars) converted to real spaces.
1058 */
1059 static public function rawUrlEncodeJS($str) {
1060 return str_replace('%20', ' ', rawurlencode($str));
1061 }
1062
1063 /**
1064 * rawurlencode which preserves "/" chars
1065 * Useful when file paths should keep the "/" chars, but have all other special chars encoded.
1066 *
1067 * @param string $str Input string
1068 * @return string Output string
1069 */
1070 static public function rawUrlEncodeFP($str) {
1071 return str_replace('%2F', '/', rawurlencode($str));
1072 }
1073
1074 /**
1075 * Checking syntax of input email address
1076 *
1077 * http://tools.ietf.org/html/rfc3696
1078 * International characters are allowed in email. So the whole address needs
1079 * to be converted to punicode before passing it to filter_var(). We convert
1080 * the user- and domain part separately to increase the chance of hitting an
1081 * entry in self::$idnaStringCache.
1082 *
1083 * Also the @ sign may appear multiple times in an address. If not used as
1084 * a boundary marker between the user- and domain part, it must be escaped
1085 * with a backslash: \@. This mean we can not just explode on the @ sign and
1086 * expect to get just two parts. So we pop off the domain and then glue the
1087 * rest together again.
1088 *
1089 * @param string $email Input string to evaluate
1090 * @return boolean Returns TRUE if the $email address (input string) is valid
1091 */
1092 static public function validEmail($email) {
1093 // Early return in case input is not a string
1094 if (!is_string($email)) {
1095 return FALSE;
1096 }
1097 $atPosition = strrpos($email, '@');
1098 if (!$atPosition || $atPosition + 1 === strlen($email)) {
1099 // Return if no @ found or it is placed at the very beginning or end of the email
1100 return FALSE;
1101 }
1102 $domain = substr($email, $atPosition + 1);
1103 $user = substr($email, 0, $atPosition);
1104 if (!preg_match('/^[a-z0-9.\\-]*$/i', $domain)) {
1105 $domain = self::idnaEncode($domain);
1106 }
1107 return filter_var($user . '@' . $domain, FILTER_VALIDATE_EMAIL) !== FALSE;
1108 }
1109
1110 /**
1111 * Checks if current e-mail sending method does not accept recipient/sender name
1112 * in a call to PHP mail() function. Windows version of mail() and mini_sendmail
1113 * program are known not to process such input correctly and they cause SMTP
1114 * errors. This function will return TRUE if current mail sending method has
1115 * problem with recipient name in recipient/sender argument for mail().
1116 *
1117 * TODO: 4.3 should have additional configuration variable, which is combined
1118 * by || with the rest in this function.
1119 *
1120 * @return boolean TRUE if mail() does not accept recipient name
1121 */
1122 static public function isBrokenEmailEnvironment() {
1123 return TYPO3_OS == 'WIN' || FALSE !== strpos(ini_get('sendmail_path'), 'mini_sendmail');
1124 }
1125
1126 /**
1127 * Changes from/to arguments for mail() function to work in any environment.
1128 *
1129 * @param string $address Address to adjust
1130 * @return string Adjusted address
1131 */
1132 static public function normalizeMailAddress($address) {
1133 if (self::isBrokenEmailEnvironment() && FALSE !== ($pos1 = strrpos($address, '<'))) {
1134 $pos2 = strpos($address, '>', $pos1);
1135 $address = substr($address, $pos1 + 1, ($pos2 ? $pos2 : strlen($address)) - $pos1 - 1);
1136 }
1137 return $address;
1138 }
1139
1140 /**
1141 * Formats a string for output between <textarea>-tags
1142 * All content outputted in a textarea form should be passed through this function
1143 * 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!
1144 *
1145 * @param string $content Input string to be formatted.
1146 * @return string Formatted for <textarea>-tags
1147 */
1148 static public function formatForTextarea($content) {
1149 return LF . htmlspecialchars($content);
1150 }
1151
1152 /**
1153 * Converts string to uppercase
1154 * The function converts all Latin characters (a-z, but no accents, etc) to
1155 * uppercase. It is safe for all supported character sets (incl. utf-8).
1156 * Unlike strtoupper() it does not honour the locale.
1157 *
1158 * @param string $str Input string
1159 * @return string Uppercase String
1160 */
1161 static public function strtoupper($str) {
1162 return strtr((string) $str, 'abcdefghijklmnopqrstuvwxyz', 'ABCDEFGHIJKLMNOPQRSTUVWXYZ');
1163 }
1164
1165 /**
1166 * Converts string to lowercase
1167 * The function converts all Latin characters (A-Z, but no accents, etc) to
1168 * lowercase. It is safe for all supported character sets (incl. utf-8).
1169 * Unlike strtolower() it does not honour the locale.
1170 *
1171 * @param string $str Input string
1172 * @return string Lowercase String
1173 */
1174 static public function strtolower($str) {
1175 return strtr((string) $str, 'ABCDEFGHIJKLMNOPQRSTUVWXYZ', 'abcdefghijklmnopqrstuvwxyz');
1176 }
1177
1178 /**
1179 * Returns a string of highly randomized bytes (over the full 8-bit range).
1180 *
1181 * Note: Returned values are not guaranteed to be crypto-safe,
1182 * most likely they are not, depending on the used retrieval method.
1183 *
1184 * @param integer $bytesToReturn Number of characters (bytes) to return
1185 * @return string Random Bytes
1186 * @see http://bugs.php.net/bug.php?id=52523
1187 * @see http://www.php-security.org/2010/05/09/mops-submission-04-generating-unpredictable-session-ids-and-hashes/index.html
1188 */
1189 static public function generateRandomBytes($bytesToReturn) {
1190 // Cache 4k of the generated bytestream.
1191 static $bytes = '';
1192 $bytesToGenerate = max(4096, $bytesToReturn);
1193 // if we have not enough random bytes cached, we generate new ones
1194 if (!isset($bytes[($bytesToReturn - 1)])) {
1195 if (TYPO3_OS === 'WIN') {
1196 // Openssl seems to be deadly slow on Windows, so try to use mcrypt
1197 // Windows PHP versions have a bug when using urandom source (see #24410)
1198 $bytes .= self::generateRandomBytesMcrypt($bytesToGenerate, MCRYPT_RAND);
1199 } else {
1200 // Try to use native PHP functions first, precedence has openssl
1201 $bytes .= self::generateRandomBytesOpenSsl($bytesToGenerate);
1202 if (!isset($bytes[($bytesToReturn - 1)])) {
1203 $bytes .= self::generateRandomBytesMcrypt($bytesToGenerate, MCRYPT_DEV_URANDOM);
1204 }
1205 // If openssl and mcrypt failed, try /dev/urandom
1206 if (!isset($bytes[($bytesToReturn - 1)])) {
1207 $bytes .= self::generateRandomBytesUrandom($bytesToGenerate);
1208 }
1209 }
1210 // Fall back if other random byte generation failed until now
1211 if (!isset($bytes[($bytesToReturn - 1)])) {
1212 $bytes .= self::generateRandomBytesFallback($bytesToReturn);
1213 }
1214 }
1215 // get first $bytesToReturn and remove it from the byte cache
1216 $output = substr($bytes, 0, $bytesToReturn);
1217 $bytes = substr($bytes, $bytesToReturn);
1218 return $output;
1219 }
1220
1221 /**
1222 * Generate random bytes using openssl if available
1223 *
1224 * @param string $bytesToGenerate
1225 * @return string
1226 */
1227 static protected function generateRandomBytesOpenSsl($bytesToGenerate) {
1228 if (!function_exists('openssl_random_pseudo_bytes')) {
1229 return '';
1230 }
1231 $isStrong = NULL;
1232 return (string) openssl_random_pseudo_bytes($bytesToGenerate, $isStrong);
1233 }
1234
1235 /**
1236 * Generate random bytes using mcrypt if available
1237 *
1238 * @param $bytesToGenerate
1239 * @param $randomSource
1240 * @return string
1241 */
1242 static protected function generateRandomBytesMcrypt($bytesToGenerate, $randomSource) {
1243 if (!function_exists('mcrypt_create_iv')) {
1244 return '';
1245 }
1246 return (string) (@mcrypt_create_iv($bytesToGenerate, $randomSource));
1247 }
1248
1249 /**
1250 * Read random bytes from /dev/urandom if it is accessible
1251 *
1252 * @param $bytesToGenerate
1253 * @return string
1254 */
1255 static protected function generateRandomBytesUrandom($bytesToGenerate) {
1256 $bytes = '';
1257 $fh = @fopen('/dev/urandom', 'rb');
1258 if ($fh) {
1259 // PHP only performs buffered reads, so in reality it will always read
1260 // at least 4096 bytes. Thus, it costs nothing extra to read and store
1261 // that much so as to speed any additional invocations.
1262 $bytes = fread($fh, $bytesToGenerate);
1263 fclose($fh);
1264 }
1265 return $bytes;
1266 }
1267
1268 /**
1269 * Generate pseudo random bytes as last resort
1270 *
1271 * @param $bytesToReturn
1272 * @return string
1273 */
1274 static protected function generateRandomBytesFallback($bytesToReturn) {
1275 $bytes = '';
1276 // We initialize with somewhat random.
1277 $randomState = $GLOBALS['TYPO3_CONF_VARS']['SYS']['encryptionKey'] . base_convert(memory_get_usage() % pow(10, 6), 10, 2) . microtime() . uniqid('') . getmypid();
1278 while (!isset($bytes[($bytesToReturn - 1)])) {
1279 $randomState = sha1(microtime() . mt_rand() . $randomState);
1280 $bytes .= sha1(mt_rand() . $randomState, TRUE);
1281 }
1282 return $bytes;
1283 }
1284
1285 /**
1286 * Returns an ASCII string (punicode) representation of $value
1287 *
1288 * @param string $value
1289 * @return string An ASCII encoded (punicode) string
1290 */
1291 static public function idnaEncode($value) {
1292 if (isset(self::$idnaStringCache[$value])) {
1293 return self::$idnaStringCache[$value];
1294 } else {
1295 if (!self::$idnaConverter) {
1296 require_once PATH_typo3 . 'contrib/idna/idna_convert.class.php';
1297 self::$idnaConverter = new \idna_convert(array('idn_version' => 2008));
1298 }
1299 self::$idnaStringCache[$value] = self::$idnaConverter->encode($value);
1300 return self::$idnaStringCache[$value];
1301 }
1302 }
1303
1304 /**
1305 * Returns a hex representation of a random byte string.
1306 *
1307 * @param integer $count Number of hex characters to return
1308 * @return string Random Bytes
1309 */
1310 static public function getRandomHexString($count) {
1311 return substr(bin2hex(self::generateRandomBytes((int)(($count + 1) / 2))), 0, $count);
1312 }
1313
1314 /**
1315 * Returns a given string with underscores as UpperCamelCase.
1316 * Example: Converts blog_example to BlogExample
1317 *
1318 * @param string $string String to be converted to camel case
1319 * @return string UpperCamelCasedWord
1320 */
1321 static public function underscoredToUpperCamelCase($string) {
1322 $upperCamelCase = str_replace(' ', '', ucwords(str_replace('_', ' ', self::strtolower($string))));
1323 return $upperCamelCase;
1324 }
1325
1326 /**
1327 * Returns a given string with underscores as lowerCamelCase.
1328 * Example: Converts minimal_value to minimalValue
1329 *
1330 * @param string $string String to be converted to camel case
1331 * @return string lowerCamelCasedWord
1332 */
1333 static public function underscoredToLowerCamelCase($string) {
1334 $upperCamelCase = str_replace(' ', '', ucwords(str_replace('_', ' ', self::strtolower($string))));
1335 $lowerCamelCase = self::lcfirst($upperCamelCase);
1336 return $lowerCamelCase;
1337 }
1338
1339 /**
1340 * Returns a given CamelCasedString as an lowercase string with underscores.
1341 * Example: Converts BlogExample to blog_example, and minimalValue to minimal_value
1342 *
1343 * @param string $string String to be converted to lowercase underscore
1344 * @return string lowercase_and_underscored_string
1345 */
1346 static public function camelCaseToLowerCaseUnderscored($string) {
1347 return self::strtolower(preg_replace('/(?<=\\w)([A-Z])/', '_\\1', $string));
1348 }
1349
1350 /**
1351 * Converts the first char of a string to lowercase if it is a latin character (A-Z).
1352 * Example: Converts "Hello World" to "hello World"
1353 *
1354 * @param string $string The string to be used to lowercase the first character
1355 * @return string The string with the first character as lowercase
1356 */
1357 static public function lcfirst($string) {
1358 return self::strtolower(substr($string, 0, 1)) . substr($string, 1);
1359 }
1360
1361 /**
1362 * Checks if a given string is a Uniform Resource Locator (URL).
1363 *
1364 * On seriously malformed URLs, parse_url may return FALSE and emit an
1365 * E_WARNING.
1366 *
1367 * filter_var() requires a scheme to be present.
1368 *
1369 * http://www.faqs.org/rfcs/rfc2396.html
1370 * Scheme names consist of a sequence of characters beginning with a
1371 * lower case letter and followed by any combination of lower case letters,
1372 * digits, plus ("+"), period ("."), or hyphen ("-"). For resiliency,
1373 * programs interpreting URI should treat upper case letters as equivalent to
1374 * lower case in scheme names (e.g., allow "HTTP" as well as "http").
1375 * scheme = alpha *( alpha | digit | "+" | "-" | "." )
1376 *
1377 * Convert the domain part to punicode if it does not look like a regular
1378 * domain name. Only the domain part because RFC3986 specifies the the rest of
1379 * the url may not contain special characters:
1380 * http://tools.ietf.org/html/rfc3986#appendix-A
1381 *
1382 * @param string $url The URL to be validated
1383 * @return boolean Whether the given URL is valid
1384 */
1385 static public function isValidUrl($url) {
1386 $parsedUrl = parse_url($url);
1387 if (!$parsedUrl || !isset($parsedUrl['scheme'])) {
1388 return FALSE;
1389 }
1390 // HttpUtility::buildUrl() will always build urls with <scheme>://
1391 // our original $url might only contain <scheme>: (e.g. mail:)
1392 // so we convert that to the double-slashed version to ensure
1393 // our check against the $recomposedUrl is proper
1394 if (!self::isFirstPartOfStr($url, $parsedUrl['scheme'] . '://')) {
1395 $url = str_replace($parsedUrl['scheme'] . ':', $parsedUrl['scheme'] . '://', $url);
1396 }
1397 $recomposedUrl = HttpUtility::buildUrl($parsedUrl);
1398 if ($recomposedUrl !== $url) {
1399 // The parse_url() had to modify characters, so the URL is invalid
1400 return FALSE;
1401 }
1402 if (isset($parsedUrl['host']) && !preg_match('/^[a-z0-9.\\-]*$/i', $parsedUrl['host'])) {
1403 $parsedUrl['host'] = self::idnaEncode($parsedUrl['host']);
1404 }
1405 return filter_var(HttpUtility::buildUrl($parsedUrl), FILTER_VALIDATE_URL) !== FALSE;
1406 }
1407
1408 /*************************
1409 *
1410 * ARRAY FUNCTIONS
1411 *
1412 *************************/
1413 /**
1414 * Check if an string item exists in an array.
1415 * Please note that the order of function parameters is reverse compared to the PHP function in_array()!!!
1416 *
1417 * Comparison to PHP in_array():
1418 * -> $array = array(0, 1, 2, 3);
1419 * -> variant_a := \TYPO3\CMS\Core\Utility\GeneralUtility::inArray($array, $needle)
1420 * -> variant_b := in_array($needle, $array)
1421 * -> variant_c := in_array($needle, $array, TRUE)
1422 * +---------+-----------+-----------+-----------+
1423 * | $needle | variant_a | variant_b | variant_c |
1424 * +---------+-----------+-----------+-----------+
1425 * | '1a' | FALSE | TRUE | FALSE |
1426 * | '' | FALSE | TRUE | FALSE |
1427 * | '0' | TRUE | TRUE | FALSE |
1428 * | 0 | TRUE | TRUE | TRUE |
1429 * +---------+-----------+-----------+-----------+
1430 *
1431 * @param array $in_array One-dimensional array of items
1432 * @param string $item Item to check for
1433 * @return boolean TRUE if $item is in the one-dimensional array $in_array
1434 */
1435 static public function inArray(array $in_array, $item) {
1436 foreach ($in_array as $val) {
1437 if (!is_array($val) && (string)$val === (string)$item) {
1438 return TRUE;
1439 }
1440 }
1441 return FALSE;
1442 }
1443
1444 /**
1445 * Explodes a $string delimited by $delim and casts each item in the array to (int).
1446 * Corresponds to \TYPO3\CMS\Core\Utility\GeneralUtility::trimExplode(), but with conversion to integers for all values.
1447 *
1448 * @param string $delimiter Delimiter string to explode with
1449 * @param string $string The string to explode
1450 * @param boolean $removeEmptyValues If set, all empty values (='') will NOT be set in output
1451 * @param integer $limit If positive, the result will contain a maximum of limit elements,
1452 * @return array Exploded values, all converted to integers
1453 */
1454 static public function intExplode($delimiter, $string, $removeEmptyValues = FALSE, $limit = 0) {
1455 $result = explode($delimiter, $string);
1456 foreach ($result as $key => &$value) {
1457 if ($removeEmptyValues && ($value === '' || trim($value) === '')) {
1458 unset($result[$key]);
1459 } else {
1460 $value = (int)$value;
1461 }
1462 }
1463 unset($value);
1464 if ($limit !== 0) {
1465 if ($limit < 0) {
1466 $result = array_slice($result, 0, $limit);
1467 } elseif (count($result) > $limit) {
1468 $lastElements = array_slice($result, $limit - 1);
1469 $result = array_slice($result, 0, $limit - 1);
1470 $result[] = implode($delimiter, $lastElements);
1471 }
1472 }
1473 return $result;
1474 }
1475
1476 /**
1477 * Reverse explode which explodes the string counting from behind.
1478 * Thus \TYPO3\CMS\Core\Utility\GeneralUtility::revExplode(':','my:words:here',2) will return array('my:words','here')
1479 *
1480 * @param string $delimiter Delimiter string to explode with
1481 * @param string $string The string to explode
1482 * @param integer $count Number of array entries
1483 * @return array Exploded values
1484 */
1485 static public function revExplode($delimiter, $string, $count = 0) {
1486 $explodedValues = explode($delimiter, strrev($string), $count);
1487 $explodedValues = array_map('strrev', $explodedValues);
1488 return array_reverse($explodedValues);
1489 }
1490
1491 /**
1492 * Explodes a string and trims all values for whitespace in the ends.
1493 * If $onlyNonEmptyValues is set, then all blank ('') values are removed.
1494 *
1495 * @param string $delim Delimiter string to explode with
1496 * @param string $string The string to explode
1497 * @param boolean $removeEmptyValues If set, all empty values will be removed in output
1498 * @param integer $limit If positive, the result will contain a maximum of
1499 * @return array Exploded values
1500 */
1501 static public function trimExplode($delim, $string, $removeEmptyValues = FALSE, $limit = 0) {
1502 $explodedValues = explode($delim, $string);
1503 $result = array_map('trim', $explodedValues);
1504 if ($removeEmptyValues) {
1505 $temp = array();
1506 foreach ($result as $value) {
1507 if ($value !== '') {
1508 $temp[] = $value;
1509 }
1510 }
1511 $result = $temp;
1512 }
1513 if ($limit !== 0) {
1514 if ($limit < 0) {
1515 $result = array_slice($result, 0, $limit);
1516 } elseif (count($result) > $limit) {
1517 $lastElements = array_slice($result, $limit - 1);
1518 $result = array_slice($result, 0, $limit - 1);
1519 $result[] = implode($delim, $lastElements);
1520 }
1521 }
1522 return $result;
1523 }
1524
1525 /**
1526 * Removes the value $cmpValue from the $array if found there. Returns the modified array
1527 *
1528 * @param array $array Array containing the values
1529 * @param string $cmpValue Value to search for and if found remove array entry where found.
1530 * @return array Output array with entries removed if search string is found
1531 */
1532 static public function removeArrayEntryByValue(array $array, $cmpValue) {
1533 foreach ($array as $k => $v) {
1534 if (is_array($v)) {
1535 $array[$k] = self::removeArrayEntryByValue($v, $cmpValue);
1536 } elseif ((string)$v === (string)$cmpValue) {
1537 unset($array[$k]);
1538 }
1539 }
1540 return $array;
1541 }
1542
1543 /**
1544 * Filters an array to reduce its elements to match the condition.
1545 * The values in $keepItems can be optionally evaluated by a custom callback function.
1546 *
1547 * Example (arguments used to call this function):
1548 * $array = array(
1549 * array('aa' => array('first', 'second'),
1550 * array('bb' => array('third', 'fourth'),
1551 * array('cc' => array('fifth', 'sixth'),
1552 * );
1553 * $keepItems = array('third');
1554 * $getValueFunc = create_function('$value', 'return $value[0];');
1555 *
1556 * Returns:
1557 * array(
1558 * array('bb' => array('third', 'fourth'),
1559 * )
1560 *
1561 * @param array $array The initial array to be filtered/reduced
1562 * @param mixed $keepItems The items which are allowed/kept in the array - accepts array or csv string
1563 * @param string $getValueFunc (optional) Callback function used to get the value to keep
1564 * @return array The filtered/reduced array with the kept items
1565 */
1566 static public function keepItemsInArray(array $array, $keepItems, $getValueFunc = NULL) {
1567 if ($array) {
1568 // Convert strings to arrays:
1569 if (is_string($keepItems)) {
1570 $keepItems = self::trimExplode(',', $keepItems);
1571 }
1572 // Check if valueFunc can be executed:
1573 if (!is_callable($getValueFunc)) {
1574 $getValueFunc = NULL;
1575 }
1576 // Do the filtering:
1577 if (is_array($keepItems) && count($keepItems)) {
1578 foreach ($array as $key => $value) {
1579 // Get the value to compare by using the callback function:
1580 $keepValue = isset($getValueFunc) ? call_user_func($getValueFunc, $value) : $value;
1581 if (!in_array($keepValue, $keepItems)) {
1582 unset($array[$key]);
1583 }
1584 }
1585 }
1586 }
1587 return $array;
1588 }
1589
1590 /**
1591 * Implodes a multidim-array into GET-parameters (eg. &param[key][key2]=value2&param[key][key3]=value3)
1592 *
1593 * @param string $name Name prefix for entries. Set to blank if you wish none.
1594 * @param array $theArray The (multidimensional) array to implode
1595 * @param string $str (keep blank)
1596 * @param boolean $skipBlank If set, parameters which were blank strings would be removed.
1597 * @param boolean $rawurlencodeParamName If set, the param name itself (for example "param[key][key2]") would be rawurlencoded as well.
1598 * @return string Imploded result, fx. &param[key][key2]=value2&param[key][key3]=value3
1599 * @see explodeUrl2Array()
1600 */
1601 static public function implodeArrayForUrl($name, array $theArray, $str = '', $skipBlank = FALSE, $rawurlencodeParamName = FALSE) {
1602 foreach ($theArray as $Akey => $AVal) {
1603 $thisKeyName = $name ? $name . '[' . $Akey . ']' : $Akey;
1604 if (is_array($AVal)) {
1605 $str = self::implodeArrayForUrl($thisKeyName, $AVal, $str, $skipBlank, $rawurlencodeParamName);
1606 } else {
1607 if (!$skipBlank || (string)$AVal !== '') {
1608 $str .= '&' . ($rawurlencodeParamName ? rawurlencode($thisKeyName) : $thisKeyName) . '=' . rawurlencode($AVal);
1609 }
1610 }
1611 }
1612 return $str;
1613 }
1614
1615 /**
1616 * Explodes a string with GETvars (eg. "&id=1&type=2&ext[mykey]=3") into an array
1617 *
1618 * @param string $string GETvars string
1619 * @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())
1620 * @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!
1621 * @see implodeArrayForUrl()
1622 */
1623 static public function explodeUrl2Array($string, $multidim = FALSE) {
1624 $output = array();
1625 if ($multidim) {
1626 parse_str($string, $output);
1627 } else {
1628 $p = explode('&', $string);
1629 foreach ($p as $v) {
1630 if (strlen($v)) {
1631 list($pK, $pV) = explode('=', $v, 2);
1632 $output[rawurldecode($pK)] = rawurldecode($pV);
1633 }
1634 }
1635 }
1636 return $output;
1637 }
1638
1639 /**
1640 * Returns an array with selected keys from incoming data.
1641 * (Better read source code if you want to find out...)
1642 *
1643 * @param string $varList List of variable/key names
1644 * @param array $getArray Array from where to get values based on the keys in $varList
1645 * @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
1646 * @return array Output array with selected variables.
1647 */
1648 static public function compileSelectedGetVarsFromArray($varList, array $getArray, $GPvarAlt = TRUE) {
1649 $keys = self::trimExplode(',', $varList, TRUE);
1650 $outArr = array();
1651 foreach ($keys as $v) {
1652 if (isset($getArray[$v])) {
1653 $outArr[$v] = $getArray[$v];
1654 } elseif ($GPvarAlt) {
1655 $outArr[$v] = self::_GP($v);
1656 }
1657 }
1658 return $outArr;
1659 }
1660
1661 /**
1662 * AddSlash array
1663 * This function traverses a multidimensional array and adds slashes to the values.
1664 * NOTE that the input array is and argument by reference.!!
1665 * Twin-function to stripSlashesOnArray
1666 *
1667 * @param array $theArray Multidimensional input array, (REFERENCE!)
1668 * @return array
1669 */
1670 static public function addSlashesOnArray(array &$theArray) {
1671 foreach ($theArray as &$value) {
1672 if (is_array($value)) {
1673 self::addSlashesOnArray($value);
1674 } else {
1675 $value = addslashes($value);
1676 }
1677 }
1678 unset($value);
1679 reset($theArray);
1680 }
1681
1682 /**
1683 * StripSlash array
1684 * This function traverses a multidimensional array and strips slashes to the values.
1685 * NOTE that the input array is and argument by reference.!!
1686 * Twin-function to addSlashesOnArray
1687 *
1688 * @param array $theArray Multidimensional input array, (REFERENCE!)
1689 * @return array
1690 */
1691 static public function stripSlashesOnArray(array &$theArray) {
1692 foreach ($theArray as &$value) {
1693 if (is_array($value)) {
1694 self::stripSlashesOnArray($value);
1695 } else {
1696 $value = stripslashes($value);
1697 }
1698 }
1699 unset($value);
1700 reset($theArray);
1701 }
1702
1703 /**
1704 * Either slashes ($cmd=add) or strips ($cmd=strip) array $arr depending on $cmd
1705 *
1706 * @param array $arr Multidimensional input array
1707 * @param string $cmd "add" or "strip", depending on usage you wish.
1708 * @return array
1709 */
1710 static public function slashArray(array $arr, $cmd) {
1711 if ($cmd == 'strip') {
1712 self::stripSlashesOnArray($arr);
1713 }
1714 if ($cmd == 'add') {
1715 self::addSlashesOnArray($arr);
1716 }
1717 return $arr;
1718 }
1719
1720 /**
1721 * Rename Array keys with a given mapping table
1722 *
1723 * @param array $array Array by reference which should be remapped
1724 * @param array $mappingTable Array with remap information, array/$oldKey => $newKey)
1725 */
1726 static public function remapArrayKeys(&$array, $mappingTable) {
1727 if (is_array($mappingTable)) {
1728 foreach ($mappingTable as $old => $new) {
1729 if ($new && isset($array[$old])) {
1730 $array[$new] = $array[$old];
1731 unset($array[$old]);
1732 }
1733 }
1734 }
1735 }
1736
1737 /**
1738 * Merges two arrays recursively and "binary safe" (integer keys are
1739 * overridden as well), overruling similar values in the first array
1740 * ($arr0) with the values of the second array ($arr1)
1741 * In case of identical keys, ie. keeping the values of the second.
1742 *
1743 * @param array $arr0 First array
1744 * @param array $arr1 Second array, overruling the first array
1745 * @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.
1746 * @param boolean $includeEmptyValues If set, values from $arr1 will overrule if they are empty or zero. Default: TRUE
1747 * @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.
1748 * @return array Resulting array where $arr1 values has overruled $arr0 values
1749 * @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)
1750 */
1751 static public function array_merge_recursive_overrule(array $arr0, array $arr1, $notAddKeys = FALSE, $includeEmptyValues = TRUE, $enableUnsetFeature = TRUE) {
1752 self::logDeprecatedFunction();
1753 ArrayUtility::mergeRecursiveWithOverrule($arr0, $arr1, !$notAddKeys, $includeEmptyValues, $enableUnsetFeature);
1754 // Our local $arr0 has been modified now, so return it as result
1755 return $arr0;
1756 }
1757
1758 /**
1759 * 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.
1760 *
1761 * @param array $arr1 First array
1762 * @param array $arr2 Second array
1763 * @return array Merged result.
1764 */
1765 static public function array_merge(array $arr1, array $arr2) {
1766 return $arr2 + $arr1;
1767 }
1768
1769 /**
1770 * Filters keys off from first array that also exist in second array. Comparison is done by keys.
1771 * This method is a recursive version of php array_diff_assoc()
1772 *
1773 * @param array $array1 Source array
1774 * @param array $array2 Reduce source array by this array
1775 * @return array Source array reduced by keys also present in second array
1776 */
1777 static public function arrayDiffAssocRecursive(array $array1, array $array2) {
1778 $differenceArray = array();
1779 foreach ($array1 as $key => $value) {
1780 if (!array_key_exists($key, $array2)) {
1781 $differenceArray[$key] = $value;
1782 } elseif (is_array($value)) {
1783 if (is_array($array2[$key])) {
1784 $differenceArray[$key] = self::arrayDiffAssocRecursive($value, $array2[$key]);
1785 }
1786 }
1787 }
1788 return $differenceArray;
1789 }
1790
1791 /**
1792 * Takes a row and returns a CSV string of the values with $delim (default is ,) and $quote (default is ") as separator chars.
1793 *
1794 * @param array $row Input array of values
1795 * @param string $delim Delimited, default is comma
1796 * @param string $quote Quote-character to wrap around the values.
1797 * @return string A single line of CSV
1798 */
1799 static public function csvValues(array $row, $delim = ',', $quote = '"') {
1800 $out = array();
1801 foreach ($row as $value) {
1802 $out[] = str_replace($quote, $quote . $quote, $value);
1803 }
1804 $str = $quote . implode(($quote . $delim . $quote), $out) . $quote;
1805 return $str;
1806 }
1807
1808 /**
1809 * Removes dots "." from end of a key identifier of TypoScript styled array.
1810 * array('key.' => array('property.' => 'value')) --> array('key' => array('property' => 'value'))
1811 *
1812 * @param array $ts TypoScript configuration array
1813 * @return array TypoScript configuration array without dots at the end of all keys
1814 */
1815 static public function removeDotsFromTS(array $ts) {
1816 $out = array();
1817 foreach ($ts as $key => $value) {
1818 if (is_array($value)) {
1819 $key = rtrim($key, '.');
1820 $out[$key] = self::removeDotsFromTS($value);
1821 } else {
1822 $out[$key] = $value;
1823 }
1824 }
1825 return $out;
1826 }
1827
1828 /**
1829 * Sorts an array by key recursive - uses natural sort order (aAbB-zZ)
1830 *
1831 * @param array $array array to be sorted recursively, passed by reference
1832 * @return boolean TRUE if param is an array
1833 */
1834 static public function naturalKeySortRecursive(&$array) {
1835 if (!is_array($array)) {
1836 return FALSE;
1837 }
1838 uksort($array, 'strnatcasecmp');
1839 foreach ($array as $key => $value) {
1840 self::naturalKeySortRecursive($array[$key]);
1841 }
1842 return TRUE;
1843 }
1844
1845 /*************************
1846 *
1847 * HTML/XML PROCESSING
1848 *
1849 *************************/
1850 /**
1851 * Returns an array with all attributes of the input HTML tag as key/value pairs. Attributes are only lowercase a-z
1852 * $tag is either a whole tag (eg '<TAG OPTION ATTRIB=VALUE>') or the parameter list (ex ' OPTION ATTRIB=VALUE>')
1853 * If an attribute is empty, then the value for the key is empty. You can check if it existed with isset()
1854 *
1855 * @param string $tag HTML-tag string (or attributes only)
1856 * @return array Array with the attribute values.
1857 */
1858 static public function get_tag_attributes($tag) {
1859 $components = self::split_tag_attributes($tag);
1860 // Attribute name is stored here
1861 $name = '';
1862 $valuemode = FALSE;
1863 $attributes = array();
1864 foreach ($components as $key => $val) {
1865 // 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
1866 if ($val != '=') {
1867 if ($valuemode) {
1868 if ($name) {
1869 $attributes[$name] = $val;
1870 $name = '';
1871 }
1872 } else {
1873 if ($key = strtolower(preg_replace('/[^[:alnum:]_\\:\\-]/', '', $val))) {
1874 $attributes[$key] = '';
1875 $name = $key;
1876 }
1877 }
1878 $valuemode = FALSE;
1879 } else {
1880 $valuemode = TRUE;
1881 }
1882 }
1883 return $attributes;
1884 }
1885
1886 /**
1887 * Returns an array with the 'components' from an attribute list from an HTML tag. The result is normally analyzed by get_tag_attributes
1888 * Removes tag-name if found
1889 *
1890 * @param string $tag HTML-tag string (or attributes only)
1891 * @return array Array with the attribute values.
1892 */
1893 static public function split_tag_attributes($tag) {
1894 $tag_tmp = trim(preg_replace('/^<[^[:space:]]*/', '', trim($tag)));
1895 // Removes any > in the end of the string
1896 $tag_tmp = trim(rtrim($tag_tmp, '>'));
1897 $value = array();
1898 // Compared with empty string instead , 030102
1899 while ($tag_tmp !== '') {
1900 $firstChar = substr($tag_tmp, 0, 1);
1901 if ($firstChar === '"' || $firstChar === '\'') {
1902 $reg = explode($firstChar, $tag_tmp, 3);
1903 $value[] = $reg[1];
1904 $tag_tmp = trim($reg[2]);
1905 } elseif ($firstChar === '=') {
1906 $value[] = '=';
1907 // Removes = chars.
1908 $tag_tmp = trim(substr($tag_tmp, 1));
1909 } else {
1910 // There are '' around the value. We look for the next ' ' or '>'
1911 $reg = preg_split('/[[:space:]=]/', $tag_tmp, 2);
1912 $value[] = trim($reg[0]);
1913 $tag_tmp = trim(substr($tag_tmp, strlen($reg[0]), 1) . $reg[1]);
1914 }
1915 }
1916 reset($value);
1917 return $value;
1918 }
1919
1920 /**
1921 * Implodes attributes in the array $arr for an attribute list in eg. and HTML tag (with quotes)
1922 *
1923 * @param array $arr Array with attribute key/value pairs, eg. "bgcolor"=>"red", "border"=>0
1924 * @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!
1925 * @param boolean $dontOmitBlankAttribs If TRUE, don't check if values are blank. Default is to omit attributes with blank values.
1926 * @return string Imploded attributes, eg. 'bgcolor="red" border="0"'
1927 */
1928 static public function implodeAttributes(array $arr, $xhtmlSafe = FALSE, $dontOmitBlankAttribs = FALSE) {
1929 if ($xhtmlSafe) {
1930 $newArr = array();
1931 foreach ($arr as $p => $v) {
1932 if (!isset($newArr[strtolower($p)])) {
1933 $newArr[strtolower($p)] = htmlspecialchars($v);
1934 }
1935 }
1936 $arr = $newArr;
1937 }
1938 $list = array();
1939 foreach ($arr as $p => $v) {
1940 if ((string)$v !== '' || $dontOmitBlankAttribs) {
1941 $list[] = $p . '="' . $v . '"';
1942 }
1943 }
1944 return implode(' ', $list);
1945 }
1946
1947 /**
1948 * Wraps JavaScript code XHTML ready with <script>-tags
1949 * Automatic re-indenting of the JS code is done by using the first line as indent reference.
1950 * This is nice for indenting JS code with PHP code on the same level.
1951 *
1952 * @param string $string JavaScript code
1953 * @param boolean $linebreak Wrap script element in line breaks? Default is TRUE.
1954 * @return string The wrapped JS code, ready to put into a XHTML page
1955 */
1956 static public function wrapJS($string, $linebreak = TRUE) {
1957 if (trim($string)) {
1958 // <script wrapped in nl?
1959 $cr = $linebreak ? LF : '';
1960 // remove nl from the beginning
1961 $string = preg_replace('/^\\n+/', '', $string);
1962 // re-ident to one tab using the first line as reference
1963 $match = array();
1964 if (preg_match('/^(\\t+)/', $string, $match)) {
1965 $string = str_replace($match[1], TAB, $string);
1966 }
1967 $string = $cr . '<script type="text/javascript">
1968 /*<![CDATA[*/
1969 ' . $string . '
1970 /*]]>*/
1971 </script>' . $cr;
1972 }
1973 return trim($string);
1974 }
1975
1976 /**
1977 * Parses XML input into a PHP array with associative keys
1978 *
1979 * @param string $string XML data input
1980 * @param integer $depth Number of element levels to resolve the XML into an array. Any further structure will be set as XML.
1981 * @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.
1982 * @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
1983 */
1984 static public function xml2tree($string, $depth = 999) {
1985 $parser = xml_parser_create();
1986 $vals = array();
1987 $index = array();
1988 xml_parser_set_option($parser, XML_OPTION_CASE_FOLDING, 0);
1989 xml_parser_set_option($parser, XML_OPTION_SKIP_WHITE, 0);
1990 xml_parse_into_struct($parser, $string, $vals, $index);
1991 if (xml_get_error_code($parser)) {
1992 return 'Line ' . xml_get_current_line_number($parser) . ': ' . xml_error_string(xml_get_error_code($parser));
1993 }
1994 xml_parser_free($parser);
1995 $stack = array(array());
1996 $stacktop = 0;
1997 $startPoint = 0;
1998 $tagi = array();
1999 foreach ($vals as $key => $val) {
2000 $type = $val['type'];
2001 // open tag:
2002 if ($type == 'open' || $type == 'complete') {
2003 $stack[$stacktop++] = $tagi;
2004 if ($depth == $stacktop) {
2005 $startPoint = $key;
2006 }
2007 $tagi = array('tag' => $val['tag']);
2008 if (isset($val['attributes'])) {
2009 $tagi['attrs'] = $val['attributes'];
2010 }
2011 if (isset($val['value'])) {
2012 $tagi['values'][] = $val['value'];
2013 }
2014 }
2015 // finish tag:
2016 if ($type == 'complete' || $type == 'close') {
2017 $oldtagi = $tagi;
2018 $tagi = $stack[--$stacktop];
2019 $oldtag = $oldtagi['tag'];
2020 unset($oldtagi['tag']);
2021 if ($depth == $stacktop + 1) {
2022 if ($key - $startPoint > 0) {
2023 $partArray = array_slice($vals, $startPoint + 1, $key - $startPoint - 1);
2024 $oldtagi['XMLvalue'] = self::xmlRecompileFromStructValArray($partArray);
2025 } else {
2026 $oldtagi['XMLvalue'] = $oldtagi['values'][0];
2027 }
2028 }
2029 $tagi['ch'][$oldtag][] = $oldtagi;
2030 unset($oldtagi);
2031 }
2032 // cdata
2033 if ($type == 'cdata') {
2034 $tagi['values'][] = $val['value'];
2035 }
2036 }
2037 return $tagi['ch'];
2038 }
2039
2040 /**
2041 * Turns PHP array into XML. See array2xml()
2042 *
2043 * @param array $array The input PHP array with any kind of data; text, binary, integers. Not objects though.
2044 * @param string $docTag Alternative document tag. Default is "phparray".
2045 * @param array $options Options for the compilation. See array2xml() for description.
2046 * @param string $charset Forced charset to prologue
2047 * @return string An XML string made from the input content in the array.
2048 * @see xml2array(),array2xml()
2049 */
2050 static public function array2xml_cs(array $array, $docTag = 'phparray', array $options = array(), $charset = '') {
2051 // Set default charset unless explicitly specified
2052 $charset = $charset ?: 'utf-8';
2053 // Return XML:
2054 return '<?xml version="1.0" encoding="' . htmlspecialchars($charset) . '" standalone="yes" ?>' . LF . self::array2xml($array, '', 0, $docTag, 0, $options);
2055 }
2056
2057 /**
2058 * Deprecated to call directly (unless you are aware of using XML prologues)! Use "array2xml_cs" instead (which adds an XML-prologue)
2059 *
2060 * Converts a PHP array into an XML string.
2061 * The XML output is optimized for readability since associative keys are used as tag names.
2062 * 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.
2063 * Numeric keys are stored with the default tag name "numIndex" but can be overridden to other formats)
2064 * 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
2065 * 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.
2066 * 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!
2067 * 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...
2068 *
2069 * @param array $array The input PHP array with any kind of data; text, binary, integers. Not objects though.
2070 * @param string $NSprefix tag-prefix, eg. a namespace prefix like "T3:
2071 * @param integer $level Current recursion level. Don't change, stay at zero!
2072 * @param string $docTag Alternative document tag. Default is "phparray".
2073 * @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
2074 * @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')
2075 * @param array $stackData Stack data. Don't touch.
2076 * @return string An XML string made from the input content in the array.
2077 * @see xml2array()
2078 */
2079 static public function array2xml(array $array, $NSprefix = '', $level = 0, $docTag = 'phparray', $spaceInd = 0, array $options = array(), array $stackData = array()) {
2080 // 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
2081 $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);
2082 // Set indenting mode:
2083 $indentChar = $spaceInd ? ' ' : TAB;
2084 $indentN = $spaceInd > 0 ? $spaceInd : 1;
2085 $nl = $spaceInd >= 0 ? LF : '';
2086 // Init output variable:
2087 $output = '';
2088 // Traverse the input array
2089 foreach ($array as $k => $v) {
2090 $attr = '';
2091 $tagName = $k;
2092 // Construct the tag name.
2093 // Use tag based on grand-parent + parent tag name
2094 if (isset($options['grandParentTagMap'][$stackData['grandParentTagName'] . '/' . $stackData['parentTagName']])) {
2095 $attr .= ' index="' . htmlspecialchars($tagName) . '"';
2096 $tagName = (string) $options['grandParentTagMap'][($stackData['grandParentTagName'] . '/' . $stackData['parentTagName'])];
2097 } elseif (isset($options['parentTagMap'][$stackData['parentTagName'] . ':_IS_NUM']) && \TYPO3\CMS\Core\Utility\MathUtility::canBeInterpretedAsInteger($tagName)) {
2098 // Use tag based on parent tag name + if current tag is numeric
2099 $attr .= ' index="' . htmlspecialchars($tagName) . '"';
2100 $tagName = (string) $options['parentTagMap'][($stackData['parentTagName'] . ':_IS_NUM')];
2101 } elseif (isset($options['parentTagMap'][$stackData['parentTagName'] . ':' . $tagName])) {
2102 // Use tag based on parent tag name + current tag
2103 $attr .= ' index="' . htmlspecialchars($tagName) . '"';
2104 $tagName = (string) $options['parentTagMap'][($stackData['parentTagName'] . ':' . $tagName)];
2105 } elseif (isset($options['parentTagMap'][$stackData['parentTagName']])) {
2106 // Use tag based on parent tag name:
2107 $attr .= ' index="' . htmlspecialchars($tagName) . '"';
2108 $tagName = (string) $options['parentTagMap'][$stackData['parentTagName']];
2109 } elseif (MathUtility::canBeInterpretedAsInteger($tagName)) {
2110 // If integer...;
2111 if ($options['useNindex']) {
2112 // If numeric key, prefix "n"
2113 $tagName = 'n' . $tagName;
2114 } else {
2115 // Use special tag for num. keys:
2116 $attr .= ' index="' . $tagName . '"';
2117 $tagName = $options['useIndexTagForNum'] ?: 'numIndex';
2118 }
2119 } elseif ($options['useIndexTagForAssoc']) {
2120 // Use tag for all associative keys:
2121 $attr .= ' index="' . htmlspecialchars($tagName) . '"';
2122 $tagName = $options['useIndexTagForAssoc'];
2123 }
2124 // The tag name is cleaned up so only alphanumeric chars (plus - and _) are in there and not longer than 100 chars either.
2125 $tagName = substr(preg_replace('/[^[:alnum:]_-]/', '', $tagName), 0, 100);
2126 // If the value is an array then we will call this function recursively:
2127 if (is_array($v)) {
2128 // Sub elements:
2129 if ($options['alt_options'][$stackData['path'] . '/' . $tagName]) {
2130 $subOptions = $options['alt_options'][$stackData['path'] . '/' . $tagName];
2131 $clearStackPath = $subOptions['clearStackPath'];
2132 } else {
2133 $subOptions = $options;
2134 $clearStackPath = FALSE;
2135 }
2136 $content = $nl . self::array2xml($v, $NSprefix, ($level + 1), '', $spaceInd, $subOptions, array(
2137 'parentTagName' => $tagName,
2138 'grandParentTagName' => $stackData['parentTagName'],
2139 'path' => ($clearStackPath ? '' : $stackData['path'] . '/' . $tagName)
2140 )) . ($spaceInd >= 0 ? str_pad('', ($level + 1) * $indentN, $indentChar) : '');
2141 // Do not set "type = array". Makes prettier XML but means that empty arrays are not restored with xml2array
2142 if ((int)$options['disableTypeAttrib'] != 2) {
2143 $attr .= ' type="array"';
2144 }
2145 } else {
2146 // Just a value:
2147 // Look for binary chars:
2148 // Check for length, because PHP 5.2.0 may crash when first argument of strcspn is empty
2149 $vLen = strlen($v);
2150 // Go for base64 encoding if the initial segment NOT matching any binary char has the same length as the whole string!
2151 if ($vLen && strcspn($v, $binaryChars) != $vLen) {
2152 // If the value contained binary chars then we base64-encode it an set an attribute to notify this situation:
2153 $content = $nl . chunk_split(base64_encode($v));
2154 $attr .= ' base64="1"';
2155 } else {
2156 // Otherwise, just htmlspecialchar the stuff:
2157 $content = htmlspecialchars($v);
2158 $dType = gettype($v);
2159 if ($dType == 'string') {
2160 if ($options['useCDATA'] && $content != $v) {
2161 $content = '<![CDATA[' . $v . ']]>';
2162 }
2163 } elseif (!$options['disableTypeAttrib']) {
2164 $attr .= ' type="' . $dType . '"';
2165 }
2166 }
2167 }
2168 if ((string)$tagName !== '') {
2169 // Add the element to the output string:
2170 $output .= ($spaceInd >= 0 ? str_pad('', ($level + 1) * $indentN, $indentChar) : '')
2171 . '<' . $NSprefix . $tagName . $attr . '>' . $content . '</' . $NSprefix . $tagName . '>' . $nl;
2172 }
2173 }
2174 // If we are at the outer-most level, then we finally wrap it all in the document tags and return that as the value:
2175 if (!$level) {
2176 $output = '<' . $docTag . '>' . $nl . $output . '</' . $docTag . '>';
2177 }
2178 return $output;
2179 }
2180
2181 /**
2182 * Converts an XML string to a PHP array.
2183 * This is the reverse function of array2xml()
2184 * This is a wrapper for xml2arrayProcess that adds a two-level cache
2185 *
2186 * @param string $string XML content to convert into an array
2187 * @param string $NSprefix The tag-prefix resolve, eg. a namespace like "T3:
2188 * @param boolean $reportDocTag If set, the document tag will be set in the key "_DOCUMENT_TAG" of the output array
2189 * @return mixed If the parsing had errors, a string with the error message is returned. Otherwise an array with the content.
2190 * @see array2xml(),xml2arrayProcess()
2191 */
2192 static public function xml2array($string, $NSprefix = '', $reportDocTag = FALSE) {
2193 static $firstLevelCache = array();
2194 $identifier = md5($string . $NSprefix . ($reportDocTag ? '1' : '0'));
2195 // Look up in first level cache
2196 if (!empty($firstLevelCache[$identifier])) {
2197 $array = $firstLevelCache[$identifier];
2198 } else {
2199 // Look up in second level cache
2200 $array = \TYPO3\CMS\Frontend\Page\PageRepository::getHash($identifier, 0);
2201 if (!is_array($array)) {
2202 $array = self::xml2arrayProcess($string, $NSprefix, $reportDocTag);
2203 \TYPO3\CMS\Frontend\Page\PageRepository::storeHash($identifier, $array, 'ident_xml2array');
2204 }
2205 // Store content in first level cache
2206 $firstLevelCache[$identifier] = $array;
2207 }
2208 return $array;
2209 }
2210
2211 /**
2212 * Converts an XML string to a PHP array.
2213 * This is the reverse function of array2xml()
2214 *
2215 * @param string $string XML content to convert into an array
2216 * @param string $NSprefix The tag-prefix resolve, eg. a namespace like "T3:
2217 * @param boolean $reportDocTag If set, the document tag will be set in the key "_DOCUMENT_TAG" of the output array
2218 * @return mixed If the parsing had errors, a string with the error message is returned. Otherwise an array with the content.
2219 * @see array2xml()
2220 */
2221 static protected function xml2arrayProcess($string, $NSprefix = '', $reportDocTag = FALSE) {
2222 // Create parser:
2223 $parser = xml_parser_create();
2224 $vals = array();
2225 $index = array();
2226 xml_parser_set_option($parser, XML_OPTION_CASE_FOLDING, 0);
2227 xml_parser_set_option($parser, XML_OPTION_SKIP_WHITE, 0);
2228 // Default output charset is UTF-8, only ASCII, ISO-8859-1 and UTF-8 are supported!!!
2229 $match = array();
2230 preg_match('/^[[:space:]]*<\\?xml[^>]*encoding[[:space:]]*=[[:space:]]*"([^"]*)"/', substr($string, 0, 200), $match);
2231 $theCharset = $match[1] ?: 'utf-8';
2232 // us-ascii / utf-8 / iso-8859-1
2233 xml_parser_set_option($parser, XML_OPTION_TARGET_ENCODING, $theCharset);
2234 // Parse content:
2235 xml_parse_into_struct($parser, $string, $vals, $index);
2236 // If error, return error message:
2237 if (xml_get_error_code($parser)) {
2238 return 'Line ' . xml_get_current_line_number($parser) . ': ' . xml_error_string(xml_get_error_code($parser));
2239 }
2240 xml_parser_free($parser);
2241 // Init vars:
2242 $stack = array(array());
2243 $stacktop = 0;
2244 $current = array();
2245 $tagName = '';
2246 $documentTag = '';
2247 // Traverse the parsed XML structure:
2248 foreach ($vals as $key => $val) {
2249 // First, process the tag-name (which is used in both cases, whether "complete" or "close")
2250 $tagName = $val['tag'];
2251 if (!$documentTag) {
2252 $documentTag = $tagName;
2253 }
2254 // Test for name space:
2255 $tagName = $NSprefix && substr($tagName, 0, strlen($NSprefix)) == $NSprefix ? substr($tagName, strlen($NSprefix)) : $tagName;
2256 // Test for numeric tag, encoded on the form "nXXX":
2257 $testNtag = substr($tagName, 1);
2258 // Closing tag.
2259 $tagName = substr($tagName, 0, 1) == 'n' && MathUtility::canBeInterpretedAsInteger($testNtag) ? (int)$testNtag : $tagName;
2260 // Test for alternative index value:
2261 if (strlen($val['attributes']['index'])) {
2262 $tagName = $val['attributes']['index'];
2263 }
2264 // Setting tag-values, manage stack:
2265 switch ($val['type']) {
2266 case 'open':
2267 // If open tag it means there is an array stored in sub-elements. Therefore increase the stackpointer and reset the accumulation array:
2268 // Setting blank place holder
2269 $current[$tagName] = array();
2270 $stack[$stacktop++] = $current;
2271 $current = array();
2272 break;
2273 case 'close':
2274 // If the tag is "close" then it is an array which is closing and we decrease the stack pointer.
2275 $oldCurrent = $current;
2276 $current = $stack[--$stacktop];
2277 // Going to the end of array to get placeholder key, key($current), and fill in array next:
2278 end($current);
2279 $current[key($current)] = $oldCurrent;
2280 unset($oldCurrent);
2281 break;
2282 case 'complete':
2283 // If "complete", then it's a value. If the attribute "base64" is set, then decode the value, otherwise just set it.
2284 if ($val['attributes']['base64']) {
2285 $current[$tagName] = base64_decode($val['value']);
2286 } else {
2287 // Had to cast it as a string - otherwise it would be evaluate FALSE if tested with isset()!!
2288 $current[$tagName] = (string) $val['value'];
2289 // Cast type:
2290 switch ((string) $val['attributes']['type']) {
2291 case 'integer':
2292 $current[$tagName] = (int)$current[$tagName];
2293 break;
2294 case 'double':
2295 $current[$tagName] = (double) $current[$tagName];
2296 break;
2297 case 'boolean':
2298 $current[$tagName] = (bool) $current[$tagName];
2299 break;
2300 case 'array':
2301 // 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...
2302 $current[$tagName] = array();
2303 break;
2304 }
2305 }
2306 break;
2307 }
2308 }
2309 if ($reportDocTag) {
2310 $current[$tagName]['_DOCUMENT_TAG'] = $documentTag;
2311 }
2312 // Finally return the content of the document tag.
2313 return $current[$tagName];
2314 }
2315
2316 /**
2317 * This implodes an array of XML parts (made with xml_parse_into_struct()) into XML again.
2318 *
2319 * @param array $vals An array of XML parts, see xml2tree
2320 * @return string Re-compiled XML data.
2321 */
2322 static public function xmlRecompileFromStructValArray(array $vals) {
2323 $XMLcontent = '';
2324 foreach ($vals as $val) {
2325 $type = $val['type'];
2326 // Open tag:
2327 if ($type == 'open' || $type == 'complete') {
2328 $XMLcontent .= '<' . $val['tag'];
2329 if (isset($val['attributes'])) {
2330 foreach ($val['attributes'] as $k => $v) {
2331 $XMLcontent .= ' ' . $k . '="' . htmlspecialchars($v) . '"';
2332 }
2333 }
2334 if ($type == 'complete') {
2335 if (isset($val['value'])) {
2336 $XMLcontent .= '>' . htmlspecialchars($val['value']) . '</' . $val['tag'] . '>';
2337 } else {
2338 $XMLcontent .= '/>';
2339 }
2340 } else {
2341 $XMLcontent .= '>';
2342 }
2343 if ($type == 'open' && isset($val['value'])) {
2344 $XMLcontent .= htmlspecialchars($val['value']);
2345 }
2346 }
2347 // Finish tag:
2348 if ($type == 'close') {
2349 $XMLcontent .= '</' . $val['tag'] . '>';
2350 }
2351 // Cdata
2352 if ($type == 'cdata') {
2353 $XMLcontent .= htmlspecialchars($val['value']);
2354 }
2355 }
2356 return $XMLcontent;
2357 }
2358
2359 /**
2360 * Extracts the attributes (typically encoding and version) of an XML prologue (header).
2361 *
2362 * @param string $xmlData XML data
2363 * @return array Attributes of the xml prologue (header)
2364 */
2365 static public function xmlGetHeaderAttribs($xmlData) {
2366 $match = array();
2367 if (preg_match('/^\\s*<\\?xml([^>]*)\\?\\>/', $xmlData, $match)) {
2368 return self::get_tag_attributes($match[1]);
2369 }
2370 }
2371
2372 /**
2373 * Minifies JavaScript
2374 *
2375 * @param string $script Script to minify
2376 * @param string $error Error message (if any)
2377 * @return string Minified script or source string if error happened
2378 */
2379 static public function minifyJavaScript($script, &$error = '') {
2380 if (is_array($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['t3lib/class.t3lib_div.php']['minifyJavaScript'])) {
2381 $fakeThis = FALSE;
2382 foreach ($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['t3lib/class.t3lib_div.php']['minifyJavaScript'] as $hookMethod) {
2383 try {
2384 $parameters = array('script' => $script);
2385 $script = static::callUserFunction($hookMethod, $parameters, $fakeThis);
2386 } catch (\Exception $e) {
2387 $errorMessage = 'Error minifying java script: ' . $e->getMessage();
2388 $error .= $errorMessage;
2389 static::devLog($errorMessage, 'TYPO3\\CMS\\Core\\Utility\\GeneralUtility', 2, array(
2390 'JavaScript' => $script,
2391 'Stack trace' => $e->getTrace(),
2392 'hook' => $hookMethod
2393 ));
2394 }
2395 }
2396 }
2397 return $script;
2398 }
2399
2400 /*************************
2401 *
2402 * FILES FUNCTIONS
2403 *
2404 *************************/
2405 /**
2406 * Reads the file or url $url and returns the content
2407 * 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.
2408 *
2409 * @param string $url File/URL to read
2410 * @param integer $includeHeader Whether the HTTP header should be fetched or not. 0=disable, 1=fetch header+content, 2=fetch header only
2411 * @param array $requestHeaders HTTP headers to be used in the request
2412 * @param array $report Error code/message and, if $includeHeader is 1, response meta data (HTTP status and content type)
2413 * @return mixed The content from the resource given as input. FALSE if an error has occured.
2414 */
2415 static public function getUrl($url, $includeHeader = 0, $requestHeaders = FALSE, &$report = NULL) {
2416 $content = FALSE;
2417 if (isset($report)) {
2418 $report['error'] = 0;
2419 $report['message'] = '';
2420 }
2421 // Use cURL for: http, https, ftp, ftps, sftp and scp
2422 if ($GLOBALS['TYPO3_CONF_VARS']['SYS']['curlUse'] == '1' && preg_match('/^(?:http|ftp)s?|s(?:ftp|cp):/', $url)) {
2423 if (isset($report)) {
2424 $report['lib'] = 'cURL';
2425 }
2426 // External URL without error checking.
2427 if (!function_exists('curl_init') || !($ch = curl_init())) {
2428 if (isset($report)) {
2429 $report['error'] = -1;
2430 $report['message'] = 'Couldn\'t initialize cURL.';
2431 }
2432 return FALSE;
2433 }
2434 curl_setopt($ch, CURLOPT_URL, $url);
2435 curl_setopt($ch, CURLOPT_HEADER, $includeHeader ? 1 : 0);
2436 curl_setopt($ch, CURLOPT_NOBODY, $includeHeader == 2 ? 1 : 0);
2437 curl_setopt($ch, CURLOPT_HTTPGET, $includeHeader == 2 ? 'HEAD' : 'GET');
2438 curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
2439 curl_setopt($ch, CURLOPT_FAILONERROR, 1);
2440 curl_setopt($ch, CURLOPT_CONNECTTIMEOUT, max(0, (int)$GLOBALS['TYPO3_CONF_VARS']['SYS']['curlTimeout']));
2441 $followLocation = @curl_setopt($ch, CURLOPT_FOLLOWLOCATION, 1);
2442 if (is_array($requestHeaders)) {
2443 curl_setopt($ch, CURLOPT_HTTPHEADER, $requestHeaders);
2444 }
2445 // (Proxy support implemented by Arco <arco@appeltaart.mine.nu>)
2446 if ($GLOBALS['TYPO3_CONF_VARS']['SYS']['curlProxyServer']) {
2447 curl_setopt($ch, CURLOPT_PROXY, $GLOBALS['TYPO3_CONF_VARS']['SYS']['curlProxyServer']);
2448 if ($GLOBALS['TYPO3_CONF_VARS']['SYS']['curlProxyNTLM']) {
2449 curl_setopt($ch, CURLOPT_PROXYAUTH, CURLAUTH_NTLM);
2450 }
2451 if ($GLOBALS['TYPO3_CONF_VARS']['SYS']['curlProxyTunnel']) {
2452 curl_setopt($ch, CURLOPT_HTTPPROXYTUNNEL, $GLOBALS['TYPO3_CONF_VARS']['SYS']['curlProxyTunnel']);
2453 }
2454 if ($GLOBALS['TYPO3_CONF_VARS']['SYS']['curlProxyUserPass']) {
2455 curl_setopt($ch, CURLOPT_PROXYUSERPWD, $GLOBALS['TYPO3_CONF_VARS']['SYS']['curlProxyUserPass']);
2456 }
2457 }
2458 $content = curl_exec($ch);
2459 if (isset($report)) {
2460 if ($content === FALSE) {
2461 $report['error'] = curl_errno($ch);
2462 $report['message'] = curl_error($ch);
2463 } else {
2464 $curlInfo = curl_getinfo($ch);
2465 // We hit a redirection but we couldn't follow it
2466 if (!$followLocation && $curlInfo['status'] >= 300 && $curlInfo['status'] < 400) {
2467 $report['error'] = -1;
2468 $report['message'] = 'Couldn\'t follow location redirect (PHP configuration option open_basedir is in effect).';
2469 } elseif ($includeHeader) {
2470 // Set only for $includeHeader to work exactly like PHP variant
2471 $report['http_code'] = $curlInfo['http_code'];
2472 $report['content_type'] = $curlInfo['content_type'];
2473 }
2474 }
2475 }
2476 curl_close($ch);
2477 } elseif ($includeHeader) {
2478 if (isset($report)) {
2479 $report['lib'] = 'socket';
2480 }
2481 $parsedURL = parse_url($url);
2482 if (!preg_match('/^https?/', $parsedURL['scheme'])) {
2483 if (isset($report)) {
2484 $report['error'] = -1;
2485 $report['message'] = 'Reading headers is not allowed for this protocol.';
2486 }
2487 return FALSE;
2488 }
2489 $port = (int)$parsedURL['port'];
2490 if ($port < 1) {
2491 if ($parsedURL['scheme'] == 'http') {
2492 $port = $port > 0 ? $port : 80;
2493 $scheme = '';
2494 } else {
2495 $port = $port > 0 ? $port : 443;
2496 $scheme = 'ssl://';
2497 }
2498 }
2499 $errno = 0;
2500 $fp = @fsockopen(($scheme . $parsedURL['host']), $port, $errno, $errstr, 2.0);
2501 if (!$fp || $errno > 0) {
2502 if (isset($report)) {
2503 $report['error'] = $errno ?: -1;
2504 $report['message'] = $errno ? ($errstr ?: 'Socket error.') : 'Socket initialization error.';
2505 }
2506 return FALSE;
2507 }
2508 $method = $includeHeader == 2 ? 'HEAD' : 'GET';
2509 $msg = $method . ' ' . (isset($parsedURL['path']) ? $parsedURL['path'] : '/') . ($parsedURL['query'] ? '?' . $parsedURL['query'] : '') . ' HTTP/1.0' . CRLF . 'Host: ' . $parsedURL['host'] . '
2510
2511 Connection: close
2512
2513 ';
2514 if (is_array($requestHeaders)) {
2515 $msg .= implode(CRLF, $requestHeaders) . CRLF;
2516 }
2517 $msg .= CRLF;
2518 fputs($fp, $msg);
2519 while (!feof($fp)) {
2520 $line = fgets($fp, 2048);
2521 if (isset($report)) {
2522 if (preg_match('|^HTTP/\\d\\.\\d +(\\d+)|', $line, $status)) {
2523 $report['http_code'] = $status[1];
2524 } elseif (preg_match('/^Content-Type: *(.*)/i', $line, $type)) {
2525 $report['content_type'] = $type[1];
2526 }
2527 }
2528 $content .= $line;
2529 if (!strlen(trim($line))) {
2530 // Stop at the first empty line (= end of header)
2531 break;
2532 }
2533 }
2534 if ($includeHeader != 2) {
2535 $content .= stream_get_contents($fp);
2536 }
2537 fclose($fp);
2538 } elseif (is_array($requestHeaders)) {
2539 if (isset($report)) {
2540 $report['lib'] = 'file/context';
2541 }
2542 $parsedURL = parse_url($url);
2543 if (!preg_match('/^https?/', $parsedURL['scheme'])) {
2544 if (isset($report)) {
2545 $report['error'] = -1;
2546 $report['message'] = 'Sending request headers is not allowed for this protocol.';
2547 }
2548 return FALSE;
2549 }
2550 $ctx = stream_context_create(array(
2551 'http' => array(
2552 'header' => implode(CRLF, $requestHeaders)
2553 )
2554 ));
2555 $content = @file_get_contents($url, FALSE, $ctx);
2556 if ($content === FALSE && isset($report)) {
2557 $report['error'] = -1;
2558 $report['message'] = 'Couldn\'t get URL: ' . implode(LF, $http_response_header);
2559 }
2560 } else {
2561 if (isset($report)) {
2562 $report['lib'] = 'file';
2563 }
2564 $content = @file_get_contents($url);
2565 if ($content === FALSE && isset($report)) {
2566 $report['error'] = -1;
2567 $report['message'] = 'Couldn\'t get URL: ' . implode(LF, $http_response_header);
2568 }
2569 }
2570 return $content;
2571 }
2572
2573 /**
2574 * Writes $content to the file $file
2575 *
2576 * @param string $file Filepath to write to
2577 * @param string $content Content to write
2578 * @param boolean $changePermissions If TRUE, permissions are forced to be set
2579 * @return boolean TRUE if the file was successfully opened and written to.
2580 */
2581 static public function writeFile($file, $content, $changePermissions = FALSE) {
2582 if (!@is_file($file)) {
2583 $changePermissions = TRUE;
2584 }
2585 if ($fd = fopen($file, 'wb')) {
2586 $res = fwrite($fd, $content);
2587 fclose($fd);
2588 if ($res === FALSE) {
2589 return FALSE;
2590 }
2591 // Change the permissions only if the file has just been created
2592 if ($changePermissions) {
2593 self::fixPermissions($file);
2594 }
2595 return TRUE;
2596 }
2597 return FALSE;
2598 }
2599
2600 /**
2601 * Sets the file system mode and group ownership of a file or a folder.
2602 *
2603 * @param string $path Path of file or folder, must not be escaped. Path can be absolute or relative
2604 * @param boolean $recursive If set, also fixes permissions of files and folders in the folder (if $path is a folder)
2605 * @return mixed TRUE on success, FALSE on error, always TRUE on Windows OS
2606 */
2607 static public function fixPermissions($path, $recursive = FALSE) {
2608 if (TYPO3_OS != 'WIN') {
2609 $result = FALSE;
2610 // Make path absolute
2611 if (!self::isAbsPath($path)) {
2612 $path = self::getFileAbsFileName($path, FALSE);
2613 }
2614 if (self::isAllowedAbsPath($path)) {
2615 if (@is_file($path)) {
2616 $targetFilePermissions = isset($GLOBALS['TYPO3_CONF_VARS']['BE']['fileCreateMask'])
2617 ? octdec($GLOBALS['TYPO3_CONF_VARS']['BE']['fileCreateMask'])
2618 : octdec('0644');
2619 // "@" is there because file is not necessarily OWNED by the user
2620 $result = @chmod($path, $targetFilePermissions);
2621 } elseif (@is_dir($path)) {
2622 $targetDirectoryPermissions = isset($GLOBALS['TYPO3_CONF_VARS']['BE']['folderCreateMask'])
2623 ? octdec($GLOBALS['TYPO3_CONF_VARS']['BE']['folderCreateMask'])
2624 : octdec('0755');
2625 // "@" is there because file is not necessarily OWNED by the user
2626 $result = @chmod($path, $targetDirectoryPermissions);
2627 }
2628 // Set createGroup if not empty
2629 if (
2630 isset($GLOBALS['TYPO3_CONF_VARS']['BE']['createGroup'])
2631 && strlen($GLOBALS['TYPO3_CONF_VARS']['BE']['createGroup']) > 0
2632 ) {
2633 // "@" is there because file is not necessarily OWNED by the user
2634 $changeGroupResult = @chgrp($path, $GLOBALS['TYPO3_CONF_VARS']['BE']['createGroup']);
2635 $result = $changeGroupResult ? $result : FALSE;
2636 }
2637 // Call recursive if recursive flag if set and $path is directory
2638 if ($recursive && @is_dir($path)) {
2639 $handle = opendir($path);
2640 while (($file = readdir($handle)) !== FALSE) {
2641 $recursionResult = NULL;
2642 if ($file !== '.' && $file !== '..') {
2643 if (@is_file(($path . '/' . $file))) {
2644 $recursionResult = self::fixPermissions($path . '/' . $file);
2645 } elseif (@is_dir(($path . '/' . $file))) {
2646 $recursionResult = self::fixPermissions($path . '/' . $file, TRUE);
2647 }
2648 if (isset($recursionResult) && !$recursionResult) {
2649 $result = FALSE;
2650 }
2651 }
2652 }
2653 closedir($handle);
2654 }
2655 }
2656 } else {
2657 $result = TRUE;
2658 }
2659 return $result;
2660 }
2661
2662 /**
2663 * Writes $content to a filename in the typo3temp/ folder (and possibly one or two subfolders...)
2664 * Accepts an additional subdirectory in the file path!
2665 *
2666 * @param string $filepath Absolute file path to write to inside "typo3temp/". First part of this string must match PATH_site."typo3temp/
2667 * @param string $content Content string to write
2668 * @return string Returns NULL on success, otherwise an error string telling about the problem.
2669 */
2670 static public function writeFileToTypo3tempDir($filepath, $content) {
2671 // Parse filepath into directory and basename:
2672 $fI = pathinfo($filepath);
2673 $fI['dirname'] .= '/';
2674 // Check parts:
2675 if (self::validPathStr($filepath) && $fI['basename'] && strlen($fI['basename']) < 60) {
2676 if (defined('PATH_site')) {
2677 // Setting main temporary directory name (standard)
2678 $dirName = PATH_site . 'typo3temp/';
2679 if (@is_dir($dirName)) {
2680 if (self::isFirstPartOfStr($fI['dirname'], $dirName)) {
2681 // Checking if the "subdir" is found:
2682 $subdir = substr($fI['dirname'], strlen($dirName));
2683 if ($subdir) {
2684 if (preg_match('/^[[:alnum:]_]+\\/$/', $subdir) || preg_match('/^[[:alnum:]_]+\\/[[:alnum:]_]+\\/$/', $subdir)) {
2685 $dirName .= $subdir;
2686 if (!@is_dir($dirName)) {
2687 self::mkdir_deep(PATH_site . 'typo3temp/', $subdir);
2688 }
2689 } else {
2690 return 'Subdir, "' . $subdir . '", was NOT on the form "[[:alnum:]_]/" or "[[:alnum:]_]/[[:alnum:]_]/"';
2691 }
2692 }
2693 // Checking dir-name again (sub-dir might have been created):
2694 if (@is_dir($dirName)) {
2695 if ($filepath == $dirName . $fI['basename']) {
2696 self::writeFile($filepath, $content);
2697 if (!@is_file($filepath)) {
2698 return 'The file was not written to the disk. Please, check that you have write permissions to the typo3temp/ directory.';
2699 }
2700 } else {
2701 return 'Calculated filelocation didn\'t match input $filepath!';
2702 }
2703 } else {
2704 return '"' . $dirName . '" is not a directory!';
2705 }
2706 } else {
2707 return '"' . $fI['dirname'] . '" was not within directory PATH_site + "typo3temp/"';
2708 }
2709 } else {
2710 return 'PATH_site + "typo3temp/" was not a directory!';
2711 }
2712 } else {
2713 return 'PATH_site constant was NOT defined!';
2714 }
2715 } else {
2716 return 'Input filepath "' . $filepath . '" was generally invalid!';
2717 }
2718 }
2719
2720 /**
2721 * Wrapper function for mkdir.
2722 * Sets folder permissions according to $GLOBALS['TYPO3_CONF_VARS']['BE']['folderCreateMask']
2723 * and group ownership according to $GLOBALS['TYPO3_CONF_VARS']['BE']['createGroup']
2724 *
2725 * @param string $newFolder Absolute path to folder, see PHP mkdir() function. Removes trailing slash internally.
2726 * @return boolean TRUE if @mkdir went well!
2727 */
2728 static public function mkdir($newFolder) {
2729 $result = @mkdir($newFolder, octdec($GLOBALS['TYPO3_CONF_VARS']['BE']['folderCreateMask']));
2730 if ($result) {
2731 self::fixPermissions($newFolder);
2732 }
2733 return $result;
2734 }
2735
2736 /**
2737 * Creates a directory - including parent directories if necessary and
2738 * sets permissions on newly created directories.
2739 *
2740 * @param string $directory Target directory to create. Must a have trailing slash
2741 * @param string $deepDirectory Directory to create. This second parameter
2742 * @return void
2743 * @throws \InvalidArgumentException If $directory or $deepDirectory are not strings
2744 * @throws \RuntimeException If directory could not be created
2745 */
2746 static public function mkdir_deep($directory, $deepDirectory = '') {
2747 if (!is_string($directory)) {
2748 throw new \InvalidArgumentException('The specified directory is of type "' . gettype($directory) . '" but a string is expected.', 1303662955);
2749 }
2750 if (!is_string($deepDirectory)) {
2751 throw new \InvalidArgumentException('The specified directory is of type "' . gettype($deepDirectory) . '" but a string is expected.', 1303662956);
2752 }
2753 $fullPath = $directory . $deepDirectory;
2754 if (!is_dir($fullPath) && strlen($fullPath) > 0) {
2755 $firstCreatedPath = self::createDirectoryPath($fullPath);
2756 if ($firstCreatedPath !== '') {
2757 self::fixPermissions($firstCreatedPath, TRUE);
2758 }
2759 }
2760 }
2761
2762 /**
2763 * Creates directories for the specified paths if they do not exist. This
2764 * functions sets proper permission mask but does not set proper user and
2765 * group.
2766 *
2767 * @static
2768 * @param string $fullDirectoryPath
2769 * @return string Path to the the first created directory in the hierarchy
2770 * @see \TYPO3\CMS\Core\Utility\GeneralUtility::mkdir_deep
2771 * @throws \RuntimeException If directory could not be created
2772 */
2773 static protected function createDirectoryPath($fullDirectoryPath) {
2774 $currentPath = $fullDirectoryPath;
2775 $firstCreatedPath = '';
2776 $permissionMask = octdec($GLOBALS['TYPO3_CONF_VARS']['BE']['folderCreateMask']);
2777 if (!@is_dir($currentPath)) {
2778 do {
2779 $firstCreatedPath = $currentPath;
2780 $separatorPosition = strrpos($currentPath, DIRECTORY_SEPARATOR);
2781 $currentPath = substr($currentPath, 0, $separatorPosition);
2782 } while (!is_dir($currentPath) && $separatorPosition !== FALSE);
2783 $result = @mkdir($fullDirectoryPath, $permissionMask, TRUE);
2784 if (!$result) {
2785 throw new \RuntimeException('Could not create directory "' . $fullDirectoryPath . '"!', 1170251400);
2786 }
2787 }
2788 return $firstCreatedPath;
2789 }
2790
2791 /**
2792 * Wrapper function for rmdir, allowing recursive deletion of folders and files
2793 *
2794 * @param string $path Absolute path to folder, see PHP rmdir() function. Removes trailing slash internally.
2795 * @param boolean $removeNonEmpty Allow deletion of non-empty directories
2796 * @return boolean TRUE if @rmdir went well!
2797 */
2798 static public function rmdir($path, $removeNonEmpty = FALSE) {
2799 $OK = FALSE;
2800 // Remove trailing slash
2801 $path = preg_replace('|/$|', '', $path);
2802 if (file_exists($path)) {
2803 $OK = TRUE;
2804 if (!is_link($path) && is_dir($path)) {
2805 if ($removeNonEmpty == TRUE && ($handle = opendir($path))) {
2806 while ($OK && FALSE !== ($file = readdir($handle))) {
2807 if ($file == '.' || $file == '..') {
2808 continue;
2809 }
2810 $OK = self::rmdir($path . '/' . $file, $removeNonEmpty);
2811 }
2812 closedir($handle);
2813 }
2814 if ($OK) {
2815 $OK = @rmdir($path);
2816 }
2817 } else {
2818 // If $path is a file, simply remove it
2819 $OK = unlink($path);
2820 }
2821 clearstatcache();
2822 } elseif (is_link($path)) {
2823 $OK = unlink($path);
2824 clearstatcache();
2825 }
2826 return $OK;
2827 }
2828
2829 /**
2830 * Flushes a directory by first moving to a temporary resource, and then
2831 * triggering the remove process. This way directories can be flushed faster
2832 * to prevent race conditions on concurrent processes accessing the same directory.
2833 *
2834 * @param string $directory The directory to be renamed and flushed
2835 * @return boolean Whether the action was successful
2836 */
2837 static public function flushDirectory($directory) {
2838 $result = FALSE;
2839
2840 if (is_dir($directory)) {
2841 $temporaryDirectory = rtrim($directory, '/') . '.' . uniqid('remove') . '/';
2842 if (rename($directory, $temporaryDirectory)) {
2843 clearstatcache();
2844 $result = self::rmdir($temporaryDirectory, TRUE);
2845 }
2846 }
2847
2848 return $result;
2849 }
2850
2851 /**
2852 * Returns an array with the names of folders in a specific path
2853 * Will return 'error' (string) if there were an error with reading directory content.
2854 *
2855 * @param string $path Path to list directories from
2856 * @return array Returns an array with the directory entries as values. If no path, the return value is nothing.
2857 */
2858 static public function get_dirs($path) {
2859 if ($path) {
2860 if (is_dir($path)) {
2861 $dir = scandir($path);
2862 $dirs = array();
2863 foreach ($dir as $entry) {
2864 if (is_dir($path . '/' . $entry) && $entry != '..' && $entry != '.') {
2865 $dirs[] = $entry;
2866 }
2867 }
2868 } else {
2869 $dirs = 'error';
2870 }
2871 }
2872 return $dirs;
2873 }
2874
2875 /**
2876 * Returns an array with the names of files in a specific path
2877 *
2878 * @param string $path Is the path to the file
2879 * @param string $extensionList is the comma list of extensions to read only (blank = all)
2880 * @param boolean $prependPath If set, then the path is prepended the file names. Otherwise only the file names are returned in the array
2881 * @param string $order is sorting: 1= sort alphabetically, 'mtime' = sort by modification time.
2882 * @param string $excludePattern A comma separated list of file names to exclude, no wildcards
2883 * @return array Array of the files found
2884 */
2885 static public function getFilesInDir($path, $extensionList = '', $prependPath = FALSE, $order = '', $excludePattern = '') {
2886 // Initialize variables:
2887 $filearray = array();
2888 $sortarray = array();
2889 $path = rtrim($path, '/');
2890 // Find files+directories:
2891 if (@is_dir($path)) {
2892 $extensionList = strtolower($extensionList);
2893 $d = dir($path);
2894 if (is_object($d)) {
2895 while ($entry = $d->read()) {
2896 if (@is_file(($path . '/' . $entry))) {
2897 $fI = pathinfo($entry);
2898 // Don't change this ever - extensions may depend on the fact that the hash is an md5 of the path! (import/export extension)
2899 $key = md5($path . '/' . $entry);
2900 if ((!strlen($extensionList) || self::inList($extensionList, strtolower($fI['extension']))) && (!strlen($excludePattern) || !preg_match(('/^' . $excludePattern . '$/'), $entry))) {
2901 $filearray[$key] = ($prependPath ? $path . '/' : '') . $entry;
2902 if ($order == 'mtime') {
2903 $sortarray[$key] = filemtime($path . '/' . $entry);
2904 } elseif ($order) {
2905 $sortarray[$key] = strtolower($entry);
2906 }
2907 }
2908 }
2909 }
2910 $d->close();
2911 } else {
2912 return 'error opening path: "' . $path . '"';
2913 }
2914 }
2915 // Sort them:
2916 if ($order) {
2917 asort($sortarray);
2918 $newArr = array();
2919 foreach ($sortarray as $k => $v) {
2920 $newArr[$k] = $filearray[$k];
2921 }
2922 $filearray = $newArr;
2923 }
2924 // Return result
2925 reset($filearray);