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