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