php-src/ext/intl/collator/collator_compare.c
Gina Peter Banyard 6600d0e00f
ext/intl: Refactor error handling (#19196)
This is a comprehensive refactoring of the error mechanism of the Intl extension.

By moving the prefixing of the current method/function being executed to actual error message creation by accessing the execution context, we get the following benefits:
- Accurate error messages indicating *what* call caused the error
  - As we *always* "copy" the message, the `copyMsg` arg becomes unused, meaning we can reduce the size of the `intl_error` struct by 4 bytes.
  - Saving it as a zend_string means we know the length of the message
- Remove the need to pass around a "function name" `char*` across multiple calls
- Use Intl's exception mechanism to generate exceptions for constructor call
  - This removes the need for replacing the error handler
  - Which didn't do anything anyway in silent mode, which required throwing non-descriptive exceptions
2025-07-30 16:00:37 +01:00

111 lines
3.1 KiB
C

/*
+----------------------------------------------------------------------+
| This source file is subject to version 3.01 of the PHP license, |
| that is bundled with this package in the file LICENSE, and is |
| available through the world-wide-web at the following url: |
| https://www.php.net/license/3_01.txt |
| If you did not receive a copy of the PHP license and are unable to |
| obtain it through the world-wide-web, please send a note to |
| license@php.net so we can mail you a copy immediately. |
+----------------------------------------------------------------------+
| Authors: Vadim Savchuk <vsavchuk@productengine.com> |
| Dmitry Lakhtyuk <dlakhtyuk@productengine.com> |
+----------------------------------------------------------------------+
*/
#ifdef HAVE_CONFIG_H
#include <config.h>
#endif
#include "php_intl.h"
#include "collator_class.h"
#include "intl_convert.h"
/* {{{ Compare two strings. */
PHP_FUNCTION( collator_compare )
{
char* str1 = NULL;
char* str2 = NULL;
size_t str1_len = 0;
size_t str2_len = 0;
UChar* ustr1 = NULL;
UChar* ustr2 = NULL;
int ustr1_len = 0;
int ustr2_len = 0;
UCollationResult result;
COLLATOR_METHOD_INIT_VARS
/* Parse parameters. */
if( zend_parse_method_parameters( ZEND_NUM_ARGS(), getThis(), "Oss",
&object, Collator_ce_ptr, &str1, &str1_len, &str2, &str2_len ) == FAILURE )
{
RETURN_THROWS();
}
/* Fetch the object. */
COLLATOR_METHOD_FETCH_OBJECT;
if (!co || !co->ucoll) {
intl_error_set_code( NULL, COLLATOR_ERROR_CODE( co ) );
intl_errors_set_custom_msg(COLLATOR_ERROR_P( co ), "Object not initialized");
zend_throw_error(NULL, "Object not initialized");
RETURN_THROWS();
}
/*
* Compare given strings (converting them to UTF-16 first).
*/
/* First convert the strings to UTF-16. */
intl_convert_utf8_to_utf16(
&ustr1, &ustr1_len, str1, str1_len, COLLATOR_ERROR_CODE_P( co ) );
if( U_FAILURE( COLLATOR_ERROR_CODE( co ) ) )
{
/* Set global error code. */
intl_error_set_code( NULL, COLLATOR_ERROR_CODE( co ) );
/* Set error messages. */
intl_errors_set_custom_msg( COLLATOR_ERROR_P( co ), "Error converting first argument to UTF-16");
if (ustr1) {
efree( ustr1 );
}
RETURN_FALSE;
}
intl_convert_utf8_to_utf16(
&ustr2, &ustr2_len, str2, str2_len, COLLATOR_ERROR_CODE_P( co ) );
if( U_FAILURE( COLLATOR_ERROR_CODE( co ) ) )
{
/* Set global error code. */
intl_error_set_code( NULL, COLLATOR_ERROR_CODE( co ) );
/* Set error messages. */
intl_errors_set_custom_msg( COLLATOR_ERROR_P( co ), "Error converting second argument to UTF-16");
if (ustr1) {
efree( ustr1 );
}
if (ustr2) {
efree( ustr2 );
}
RETURN_FALSE;
}
/* Then compare them. */
result = ucol_strcoll(
co->ucoll,
ustr1, ustr1_len,
ustr2, ustr2_len );
if( ustr1 )
efree( ustr1 );
if( ustr2 )
efree( ustr2 );
/* Return result of the comparison. */
RETURN_LONG( result );
}
/* }}} */