root/intl/resourcebundle/resourcebundle_class.c

/* [<][>][^][v][top][bottom][index][help] */

DEFINITIONS

This source file includes following definitions.
  1. ResourceBundle_object_destroy
  2. ResourceBundle_object_create
  3. resourcebundle_ctor
  4. ZEND_BEGIN_ARG_INFO_EX
  5. PHP_FUNCTION
  6. resourcebundle_array_fetch
  7. resourcebundle_array_get
  8. ZEND_BEGIN_ARG_INFO_EX
  9. resourcebundle_array_count
  10. ZEND_BEGIN_ARG_INFO_EX
  11. ZEND_BEGIN_ARG_INFO_EX
  12. ZEND_BEGIN_ARG_INFO_EX
  13. ZEND_BEGIN_ARG_INFO_EX
  14. resourcebundle_register_class

/*
   +----------------------------------------------------------------------+
   | PHP Version 5                                                        |
   +----------------------------------------------------------------------+
   | 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:           |
   | http://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: Hans-Peter Oeri (University of St.Gallen) <hp@oeri.ch>      |
   +----------------------------------------------------------------------+
 */

#include <stdlib.h>
#include <unicode/ures.h>
#include <unicode/uenum.h>

#include <zend.h>
#include <Zend/zend_exceptions.h>
#include <Zend/zend_interfaces.h>
#include <php.h>

#include "php_intl.h"
#include "intl_data.h"

#include "resourcebundle/resourcebundle.h"
#include "resourcebundle/resourcebundle_iterator.h"
#include "resourcebundle/resourcebundle_class.h"

zend_class_entry *ResourceBundle_ce_ptr = NULL;

static zend_object_handlers ResourceBundle_object_handlers;

/* {{{ ResourceBundle_object_dtor */
static void ResourceBundle_object_destroy( void *object, zend_object_handle handle TSRMLS_DC )
{
        ResourceBundle_object *rb = (ResourceBundle_object *) object;

        // only free local errors
        intl_error_reset( INTL_DATA_ERROR_P(rb) TSRMLS_CC );

        if (rb->me) {
                ures_close( rb->me );
        }
        if (rb->child) {
                ures_close( rb->child );
        }

        zend_object_std_dtor( object TSRMLS_CC );
        efree(object);
}
/* }}} */

/* {{{ ResourceBundle_object_create */
static zend_object_value ResourceBundle_object_create( zend_class_entry *ce TSRMLS_DC )
{
        zend_object_value     retval;
        ResourceBundle_object *rb;

        rb = ecalloc( 1, sizeof(ResourceBundle_object) );

        zend_object_std_init( (zend_object *) rb, ce TSRMLS_CC );
        object_properties_init((zend_object *) rb, ce);

        intl_error_init( INTL_DATA_ERROR_P(rb) TSRMLS_CC );
        rb->me = NULL;
        rb->child = NULL;

        retval.handlers = &ResourceBundle_object_handlers;
        retval.handle = zend_objects_store_put( rb, ResourceBundle_object_destroy, NULL, NULL TSRMLS_CC );

        return retval;
}
/* }}} */

