php-src/ext/intl/dateformat/datepatterngenerator_methods.cpp
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

134 lines
4 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: Mel Dafert (mel@dafert.at) |
+----------------------------------------------------------------------+
*/
#include "../intl_cppshims.h"
#include <unicode/dtptngen.h>
#include "../intl_convertcpp.h"
extern "C" {
#include "php_intl.h"
#define USE_DATETIMEPATTERNGENERATOR_POINTER 1
#include "datepatterngenerator_class.h"
#include <zend_exceptions.h>
#include <assert.h>
}
using icu::DateTimePatternGenerator;
using icu::Locale;
using icu::StringPiece;
static zend_result dtpg_ctor(INTERNAL_FUNCTION_PARAMETERS)
{
char *locale_str;
size_t locale_len = 0;
IntlDatePatternGenerator_object* dtpgo;
intl_error_reset(NULL);
zval *object = return_value;
ZEND_PARSE_PARAMETERS_START(0, 1)
Z_PARAM_OPTIONAL
Z_PARAM_STRING_OR_NULL(locale_str, locale_len)
ZEND_PARSE_PARAMETERS_END_EX(return FAILURE);
DTPATTERNGEN_METHOD_FETCH_OBJECT_NO_CHECK;
if (dtpgo->dtpg != NULL) {
intl_errors_set(DTPATTERNGEN_ERROR_P(dtpgo), U_ILLEGAL_ARGUMENT_ERROR, "Cannot call constructor twice");
return FAILURE;
}
INTL_CHECK_LOCALE_LEN_OR_FAILURE(locale_len);
if (locale_len == 0) {
locale_str = (char *) intl_locale_get_default();
}
Locale locale = Locale::createFromName(locale_str);
dtpgo->dtpg = DateTimePatternGenerator::createInstance(
locale,
DTPATTERNGEN_ERROR_CODE(dtpgo));
if (U_FAILURE(DTPATTERNGEN_ERROR_CODE(dtpgo))) {
intl_error_set(NULL, DTPATTERNGEN_ERROR_CODE(dtpgo),
"Error creating DateTimePatternGenerator");
return FAILURE;
}
return SUCCESS;
}
U_CFUNC PHP_METHOD( IntlDatePatternGenerator, create )
{
object_init_ex( return_value, IntlDatePatternGenerator_ce_ptr );
if (dtpg_ctor(INTERNAL_FUNCTION_PARAM_PASSTHRU) == FAILURE) {
zval_ptr_dtor(return_value);
RETURN_NULL();
}
}
U_CFUNC PHP_METHOD( IntlDatePatternGenerator, __construct )
{
const bool old_use_exception = INTL_G(use_exceptions);
const zend_long old_error_level = INTL_G(error_level);
INTL_G(use_exceptions) = true;
INTL_G(error_level) = 0;
/* return_value param is being changed, therefore we will always return
* NULL here */
return_value = ZEND_THIS;
if (dtpg_ctor(INTERNAL_FUNCTION_PARAM_PASSTHRU) == FAILURE) {
ZEND_ASSERT(EG(exception));
}
INTL_G(use_exceptions) = old_use_exception;
INTL_G(error_level) = old_error_level;
}
U_CFUNC PHP_METHOD( IntlDatePatternGenerator, getBestPattern )
{
char *skeleton_str = NULL;
size_t skeleton_len;
UnicodeString skeleton_uncleaned;
DTPATTERNGEN_METHOD_INIT_VARS;
/* Parse parameters. */
if( zend_parse_method_parameters( ZEND_NUM_ARGS(), getThis(), "Os",
&object, IntlDatePatternGenerator_ce_ptr, &skeleton_str, &skeleton_len ) == FAILURE )
{
RETURN_THROWS();
}
DTPATTERNGEN_METHOD_FETCH_OBJECT;
intl_stringFromChar(skeleton_uncleaned, skeleton_str, skeleton_len, DTPATTERNGEN_ERROR_CODE_P(dtpgo));
INTL_METHOD_CHECK_STATUS(dtpgo, "Skeleton is not a valid UTF-8 string");
UnicodeString skeleton = dtpgo->dtpg->getSkeleton(skeleton_uncleaned, DTPATTERNGEN_ERROR_CODE(dtpgo));
INTL_METHOD_CHECK_STATUS(dtpgo, "Error getting cleaned skeleton");
UnicodeString result = dtpgo->dtpg->getBestPattern(skeleton, DTPATTERNGEN_ERROR_CODE(dtpgo));
INTL_METHOD_CHECK_STATUS(dtpgo, "Error retrieving pattern");
zend_string *u8str = intl_charFromString(result, DTPATTERNGEN_ERROR_CODE_P(dtpgo));
INTL_METHOD_CHECK_STATUS(dtpgo, "Error converting result to UTF-8");
RETVAL_STR(u8str);
}