Use Error exceptions instead of warning in some place in string stdlib

Author: Girgias

ext/standard/string.c

@@ -295,6 +295,10 @@ static void php_spn_common_handler(INTERNAL_FUNCTION_PARAMETERS, int behavior) /
 			start = 0;
 		}
 	} else if ((size_t)start > ZSTR_LEN(s11)) {
+		/* Convert to Exception ?
+		zend_throw_exception(zend_ce_error_exception, "Offset not contained in string", E_ERROR);
+		return;
+		 */
 		RETURN_FALSE;
 	}
 
@@ -328,15 +332,15 @@ static void php_spn_common_handler(INTERNAL_FUNCTION_PARAMETERS, int behavior) /
 }
 /* }}} */
 
-/* {{{ proto int|false strspn(string str, string mask [, int start [, int len]])
+/* {{{ proto int strspn(string str, string mask [, int start [, int len]])
    Finds length of initial segment consisting entirely of characters found in mask. If start or/and length is provided works like strspn(substr($s,$start,$len),$good_chars) */
 PHP_FUNCTION(strspn)
 {
 	php_spn_common_handler(INTERNAL_FUNCTION_PARAM_PASSTHRU, STR_STRSPN);
 }
 /* }}} */
 
-/* {{{ proto int|false strcspn(string str, string mask [, int start [, int len]])
+/* {{{ proto int strcspn(string str, string mask [, int start [, int len]])
    Finds length of initial segment consisting entirely of characters not found in mask. If start or/and length is provide works like strcspn(substr($s,$start,$len),$bad_chars) */
 PHP_FUNCTION(strcspn)
 {
@@ -686,6 +690,9 @@ PHP_FUNCTION(nl_langinfo)
 #endif
 			break;
 		default:
+			/* TODO Convert to ErrorException
+			 * zend_throw_exception(zend_ce_error_exception, "", E_ERROR);
+			 */
 			php_error_docref(NULL, E_WARNING, "Item '" ZEND_LONG_FMT "' is not valid", item);
 			RETURN_FALSE;
 	}
@@ -722,6 +729,7 @@ PHP_FUNCTION(strcoll)
  * it needs to be incrementing.
  * Returns: FAILURE/SUCCESS whether the input was correct (i.e. no range errors)
  */
+/* TODO (maybe) convert docref errors into ErrorException? */
 static inline int php_charmask(const unsigned char *input, size_t len, char *mask)
 {
 	const unsigned char *end;
@@ -911,7 +919,7 @@ PHP_FUNCTION(ltrim)
 }
 /* }}} */
 
-/* {{{ proto string|false wordwrap(string str [, int width [, string break [, bool cut]]])
+/* {{{ proto string wordwrap(string str [, int width [, string break [, bool cut]]])
    Wraps buffer to selected number of characters using string break char */
 PHP_FUNCTION(wordwrap)
 {
@@ -937,13 +945,13 @@ PHP_FUNCTION(wordwrap)
 	}
 
 	if (breakchar_len == 0) {
-		php_error_docref(NULL, E_WARNING, "Break string cannot be empty");
-		RETURN_FALSE;
+		zend_throw_exception(zend_ce_error_exception, "Break string cannot be empty", E_ERROR);
+		return;
 	}
 
 	if (linelength == 0 && docut) {
-		php_error_docref(NULL, E_WARNING, "Can't force cut when width is zero");
-		RETURN_FALSE;
+		zend_throw_exception(zend_ce_error_exception, "Can't force cut when width is zero", E_ERROR);
+		return;
 	}
 
 	/* Special case for a single-character break as it needs no
@@ -1133,7 +1141,7 @@ PHPAPI void php_explode_negative_limit(const zend_string *delim, zend_string *st
 }
 /* }}} */
 
-/* {{{ proto array|false explode(string separator, string str [, int limit])
+/* {{{ proto array explode(string separator, string str [, int limit])
    Splits a string on string separator and return array of components. If limit is positive only limit number of components is returned. If limit is negative all components except the last abs(limit) are returned. */
 PHP_FUNCTION(explode)
 {
@@ -1149,8 +1157,8 @@ PHP_FUNCTION(explode)
 	ZEND_PARSE_PARAMETERS_END();
 
 	if (ZSTR_LEN(delim) == 0) {
-		php_error_docref(NULL, E_WARNING, "Empty delimiter");
-		RETURN_FALSE;
+		zend_throw_exception(zend_ce_error_exception, "Empty delimiter", E_ERROR);
+		return;
 	}
 
 	array_init(return_value);
@@ -1623,7 +1631,7 @@ PHPAPI size_t php_dirname(char *path, size_t len)
 }
 /* }}} */
 
