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