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 | Authors: Georg Richter <georg@php.net> |
14 | Andrey Hristov <andrey@php.net> |
15 | Ulf Wendel <uw@php.net> |
16 +----------------------------------------------------------------------+
17 */
18
19 #ifndef PHP_MYSQLI_STRUCTS_H
20 #define PHP_MYSQLI_STRUCTS_H
21
22 /* A little hack to prevent build break, when mysql is used together with
23 * c-client, which also defines LIST.
24 */
25 #ifdef LIST
26 #undef LIST
27 #endif
28
29 #include "ext/mysqlnd/mysqlnd.h"
30 #include "mysqli_mysqlnd.h"
31
32
33 #define MYSQLI_VERSION_ID 101009
34
35 enum mysqli_status {
36 MYSQLI_STATUS_UNKNOWN=0,
37 MYSQLI_STATUS_INITIALIZED,
38 MYSQLI_STATUS_VALID
39 };
40
41 typedef struct {
42 char *val;
43 zend_ulong buflen;
44 zend_ulong output_len;
45 zend_ulong type;
46 } VAR_BUFFER;
47
48 typedef struct {
49 unsigned int var_cnt;
50 VAR_BUFFER *buf;
51 zval *vars;
52 my_bool *is_null;
53 } BIND_BUFFER;
54
55 typedef struct {
56 MYSQL_STMT *stmt;
57 BIND_BUFFER param;
58 BIND_BUFFER result;
59 char *query;
60 } MY_STMT;
61
62 typedef struct {
63 MYSQL *mysql;
64 zend_string *hash_key;
65 zval li_read;
66 php_stream *li_stream;
67 unsigned int multi_query;
68 bool persistent;
69 int async_result_fetch_type;
70 } MY_MYSQL;
71
72 typedef struct {
73 void *ptr; /* resource: (mysql, result, stmt) */
74 void *info; /* additional buffer */
75 enum mysqli_status status; /* object status */
76 } MYSQLI_RESOURCE;
77
78 typedef struct _mysqli_object {
79 void *ptr;
80 HashTable *prop_handler;
81 zend_object zo;
82 } mysqli_object; /* extends zend_object */
83
php_mysqli_fetch_object(zend_object * obj)84 static inline mysqli_object *php_mysqli_fetch_object(zend_object *obj) {
85 return (mysqli_object *)((char*)(obj) - XtOffsetOf(mysqli_object, zo));
86 }
87
88 #define Z_MYSQLI_P(zv) php_mysqli_fetch_object(Z_OBJ_P((zv)))
89
90 typedef struct st_mysqli_warning MYSQLI_WARNING;
91
92 struct st_mysqli_warning {
93 zval reason;
94 zval sqlstate;
95 int errorno;
96 MYSQLI_WARNING *next;
97 };
98
99 typedef struct _mysqli_property_entry {
100 const char *pname;
101 size_t pname_length;
102 int (*r_func)(mysqli_object *obj, zval *retval, bool quiet);
103 int (*w_func)(mysqli_object *obj, zval *value);
104 } mysqli_property_entry;
105
106 typedef struct {
107 zend_ptr_stack free_links;
108 } mysqli_plist_entry;
109
110 #ifdef PHP_WIN32
111 #define PHP_MYSQLI_API __declspec(dllexport)
112 #ifndef L64
113 #define L64(x) x##i64
114 #endif
115 typedef __int64 my_longlong;
116 #else
117 # if defined(__GNUC__) && __GNUC__ >= 4
118 # define PHP_MYSQLI_API __attribute__ ((visibility("default")))
119 # else
120 # define PHP_MYSQLI_API
121 # endif
122 #ifndef L64
123 #define L64(x) x##LL
124 #endif
125 typedef int64_t my_longlong;
126 #endif
127
128 /* we need this for PRIu64 and PRId64 */
129 #include <inttypes.h>
130 #define MYSQLI_LLU_SPEC "%" PRIu64
131 #define MYSQLI_LL_SPEC "%" PRId64
132
133 #ifdef ZTS
134 #include "TSRM.h"
135 #endif
136
137 extern zend_class_entry *mysqli_link_class_entry;
138 extern zend_class_entry *mysqli_stmt_class_entry;
139 extern zend_class_entry *mysqli_result_class_entry;
140 extern zend_class_entry *mysqli_driver_class_entry;
141 extern zend_class_entry *mysqli_warning_class_entry;
142 extern zend_class_entry *mysqli_exception_class_entry;
143 extern int php_le_pmysqli(void);
144 extern void php_mysqli_dtor_p_elements(void *data);
145
146 extern void php_mysqli_close(MY_MYSQL * mysql, int close_type, int resource_status);
147
148 extern const zend_object_iterator_funcs php_mysqli_result_iterator_funcs;
149 extern zend_object_iterator *php_mysqli_result_get_iterator(zend_class_entry *ce, zval *object, int by_ref);
150
151 extern void php_mysqli_fetch_into_hash_aux(zval *return_value, MYSQL_RES * result, zend_long fetchtype);
152
153 #define MYSQLI_DISABLE_MQ if (mysql->multi_query) { \
154 mysql_set_server_option(mysql->mysql, MYSQL_OPTION_MULTI_STATEMENTS_OFF); \
155 mysql->multi_query = 0; \
156 }
157
158 #define MYSQLI_ENABLE_MQ if (!mysql->multi_query) { \
159 mysql_set_server_option(mysql->mysql, MYSQL_OPTION_MULTI_STATEMENTS_ON); \
160 mysql->multi_query = 1; \
161 }
162
163 #define MYSQLI_REGISTER_RESOURCE_EX(__ptr, __zval) \
164 (Z_MYSQLI_P(__zval))->ptr = __ptr;
165
166 #define MYSQLI_RETVAL_RESOURCE(__ptr, __ce) \
167 RETVAL_OBJ(mysqli_objects_new(__ce)); \
168 MYSQLI_REGISTER_RESOURCE_EX(__ptr, return_value)
169
170 #define MYSQLI_REGISTER_RESOURCE(__ptr, __ce) \
171 {\
172 zval *object = getThis(); \
173 if (!object || !instanceof_function(Z_OBJCE_P(object), mysqli_link_class_entry)) { \
174 object = return_value; \
175 ZVAL_OBJ(object, mysqli_objects_new(__ce)); \
176 } \
177 MYSQLI_REGISTER_RESOURCE_EX(__ptr, object)\
178 }
179
180 #define MYSQLI_FETCH_RESOURCE(__ptr, __type, __id, __name, __check) \
181 { \
182 MYSQLI_RESOURCE *my_res; \
183 mysqli_object *intern = Z_MYSQLI_P(__id); \
184 if (!(my_res = (MYSQLI_RESOURCE *)intern->ptr)) {\
185 zend_throw_error(NULL, "%s object is already closed", ZSTR_VAL(intern->zo.ce->name));\
186 RETURN_THROWS();\
187 }\
188 __ptr = (__type)my_res->ptr; \
189 if (my_res->status < __check) { \
190 zend_throw_error(NULL, "%s object is not fully initialized", ZSTR_VAL(intern->zo.ce->name)); \
191 RETURN_THROWS();\
192 }\
193 }
194
195 #define MYSQLI_FETCH_RESOURCE_BY_OBJ(__ptr, __type, __obj, __name, __check) \
196 { \
197 MYSQLI_RESOURCE *my_res; \
198 if (!(my_res = (MYSQLI_RESOURCE *)(__obj->ptr))) {\
199 zend_throw_error(NULL, "%s object is already closed", ZSTR_VAL(intern->zo.ce->name));\
200 return;\
201 }\
202 __ptr = (__type)my_res->ptr; \
203 if (my_res->status < __check) { \
204 zend_throw_error(NULL, "%s object is not fully initialized", ZSTR_VAL(intern->zo.ce->name)); \
205 return;\
206 }\
207 }
208
209 #define MYSQLI_FETCH_RESOURCE_CONN(__ptr, __id, __check) \
210 { \
211 MYSQLI_FETCH_RESOURCE((__ptr), MY_MYSQL *, (__id), "mysqli_link", (__check)); \
212 if (!(__ptr)->mysql) { \
213 zend_throw_error(NULL, "%s object is not fully initialized", ZSTR_VAL(Z_OBJCE_P(__id)->name)); \
214 RETURN_THROWS(); \
215 } \
216 }
217
218 #define MYSQLI_FETCH_RESOURCE_STMT(__ptr, __id, __check) \
219 { \
220 MYSQLI_FETCH_RESOURCE((__ptr), MY_STMT *, (__id), "mysqli_stmt", (__check)); \
221 ZEND_ASSERT((__ptr)->stmt && "Missing statement?"); \
222 }
223
224 #define MYSQLI_SET_STATUS(__id, __value) \
225 { \
226 mysqli_object *intern = Z_MYSQLI_P(__id); \
227 ((MYSQLI_RESOURCE *)intern->ptr)->status = __value; \
228 } \
229
230 #define MYSQLI_CLEAR_RESOURCE(__id) \
231 { \
232 mysqli_object *intern = Z_MYSQLI_P(__id); \
233 efree(intern->ptr); \
234 intern->ptr = NULL; \
235 }
236
237
238 ZEND_BEGIN_MODULE_GLOBALS(mysqli)
239 zend_long num_links;
240 zend_long max_links;
241 zend_long num_active_persistent;
242 zend_long num_inactive_persistent;
243 zend_long max_persistent;
244 bool allow_persistent;
245 zend_ulong default_port;
246 char *default_host;
247 char *default_user;
248 char *default_pw;
249 char *default_socket;
250 bool allow_local_infile;
251 char *local_infile_directory;
252 zend_long error_no;
253 char *error_msg;
254 zend_long report_mode;
255 bool rollback_on_cached_plink;
256 ZEND_END_MODULE_GLOBALS(mysqli)
257
258 #define MyG(v) ZEND_MODULE_GLOBALS_ACCESSOR(mysqli, v)
259
260 #if defined(ZTS) && defined(COMPILE_DL_MYSQLI)
261 ZEND_TSRMLS_CACHE_EXTERN()
262 #endif
263
264 ZEND_EXTERN_MODULE_GLOBALS(mysqli)
265
266 #endif /* PHP_MYSQLI_STRUCTS.H */
267