/* {{{ ResourceBundle_ctor */
static void resourcebundle_ctor(INTERNAL_FUNCTION_PARAMETERS) 
{
        char *    bundlename;
        int       bundlename_len = 0;
        char *    locale;
        int       locale_len = 0;
        zend_bool fallback = 1;

        char *    pbuf;

        zval                  *object = return_value;
        ResourceBundle_object *rb = (ResourceBundle_object *) zend_object_store_get_object( object TSRMLS_CC);

        intl_error_reset( NULL TSRMLS_CC );

        if( zend_parse_parameters( ZEND_NUM_ARGS() TSRMLS_CC, "s!s!|b", 
                &locale, &locale_len, &bundlename, &bundlename_len, &fallback ) == FAILURE )
        {
                intl_error_set( NULL, U_ILLEGAL_ARGUMENT_ERROR,
                        "resourcebundle_ctor: unable to parse input parameters", 0 TSRMLS_CC );
                zval_dtor( return_value );
                RETURN_NULL();
        }

        INTL_CHECK_LOCALE_LEN_OBJ(locale_len, return_value);
        
        if (locale == NULL) {
                locale = INTL_G(default_locale);
        }

        if (fallback) {
                rb->me = ures_open(bundlename, locale, &INTL_DATA_ERROR_CODE(rb));
        } else {
                rb->me = ures_openDirect(bundlename, locale, &INTL_DATA_ERROR_CODE(rb));
        }

        INTL_CTOR_CHECK_STATUS(rb, "resourcebundle_ctor: Cannot load libICU resource bundle");

        if (!fallback && (INTL_DATA_ERROR_CODE(rb) == U_USING_FALLBACK_WARNING ||
                        INTL_DATA_ERROR_CODE(rb) == U_USING_DEFAULT_WARNING)) {
                intl_errors_set_code(NULL, INTL_DATA_ERROR_CODE(rb) TSRMLS_CC);
                spprintf(&pbuf, 0, "resourcebundle_ctor: Cannot load libICU resource "
                                "'%s' without fallback from %s to %s",
                                bundlename ? bundlename : "(default data)", locale,
                                ures_getLocaleByType(
                                        rb->me, ULOC_ACTUAL_LOCALE, &INTL_DATA_ERROR_CODE(rb)));
                intl_errors_set_custom_msg(INTL_DATA_ERROR_P(rb), pbuf, 1 TSRMLS_CC);
                efree(pbuf);
                zval_dtor(return_value);
                RETURN_NULL();
        }
}
/* }}} */

/* {{{ arginfo_resourcebundle__construct */
ZEND_BEGIN_ARG_INFO_EX( arginfo_resourcebundle___construct, 0, 0, 2 )
        ZEND_ARG_INFO( 0, locale )
        ZEND_ARG_INFO( 0, bundlename )
        ZEND_ARG_INFO( 0, fallback )
ZEND_END_ARG_INFO()
/* }}} */

/* {{{ proto void ResourceBundle::__construct( string $locale [, string $bundlename [, bool $fallback = true ]] )
 * ResourceBundle object constructor
 */
PHP_METHOD( ResourceBundle, __construct )
{
        return_value = getThis();
        resourcebundle_ctor(INTERNAL_FUNCTION_PARAM_PASSTHRU);
}
/* }}} */

/* {{{ proto ResourceBundle ResourceBundle::create( string $locale [, string $bundlename [, bool $fallback = true ]] )
proto ResourceBundle resourcebundle_create( string $locale [, string $bundlename [, bool $fallback = true ]] )
*/
PHP_FUNCTION( resourcebundle_create ) 
{
        object_init_ex( return_value, ResourceBundle_ce_ptr );
        resourcebundle_ctor(INTERNAL_FUNCTION_PARAM_PASSTHRU);
}
/* }}} */