-/* {{{ proto string|null dirname(string path[, int levels])
+/* {{{ proto string dirname(string path[, int levels])
    Returns the directory name component of the path */
 PHP_FUNCTION(dirname)
 {
@@ -1648,7 +1656,7 @@ PHP_FUNCTION(dirname)
 		ZSTR_LEN(ret) = zend_dirname(ZSTR_VAL(ret), str_len);
 #endif
 	} else if (levels < 1) {
-		php_error_docref(NULL, E_WARNING, "Invalid argument, levels must be >= 1");
+		zend_throw_exception(zend_ce_error_exception, "Invalid argument, levels must be >= 1", E_ERROR);
 		zend_string_efree(ret);
 		return;
 	} else {
@@ -1817,8 +1825,8 @@ PHP_FUNCTION(stristr)
 	ZEND_PARSE_PARAMETERS_END();
 
 	if (!ZSTR_LEN(needle)) {
-		php_error_docref(NULL, E_WARNING, "Empty needle");
-		RETURN_FALSE;
+		zend_throw_exception(zend_ce_error_exception, "Empty needle", E_ERROR);
+		return;
 	}
 
 	haystack_dup = estrndup(ZSTR_VAL(haystack), ZSTR_LEN(haystack));
@@ -1858,8 +1866,8 @@ PHP_FUNCTION(strstr)
 	ZEND_PARSE_PARAMETERS_END();
 
 	if (!ZSTR_LEN(needle)) {
-		php_error_docref(NULL, E_WARNING, "Empty needle");
-		RETURN_FALSE;
+		zend_throw_exception(zend_ce_error_exception, "Empty needle", E_ERROR);
+		return;
 	}
 
 	found = php_memnstr(ZSTR_VAL(haystack), ZSTR_VAL(needle), ZSTR_LEN(needle), ZSTR_VAL(haystack) + ZSTR_LEN(haystack));
@@ -1904,8 +1912,8 @@ PHP_FUNCTION(strpos)
 	}
 
 	if (!ZSTR_LEN(needle)) {
-		php_error_docref(NULL, E_WARNING, "Empty needle");
-		RETURN_FALSE;
+		zend_throw_exception(zend_ce_error_exception, "Empty needle", E_ERROR);
+		return;
 	}
 
 	found = (char*)php_memnstr(ZSTR_VAL(haystack) + offset,
@@ -2198,8 +2206,8 @@ PHP_FUNCTION(chunk_split)
 	ZEND_PARSE_PARAMETERS_END();
 
 	if (chunklen <= 0) {
-		php_error_docref(NULL, E_WARNING, "Chunk length should be greater than zero");
-		RETURN_FALSE;
+		zend_throw_exception(zend_ce_error_exception, "Chunk length should be greater than zero", E_ERROR);
+		return;
 	}
 
 	if ((size_t)chunklen > ZSTR_LEN(str)) {
@@ -2354,11 +2362,13 @@ PHP_FUNCTION(substr_replace)
 			(argc == 3 && Z_TYPE_P(from) == IS_ARRAY) ||
 			(argc == 4 && Z_TYPE_P(from) != Z_TYPE_P(len))
 		) {
+			/* TODO can convert to TypeError ? */
 			php_error_docref(NULL, E_WARNING, "'start' and 'length' should be of same type - numerical or array ");
 			RETURN_STR_COPY(Z_STR_P(str));
 		}
 		if (argc == 4 && Z_TYPE_P(from) == IS_ARRAY) {
 			if (zend_hash_num_elements(Z_ARRVAL_P(from)) != zend_hash_num_elements(Z_ARRVAL_P(len))) {
+				/* TODO can convert to Exception ? */
 				php_error_docref(NULL, E_WARNING, "'start' and 'length' should have the same number of elements");
 				RETURN_STR_COPY(Z_STR_P(str));
 			}
@@ -2428,6 +2438,7 @@ PHP_FUNCTION(substr_replace)
 			zend_tmp_string_release(tmp_repl_str);
 			RETURN_NEW_STR(result);
 		} else {
+			/* TODO can convert to Exception ? */
 			php_error_docref(NULL, E_WARNING, "Functionality of 'start' and 'length' as arrays is not implemented");
 			RETURN_STR_COPY(Z_STR_P(str));
 		}
@@ -3296,7 +3307,7 @@ PHPAPI zend_string *php_str_to_str(const char *haystack, size_t length, const ch
 }
 /* }}} */
 
-/* {{{ proto string|false strtr(string str, string from[, string to])
+/* {{{ proto string strtr(string str, string from[, string to])
    Translates characters in str using given translation tables */
 PHP_FUNCTION(strtr)
 {
@@ -3314,8 +3325,8 @@ PHP_FUNCTION(strtr)
 	ZEND_PARSE_PARAMETERS_END();
 
 	if (ac == 2 && Z_TYPE_P(from) != IS_ARRAY) {
-		php_error_docref(NULL, E_WARNING, "The second argument is not an array");
-		RETURN_FALSE;
+		zend_type_error("The second argument is not an array");
+		return;
 	}
 
 	/* shortcut for empty string */
@@ -3363,6 +3374,7 @@ PHP_FUNCTION(strtr)
 		}
 	} else {
 		if (!try_convert_to_string(from)) {
+			zend_type_error("Cannot convert 'from' into string.");
 			return;
 		}
 
@@ -5367,7 +5379,7 @@ PHP_FUNCTION(str_repeat)
 	ZEND_PARSE_PARAMETERS_END();
 
 	if (mult < 0) {
-		php_error_docref(NULL, E_WARNING, "Second argument has to be greater than or equal to 0");
+		zend_throw_exception(zend_ce_error_exception, "Second argument has to be greater than or equal to 0", E_ERROR);
 		return;
 	}
 
@@ -5405,7 +5417,7 @@ PHP_FUNCTION(str_repeat)
 }
 /* }}} */
 
