root/trunk/midgard/apis/php5/php_midgard.h

/* $Id$
Copyright (C) 1999 Jukka Zitting <jukka.zitting@iki.fi>
Copyright (C) 2000 The Midgard Project ry
Copyright (C) 2006 Piotr Pokora <piotrek.pokora@gmail.com>

This program is free software; you can redistribute it and/or modify it
under the terms of the GNU Lesser General Public License as published
by the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
*/

#ifdef G_LOG_DOMAIN
#undef G_LOG_DOMAIN
#define G_LOG_DOMAIN "midgard-core"
#endif

#ifndef PHP_MIDGARD_H
#define PHP_MIDGARD_H

#include "config.h"

#ifdef PHP_WIN32
#include "config.w32.h"
#endif

#ifndef PHP_CONFIG_H
#define PHP_CONFIG_H
#include "php_config.h"
#endif

/* Do not load Apache regex when php compiled with 'system' as regex's TYPE */
#if REGEX == 0
#ifndef _REGEX_H
#define _REGEX_H 1
#endif
#endif

#include "php.h"
#include "php_globals.h"
#include "ext/standard/info.h"
#include "ext/standard/php_var.h"
#include "SAPI.h"
#include "ext/standard/php_standard.h"
#include "ext/standard/php_smart_str.h"
#include "ext/standard/info.h"

#if HAVE_MIDGARD