/* {{{ resourcebundle_array_fetch */
static void resourcebundle_array_fetch(zval *object, zval *offset, zval *return_value, int fallback TSRMLS_DC) 
{
        int32_t     meindex;
        char *      mekey;
        long        mekeylen;
    zend_bool    is_numeric = 0;
        char         *pbuf;
        ResourceBundle_object *rb;

        intl_error_reset( NULL TSRMLS_CC );     
        RESOURCEBUNDLE_METHOD_FETCH_OBJECT;

        if(Z_TYPE_P(offset) == IS_LONG) {
                is_numeric = 1;
                meindex = Z_LVAL_P(offset);
                rb->child = ures_getByIndex( rb->me, meindex, rb->child, &INTL_DATA_ERROR_CODE(rb) );
        } else if(Z_TYPE_P(offset) == IS_STRING) {
                mekey = Z_STRVAL_P(offset);
                mekeylen = Z_STRLEN_P(offset);
                rb->child = ures_getByKey(rb->me, mekey, rb->child, &INTL_DATA_ERROR_CODE(rb) );
        } else {
                intl_errors_set(INTL_DATA_ERROR_P(rb), U_ILLEGAL_ARGUMENT_ERROR,        
                        "resourcebundle_get: index should be integer or string", 0 TSRMLS_CC);
                RETURN_NULL();
        }

        intl_error_set_code( NULL, INTL_DATA_ERROR_CODE(rb) TSRMLS_CC );        
        if (U_FAILURE(INTL_DATA_ERROR_CODE(rb))) {
                if (is_numeric) {
                        spprintf( &pbuf, 0, "Cannot load resource element %d", meindex );
                } else {
                        spprintf( &pbuf, 0, "Cannot load resource element '%s'", mekey );
                }
                intl_errors_set_custom_msg( INTL_DATA_ERROR_P(rb), pbuf, 1 TSRMLS_CC );
                efree(pbuf);
                RETURN_NULL();
        }

        if (!fallback && (INTL_DATA_ERROR_CODE(rb) == U_USING_FALLBACK_WARNING || INTL_DATA_ERROR_CODE(rb) == U_USING_DEFAULT_WARNING)) {
                UErrorCode icuerror;
                const char * locale = ures_getLocaleByType( rb->me, ULOC_ACTUAL_LOCALE, &icuerror );
                if (is_numeric) {
                        spprintf( &pbuf, 0, "Cannot load element %d without fallback from to %s", meindex, locale );
                } else {
                        spprintf( &pbuf, 0, "Cannot load element '%s' without fallback from to %s", mekey, locale );
                }
                intl_errors_set_custom_msg( INTL_DATA_ERROR_P(rb), pbuf, 1 TSRMLS_CC );
                efree(pbuf);
                RETURN_NULL();
        }

        resourcebundle_extract_value( return_value, rb TSRMLS_CC );
}
/* }}} */

/* {{{ resourcebundle_array_get */
zval *resourcebundle_array_get(zval *object, zval *offset, int type TSRMLS_DC) 
{
        zval *retval;

        if(offset == NULL) {
                php_error( E_ERROR, "Cannot apply [] to ResourceBundle object" );
        }
        MAKE_STD_ZVAL(retval);

        resourcebundle_array_fetch(object, offset, retval, 1 TSRMLS_CC);
        Z_DELREF_P(retval);
        return retval;
}
/* }}} */

/* {{{ arginfo_resourcebundle_get */
ZEND_BEGIN_ARG_INFO_EX( arginfo_resourcebundle_get, 0, 0, 1 )
        ZEND_ARG_INFO( 0, index )
        ZEND_ARG_INFO( 0, fallback )
ZEND_END_ARG_INFO()
/* }}} */

/* {{{ proto mixed ResourceBundle::get( integer|string $resindex [, bool $fallback = true ] )
 * proto mixed resourcebundle_get( ResourceBundle $rb, integer|string $resindex [, bool $fallback = true ] )
 * Get resource identified by numerical index or key name.
 */
PHP_FUNCTION( resourcebundle_get )
{
        zend_bool   fallback = 1;
        zval *          offset;
        zval *      object;

        if (zend_parse_method_parameters(ZEND_NUM_ARGS() TSRMLS_CC, getThis(), "Oz|b",  &object, ResourceBundle_ce_ptr, &offset, &fallback ) == FAILURE) {
                intl_error_set(NULL, U_ILLEGAL_ARGUMENT_ERROR,  
                        "resourcebundle_get: unable to parse input params", 0 TSRMLS_CC);
                RETURN_FALSE;
        }

        resourcebundle_array_fetch(object, offset, return_value, fallback TSRMLS_CC);
}
/* }}} */

/* {{{ resourcebundle_array_count */
int resourcebundle_array_count(zval *object, long *count TSRMLS_DC) 
{
        ResourceBundle_object *rb;
        RESOURCEBUNDLE_METHOD_FETCH_OBJECT_NO_CHECK;

        if (rb->me == NULL) {
                intl_errors_set(&rb->error, U_ILLEGAL_ARGUMENT_ERROR,
                                "Found unconstructed ResourceBundle", 0 TSRMLS_CC);
                return 0;
        }

        *count = ures_getSize( rb->me );

        return SUCCESS;
}
/* }}} */

