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