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