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