#define MGD_FUNCTION(ret, name, param) \
        PHP_FUNCTION(mgd_##name)

#define MGD_FE(name, arg_types) \
        PHP_FE(mgd_##name, arg_types)

#include <midgard/midgard.h>
#include <midgard/midgard_http_host.h>

#ifdef ZTS
#include <TSRM.h>
#endif

extern MidgardConnection *mgd_handle();
extern void mgd_handle_set(MidgardConnection *mgd);
extern guint global_loghandler;

int mgd_get_errno();
void mgd_reset_errno();
void mgd_set_errno(MgdErrorGeneric mgd_errno);

extern zend_module_entry midgard2_module_entry;

#ifdef ZTS
typedef struct {
         MidgardConnection *mgd;
         zval *schema_types;
} midgard2_globals;
#endif

#define phpext_midgard_ptr &midgard2_module_entry

#ifdef PHP_WIN32
#define PHP_MIDGARD_API __declspec(dllexport)
#else
#define PHP_MIDGARD_API
#endif

PHP_MINIT_FUNCTION(midgard2);
PHP_MSHUTDOWN_FUNCTION(midgard2);
PHP_RINIT_FUNCTION(midgard2);
PHP_RSHUTDOWN_FUNCTION(midgard2);
PHP_MINFO_FUNCTION(midgard2);

PHP_FUNCTION(confirm_midgard2_compiled);        /* For testing, remove later. */

ZEND_BEGIN_MODULE_GLOBALS(midgard2)
        MidgardConnection *mgd;
ZEND_END_MODULE_GLOBALS(midgard2)

/* ZEND_EXTERN_MODULE_GLOBALS(midgard)  */

#ifdef ZTS 

#define MGDG(v) TSRMG(midgard2_globals_id, zend_midgard2_globals *, v)
/* #define MGDLS_FETCH() php_midgard2_globals *midgard_globals = ts_resource(midgard2_globals_id) */
/* TODO , make sure if we need to get midgard_globals_id from thread safety resources.
 * TSRMLS_FETCH() macro seems to do the same
 */ 
#define MGDLS_FETCH() 
#else
#define MGDG(v) (midgard2_globals.v)
#define MGDLS_FETCH()
#endif

#else

#define phpext_midgard2_ptr NULL

#endif

PHP_FUNCTION(_midgard_php_object_constructor);
/* FIXME , change name */
PHP_FUNCTION(_get_type_by_id);
PHP_FUNCTION(_midgard_php_object_get_by_guid);
PHP_FUNCTION(_midgard_php_object_update);
PHP_FUNCTION(_midgard_php_object_create);
PHP_FUNCTION(_midgard_php_object_is_in_parent_tree);
PHP_FUNCTION(_midgard_php_object_is_in_tree);
PHP_FUNCTION(_midgard_php_object_get_tree);
PHP_FUNCTION(_midgard_php_object_delete);
PHP_FUNCTION(_midgard_php_object_get_parent);
PHP_FUNCTION(_midgard_php_object_get);
PHP_FUNCTION(_midgard_php_object_list);
PHP_FUNCTION(_midgard_php_object_list_children);
PHP_FUNCTION(_midgard_php_object_get_by_path);
PHP_FUNCTION(_midgard_php_object_parent);
PHP_FUNCTION(_php_midgard_object_get_languages);
PHP_FUNCTION(_php_midgard_object_purge);
PHP_FUNCTION(_php_midgard_object_undelete);
PHP_FUNCTION(_php_midgard_object_parameter);
PHP_FUNCTION(_php_midgard_object_connect);

MGD_FUNCTION(ret_type, import_object, (type param));
MGD_FUNCTION(ret_type, get_class_data, (type param));
MGD_FUNCTION(ret_type, get_class_property, (type param));
MGD_FUNCTION(ret_type, get_class_properties, (type param));
MGD_FUNCTION(ret_type, get_sitegroup_size, (type param));

#define MGD_PHP_BCLASS_FROM_NAME(classname) \
        guint name_length; \
        zend_class_entry *__bce, **__ce; \
        gchar *lower_class_name; \
        name_length = strlen(classname); \
        lower_class_name = g_ascii_strdown(classname, name_length); \
        if (zend_hash_find(CG(class_table), \
        lower_class_name, name_length+1, (void **) &__ce)  == SUCCESS) { \
                __bce = php_midgard_get_baseclass_ptr(*__ce); \
                zend_classname = __bce->name; \
                g_free(lower_class_name); \
        } else { \
                g_free(lower_class_name); \
                php_error(E_ERROR, "%s is not registered class", classname); \
        }

/* Underlying GObject bindings */
zval *php_midgard_gobject_read_property(zval *zobject, zval *prop, int type TSRMLS_DC);
void php_midgard_gobject_write_property(zval *zobject, zval *prop, zval *value TSRMLS_DC);
void php_midgard_zendobject_register_properties (zval *zobject, GObject *gobject);
int php_midgard_gobject_has_property(zval *zobject, zval *prop, int type TSRMLS_DC);
HashTable *php_midgard_zendobject_get_properties (zval *zobject TSRMLS_DC);

extern MgdObject *php_midgard_get_midgard_object(zval *zobj);
extern void php_midgard_array_from_objects(GObject **objects, const gchar *class_name, zval *zarray);

extern GValue *php_midgard_zval2gvalue(zval *zvalue);
extern gboolean php_midgard_gvalue2zval(GValue *gvalue, zval *zvalue);

extern GParameter *php_midgard_array_to_gparameter(zval *params, guint *n_params);

extern zend_class_entry *php_midgard_get_baseclass_ptr_by_name(const gchar *name);

/* closures */
void php_midgard_object_connect_class_closures(GObject *object, zval *zobject);
void php_midgard_gobject_closure_hash_new();
void php_midgard_gobject_closure_hash_reset();
void php_midgard_gobject_closure_hash_free();

zend_class_entry *midgard_php_register_internal_class(
        const gchar *class_name, GType class_type, zend_class_entry ce,
        function_entry *fe);
        
/* Midgard core's classes */    
extern void php_midgard_collector_init(int module_number);
extern void php_midgard_config_init(int module_number);
extern void php_midgard_user_init(int module_number);
extern void php_midgard_blob_init(int module_number);
extern void php_midgard_sitegroup_init(int module_number);
extern void php_midgard_query_builder_init(int module_number);
extern void php_midgard_object_class_init(int module_number);
extern void php_midgard_request_config_init(int module_number);
extern void php_midgard_reflection_property_init(int module_number);
extern void php_midgard_connection_init(int module_number);
extern void php_midgard_object_init(int module_number);
extern void php_midgard_dbus_init(int module_number);
extern void php_midgard_replicator_init(int module_number);

zend_class_entry *php_midgard_get_baseclass_ptr(zend_class_entry *ce);
zend_class_entry *php_midgard_get_baseclass_ptr_by_name(const gchar *name);

void php_midgard_log_errors(const gchar *domain, GLogLevelFlags level,
                const gchar *msg, gpointer userdata);

gboolean php_midgard_error_throw_exception(MidgardConnection *mgd);

/* ROUTINES */
extern void php_midgard_initialize_request_for_http(MidgardHttpHost *host);

#define CHECK_MGD \
        if (!mgd_handle()) \
                php_error(E_ERROR, "Can not find MidgardConnection"); \
        gchar *_check_cname_space = NULL; \
        gchar *_check_class_name = get_active_class_name(&_check_cname_space TSRMLS_CC); \
        g_log("midgard-core", G_LOG_LEVEL_INFO, \
                " %s%s%s(...)", _check_class_name, _check_cname_space, \
                get_active_function_name(TSRMLS_C));

#endif  /* PHP_MIDGARD_H */

/*
 * Local variables:
 * tab-width: 4
 * c-basic-offset: 4
 * End:
 */