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