1 /*
2    +----------------------------------------------------------------------+
3    | Copyright (c) The PHP Group                                          |
4    +----------------------------------------------------------------------+
5    | This source file is subject to version 3.01 of the PHP license,      |
6    | that is bundled with this package in the file LICENSE, and is        |
7    | available through the world-wide-web at the following url:           |
8    | https://www.php.net/license/3_01.txt                                 |
9    | If you did not receive a copy of the PHP license and are unable to   |
10    | obtain it through the world-wide-web, please send a note to          |
11    | license@php.net so we can mail you a copy immediately.               |
12    +----------------------------------------------------------------------+
13    | Author: Wez Furlong <wez@thebrainroom.com>                           |
14    +----------------------------------------------------------------------+
15  */
16 
17 #ifndef PHP_COM_DOTNET_INTERNAL_H
18 #define PHP_COM_DOTNET_INTERNAL_H
19 
20 #define _WIN32_DCOM
21 #define COBJMACROS
22 #include <ocidl.h>
23 #include <oleauto.h>
24 #include <unknwn.h>
25 #include <dispex.h>
26 #include "win32/winutil.h"
27 
28 typedef struct _php_com_dotnet_object {
29 	zend_object zo;
30 
31 	VARIANT v;
32 	bool modified;
33 
34 	int code_page;
35 
36 	ITypeInfo *typeinfo;
37 
38 	zend_class_entry *ce;
39 
40    	/* associated event sink */
41 	IDispatch *sink_dispatch;
42 	GUID sink_id;
43 	DWORD sink_cookie;
44 
45 	/* cache for method signatures */
46 	HashTable *method_cache;
47 	/* cache for name -> DISPID */
48 	HashTable *id_of_name_cache;
49 } php_com_dotnet_object;
50 
php_com_is_valid_object(zval * zv)51 static inline bool php_com_is_valid_object(zval *zv)
52 {
53 	zend_class_entry *ce = Z_OBJCE_P(zv);
54 	return zend_string_equals_literal(ce->name, "com") ||
55 		zend_string_equals_literal(ce->name, "dotnet") ||
56 		zend_string_equals_literal(ce->name, "variant");
57 }
58 
59 #define CDNO_FETCH(zv)			(php_com_dotnet_object*)Z_OBJ_P(zv)
60 #define CDNO_FETCH_VERIFY(obj, zv)	do { \
61 	if (!php_com_is_valid_object(zv)) { \
62 		php_com_throw_exception(E_UNEXPECTED, "expected a variant object"); \
63 		return; \
64 	} \
65 	obj = (php_com_dotnet_object*)Z_OBJ_P(zv); \
66 } while(0)
67 
68 /* com_extension.c */
69 zend_class_entry *php_com_variant_class_entry, *php_com_exception_class_entry, *php_com_saproxy_class_entry;
70 
71 /* com_handlers.c */
72 zend_object* php_com_object_new(zend_class_entry *ce);
73 zend_object* php_com_object_clone(zend_object *object);
74 void php_com_object_free_storage(zend_object *object);
75 extern zend_object_handlers php_com_object_handlers;
76 void php_com_object_enable_event_sink(php_com_dotnet_object *obj, bool enable);
77 
78 /* com_saproxy.c */
79 zend_object_iterator *php_com_saproxy_iter_get(zend_class_entry *ce, zval *object, int by_ref);
80 void php_com_saproxy_create(zend_object *com_object, zval *proxy_out, zval *index);
81 extern zend_object_handlers php_com_saproxy_handlers;
82 
83 /* com_olechar.c */
84 PHP_COM_DOTNET_API zend_string *php_com_olestring_to_string(OLECHAR *olestring, int codepage);
85 PHP_COM_DOTNET_API OLECHAR *php_com_string_to_olestring(const char *string,
86 		size_t string_len, int codepage);
87 BSTR php_com_string_to_bstr(zend_string *string, int codepage);
88 zend_string *php_com_bstr_to_string(BSTR bstr, int codepage);
89 
90 
91 /* com_com.c */
92 PHP_METHOD(com, __construct);
93 
94 HRESULT php_com_invoke_helper(php_com_dotnet_object *obj, DISPID id_member,
95 		WORD flags, DISPPARAMS *disp_params, VARIANT *v, bool silent, bool allow_noarg);
96 HRESULT php_com_get_id_of_name(php_com_dotnet_object *obj, zend_string *name,
97 		DISPID *dispid);
98 zend_result php_com_do_invoke_by_id(php_com_dotnet_object *obj, DISPID dispid,
99 		WORD flags,	VARIANT *v, int nargs, zval *args, bool silent, bool allow_noarg);
100 zend_result php_com_do_invoke(php_com_dotnet_object *obj, zend_string *name,
101 		WORD flags,	VARIANT *v, int nargs, zval *args, bool allow_noarg);
102 zend_result php_com_do_invoke_byref(php_com_dotnet_object *obj, zend_internal_function *f,
103 		WORD flags,	VARIANT *v, int nargs, zval *args);
104 
105 /* com_wrapper.c */
106 int php_com_wrapper_minit(INIT_FUNC_ARGS);
107 PHP_COM_DOTNET_API IDispatch *php_com_wrapper_export_as_sink(zval *val, GUID *sinkid, HashTable *id_to_name);
108 PHP_COM_DOTNET_API IDispatch *php_com_wrapper_export(zval *val);
109 
110 /* com_persist.c */
111 void php_com_persist_minit(INIT_FUNC_ARGS);
112 
113 /* com_variant.c */
114 PHP_METHOD(variant, __construct);
115 
116 PHP_COM_DOTNET_API void php_com_variant_from_zval_with_type(VARIANT *v, zval *z, VARTYPE type, int codepage);
117 PHP_COM_DOTNET_API void php_com_variant_from_zval(VARIANT *v, zval *z, int codepage);
118 PHP_COM_DOTNET_API zend_result php_com_zval_from_variant(zval *z, VARIANT *v, int codepage);
119 PHP_COM_DOTNET_API zend_result php_com_copy_variant(VARIANT *dst, VARIANT *src);
120 
121 /* com_dotnet.c */
122 PHP_METHOD(dotnet, __construct);
123 void php_com_dotnet_rshutdown(void);
124 void php_com_dotnet_mshutdown(void);
125 
126 /* com_misc.c */
127 void php_com_throw_exception(HRESULT code, char *message);
128 PHP_COM_DOTNET_API void php_com_wrap_dispatch(zval *z, IDispatch *disp,
129 		int codepage);
130 PHP_COM_DOTNET_API void php_com_wrap_variant(zval *z, VARIANT *v,
131 		int codepage);
132 PHP_COM_DOTNET_API bool php_com_safearray_get_elem(VARIANT *array, VARIANT *dest, LONG dim1);
133 
134 /* com_typeinfo.c */
135 PHP_COM_DOTNET_API ITypeLib *php_com_load_typelib_via_cache(const char *search_string, int codepage);
136 PHP_COM_DOTNET_API ITypeLib *php_com_load_typelib(char *search_string, int codepage);
137 PHP_COM_DOTNET_API zend_result php_com_import_typelib(ITypeLib *TL, int mode, int codepage);
138 void php_com_typelibrary_dtor(zval *pDest);
139 ITypeInfo *php_com_locate_typeinfo(zend_string *type_lib_name, php_com_dotnet_object *obj,
140 		zend_string *dispatch_name, bool sink);
141 bool php_com_process_typeinfo(ITypeInfo *typeinfo, HashTable *id_to_name, bool printdef, GUID *guid, int codepage);
142 ITypeLib *php_com_cache_typelib(ITypeLib* TL, char *cache_key, zend_long cache_key_len);
143 PHP_MINIT_FUNCTION(com_typeinfo);
144 PHP_MSHUTDOWN_FUNCTION(com_typeinfo);
145 
146 /* com_iterator.c */
147 zend_object_iterator *php_com_iter_get(zend_class_entry *ce, zval *object, int by_ref);
148 
149 
150 #endif
151