-/* {{{ proto array|string|false count_chars(string input [, int mode])
+/* {{{ proto array|string count_chars(string input [, int mode])
    Returns info about what characters are used in input */
 PHP_FUNCTION(count_chars)
 {
@@ -5425,8 +5437,8 @@ PHP_FUNCTION(count_chars)
 	ZEND_PARSE_PARAMETERS_END();
 
 	if (mymode < 0 || mymode > 4) {
-		php_error_docref(NULL, E_WARNING, "Unknown mode");
-		RETURN_FALSE;
+		zend_throw_exception(zend_ce_error_exception, "Unknown mode", E_ERROR);
+		return;
 	}
 
 	buf = (const unsigned char *) ZSTR_VAL(input);
@@ -5614,8 +5626,8 @@ PHP_FUNCTION(substr_count)
 	ZEND_PARSE_PARAMETERS_END();
 
 	if (needle_len == 0) {
-		php_error_docref(NULL, E_WARNING, "Empty substring");
-		RETURN_FALSE;
+		zend_throw_exception(zend_ce_error_exception, "Empty substring", E_ERROR);
+		return;
 	}
 
 	p = haystack;
@@ -5636,6 +5648,7 @@ PHP_FUNCTION(substr_count)
 			length += (haystack_len - offset);
 		}
 		if (length < 0 || ((size_t)length > (haystack_len - offset))) {
+			/* Convert to Exception ? */
 			php_error_docref(NULL, E_WARNING, "Invalid length value");
 			RETURN_FALSE;
 		}
@@ -5691,18 +5704,19 @@ PHP_FUNCTION(str_pad)
 	}
 
 	if (pad_str_len == 0) {
-		php_error_docref(NULL, E_WARNING, "Padding string cannot be empty");
+		zend_throw_exception(zend_ce_error_exception, "Padding string cannot be empty", E_ERROR);
 		return;
 	}
 
 	if (pad_type_val < STR_PAD_LEFT || pad_type_val > STR_PAD_BOTH) {
-		php_error_docref(NULL, E_WARNING, "Padding type has to be STR_PAD_LEFT, STR_PAD_RIGHT, or STR_PAD_BOTH");
+		zend_throw_exception(zend_ce_error_exception,
+				"Padding type has to be STR_PAD_LEFT, STR_PAD_RIGHT, or STR_PAD_BOTH", E_ERROR);
 		return;
 	}
 
 	num_pad_chars = pad_length - ZSTR_LEN(input);
 	if (num_pad_chars >= INT_MAX) {
-		php_error_docref(NULL, E_WARNING, "Padding length is too long");
+		zend_throw_exception(zend_ce_error_exception, "Padding length is too long", E_ERROR);
 		return;
 	}
 