/* {{{ arginfo_resourcebundle_count */
ZEND_BEGIN_ARG_INFO_EX( arginfo_resourcebundle_count, 0, 0, 0 )
ZEND_END_ARG_INFO()
/* }}} */

/* {{{ proto int ResourceBundle::count()
 * proto int resourcebundle_count( ResourceBundle $bundle )
 * Get resources count
 */
PHP_FUNCTION( resourcebundle_count )
{
        int32_t                len;
        RESOURCEBUNDLE_METHOD_INIT_VARS;

        if( zend_parse_method_parameters( ZEND_NUM_ARGS() TSRMLS_CC, getThis(), "O", &object, ResourceBundle_ce_ptr ) == FAILURE ) {
                intl_error_set(NULL, U_ILLEGAL_ARGUMENT_ERROR,  
                        "resourcebundle_count: unable to parse input params", 0 TSRMLS_CC);
                RETURN_FALSE;
        }

        RESOURCEBUNDLE_METHOD_FETCH_OBJECT;

        len = ures_getSize( rb->me );
        RETURN_LONG( len );
}

/* {{{ arginfo_resourcebundle_getlocales */
ZEND_BEGIN_ARG_INFO_EX( arginfo_resourcebundle_getlocales, 0, 0, 1 )
        ZEND_ARG_INFO( 0, bundlename )
ZEND_END_ARG_INFO()
/* }}} */

/* {{{ proto array ResourceBundle::getLocales( string $bundlename )
 * proto array resourcebundle_locales( string $bundlename )
 * Get available locales from ResourceBundle name
 */
