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