@@ -5920,7 +5934,7 @@ PHP_FUNCTION(str_shuffle)
 }
 /* }}} */
 
-/* {{{ proto mixed str_word_count(string str, [int format [, string charlist]])
+/* {{{ proto array|int|null|false str_word_count(string str, [int format [, string charlist]])
    	Counts the number of words inside a string. If format of 1 is specified,
    	then the function will return an array containing all the words
    	found inside the string. If format of 2 is specified, then the function
@@ -5961,6 +5975,10 @@ PHP_FUNCTION(str_word_count)
 			/* nothing to be done */
 			break;
 		default:
+			/* Not sure how to proceed here
+			zend_throw_exception(zend_ce_error_exception, "Padding string cannot be empty", E_ERROR);
+			return;
+			*/
 			php_error_docref(NULL, E_WARNING, "Invalid format value " ZEND_LONG_FMT, type);
 			RETURN_FALSE;
 	}
@@ -6062,7 +6080,7 @@ PHP_FUNCTION(money_format)
 /* }}} */
 #endif
 
-/* {{{ proto array|false str_split(string str [, int split_length])
+/* {{{ proto array str_split(string str [, int split_length])
    Convert a string to an array. If split_length is specified, break the string down into chunks each split_length characters long. */
 PHP_FUNCTION(str_split)
 {
@@ -6078,8 +6096,8 @@ PHP_FUNCTION(str_split)
 	ZEND_PARSE_PARAMETERS_END();
 
 	if (split_length <= 0) {
-		php_error_docref(NULL, E_WARNING, "The length of each segment must be greater than zero");
-		RETURN_FALSE;
+		zend_throw_exception(zend_ce_error_exception, "The length of each segment must be greater than zero", E_ERROR);
+		return;
 	}
 
 
@@ -6118,8 +6136,8 @@ PHP_FUNCTION(strpbrk)
 	ZEND_PARSE_PARAMETERS_END_EX(RETURN_FALSE);
 
 	if (!ZSTR_LEN(char_list)) {
-		php_error_docref(NULL, E_WARNING, "The character list cannot be empty");
-		RETURN_FALSE;
+		zend_throw_exception(zend_ce_error_exception, "The character list cannot be empty", E_ERROR);
+		return;
 	}
 
 	for (haystack_ptr = ZSTR_VAL(haystack); haystack_ptr < (ZSTR_VAL(haystack) + ZSTR_LEN(haystack)); ++haystack_ptr) {
@@ -6157,8 +6175,8 @@ PHP_FUNCTION(substr_compare)
 		if (len == 0) {
 			RETURN_LONG(0L);
 		} else {
-			php_error_docref(NULL, E_WARNING, "The length must be greater than or equal to zero");
-			RETURN_FALSE;
+			zend_throw_exception(zend_ce_error_exception, "The length must be greater than or equal to zero", E_ERROR);
+			return;
 		}
 	}
 
@@ -6168,6 +6186,7 @@ PHP_FUNCTION(substr_compare)
 	}
 
 	if ((size_t)offset > ZSTR_LEN(s1)) {
+		/* Candidate to convert to Exception ? */
 		php_error_docref(NULL, E_WARNING, "The start position cannot exceed initial string length");
 		RETURN_FALSE;
 	}

ext/standard/tests/strings/bug33605.phpt

@@ -2,10 +2,12 @@
 Bug #33605 (substr_compare crashes)
 --FILE--
 <?php
-$res = substr_compare("aa", "a", -99999999, -1, 0);
-var_dump($res);
+try {
+    substr_compare("aa", "a", -99999999, -1, 0);
+} catch (\ErrorException $e) {
+    echo $e->getMessage();
+}
 
 ?>
 --EXPECTF--
-Warning: substr_compare(): The length must be greater than or equal to zero in %s on line %d
-bool(false)
+The length must be greater than or equal to zero

ext/standard/tests/strings/bug63943.phpt

@@ -2,7 +2,11 @@
 Bug #63943 (Bad warning text from strpos() on empty needle)
 --FILE--
 <?php
-strpos("lllllll", '');
+try {
+    strpos("lllllll", '');
+} catch (\ErrorException $e) {
+    echo $e->getMessage();
+}
 ?>
 --EXPECTF--
-Warning: strpos(): Empty needle in %sbug63943.php on line %d
+Empty needle