PHP_FUNCTION( resourcebundle_locales )
{
        char * bundlename;
        int    bundlename_len = 0;
        const char * entry;
        int entry_len;
        UEnumeration *icuenum;
        UErrorCode   icuerror = U_ZERO_ERROR;

        intl_errors_reset( NULL TSRMLS_CC );

        if( zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s", &bundlename, &bundlename_len ) == FAILURE )
        {
                intl_error_set(NULL, U_ILLEGAL_ARGUMENT_ERROR,  
                        "resourcebundle_locales: unable to parse input params", 0 TSRMLS_CC);
                RETURN_FALSE;
        }

        if(bundlename_len == 0) {
                // fetch default locales list
                bundlename = NULL;
        }

        icuenum = ures_openAvailableLocales( bundlename, &icuerror );
        INTL_CHECK_STATUS(icuerror, "Cannot fetch locales list");               

        uenum_reset( icuenum, &icuerror );
        INTL_CHECK_STATUS(icuerror, "Cannot iterate locales list");             

        array_init( return_value );
        while ((entry = uenum_next( icuenum, &entry_len, &icuerror ))) {
                add_next_index_stringl( return_value, (char *) entry, entry_len, 1 );
        }
        uenum_close( icuenum );
}
/* }}} */

/* {{{ arginfo_resourcebundle_get_error_code */
ZEND_BEGIN_ARG_INFO_EX( arginfo_resourcebundle_get_error_code, 0, 0, 0 )
ZEND_END_ARG_INFO()
/* }}} */

/* {{{ proto string ResourceBundle::getErrorCode( )
 * proto string resourcebundle_get_error_code( ResourceBundle $bundle )
 * Get text description for ResourceBundle's last error code.
 */
PHP_FUNCTION( resourcebundle_get_error_code )
{
        RESOURCEBUNDLE_METHOD_INIT_VARS;

        if( zend_parse_method_parameters( ZEND_NUM_ARGS() TSRMLS_CC, getThis(), "O",
                &object, ResourceBundle_ce_ptr ) == FAILURE )
        {
                intl_error_set( NULL, U_ILLEGAL_ARGUMENT_ERROR,
                        "resourcebundle_get_error_code: unable to parse input params", 0 TSRMLS_CC );
                RETURN_FALSE;
        }

        rb = (ResourceBundle_object *) zend_object_store_get_object( object TSRMLS_CC );

        RETURN_LONG(INTL_DATA_ERROR_CODE(rb));
}
/* }}} */

/* {{{ arginfo_resourcebundle_get_error_message */
ZEND_BEGIN_ARG_INFO_EX( arginfo_resourcebundle_get_error_message, 0, 0, 0 )
ZEND_END_ARG_INFO()
/* }}} */

/* {{{ proto string ResourceBundle::getErrorMessage( )
 * proto string resourcebundle_get_error_message( ResourceBundle $bundle )
 * Get text description for ResourceBundle's last error.
 */
PHP_FUNCTION( resourcebundle_get_error_message )
{
        char* message = NULL;
        RESOURCEBUNDLE_METHOD_INIT_VARS;

        if( zend_parse_method_parameters( ZEND_NUM_ARGS() TSRMLS_CC, getThis(), "O",
                &object, ResourceBundle_ce_ptr ) == FAILURE )
        {
                intl_error_set( NULL, U_ILLEGAL_ARGUMENT_ERROR,
                        "resourcebundle_get_error_message: unable to parse input params", 0 TSRMLS_CC );
                RETURN_FALSE;
        }

        rb = (ResourceBundle_object *) zend_object_store_get_object( object TSRMLS_CC );
        message = (char *)intl_error_get_message(INTL_DATA_ERROR_P(rb) TSRMLS_CC);
        RETURN_STRING(message, 0);
}
/* }}} */

/* {{{ ResourceBundle_class_functions
 * Every 'ResourceBundle' class method has an entry in this table
 */
static zend_function_entry ResourceBundle_class_functions[] = {
        PHP_ME( ResourceBundle, __construct, arginfo_resourcebundle___construct, ZEND_ACC_PUBLIC|ZEND_ACC_CTOR )
        ZEND_NAMED_ME( create, ZEND_FN( resourcebundle_create ), arginfo_resourcebundle___construct, ZEND_ACC_PUBLIC|ZEND_ACC_STATIC )
        ZEND_NAMED_ME( get, ZEND_FN(resourcebundle_get), arginfo_resourcebundle_get, ZEND_ACC_PUBLIC )
        ZEND_NAMED_ME( count, ZEND_FN(resourcebundle_count), arginfo_resourcebundle_count, ZEND_ACC_PUBLIC )
        ZEND_NAMED_ME( getLocales, ZEND_FN(resourcebundle_locales), arginfo_resourcebundle_getlocales, ZEND_ACC_PUBLIC | ZEND_ACC_STATIC )
        ZEND_NAMED_ME( getErrorCode, ZEND_FN(resourcebundle_get_error_code), arginfo_resourcebundle_get_error_code, ZEND_ACC_PUBLIC )
        ZEND_NAMED_ME( getErrorMessage, ZEND_FN(resourcebundle_get_error_message), arginfo_resourcebundle_get_error_message, ZEND_ACC_PUBLIC )
        PHP_FE_END
};
/* }}} */

/* {{{ resourcebundle_register_class
 * Initialize 'ResourceBundle' class
 */
void resourcebundle_register_class( TSRMLS_D )
{
        zend_class_entry ce;

        INIT_CLASS_ENTRY( ce, "ResourceBundle", ResourceBundle_class_functions );

        ce.create_object = ResourceBundle_object_create;
        ce.get_iterator = resourcebundle_get_iterator;

        ResourceBundle_ce_ptr = zend_register_internal_class( &ce TSRMLS_CC );

        if( !ResourceBundle_ce_ptr )
        {
                zend_error(E_ERROR, "Failed to register ResourceBundle class");
                return;
        }

        ResourceBundle_object_handlers = std_object_handlers;
        ResourceBundle_object_handlers.clone_obj          = NULL; /* ICU ResourceBundle has no clone implementation */
        ResourceBundle_object_handlers.read_dimension = resourcebundle_array_get;
        ResourceBundle_object_handlers.count_elements = resourcebundle_array_count;

        zend_class_implements(ResourceBundle_ce_ptr TSRMLS_CC, 1, zend_ce_traversable);
}
/* }}} */

/*
 * Local variables:
 * tab-width: 4
 * c-basic-offset: 4
 * End:
 * vim600: noet sw=4 ts=4 fdm=marker
 * vim<600: noet sw=4 ts=4
 */

/* [<][>][^][v][top][bottom][index][help] */