Skip to content

Commit fca78f8

Browse files
derrabusderrabus
committed
Bugfix: mbstring polyfills must not raise value errors in PHP 7
1 parent a5ae132 commit fca78f8

File tree

11 files changed

+262
-57
lines changed

11 files changed

+262
-57
lines changed

‎src/Mbstring/Mbstring.php

Lines changed: 42 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -834,19 +834,32 @@ public static function mb_ord($s, $encoding = null)
834834
return $code;
835835
}
836836

837-
public static function mb_str_pad(string $string, int $length, string $pad_string = ' ', int $pad_type = \STR_PAD_RIGHT, ?string $encoding = null): string
837+
/** @return string|false */
838+
public static function mb_str_pad(string $string, int $length, string $pad_string = ' ', int $pad_type = \STR_PAD_RIGHT, ?string $encoding = null)
838839
{
839840
if (!\in_array($pad_type, [\STR_PAD_RIGHT, \STR_PAD_LEFT, \STR_PAD_BOTH], true)) {
841+
if (\PHP_VERSION_ID < 80000) {
842+
trigger_error('mb_str_pad(): Argument #4 ($pad_type) must be STR_PAD_LEFT, STR_PAD_RIGHT, or STR_PAD_BOTH', \E_USER_WARNING);
843+
844+
return false;
845+
}
846+
840847
throw new \ValueError('mb_str_pad(): Argument #4 ($pad_type) must be STR_PAD_LEFT, STR_PAD_RIGHT, or STR_PAD_BOTH');
841848
}
842849

843850
if (null === $encoding) {
844851
$encoding = self::mb_internal_encoding();
845-
} else {
846-
self::assertEncoding($encoding, 'mb_str_pad(): Argument #5 ($encoding) must be a valid encoding, "%s" given');
852+
} elseif (!self::assertEncoding($encoding, 'mb_str_pad(): Argument #5 ($encoding) must be a valid encoding, "%s" given')) {
853+
return false;
847854
}
848855

849856
if (self::mb_strlen($pad_string, $encoding) <= 0) {
857+
if (\PHP_VERSION_ID < 80000) {
858+
trigger_error('mb_str_pad(): Argument #3 ($pad_string) must be a non-empty string', \E_USER_WARNING);
859+
860+
return false;
861+
}
862+
850863
throw new \ValueError('mb_str_pad(): Argument #3 ($pad_string) must be a non-empty string');
851864
}
852865

@@ -869,12 +882,13 @@ public static function mb_str_pad(string $string, int $length, string $pad_strin
869882
}
870883
}
871884

872-
public static function mb_ucfirst(string $string, ?string $encoding = null): string
885+
/** @return string|false */
886+
public static function mb_ucfirst(string $string, ?string $encoding = null)
873887
{
874888
if (null === $encoding) {
875889
$encoding = self::mb_internal_encoding();
876-
} else {
877-
self::assertEncoding($encoding, 'mb_ucfirst(): Argument #2 ($encoding) must be a valid encoding, "%s" given');
890+
} elseif (!self::assertEncoding($encoding, 'mb_ucfirst(): Argument #2 ($encoding) must be a valid encoding, "%s" given')) {
891+
return false;
878892
}
879893

880894
$firstChar = mb_substr($string, 0, 1, $encoding);
@@ -883,12 +897,13 @@ public static function mb_ucfirst(string $string, ?string $encoding = null): str
883897
return $firstChar.mb_substr($string, 1, null, $encoding);
884898
}
885899

