pq\Cursor::__construct
[m6w6/ext-pq] / src / php_pqcur.c
1 /*
2 +--------------------------------------------------------------------+
3 | PECL :: pq |
4 +--------------------------------------------------------------------+
5 | Redistribution and use in source and binary forms, with or without |
6 | modification, are permitted provided that the conditions mentioned |
7 | in the accompanying LICENSE file are met. |
8 +--------------------------------------------------------------------+
9 | Copyright (c) 2013, Michael Wallner <mike@php.net> |
10 +--------------------------------------------------------------------+
11 */
12
13 #ifdef HAVE_CONFIG_H
14 # include "config.h"
15 #endif
16
17 #include <php.h>
18 #include <ext/standard/php_smart_str.h>
19
20 #include "php_pq.h"
21 #include "php_pq_misc.h"
22 #include "php_pq_object.h"
23 #include "php_pqexc.h"
24 #include "php_pqconn.h"
25 #include "php_pqres.h"
26 #include "php_pqcur.h"
27
28 zend_class_entry *php_pqcur_class_entry;
29 static zend_object_handlers php_pqcur_object_handlers;
30 static HashTable php_pqcur_object_prophandlers;
31
32 static void cur_close(php_pqcur_object_t *obj TSRMLS_DC)
33 {
34 if (obj->intern->open) {
35 PGresult *res;
36 smart_str cmd = {0};
37
38 smart_str_appends(&cmd, "CLOSE ");
39 smart_str_appends(&cmd, obj->intern->name);
40 smart_str_0(&cmd);
41
42 if ((res = PQexec(obj->intern->conn->intern->conn, cmd.c))) {
43 PHP_PQclear(res);
44 }
45 smart_str_free(&cmd);
46
47 obj->intern->open = 0;
48 }
49 }
50
51 static void cur_fetch_or_move(INTERNAL_FUNCTION_PARAMETERS, const char *action, zend_bool async)
52 {
53 char *spec_str = "1";
54 int spec_len = 1;
55 STATUS rv;
56 php_pq_callback_t resolver = {{0}};
57 zend_error_handling zeh;
58
59 zend_replace_error_handling(EH_THROW, exce(EX_INVALID_ARGUMENT), &zeh TSRMLS_CC);
60 rv = zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, async ? "|sf" : "|s", &spec_str, &spec_len, &resolver.fci, &resolver.fcc);
61 zend_restore_error_handling(&zeh TSRMLS_CC);
62
63 if (SUCCESS == rv) {
64 php_pqcur_object_t *obj = zend_object_store_get_object(getThis() TSRMLS_CC);
65
66 if (!obj->intern) {
67 throw_exce(EX_UNINITIALIZED TSRMLS_CC, "pq\\Cursor not initialized");
68 } else {
69 smart_str cmd = {0};
70
71 smart_str_appends(&cmd, *action == 'f' ? "FETCH " : "MOVE ");
72 smart_str_appendl(&cmd, spec_str, spec_len);
73 smart_str_appends(&cmd, " FROM ");
74 smart_str_appends(&cmd, obj->intern->name);
75 smart_str_0(&cmd);
76
77 if (async) {
78 int rc = PQsendQuery(obj->intern->conn->intern->conn, cmd.c);
79
80 if (!rc) {
81 throw_exce(EX_IO TSRMLS_CC, "Failed to %s cursor (%s)", *action == 'f' ? "fetch from" : "move in", PHP_PQerrorMessage(obj->intern->conn->intern->conn));
82 } else if (obj->intern->conn->intern->unbuffered && !PQsetSingleRowMode(obj->intern->conn->intern->conn)) {
83 throw_exce(EX_RUNTIME TSRMLS_CC, "Failed to enable unbuffered mode (%s)", PHP_PQerrorMessage(obj->intern->conn->intern->conn));
84 } else {
85 php_pq_callback_recurse(&obj->intern->conn->intern->onevent, &resolver TSRMLS_CC);
86 obj->intern->conn->intern->poller = PQconsumeInput;
87 }
88 } else {
89 PGresult *res = PQexec(obj->intern->conn->intern->conn, cmd.c);
90
91 if (!res) {
92 throw_exce(EX_RUNTIME TSRMLS_CC, "Failed to %s cursor (%s)", *action == 'f' ? "fetch from" : "move in", PHP_PQerrorMessage(obj->intern->conn->intern->conn));
93 } else if (SUCCESS == php_pqres_success(res TSRMLS_CC)) {
94 php_pq_object_to_zval_no_addref(PQresultInstanceData(res, php_pqconn_event), &return_value TSRMLS_CC);
95
96 }
97 }
98 smart_str_free(&cmd);
99 php_pqconn_notify_listeners(obj->intern->conn TSRMLS_CC);
100 }
101 }
102 }
103
104 static void php_pqcur_object_free(void *o TSRMLS_DC)
105 {
106 php_pqcur_object_t *obj = o;
107 #if DBG_GC
108 fprintf(stderr, "FREE cur(#%d) %p (conn: %p)\n", obj->zv.handle, obj, obj->intern->conn);
109 #endif
110 if (obj->intern) {
111 cur_close(obj TSRMLS_CC);
112 php_pq_object_delref(obj->intern->conn TSRMLS_CC);
113 efree(obj->intern->decl);
114 efree(obj->intern->name);
115 efree(obj->intern);
116 obj->intern = NULL;
117 }
118 zend_object_std_dtor((zend_object *) o TSRMLS_CC);
119 efree(obj);
120 }
121
122 zend_object_value php_pqcur_create_object_ex(zend_class_entry *ce, php_pqcur_t *intern, php_pqcur_object_t **ptr TSRMLS_DC)
123 {
124 php_pqcur_object_t *o;
125
126 o = ecalloc(1, sizeof(*o));
127 zend_object_std_init((zend_object *) o, ce TSRMLS_CC);
128 object_properties_init((zend_object *) o, ce);
129 o->prophandler = &php_pqcur_object_prophandlers;
130
131 if (ptr) {
132 *ptr = o;
133 }
134
135 if (intern) {
136 o->intern = intern;
137 }
138
139 o->zv.handle = zend_objects_store_put((zend_object *) o, NULL, php_pqcur_object_free, NULL TSRMLS_CC);
140 o->zv.handlers = &php_pqcur_object_handlers;
141
142 return o->zv;
143 }
144
145 static zend_object_value php_pqcur_create_object(zend_class_entry *class_type TSRMLS_DC)
146 {
147 return php_pqcur_create_object_ex(class_type, NULL, NULL TSRMLS_CC);
148 }
149
150 static void php_pqcur_object_read_name(zval *object, void *o, zval *return_value TSRMLS_DC)
151 {
152 php_pqcur_object_t *obj = o;
153
154 RETVAL_STRING(obj->intern->name, 1);
155 }
156
157 static void php_pqcur_object_read_connection(zval *object, void *o, zval *return_value TSRMLS_DC)
158 {
159 php_pqcur_object_t *obj = o;
160
161 php_pq_object_to_zval(obj->intern->conn, &return_value TSRMLS_CC);
162 }
163
164 char *php_pqcur_declare_str(const char *name_str, size_t name_len, unsigned flags, const char *query_str, size_t query_len)
165 {
166 size_t decl_len = name_len + query_len + sizeof("DECLARE BINARY INSENSITIVE NO SCROLL CURSOR WITHOUT HOLD FOR ");
167 char *decl_str;
168
169 decl_str = emalloc(decl_len);
170 decl_len = slprintf(decl_str, decl_len, "DECLARE %s %s %s %s CURSOR %s FOR %s",
171 name_str,
172 (flags & PHP_PQ_DECLARE_BINARY) ? "BINARY" : "",
173 (flags & PHP_PQ_DECLARE_INSENSITIVE) ? "INSENSITIVE" : "",
174 (flags & PHP_PQ_DECLARE_NO_SCROLL) ? "NO SCROLL" :
175 (flags & PHP_PQ_DECLARE_SCROLL) ? "SCROLL" : "",
176 (flags & PHP_PQ_DECLARE_WITH_HOLD) ? "WITH HOLD" : "",
177 query_str
178 );
179 return decl_str;
180 }
181
182 ZEND_BEGIN_ARG_INFO_EX(ai_pqcur___construct, 0, 0, 4)
183 ZEND_ARG_OBJ_INFO(0, connection, pq\\Connection, 0)
184 ZEND_ARG_INFO(0, name)
185 ZEND_ARG_INFO(0, flags)
186 ZEND_ARG_INFO(0, query)
187 ZEND_ARG_INFO(0, async)
188 ZEND_END_ARG_INFO();
189 static PHP_METHOD(pqcur, __construct) {
190 zend_error_handling zeh;
191 char *name_str, *query_str;
192 int name_len, query_len;
193 long flags;
194 zval *zconn;
195 STATUS rv;
196 zend_bool async = 0;
197
198 zend_replace_error_handling(EH_THROW, exce(EX_INVALID_ARGUMENT), &zeh TSRMLS_CC);
199 rv = zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "Osls|b", &zconn, php_pqconn_class_entry, &name_str, &name_len, &flags, &query_str, &query_len, &async);
200 zend_restore_error_handling(&zeh TSRMLS_CC);
201
202 if (SUCCESS == rv) {
203 php_pqcur_object_t *obj = zend_object_store_get_object(getThis() TSRMLS_CC);
204 php_pqconn_object_t *conn_obj = zend_object_store_get_object(zconn TSRMLS_CC);
205
206 if (obj->intern) {
207 throw_exce(EX_BAD_METHODCALL TSRMLS_CC, "pq\\Cursor already initialized");
208 } if (!conn_obj->intern) {
209 throw_exce(EX_UNINITIALIZED TSRMLS_CC, "pq\\Connection not initialized");
210 } else {
211 char *decl = php_pqcur_declare_str(name_str, name_len, flags, query_str, query_len);
212
213 if (async) {
214 rv = php_pqconn_declare_async(zconn, conn_obj, decl TSRMLS_CC);
215 } else {
216 rv = php_pqconn_declare(zconn, conn_obj, decl TSRMLS_CC);
217 }
218
219 if (SUCCESS != rv) {
220 efree(decl);
221 } else {
222 php_pqcur_t *cur = ecalloc(1, sizeof(*cur));
223
224 php_pq_object_addref(conn_obj TSRMLS_CC);
225 cur->conn = conn_obj;
226 cur->open = 1;
227 cur->name = estrdup(name_str);
228 cur->decl = decl;
229 obj->intern = cur;
230 }
231 }
232 }
233 }
234
235 ZEND_BEGIN_ARG_INFO_EX(ai_pqcur_open, 0, 0, 0)
236 ZEND_END_ARG_INFO();
237 static PHP_METHOD(pqcur, open)
238 {
239 zend_error_handling zeh;
240 STATUS rv;
241
242 zend_replace_error_handling(EH_THROW, exce(EX_INVALID_ARGUMENT), &zeh TSRMLS_CC);
243 rv = zend_parse_parameters_none();
244 zend_restore_error_handling(&zeh TSRMLS_CC);
245
246 if (rv == SUCCESS) {
247 php_pqcur_object_t *obj = zend_object_store_get_object(getThis() TSRMLS_CC);
248
249 if (!obj->intern) {
250 throw_exce(EX_UNINITIALIZED TSRMLS_CC, "pq\\Cursor not initialized");
251 } else if (!obj->intern->open) {
252 if (SUCCESS == php_pqconn_declare(NULL, obj->intern->conn, obj->intern->decl TSRMLS_CC)) {
253 obj->intern->open = 1;
254 }
255 }
256 }
257 }
258
259 ZEND_BEGIN_ARG_INFO_EX(ai_pqcur_close, 0, 0, 0)
260 ZEND_END_ARG_INFO();
261 static PHP_METHOD(pqcur, close)
262 {
263 zend_error_handling zeh;
264 STATUS rv;
265
266 zend_replace_error_handling(EH_THROW, exce(EX_INVALID_ARGUMENT), &zeh TSRMLS_CC);
267 rv = zend_parse_parameters_none();
268 zend_restore_error_handling(&zeh TSRMLS_CC);
269
270 if (rv == SUCCESS) {
271 php_pqcur_object_t *obj = zend_object_store_get_object(getThis() TSRMLS_CC);
272
273 if (!obj->intern) {
274 throw_exce(EX_UNINITIALIZED TSRMLS_CC, "pq\\Cursor not initialized");
275 } else {
276 cur_close(obj TSRMLS_CC);
277 }
278 }
279 }
280
281 ZEND_BEGIN_ARG_INFO_EX(ai_pqcur_fetch, 0, 0, 1)
282 ZEND_ARG_INFO(0, spec)
283 ZEND_END_ARG_INFO();
284 static PHP_METHOD(pqcur, fetch)
285 {
286 cur_fetch_or_move(INTERNAL_FUNCTION_PARAM_PASSTHRU, "fetch", 0);
287 }
288
289 ZEND_BEGIN_ARG_INFO_EX(ai_pqcur_move, 0, 0, 0)
290 ZEND_ARG_INFO(0, spec)
291 ZEND_END_ARG_INFO();
292 static PHP_METHOD(pqcur, move)
293 {
294 cur_fetch_or_move(INTERNAL_FUNCTION_PARAM_PASSTHRU, "move", 0);
295 }
296
297 ZEND_BEGIN_ARG_INFO_EX(ai_pqcur_fetchAsync, 0, 0, 0)
298 ZEND_ARG_INFO(0, spec)
299 ZEND_ARG_INFO(0, callback)
300 ZEND_END_ARG_INFO();
301 static PHP_METHOD(pqcur, fetchAsync)
302 {
303 cur_fetch_or_move(INTERNAL_FUNCTION_PARAM_PASSTHRU, "fetch", 1);
304 }
305
306 ZEND_BEGIN_ARG_INFO_EX(ai_pqcur_moveAsync, 0, 0, 0)
307 ZEND_ARG_INFO(0, spec)
308 ZEND_ARG_INFO(0, callback)
309 ZEND_END_ARG_INFO();
310 static PHP_METHOD(pqcur, moveAsync)
311 {
312 cur_fetch_or_move(INTERNAL_FUNCTION_PARAM_PASSTHRU, "move", 1);
313 }
314
315 static zend_function_entry php_pqcur_methods[] = {
316 PHP_ME(pqcur, __construct, ai_pqcur___construct, ZEND_ACC_PUBLIC|ZEND_ACC_CTOR)
317 PHP_ME(pqcur, open, ai_pqcur_open, ZEND_ACC_PUBLIC)
318 PHP_ME(pqcur, close, ai_pqcur_close, ZEND_ACC_PUBLIC)
319 PHP_ME(pqcur, fetch, ai_pqcur_fetch, ZEND_ACC_PUBLIC)
320 PHP_ME(pqcur, move, ai_pqcur_move, ZEND_ACC_PUBLIC)
321 PHP_ME(pqcur, fetchAsync, ai_pqcur_fetchAsync, ZEND_ACC_PUBLIC)
322 PHP_ME(pqcur, moveAsync, ai_pqcur_moveAsync, ZEND_ACC_PUBLIC)
323 {NULL, NULL, NULL}
324 };
325
326 PHP_MSHUTDOWN_FUNCTION(pqcur)
327 {
328 zend_hash_destroy(&php_pqcur_object_prophandlers);
329 return SUCCESS;
330 }
331
332 PHP_MINIT_FUNCTION(pqcur)
333 {
334 zend_class_entry ce = {0};
335 php_pq_object_prophandler_t ph = {0};
336
337 INIT_NS_CLASS_ENTRY(ce, "pq", "Cursor", php_pqcur_methods);
338 php_pqcur_class_entry = zend_register_internal_class_ex(&ce, NULL, NULL TSRMLS_CC);
339 php_pqcur_class_entry->create_object = php_pqcur_create_object;
340
341 memcpy(&php_pqcur_object_handlers, zend_get_std_object_handlers(), sizeof(zend_object_handlers));
342 php_pqcur_object_handlers.read_property = php_pq_object_read_prop;
343 php_pqcur_object_handlers.write_property = php_pq_object_write_prop;
344 php_pqcur_object_handlers.clone_obj = NULL;
345 php_pqcur_object_handlers.get_property_ptr_ptr = NULL;
346 php_pqcur_object_handlers.get_gc = NULL;
347 php_pqcur_object_handlers.get_properties = php_pq_object_properties;
348 php_pqcur_object_handlers.get_debug_info = php_pq_object_debug_info;
349
350 zend_hash_init(&php_pqcur_object_prophandlers, 2, NULL, NULL, 1);
351
352 zend_declare_class_constant_long(php_pqcur_class_entry, ZEND_STRL("BINARY"), PHP_PQ_DECLARE_BINARY TSRMLS_CC);
353 zend_declare_class_constant_long(php_pqcur_class_entry, ZEND_STRL("INSENSITIVE"), PHP_PQ_DECLARE_INSENSITIVE TSRMLS_CC);
354 zend_declare_class_constant_long(php_pqcur_class_entry, ZEND_STRL("WITH_HOLD"), PHP_PQ_DECLARE_WITH_HOLD TSRMLS_CC);
355 zend_declare_class_constant_long(php_pqcur_class_entry, ZEND_STRL("SCROLL"), PHP_PQ_DECLARE_SCROLL TSRMLS_CC);
356 zend_declare_class_constant_long(php_pqcur_class_entry, ZEND_STRL("NO_SCROLL"), PHP_PQ_DECLARE_NO_SCROLL TSRMLS_CC);
357
358 zend_declare_property_null(php_pqcur_class_entry, ZEND_STRL("name"), ZEND_ACC_PUBLIC TSRMLS_CC);
359 ph.read = php_pqcur_object_read_name;
360 zend_hash_add(&php_pqcur_object_prophandlers, "name", sizeof("name"), (void *) &ph, sizeof(ph), NULL);
361
362 zend_declare_property_null(php_pqcur_class_entry, ZEND_STRL("connection"), ZEND_ACC_PUBLIC TSRMLS_CC);
363 ph.read = php_pqcur_object_read_connection;
364 zend_hash_add(&php_pqcur_object_prophandlers, "connection", sizeof("connection"), (void *) &ph, sizeof(ph), NULL);
365
366 return SUCCESS;
367 }
368
369 /*
370 * Local variables:
371 * tab-width: 4
372 * c-basic-offset: 4
373 * End:
374 * vim600: noet sw=4 ts=4 fdm=marker
375 * vim<600: noet sw=4 ts=4
376 */