-
Notifications
You must be signed in to change notification settings - Fork 639
/
GeneralUtility.php
3194 lines (3044 loc) · 140 KB
/
GeneralUtility.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<?php
declare(strict_types=1);
/*
* This file is part of the TYPO3 CMS project.
*
* It is free software; you can redistribute it and/or modify it under
* the terms of the GNU General Public License, either version 2
* of the License, or any later version.
*
* For the full copyright and license information, please read the
* LICENSE.txt file that was distributed with this source code.
*
* The TYPO3 project - inspiring people to share!
*/
namespace TYPO3\CMS\Core\Utility;
use Egulias\EmailValidator\EmailValidator;
use Egulias\EmailValidator\Validation\EmailValidation;
use Egulias\EmailValidator\Validation\MultipleValidationWithAnd;
use Egulias\EmailValidator\Validation\RFCValidation;
use GuzzleHttp\Exception\RequestException;
use Psr\Container\ContainerInterface;
use Psr\Http\Message\ServerRequestInterface;
use Psr\Log\LoggerAwareInterface;
use Psr\Log\LoggerInterface;
use TYPO3\CMS\Core\Authentication\AbstractAuthenticationService;
use TYPO3\CMS\Core\Cache\CacheManager;
use TYPO3\CMS\Core\Core\ClassLoadingInformation;
use TYPO3\CMS\Core\Core\Environment;
use TYPO3\CMS\Core\Http\ApplicationType;
use TYPO3\CMS\Core\Http\RequestFactory;
use TYPO3\CMS\Core\Log\LogManager;
use TYPO3\CMS\Core\Package\Exception as PackageException;
use TYPO3\CMS\Core\SingletonInterface;
/**
* The legendary "t3lib_div" class - Miscellaneous functions for general purpose.
* Most of the functions do not relate specifically to TYPO3
* However a section of functions requires certain TYPO3 features available
* See comments in the source.
* You are encouraged to use this library in your own scripts!
*
* USE:
* All methods in this class are meant to be called statically.
* So use \TYPO3\CMS\Core\Utility\GeneralUtility::[method-name] to refer to the functions, eg. '\TYPO3\CMS\Core\Utility\GeneralUtility::milliseconds()'
*/
class GeneralUtility
{
protected static ?ContainerInterface $container = null;
/**
* Singleton instances returned by `makeInstance`, using the class names as array keys
*
* @var array<class-string, SingletonInterface>
*/
protected static array $singletonInstances = [];
/**
* Instances returned by `makeInstance`, using the class names as array keys
*
* @var array<class-string, array<int, object>>
*/
protected static array $nonSingletonInstances = [];
/**
* Cache for `makeInstance` with given class name and final class names to reduce number of
* `self::getClassName()` calls
*
* @var array<class-string, class-string> Given class name => final class name
*/
protected static array $finalClassNameCache = [];
/**
* @var array<string, string|bool|array<string, string|bool|null>|null>
*/
protected static array $indpEnvCache = [];
final private function __construct()
{
}
/**
* Truncates a string with appended/prepended "..." and takes current character set into consideration.
*
* @param string $string String to truncate
* @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.
* @param string $appendString Appendix to the truncated string
* @return string Cropped string
*/
public static function fixed_lgd_cs(string $string, int $chars, string $appendString = '...'): string
{
if ($chars === 0 || mb_strlen($string, 'utf-8') <= abs($chars)) {
return $string;
}
if ($chars > 0) {
$string = mb_substr($string, 0, $chars, 'utf-8') . $appendString;
} else {
$string = $appendString . mb_substr($string, $chars, mb_strlen($string, 'utf-8'), 'utf-8');
}
return $string;
}
/**
* Match IP number with list of numbers with wildcard
* Dispatcher method for switching into specialised IPv4 and IPv6 methods.
*
* @param string $baseIP Is the current remote IP address for instance, typ. REMOTE_ADDR
* @param string $list Is a comma-list of IP-addresses to match with. CIDR-notation should be used. For IPv4 addresses only, the *-wildcard is also 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.
* @return bool TRUE if an IP-mask from $list matches $baseIP
*/
public static function cmpIP(string $baseIP, string $list): bool
{
$list = trim($list);
if ($list === '') {
return false;
}
if ($list === '*') {
return true;
}
if (str_contains($baseIP, ':') && self::validIPv6($baseIP)) {
return self::cmpIPv6($baseIP, $list);
}
return self::cmpIPv4($baseIP, $list);
}
/**
* Match IPv4 number with list of numbers with wildcard
*
* @param string $baseIP Is the current remote IP address for instance, typ. REMOTE_ADDR
* @param string $list Is a comma-list of IP-addresses to match with. CIDR-notation, *-wildcard allowed instead of number, plus leaving out parts in the IP number is accepted as wildcard (eg. 192.168.0.0/16 equals 192.168.*.* equals 192.168), could also contain IPv6 addresses
* @return bool TRUE if an IP-mask from $list matches $baseIP
*/
public static function cmpIPv4(string $baseIP, string $list): bool
{
$IPpartsReq = explode('.', $baseIP);
if (count($IPpartsReq) === 4) {
$values = self::trimExplode(',', $list, true);
foreach ($values as $test) {
$testList = explode('/', $test);
if (count($testList) === 2) {
[$test, $mask] = $testList;
} else {
$mask = false;
}
if ((int)$mask) {
$mask = (int)$mask;
// "192.168.3.0/24"
$lnet = (int)ip2long($test);
$lip = (int)ip2long($baseIP);
$binnet = str_pad(decbin($lnet), 32, '0', STR_PAD_LEFT);
$firstpart = substr($binnet, 0, $mask);
$binip = str_pad(decbin($lip), 32, '0', STR_PAD_LEFT);
$firstip = substr($binip, 0, $mask);
$yes = $firstpart === $firstip;
} else {
// "192.168.*.*"
$IPparts = explode('.', $test);
$yes = 1;
foreach ($IPparts as $index => $val) {
$val = trim($val);
if ($val !== '*' && $IPpartsReq[$index] !== $val) {
$yes = 0;
}
}
}
if ($yes) {
return true;
}
}
}
return false;
}
/**
* Match IPv6 address with a list of IPv6 prefixes
*
* @param string $baseIP Is the current remote IP address for instance
* @param string $list Is a comma-list of IPv6 prefixes, could also contain IPv4 addresses. IPv6 addresses
* must be specified in CIDR-notation, not with * wildcard, otherwise self::validIPv6() will fail.
* @return bool TRUE If a baseIP matches any prefix
*/
public static function cmpIPv6(string $baseIP, string $list): bool
{
// Policy default: Deny connection
$success = false;
$baseIP = self::normalizeIPv6($baseIP);
$values = self::trimExplode(',', $list, true);
foreach ($values as $test) {
$testList = explode('/', $test);
if (count($testList) === 2) {
[$test, $mask] = $testList;
} else {
$mask = false;
}
if (self::validIPv6($test)) {
$test = self::normalizeIPv6($test);
$maskInt = (int)$mask ?: 128;
// Special case; /0 is an allowed mask - equals a wildcard
if ($mask === '0') {
$success = true;
} elseif ($maskInt == 128) {
$success = $test === $baseIP;
} else {
$testBin = (string)inet_pton($test);
$baseIPBin = (string)inet_pton($baseIP);
$success = true;
// Modulo is 0 if this is a 8-bit-boundary
$maskIntModulo = $maskInt % 8;
$numFullCharactersUntilBoundary = (int)($maskInt / 8);
$substring = (string)substr($baseIPBin, 0, $numFullCharactersUntilBoundary);
if (!str_starts_with($testBin, $substring)) {
$success = false;
} elseif ($maskIntModulo > 0) {
// If not an 8-bit-boundary, check bits of last character
$testLastBits = str_pad(decbin(ord(substr($testBin, $numFullCharactersUntilBoundary, 1))), 8, '0', STR_PAD_LEFT);
$baseIPLastBits = str_pad(decbin(ord(substr($baseIPBin, $numFullCharactersUntilBoundary, 1))), 8, '0', STR_PAD_LEFT);
if (strncmp($testLastBits, $baseIPLastBits, $maskIntModulo) != 0) {
$success = false;
}
}
}
}
if ($success) {
return true;
}
}
return false;
}
/**
* Normalize an IPv6 address to full length
*
* @param string $address Given IPv6 address
* @return string Normalized address
*/
public static function normalizeIPv6(string $address): string
{
$normalizedAddress = '';
// According to RFC lowercase-representation is recommended
$address = strtolower($address);
// Normalized representation has 39 characters (0000:0000:0000:0000:0000:0000:0000:0000)
if (strlen($address) === 39) {
// Already in full expanded form
return $address;
}
// Count 2 if if address has hidden zero blocks
$chunks = explode('::', $address);
if (count($chunks) === 2) {
$chunksLeft = explode(':', $chunks[0]);
$chunksRight = explode(':', $chunks[1]);
$left = count($chunksLeft);
$right = count($chunksRight);
// Special case: leading zero-only blocks count to 1, should be 0
if ($left === 1 && strlen($chunksLeft[0]) === 0) {
$left = 0;
}
$hiddenBlocks = 8 - ($left + $right);
$hiddenPart = '';
$h = 0;
while ($h < $hiddenBlocks) {
$hiddenPart .= '0000:';
$h++;
}
if ($left === 0) {
$stageOneAddress = $hiddenPart . $chunks[1];
} else {
$stageOneAddress = $chunks[0] . ':' . $hiddenPart . $chunks[1];
}
} else {
$stageOneAddress = $address;
}
// Normalize the blocks:
$blocks = explode(':', $stageOneAddress);
$divCounter = 0;
foreach ($blocks as $block) {
$tmpBlock = '';
$i = 0;
$hiddenZeros = 4 - strlen($block);
while ($i < $hiddenZeros) {
$tmpBlock .= '0';
$i++;
}
$normalizedAddress .= $tmpBlock . $block;
if ($divCounter < 7) {
$normalizedAddress .= ':';
$divCounter++;
}
}
return $normalizedAddress;
}
/**
* Validate a given IP address.
*
* Possible format are IPv4 and IPv6.
*
* @param string $ip IP address to be tested
* @return bool TRUE if $ip is either of IPv4 or IPv6 format.
*/
public static function validIP(string $ip): bool
{
return filter_var($ip, FILTER_VALIDATE_IP) !== false;
}
/**
* Validate a given IP address to the IPv4 address format.
*
* Example for possible format: 10.0.45.99
*
* @param string $ip IP address to be tested
* @return bool TRUE if $ip is of IPv4 format.
*/
public static function validIPv4(string $ip): bool
{
return filter_var($ip, FILTER_VALIDATE_IP, FILTER_FLAG_IPV4) !== false;
}
/**
* Validate a given IP address to the IPv6 address format.
*
* Example for possible format: 43FB::BB3F:A0A0:0 | ::1
*
* @param string $ip IP address to be tested
* @return bool TRUE if $ip is of IPv6 format.
*/
public static function validIPv6(string $ip): bool
{
return filter_var($ip, FILTER_VALIDATE_IP, FILTER_FLAG_IPV6) !== false;
}
/**
* Match fully qualified domain name with list of strings with wildcard
*
* @param string $baseHost A hostname or an IPv4/IPv6-address (will by reverse-resolved; typically REMOTE_ADDR)
* @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)
* @return bool TRUE if a domain name mask from $list matches $baseIP
*/
public static function cmpFQDN(string $baseHost, string $list): bool
{
$baseHost = trim($baseHost);
if (empty($baseHost)) {
return false;
}
if (self::validIPv4($baseHost) || self::validIPv6($baseHost)) {
// Resolve hostname
// Note: this is reverse-lookup and can be randomly set as soon as somebody is able to set
// the reverse-DNS for his IP (security when for example used with REMOTE_ADDR)
$baseHostName = (string)gethostbyaddr($baseHost);
if ($baseHostName === $baseHost) {
// Unable to resolve hostname
return false;
}
} else {
$baseHostName = $baseHost;
}
$baseHostNameParts = explode('.', $baseHostName);
$values = self::trimExplode(',', $list, true);
foreach ($values as $test) {
$hostNameParts = explode('.', $test);
// To match hostNameParts can only be shorter (in case of wildcards) or equal
$hostNamePartsCount = count($hostNameParts);
$baseHostNamePartsCount = count($baseHostNameParts);
if ($hostNamePartsCount > $baseHostNamePartsCount) {
continue;
}
$yes = true;
foreach ($hostNameParts as $index => $val) {
$val = trim($val);
if ($val === '*') {
// Wildcard valid for one or more hostname-parts
$wildcardStart = $index + 1;
// Wildcard as last/only part always matches, otherwise perform recursive checks
if ($wildcardStart < $hostNamePartsCount) {
$wildcardMatched = false;
$tempHostName = implode('.', array_slice($hostNameParts, $index + 1));
while ($wildcardStart < $baseHostNamePartsCount && !$wildcardMatched) {
$tempBaseHostName = implode('.', array_slice($baseHostNameParts, $wildcardStart));
$wildcardMatched = self::cmpFQDN($tempBaseHostName, $tempHostName);
$wildcardStart++;
}
if ($wildcardMatched) {
// Match found by recursive compare
return true;
}
$yes = false;
}
} elseif ($baseHostNameParts[$index] !== $val) {
// In case of no match
$yes = false;
}
}
if ($yes) {
return true;
}
}
return false;
}
/**
* Checks if a given URL matches the host that currently handles this HTTP request.
* Scheme, hostname and (optional) port of the given URL are compared.
*
* @param string $url URL to compare with the TYPO3 request host
* @return bool Whether the URL matches the TYPO3 request host
*/
public static function isOnCurrentHost(string $url): bool
{
return stripos($url . '/', self::getIndpEnv('TYPO3_REQUEST_HOST') . '/') === 0;
}
/**
* Check for item in list
* Check if an item exists in a comma-separated list of items.
*
* @param string $list Comma-separated list of items (string)
* @param string $item Item to check for
* @return bool TRUE if $item is in $list
*/
public static function inList($list, $item)
{
return str_contains(',' . $list . ',', ',' . $item . ',');
}
/**
* Expand a comma-separated list of integers with ranges (eg 1,3-5,7 becomes 1,3,4,5,7).
* Ranges are limited to 1000 values per range.
*
* @param string $list Comma-separated list of integers with ranges (string)
* @return string New comma-separated list of items
*/
public static function expandList($list)
{
$items = explode(',', $list);
$list = [];
foreach ($items as $item) {
$range = explode('-', $item);
if (isset($range[1])) {
$runAwayBrake = 1000;
for ($n = $range[0]; $n <= $range[1]; $n++) {
$list[] = $n;
$runAwayBrake--;
if ($runAwayBrake <= 0) {
break;
}
}
} else {
$list[] = $item;
}
}
return implode(',', $list);
}
/**
* Makes a positive integer hash out of the first 7 chars from the md5 hash of the input
*
* @param string $str String to md5-hash
* @return int Returns 28bit integer-hash
*/
public static function md5int($str)
{
return hexdec(substr(md5($str), 0, 7));
}
/**
* Returns a proper HMAC on a given input string and secret TYPO3 encryption key.
*
* @param string $input Input string to create HMAC from
* @param string $additionalSecret additionalSecret to prevent hmac being used in a different context
* @return string resulting (hexadecimal) HMAC currently with a length of 40 (HMAC-SHA-1)
*/
public static function hmac($input, $additionalSecret = '')
{
$hashAlgorithm = 'sha1';
$secret = $GLOBALS['TYPO3_CONF_VARS']['SYS']['encryptionKey'] . $additionalSecret;
return hash_hmac($hashAlgorithm, $input, $secret);
}
/**
* Splits a reference to a file in 5 parts
*
* @param string $fileNameWithPath File name with path to be analyzed (must exist if open_basedir is set)
* @return array<string, string> Contains keys [path], [file], [filebody], [fileext], [realFileext]
*/
public static function split_fileref($fileNameWithPath)
{
$info = [];
$reg = [];
if (preg_match('/(.*\\/)(.*)$/', $fileNameWithPath, $reg)) {
$info['path'] = $reg[1];
$info['file'] = $reg[2];
} else {
$info['path'] = '';
$info['file'] = $fileNameWithPath;
}
$reg = '';
// If open_basedir is set and the fileName was supplied without a path the is_dir check fails
if (!is_dir($fileNameWithPath) && preg_match('/(.*)\\.([^\\.]*$)/', $info['file'], $reg)) {
$info['filebody'] = $reg[1];
$info['fileext'] = strtolower($reg[2]);
$info['realFileext'] = $reg[2];
} else {
$info['filebody'] = $info['file'];
$info['fileext'] = '';
}
reset($info);
return $info;
}
/**
* Returns the directory part of a path without trailing slash
* If there is no dir-part, then an empty string is returned.
* Behaviour:
*
* '/dir1/dir2/script.php' => '/dir1/dir2'
* '/dir1/' => '/dir1'
* 'dir1/script.php' => 'dir1'
* 'd/script.php' => 'd'
* '/script.php' => ''
* '' => ''
*
* @param string $path Directory name / path
* @return string Processed input value. See function description.
*/
public static function dirname($path)
{
$p = self::revExplode('/', $path, 2);
return count($p) === 2 ? $p[0] : '';
}
/**
* Formats the input integer $sizeInBytes as bytes/kilobytes/megabytes (-/K/M)
*
* @param int $sizeInBytes Number of bytes to format.
* @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".
* @param int $base The unit base if not using a unit name. Defaults to 1024.
* @return string Formatted representation of the byte number, for output.
*/
public static function formatSize($sizeInBytes, $labels = '', $base = 0)
{
$defaultFormats = [
'iec' => ['base' => 1024, 'labels' => [' ', ' Ki', ' Mi', ' Gi', ' Ti', ' Pi', ' Ei', ' Zi', ' Yi']],
'si' => ['base' => 1000, 'labels' => [' ', ' k', ' M', ' G', ' T', ' P', ' E', ' Z', ' Y']],
];
// Set labels and base:
if (empty($labels)) {
$labels = 'iec';
}
if (isset($defaultFormats[$labels])) {
$base = $defaultFormats[$labels]['base'];
$labelArr = $defaultFormats[$labels]['labels'];
} else {
$base = (int)$base;
if ($base !== 1000 && $base !== 1024) {
$base = 1024;
}
$labelArr = explode('|', str_replace('"', '', $labels));
}
// This is set via Site Handling and in the Locales class via setlocale()
// LC_NUMERIC is not set because of side effects when calculating with floats
// see @\TYPO3\CMS\Core\Localization\Locales::setLocale
$currentLocale = setlocale(LC_MONETARY, '0');
$oldLocale = setlocale(LC_NUMERIC, '0');
setlocale(LC_NUMERIC, $currentLocale);
$localeInfo = localeconv();
setlocale(LC_NUMERIC, $oldLocale);
$sizeInBytes = max($sizeInBytes, 0);
$multiplier = floor(($sizeInBytes ? log($sizeInBytes) : 0) / log($base));
$sizeInUnits = $sizeInBytes / $base ** $multiplier;
if ($sizeInUnits > ($base * .9)) {
$multiplier++;
}
$multiplier = min($multiplier, count($labelArr) - 1);
$sizeInUnits = $sizeInBytes / $base ** $multiplier;
return number_format($sizeInUnits, (($multiplier > 0) && ($sizeInUnits < 20)) ? 2 : 0, $localeInfo['decimal_point'], '') . $labelArr[$multiplier];
}
/**
* This splits a string by the chars in $operators (typical /+-*) and returns an array with them in
*
* @param string $string Input string, eg "123 + 456 / 789 - 4
* @param string $operators Operators to split by, typically "/+-*
* @return array<int, array<int, string>> Array with operators and operands separated.
* @see \TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::calc()
* @see \TYPO3\CMS\Frontend\Imaging\GifBuilder::calcOffset()
*/
public static function splitCalc($string, $operators)
{
$res = [];
$sign = '+';
while ($string) {
$valueLen = strcspn($string, $operators);
$value = substr($string, 0, $valueLen);
$res[] = [$sign, trim($value)];
$sign = substr($string, $valueLen, 1);
$string = substr($string, $valueLen + 1);
}
reset($res);
return $res;
}
/**
* Checking syntax of input email address
*
* @param string $email Input string to evaluate
* @return bool Returns TRUE if the $email address (input string) is valid
*/
public static function validEmail(string $email): bool
{
if (trim($email) !== $email) {
return false;
}
if (!str_contains($email, '@')) {
return false;
}
$validators = [];
foreach ($GLOBALS['TYPO3_CONF_VARS']['MAIL']['validators'] ?? [RFCValidation::class] as $className) {
$validator = new $className();
if ($validator instanceof EmailValidation) {
$validators[] = $validator;
}
}
return (new EmailValidator())->isValid($email, new MultipleValidationWithAnd($validators, MultipleValidationWithAnd::STOP_ON_ERROR));
}
/**
* Returns a given string with underscores as UpperCamelCase.
* Example: Converts blog_example to BlogExample
*
* @param string $string String to be converted to camel case
* @return string UpperCamelCasedWord
*/
public static function underscoredToUpperCamelCase($string)
{
return str_replace(' ', '', ucwords(str_replace('_', ' ', strtolower($string))));
}
/**
* Returns a given string with underscores as lowerCamelCase.
* Example: Converts minimal_value to minimalValue
*
* @param string $string String to be converted to camel case
* @return string lowerCamelCasedWord
*/
public static function underscoredToLowerCamelCase($string)
{
return lcfirst(str_replace(' ', '', ucwords(str_replace('_', ' ', strtolower($string)))));
}
/**
* Returns a given CamelCasedString as a lowercase string with underscores.
* Example: Converts BlogExample to blog_example, and minimalValue to minimal_value
*
* @param string $string String to be converted to lowercase underscore
* @return string lowercase_and_underscored_string
*/
public static function camelCaseToLowerCaseUnderscored($string)
{
$value = preg_replace('/(?<=\\w)([A-Z])/', '_\\1', $string) ?? '';
return mb_strtolower($value, 'utf-8');
}
/**
* Checks if a given string is a Uniform Resource Locator (URL).
*
* On seriously malformed URLs, parse_url may return FALSE and emit an
* E_WARNING.
*
* filter_var() requires a scheme to be present.
*
* http://www.faqs.org/rfcs/rfc2396.html
* Scheme names consist of a sequence of characters beginning with a
* lower case letter and followed by any combination of lower case letters,
* digits, plus ("+"), period ("."), or hyphen ("-"). For resiliency,
* programs interpreting URI should treat upper case letters as equivalent to
* lower case in scheme names (e.g., allow "HTTP" as well as "http").
* scheme = alpha *( alpha | digit | "+" | "-" | "." )
*
* Convert the domain part to punicode if it does not look like a regular
* domain name. Only the domain part because RFC3986 specifies the the rest of
* the url may not contain special characters:
* https://tools.ietf.org/html/rfc3986#appendix-A
*
* @param string $url The URL to be validated
* @return bool Whether the given URL is valid
*/
public static function isValidUrl(string $url): bool
{
$parsedUrl = parse_url($url);
if (!$parsedUrl || !isset($parsedUrl['scheme'])) {
return false;
}
// HttpUtility::buildUrl() will always build urls with <scheme>://
// our original $url might only contain <scheme>: (e.g. mail:)
// so we convert that to the double-slashed version to ensure
// our check against the $recomposedUrl is proper
if (!str_starts_with($url, $parsedUrl['scheme'] . '://')) {
$url = str_replace($parsedUrl['scheme'] . ':', $parsedUrl['scheme'] . '://', $url);
}
$recomposedUrl = HttpUtility::buildUrl($parsedUrl);
if ($recomposedUrl !== $url) {
// The parse_url() had to modify characters, so the URL is invalid
return false;
}
if (isset($parsedUrl['host']) && !preg_match('/^[a-z0-9.\\-]*$/i', $parsedUrl['host'])) {
$host = idn_to_ascii($parsedUrl['host']);
if ($host === false) {
return false;
}
$parsedUrl['host'] = $host;
}
return filter_var(HttpUtility::buildUrl($parsedUrl), FILTER_VALIDATE_URL) !== false;
}
/*************************
*
* ARRAY FUNCTIONS
*
*************************/
/**
* Explodes a $string delimited by $delimiter and casts each item in the array to (int).
* Corresponds to \TYPO3\CMS\Core\Utility\GeneralUtility::trimExplode(), but with conversion to integers for all values.
*
* @param string $delimiter Delimiter string to explode with
* @param string $string The string to explode
* @param bool $removeEmptyValues If set, all empty values (='') will NOT be set in output
* @return array<int, int> Exploded values, all converted to integers
*/
public static function intExplode(string $delimiter, string $string, bool $removeEmptyValues = false): array
{
$result = explode($delimiter, $string);
foreach ($result as $key => &$value) {
if ($removeEmptyValues && trim($value) === '') {
unset($result[$key]);
} else {
$value = (int)$value;
}
}
unset($value);
// @todo: refactor this method to first remove empty values using `array_filter`,
// and then `array_walk` with `intval` on the result
/** @var array<int, int> $result */
return $result;
}
/**
* Reverse explode which explodes the string counting from behind.
*
* Note: The delimiter has to given in the reverse order as
* it is occurring within the string.
*
* GeneralUtility::revExplode('[]', '[my][words][here]', 2)
* ==> array('[my][words', 'here]')
*
* @param string $delimiter Delimiter string to explode with
* @param string $string The string to explode
* @param int $limit Number of array entries
*
* @return list<string> Exploded values
*/
public static function revExplode(string $delimiter, string $string, int $limit = 0): array
{
// 2 is the (currently, as of 2014-02) most-used value for `$limit` in the core, therefore we check it first
if ($limit === 2) {
$position = strrpos($string, strrev($delimiter));
if ($position !== false) {
return [substr($string, 0, $position), substr($string, $position + strlen($delimiter))];
}
return [$string];
}
if ($limit <= 1) {
return [$string];
}
$explodedValues = explode($delimiter, strrev($string), $limit);
$explodedValues = array_map(strrev(...), $explodedValues);
return array_reverse($explodedValues);
}
/**
* Explodes a string and removes whitespace-only values.
*
* If $removeEmptyValues is set, then all values that contain only whitespace are removed.
*
* Each item will have leading and trailing whitespace removed. However, if the tail items are
* returned as a single array item, their internal whitespace will not be modified.
*
* @param string $delim Delimiter string to explode with
* @param string $string The string to explode
* @param bool $removeEmptyValues If set, all empty values will be removed in output
* @param int $limit If limit is set and positive, the returned array will contain a maximum of limit elements with
* the last element containing the rest of string. If the limit parameter is negative, all components
* except the last -limit are returned.
* @return list<string> Exploded values
* @phpstan-return ($removeEmptyValues is true ? list<non-empty-string> : list<string>) Exploded values
*/
public static function trimExplode(string $delim, string $string, bool $removeEmptyValues = false, int $limit = 0): array
{
$result = explode($delim, $string);
if ($removeEmptyValues) {
// Remove items that are just whitespace, but leave whitespace intact for the rest.
$result = array_values(array_filter($result, static fn (string $item): bool => trim($item) !== ''));
}
if ($limit === 0) {
// Return everything.
return array_map(trim(...), $result);
}
if ($limit < 0) {
// Trim and return just the first $limit elements and ignore the rest.
return array_map(trim(...), array_slice($result, 0, $limit));
}
// Fold the last length - $limit elements into a single trailing item, then trim and return the result.
$tail = array_slice($result, $limit - 1);
$result = array_slice($result, 0, $limit - 1);
if ($tail) {
$result[] = implode($delim, $tail);
}
return array_map(trim(...), $result);
}
/**
* Implodes a multidim-array into GET-parameters (eg. ¶m[key][key2]=value2¶m[key][key3]=value3)
*
* @param string $name Name prefix for entries. Set to blank if you wish none.
* @param array $theArray The (multidimensional) array to implode
* @param string $str (keep blank)
* @param bool $skipBlank If set, parameters which were blank strings would be removed.
* @param bool $rawurlencodeParamName If set, the param name itself (for example "param[key][key2]") would be rawurlencoded as well.
* @return string Imploded result, fx. ¶m[key][key2]=value2¶m[key][key3]=value3
* @see explodeUrl2Array()
*/
public static function implodeArrayForUrl(string $name, array $theArray, string $str = '', bool $skipBlank = false, bool $rawurlencodeParamName = false): string
{
foreach ($theArray as $Akey => $AVal) {
$thisKeyName = $name ? $name . '[' . $Akey . ']' : $Akey;
if (is_array($AVal)) {
$str = self::implodeArrayForUrl($thisKeyName, $AVal, $str, $skipBlank, $rawurlencodeParamName);
} else {
$stringValue = (string)$AVal;
if (!$skipBlank || $stringValue !== '') {
$parameterName = $rawurlencodeParamName ? rawurlencode($thisKeyName) : $thisKeyName;
$parameterValue = rawurlencode($stringValue);
$str .= '&' . $parameterName . '=' . $parameterValue;
}
}
}
return $str;
}
/**
* Explodes a string with GETvars (eg. "&id=1&type=2&ext[mykey]=3") into an array.
*
* Note! If you want to use a multi-dimensional string, consider this plain simple PHP code instead:
*
* $result = [];
* parse_str($queryParametersAsString, $result);
*
* However, if you do magic with a flat structure (e.g. keeping "ext[mykey]" as flat key in a one-dimensional array)
* then this method is for you.
*
* @param string $string GETvars string
* @return array<array-key, string> 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!
* @see implodeArrayForUrl()
*/
public static function explodeUrl2Array(string $string): array
{
$output = [];
$p = explode('&', $string);
foreach ($p as $v) {
if ($v !== '') {
$nameAndValue = explode('=', $v, 2);
$output[rawurldecode($nameAndValue[0])] = isset($nameAndValue[1]) ? rawurldecode($nameAndValue[1]) : '';
}
}
return $output;
}
/**
* Removes dots "." from end of a key identifier of TypoScript styled array.
* array('key.' => array('property.' => 'value')) --> array('key' => array('property' => 'value'))
*
* @param array $ts TypoScript configuration array
* @return array TypoScript configuration array without dots at the end of all keys
*/
public static function removeDotsFromTS(array $ts): array
{
$out = [];
foreach ($ts as $key => $value) {
if (is_array($value)) {
$key = rtrim($key, '.');
$out[$key] = self::removeDotsFromTS($value);
} else {
$out[$key] = $value;
}
}
return $out;
}
/*************************
*
* HTML/XML PROCESSING
*
*************************/
/**
* Returns an array with all attributes of the input HTML tag as key/value pairs. Attributes are only lowercase a-z
* $tag is either a whole tag (eg '<TAG OPTION ATTRIB=VALUE>') or the parameter list (ex ' OPTION ATTRIB=VALUE>')
* If an attribute is empty, then the value for the key is empty. You can check if it existed with isset()
*
* @param string $tag HTML-tag string (or attributes only)
* @param bool $decodeEntities Whether to decode HTML entities
* @return array<string, string> Array with the attribute values.
*/
public static function get_tag_attributes($tag, bool $decodeEntities = false)
{
$components = self::split_tag_attributes($tag);
// Attribute name is stored here
$name = '';
$valuemode = false;
$attributes = [];
foreach ($components as $key => $val) {
// 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
if ($val !== '=') {
if ($valuemode) {
if ($name) {
$attributes[$name] = $decodeEntities ? htmlspecialchars_decode($val) : $val;
$name = '';
}
} else {
if ($key = strtolower(preg_replace('/[^[:alnum:]_\\:\\-]/', '', $val) ?? '')) {
$attributes[$key] = '';
$name = $key;
}
}
$valuemode = false;
} else {
$valuemode = true;
}
}
return $attributes;
}
/**
* Returns an array with the 'components' from an attribute list from an HTML tag. The result is normally analyzed by get_tag_attributes
* Removes tag-name if found
*
* @param string $tag HTML-tag string (or attributes only)
* @return string[] Array with the attribute values.
*/
public static function split_tag_attributes($tag)
{
$tag_tmp = trim(preg_replace('/^<[^[:space:]]*/', '', trim($tag)) ?? '');
// Removes any > in the end of the string
$tag_tmp = trim(rtrim($tag_tmp, '>'));
$value = [];
// Compared with empty string instead , 030102
while ($tag_tmp !== '') {
$firstChar = $tag_tmp[0];
if ($firstChar === '"' || $firstChar === '\'') {
$reg = explode($firstChar, $tag_tmp, 3);
$value[] = $reg[1];
$tag_tmp = trim($reg[2] ?? '');
} elseif ($firstChar === '=') {
$value[] = '=';
// Removes = chars.
$tag_tmp = trim(substr($tag_tmp, 1));
} else {
// There are '' around the value. We look for the next ' ' or '>'
$reg = preg_split('/[[:space:]=]/', $tag_tmp, 2);
$value[] = trim($reg[0]);
$tag_tmp = trim(substr($tag_tmp, strlen($reg[0]), 1) . ($reg[1] ?? ''));
}
}
reset($value);
return $value;
}
/**
* Implodes attributes in the array $arr for an attribute list in eg. and HTML tag (with quotes)
*
* @param array<string, string> $arr Array with attribute key/value pairs, eg. "bgcolor" => "red", "border" => "0"
* @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!
* @param bool $keepBlankAttributes If TRUE, don't check if values are blank. Default is to omit attributes with blank values.
* @return string Imploded attributes, eg. 'bgcolor="red" border="0"'
*/
public static function implodeAttributes(array $arr, $xhtmlSafe = false, $keepBlankAttributes = false)
{
if ($xhtmlSafe) {
$newArr = [];
foreach ($arr as $attributeName => $attributeValue) {
$attributeName = strtolower($attributeName);
if (!isset($newArr[$attributeName])) {
$newArr[$attributeName] = htmlspecialchars((string)$attributeValue);
}