886-
public static function mb_lcfirst(string $string, ?string $encoding = null): string
900+
/** @return string|false */
901+
public static function mb_lcfirst(string $string, ?string $encoding = null)
887902
{
888903
if (null === $encoding) {
889904
$encoding = self::mb_internal_encoding();
890-
} else {
891-
self::assertEncoding($encoding, 'mb_lcfirst(): Argument #2 ($encoding) must be a valid encoding, "%s" given');
905+
} elseif (!self::assertEncoding($encoding, 'mb_lcfirst(): Argument #2 ($encoding) must be a valid encoding, "%s" given')) {
906+
return false;
892907
}
893908

894909
$firstChar = mb_substr($string, 0, 1, $encoding);
@@ -971,27 +986,31 @@ private static function getEncoding($encoding)
971986
return $encoding;
972987
}
973988

974-
public static function mb_trim(string $string, ?string $characters = null, ?string $encoding = null): string
989+
/** @return string|false */
990+
public static function mb_trim(string $string, ?string $characters = null, ?string $encoding = null)
975991
{
976992
return self::mb_internal_trim('{^[%s]+|[%1$s]+$}Du', $string, $characters, $encoding, __FUNCTION__);
977993
}
978994

979-
public static function mb_ltrim(string $string, ?string $characters = null, ?string $encoding = null): string
995+
/** @return string|false */
996+
public static function mb_ltrim(string $string, ?string $characters = null, ?string $encoding = null)
980997
{
981998
return self::mb_internal_trim('{^[%s]+}Du', $string, $characters, $encoding, __FUNCTION__);
982999
}
9831000

984-
public static function mb_rtrim(string $string, ?string $characters = null, ?string $encoding = null): string
1001+
/** @return string|false */
1002+
public static function mb_rtrim(string $string, ?string $characters = null, ?string $encoding = null)
9851003
{
9861004
return self::mb_internal_trim('{[%s]+$}D', $string, $characters, $encoding, __FUNCTION__);
9871005
}
9881006

989-
private static function mb_internal_trim(string $regex, string $string, ?string $characters, ?string $encoding, string $function): string
1007+
/** @return string|false */
1008+
private static function mb_internal_trim(string $regex, string $string, ?string $characters, ?string $encoding, string $function)
9901009
{
9911010
if (null === $encoding) {
9921011
$encoding = self::mb_internal_encoding();
993-
} else {
994-
self::assertEncoding($encoding, $function.'(): Argument #3 ($encoding) must be a valid encoding, "%s" given');
1012+
} elseif (!self::assertEncoding($encoding, $function.'(): Argument #3 ($encoding) must be a valid encoding, "%s" given')) {
1013+
return false;
9951014
}
9961015

9971016
if ('' === $characters) {
@@ -1029,17 +1048,22 @@ private static function mb_internal_trim(string $regex, string $string, ?string
10291048
return iconv('UTF-8', $encoding.'//IGNORE', $string);
10301049
}
10311050

1032-
private static function assertEncoding(string $encoding, string $errorFormat): void
1051+
private static function assertEncoding(string $encoding, string $errorFormat): bool
10331052
{
10341053
try {
10351054
$validEncoding = @self::mb_check_encoding('', $encoding);
10361055
} catch (\ValueError $e) {
10371056
throw new \ValueError(sprintf($errorFormat, $encoding));
10381057
}
10391058

1040-
// BC for PHP 7.3 and lower
10411059
if (!$validEncoding) {
1042-
throw new \ValueError(sprintf($errorFormat, $encoding));
1060+
if (\PHP_VERSION_ID >= 80000) {
1061+
throw new \ValueError(sprintf($errorFormat, $encoding));
1062+
}
1063+
1064+
trigger_error(sprintf($errorFormat, $encoding), E_USER_WARNING);
10431065
}
1066+
1067+
return $validEncoding;
10441068
}
10451069
}

‎src/Mbstring/bootstrap.php

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -133,27 +133,27 @@ function mb_str_split($string, $length = 1, $encoding = null) { return p\Mbstrin
133133
}
134134

135135
if (!function_exists('mb_str_pad')) {
136-
function mb_str_pad(string $string, int $length, string $pad_string = ' ', int $pad_type = STR_PAD_RIGHT, ?string $encoding = null): string { return p\Mbstring::mb_str_pad($string, $length, $pad_string, $pad_type, $encoding); }
136+
function mb_str_pad(string $string, int $length, string $pad_string = ' ', int $pad_type = STR_PAD_RIGHT, ?string $encoding = null) { return p\Mbstring::mb_str_pad($string, $length, $pad_string, $pad_type, $encoding); }
137137
}
138138

139139
if (!function_exists('mb_ucfirst')) {
140-
function mb_ucfirst(string $string, ?string $encoding = null): string { return p\Mbstring::mb_ucfirst($string, $encoding); }
140+
function mb_ucfirst(string $string, ?string $encoding = null) { return p\Mbstring::mb_ucfirst($string, $encoding); }
141141
}
142142

143143
if (!function_exists('mb_lcfirst')) {
144-
function mb_lcfirst(string $string, ?string $encoding = null): string { return p\Mbstring::mb_lcfirst($string, $encoding); }
144+
function mb_lcfirst(string $string, ?string $encoding = null) { return p\Mbstring::mb_lcfirst($string, $encoding); }
145145
}
146146

147147
if (!function_exists('mb_trim')) {
148-
function mb_trim(string $string, ?string $characters = null, ?string $encoding = null): string { return p\Mbstring::mb_trim($string, $characters, $encoding); }
148+
function mb_trim(string $string, ?string $characters = null, ?string $encoding = null) { return p\Mbstring::mb_trim($string, $characters, $encoding); }
149149
}
150150

151151
if (!function_exists('mb_ltrim')) {
152-
function mb_ltrim(string $string, ?string $characters = null, ?string $encoding = null): string { return p\Mbstring::mb_ltrim($string, $characters, $encoding); }
152+
function mb_ltrim(string $string, ?string $characters = null, ?string $encoding = null) { return p\Mbstring::mb_ltrim($string, $characters, $encoding); }
153153
}
154154

155155
if (!function_exists('mb_rtrim')) {
156-
function mb_rtrim(string $string, ?string $characters = null, ?string $encoding = null): string { return p\Mbstring::mb_rtrim($string, $characters, $encoding); }
156+
function mb_rtrim(string $string, ?string $characters = null, ?string $encoding = null) { return p\Mbstring::mb_rtrim($string, $characters, $encoding); }
157157
}
158158

159159

‎src/Php83/Php83.php

Lines changed: 17 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,8 @@ public static function json_validate(string $json, int $depth = 512, int $flags
4040
return \JSON_ERROR_NONE === json_last_error();
4141
}
4242

43-
public static function mb_str_pad(string $string, int $length, string $pad_string = ' ', int $pad_type = \STR_PAD_RIGHT, ?string $encoding = null): string
43+
/** @return string|false */
44+
public static function mb_str_pad(string $string, int $length, string $pad_string = ' ', int $pad_type = \STR_PAD_RIGHT, ?string $encoding = null)
4445
{
4546
if (!\in_array($pad_type, [\STR_PAD_RIGHT, \STR_PAD_LEFT, \STR_PAD_BOTH], true)) {
4647
throw new \ValueError('mb_str_pad(): Argument #4 ($pad_type) must be STR_PAD_LEFT, STR_PAD_RIGHT, or STR_PAD_BOTH');
@@ -50,19 +51,27 @@ public static function mb_str_pad(string $string, int $length, string $pad_strin
5051
$encoding = mb_internal_encoding();
5152
}
5253

54+
$errorToTrigger = null;
5355
try {
54-
$validEncoding = @mb_check_encoding('', $encoding);
56+
if (!@mb_check_encoding('', $encoding)) {
57+
$errorToTrigger = sprintf('mb_str_pad(): Argument #5 ($encoding) must be a valid encoding, "%s" given', $encoding);
58+
}
5559
} catch (\ValueError $e) {
56-
throw new \ValueError(sprintf('mb_str_pad(): Argument #5 ($encoding) must be a valid encoding, "%s" given', $encoding));
60+
$errorToTrigger = sprintf('mb_str_pad(): Argument #5 ($encoding) must be a valid encoding, "%s" given', $encoding);
5761
}
5862

59-
// BC for PHP 7.3 and lower
60-
if (!$validEncoding) {
61-
throw new \ValueError(sprintf('mb_str_pad(): Argument #5 ($encoding) must be a valid encoding, "%s" given', $encoding));
63+
if (mb_strlen($pad_string, $encoding) <= 0) {
64+
$errorToTrigger = 'mb_str_pad(): Argument #3 ($pad_string) must be a non-empty string';
6265
}
6366

64-
if (mb_strlen($pad_string, $encoding) <= 0) {
65-
throw new \ValueError('mb_str_pad(): Argument #3 ($pad_string) must be a non-empty string');
67+
if (null !== $errorToTrigger) {
68+
if (PHP_VERSION_ID < 80000) {
69+
trigger_error($errorToTrigger, E_USER_WARNING);
70+
71+
return false;
72+
}
73+
74+
throw new \ValueError($errorToTrigger);
6675
}
6776

6877
$paddingRequired = $length - mb_strlen($string, $encoding);

‎src/Php83/bootstrap.php

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -19,12 +19,6 @@
1919
function json_validate(string $json, int $depth = 512, int $flags = 0): bool { return p\Php83::json_validate($json, $depth, $flags); }
2020
}
2121

22-
if (extension_loaded('mbstring')) {
23-
if (!function_exists('mb_str_pad')) {
24-
function mb_str_pad(string $string, int $length, string $pad_string = ' ', int $pad_type = STR_PAD_RIGHT, ?string $encoding = null): string { return p\Php83::mb_str_pad($string, $length, $pad_string, $pad_type, $encoding); }
25-
}
26-
}
27-
2822
if (!function_exists('stream_context_set_options')) {
2923
function stream_context_set_options($context, array $options): bool { return stream_context_set_option($context, $options); }
3024
}
@@ -37,8 +31,14 @@ function str_increment(string $string): string { return p\Php83::str_increment($
3731
function str_decrement(string $string): string { return p\Php83::str_decrement($string); }
3832
}
3933

40-
if (\PHP_VERSION_ID >= 80100) {
41-
return require __DIR__.'/bootstrap81.php';
34+
if (\PHP_VERSION_ID >= 80000) {
35+
return require __DIR__.'/bootstrap80.php';
36+
}
37+
38+
if (extension_loaded('mbstring')) {
39+
if (!function_exists('mb_str_pad')) {
40+
function mb_str_pad(string $string, int $length, string $pad_string = ' ', int $pad_type = STR_PAD_RIGHT, ?string $encoding = null) { return p\Php83::mb_str_pad($string, $length, $pad_string, $pad_type, $encoding); }
41+
}
4242
}
4343

4444
if (!function_exists('ldap_exop_sync') && function_exists('ldap_exop')) {

‎src/Php83/bootstrap80.php

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
<?php
2+
3+
if (extension_loaded('mbstring')) {
4+
if (!function_exists('mb_str_pad')) {
5+
function mb_str_pad(string $string, int $length, string $pad_string = ' ', int $pad_type = STR_PAD_RIGHT, ?string $encoding = null): string { return p\Php83::mb_str_pad($string, $length, $pad_string, $pad_type, $encoding); }
6+
}
7+
}
8+
9+
if (\PHP_VERSION_ID >= 80100) {
10+
return require __DIR__.'/bootstrap81.php';
11+
}
12+
13+
if (!function_exists('ldap_exop_sync') && function_exists('ldap_exop')) {
14+
function ldap_exop_sync($ldap, string $request_oid, ?string $request_data = null, ?array $controls = null, &$response_data = null, &$response_oid = null): bool { return ldap_exop($ldap, $request_oid, $request_data, $controls, $response_data, $response_oid); }
15+
}
16+
17+
if (!function_exists('ldap_connect_wallet') && function_exists('ldap_connect')) {
18+
function ldap_connect_wallet(?string $uri, string $wallet, string $password, int $auth_mode = \GSLC_SSL_NO_AUTH) { return ldap_connect($uri, $wallet, $password, $auth_mode); }
19+
}

‎src/Php84/Php84.php

Lines changed: 31 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,8 @@
1919
*/
2020
final class Php84
2121
{
22-
public static function mb_ucfirst(string $string, ?string $encoding = null): string
22+
/** @return string|false */
23+
public static function mb_ucfirst(string $string, ?string $encoding = null)
2324
{
2425
if (null === $encoding) {
2526
$encoding = mb_internal_encoding();
@@ -31,8 +32,13 @@ public static function mb_ucfirst(string $string, ?string $encoding = null): str
3132
throw new \ValueError(sprintf('mb_ucfirst(): Argument #2 ($encoding) must be a valid encoding, "%s" given', $encoding));
3233
}
3334

34-
// BC for PHP 7.3 and lower
3535
if (!$validEncoding) {
36+
if (PHP_VERSION_ID < 80000) {
37+
trigger_error(sprintf('mb_ucfirst(): Argument #2 ($encoding) must be a valid encoding, "%s" given', $encoding), \E_USER_WARNING);
38+
39+
return false;
40+
}
41+
3642
throw new \ValueError(sprintf('mb_ucfirst(): Argument #2 ($encoding) must be a valid encoding, "%s" given', $encoding));
3743
}
3844

@@ -42,7 +48,8 @@ public static function mb_ucfirst(string $string, ?string $encoding = null): str
4248
return $firstChar.mb_substr($string, 1, null, $encoding);
4349
}
4450

45-
public static function mb_lcfirst(string $string, ?string $encoding = null): string
51+
/** @return string|false */
52+
public static function mb_lcfirst(string $string, ?string $encoding = null)
4653
{
4754
if (null === $encoding) {
4855
$encoding = mb_internal_encoding();
@@ -54,8 +61,13 @@ public static function mb_lcfirst(string $string, ?string $encoding = null): str
5461
throw new \ValueError(sprintf('mb_lcfirst(): Argument #2 ($encoding) must be a valid encoding, "%s" given', $encoding));
5562
}
5663

57-
// BC for PHP 7.3 and lower
5864
if (!$validEncoding) {
65+
if (PHP_VERSION_ID < 80000) {
66+
trigger_error(sprintf('mb_lcfirst(): Argument #2 ($encoding) must be a valid encoding, "%s" given', $encoding), \E_USER_WARNING);
67+
68+
return false;
69+
}
70+
5971
throw new \ValueError(sprintf('mb_lcfirst(): Argument #2 ($encoding) must be a valid encoding, "%s" given', $encoding));
6072
}
6173

@@ -109,22 +121,26 @@ public static function array_all(array $array, callable $callback): bool
109121
return true;
110122
}
111123

112-
public static function mb_trim(string $string, ?string $characters = null, ?string $encoding = null): string
124+
/** @return string|false */
125+
public static function mb_trim(string $string, ?string $characters = null, ?string $encoding = null)
113126
{
114127
return self::mb_internal_trim('{^[%s]+|[%1$s]+$}Du', $string, $characters, $encoding, __FUNCTION__);
115128
}
116129

117-
public static function mb_ltrim(string $string, ?string $characters = null, ?string $encoding = null): string
130+
/** @return string|false */
131+
public static function mb_ltrim(string $string, ?string $characters = null, ?string $encoding = null)
118132
{
119133
return self::mb_internal_trim('{^[%s]+}Du', $string, $characters, $encoding, __FUNCTION__);
120134
}
121135

122-
public static function mb_rtrim(string $string, ?string $characters = null, ?string $encoding = null): string
136+
/** @return string|false */
137+
public static function mb_rtrim(string $string, ?string $characters = null, ?string $encoding = null)
123138
{
124-
return self::mb_internal_trim('{[%s]+$}Du', $string, $characters, $encoding, __FUNCTION__);
139+
return self::mb_internal_trim('{[%s]+$}D', $string, $characters, $encoding, __FUNCTION__);
125140
}
126141

127-
private static function mb_internal_trim(string $regex, string $string, ?string $characters, ?string $encoding, string $function): string
142+
/** @return string|false */
143+
private static function mb_internal_trim(string $regex, string $string, ?string $characters, ?string $encoding, string $function)
128144
{
129145
if (null === $encoding) {
130146
$encoding = mb_internal_encoding();
@@ -136,8 +152,13 @@ private static function mb_internal_trim(string $regex, string $string, ?string
136152
throw new \ValueError(sprintf('%s(): Argument #3 ($encoding) must be a valid encoding, "%s" given', $function, $encoding));
137153
}
138154

139-
// BC for PHP 7.3 and lower
140155
if (!$validEncoding) {
156+
if (PHP_VERSION_ID < 80000) {
157+
trigger_error(sprintf('%s(): Argument #3 ($encoding) must be a valid encoding, "%s" given', $function, $encoding), \E_USER_WARNING);
158+
159+
return false;
160+
}
161+
141162
throw new \ValueError(sprintf('%s(): Argument #3 ($encoding) must be a valid encoding, "%s" given', $function, $encoding));
142163
}
143164

‎src/Php84/bootstrap.php

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -39,24 +39,28 @@ function array_any(array $array, callable $callback): bool { return p\Php84::arr
3939
function array_all(array $array, callable $callback): bool { return p\Php84::array_all($array, $callback); }
4040
}
4141

42+
if (\PHP_VERSION_ID >= 80000) {
43+
return require __DIR__ . '/bootstrap80.php';
44+
}
45+
4246
if (extension_loaded('mbstring')) {
4347
if (!function_exists('mb_ucfirst')) {
44-
function mb_ucfirst(string $string, ?string $encoding = null): string { return p\Php84::mb_ucfirst($string, $encoding); }
48+
function mb_ucfirst(string $string, ?string $encoding = null) { return p\Php84::mb_ucfirst($string, $encoding); }
4549
}
4650

4751
if (!function_exists('mb_lcfirst')) {
48-
function mb_lcfirst(string $string, ?string $encoding = null): string { return p\Php84::mb_lcfirst($string, $encoding); }
52+
function mb_lcfirst(string $string, ?string $encoding = null) { return p\Php84::mb_lcfirst($string, $encoding); }
4953
}
5054

5155
if (!function_exists('mb_trim')) {
52-
function mb_trim(string $string, ?string $characters = null, ?string $encoding = null): string { return p\Php84::mb_trim($string, $characters, $encoding); }
56+
function mb_trim(string $string, ?string $characters = null, ?string $encoding = null) { return p\Php84::mb_trim($string, $characters, $encoding); }
5357
}
5458

5559
if (!function_exists('mb_ltrim')) {
56-
function mb_ltrim(string $string, ?string $characters = null, ?string $encoding = null): string { return p\Php84::mb_ltrim($string, $characters, $encoding); }
60+
function mb_ltrim(string $string, ?string $characters = null, ?string $encoding = null) { return p\Php84::mb_ltrim($string, $characters, $encoding); }
5761
}
5862

5963
if (!function_exists('mb_rtrim')) {
60-
function mb_rtrim(string $string, ?string $characters = null, ?string $encoding = null): string { return p\Php84::mb_rtrim($string, $characters, $encoding); }
64+
function mb_rtrim(string $string, ?string $characters = null, ?string $encoding = null) { return p\Php84::mb_rtrim($string, $characters, $encoding); }
6165
}
6266
}

0 commit comments

Comments
 (0)