git.m6w6.name Git - m6w6/ext-pq/blob - 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, zend_bool async, zend_bool silent TSRMLS_DC)
  33 {
  34         if (obj->intern->open && obj->intern->conn->intern) {
  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 (async) {
  43                         if (PQsendQuery(obj->intern->conn->intern->conn, cmd.c)) {
  44                                 obj->intern->conn->intern->poller = PQconsumeInput;
  45                                 php_pqconn_notify_listeners(obj->intern->conn TSRMLS_CC);
  46                         } else if (!silent) {
  47                                 throw_exce(EX_IO TSRMLS_CC, "Failed to close cursor (%s)", PHP_PQerrorMessage(obj->intern->conn->intern->conn));
  48                         }
  49                 } else {
  50                         if ((res = PQexec(obj->intern->conn->intern->conn, cmd.c))) {
  51                                 PHP_PQclear(res);
  52                         } else if (!silent) {
  53                                 throw_exce(EX_RUNTIME TSRMLS_CC, "Failed to close cursor (%s)", PHP_PQerrorMessage(obj->intern->conn->intern->conn));
  54                         }
  55                 }
  56
  57                 smart_str_free(&cmd);
  58                 obj->intern->open = 0;
  59         }
  60 }
  61
  62 static void cur_open(INTERNAL_FUNCTION_PARAMETERS, zend_bool async)
  63 {
  64         zend_error_handling zeh;
  65         STATUS rv;
  66
  67         zend_replace_error_handling(EH_THROW, exce(EX_INVALID_ARGUMENT), &zeh TSRMLS_CC);
  68         rv = zend_parse_parameters_none();
  69         zend_restore_error_handling(&zeh TSRMLS_CC);
  70
  71         if (rv == FAILURE) {
  72                 return;
  73         }
  74
  75         php_pqcur_object_t *obj = zend_object_store_get_object(getThis() TSRMLS_CC);
  76
  77         if (!obj->intern) {
  78                 throw_exce(EX_UNINITIALIZED TSRMLS_CC, "pq\\Cursor not initialized");
  79                 return;
  80         } else if (obj->intern->open) {
  81                 return;
  82         }
  83
  84         if (async) {
  85                 rv = php_pqconn_declare_async(NULL, obj->intern->conn, obj->intern->decl TSRMLS_CC);
  86         } else {
  87                 rv = php_pqconn_declare(NULL, obj->intern->conn, obj->intern->decl TSRMLS_CC);
  88         }
  89
  90         if (rv == SUCCESS) {
  91                 obj->intern->open = 1;
  92         }
  93 }
  94
  95 static void cur_fetch_or_move(INTERNAL_FUNCTION_PARAMETERS, const char *action, zend_bool async)
  96 {
  97         char *spec_str = "1";
  98         int spec_len = 1;
  99         STATUS rv;
 100         php_pq_callback_t resolver = {{0}};
 101         zend_error_handling zeh;
 102
 103         zend_replace_error_handling(EH_THROW, exce(EX_INVALID_ARGUMENT), &zeh TSRMLS_CC);
 104         rv = zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, async ? "|sf" : "|s", &spec_str, &spec_len, &resolver.fci, &resolver.fcc);
 105         zend_restore_error_handling(&zeh TSRMLS_CC);
 106
 107         if (SUCCESS == rv) {
 108                 php_pqcur_object_t *obj = zend_object_store_get_object(getThis() TSRMLS_CC);
 109
 110                 if (!obj->intern) {
 111                         throw_exce(EX_UNINITIALIZED TSRMLS_CC, "pq\\Cursor not initialized");
 112                 } else {
 113                         smart_str cmd = {0};
 114
 115                         smart_str_appends(&cmd, *action == 'f' ? "FETCH " : "MOVE ");
 116                         smart_str_appendl(&cmd, spec_str, spec_len);
 117                         smart_str_appends(&cmd, " FROM ");
 118                         smart_str_appends(&cmd, obj->intern->name);
 119                         smart_str_0(&cmd);
 120
 121                         if (async) {
 122                                 int rc = PQsendQuery(obj->intern->conn->intern->conn, cmd.c);
 123
 124                                 if (!rc) {
 125                                         throw_exce(EX_IO TSRMLS_CC, "Failed to %s cursor (%s)", *action == 'f' ? "fetch from" : "move in", PHP_PQerrorMessage(obj->intern->conn->intern->conn));
 126 #if HAVE_PQSETSINGLEROWMODE
 127                                 } else if (obj->intern->conn->intern->unbuffered && !PQsetSingleRowMode(obj->intern->conn->intern->conn)) {
 128                                         throw_exce(EX_RUNTIME TSRMLS_CC, "Failed to enable unbuffered mode (%s)", PHP_PQerrorMessage(obj->intern->conn->intern->conn));
 129 #endif
 130                                 } else {
 131                                         php_pq_callback_recurse(&obj->intern->conn->intern->onevent, &resolver TSRMLS_CC);
 132                                         obj->intern->conn->intern->poller = PQconsumeInput;
 133                                 }
 134                         } else {
 135                                 PGresult *res = PQexec(obj->intern->conn->intern->conn, cmd.c);
 136
 137                                 if (!res) {
 138                                         throw_exce(EX_RUNTIME TSRMLS_CC, "Failed to %s cursor (%s)", *action == 'f' ? "fetch from" : "move in", PHP_PQerrorMessage(obj->intern->conn->intern->conn));
 139                                 } else if (SUCCESS == php_pqres_success(res TSRMLS_CC)) {
 140                                         php_pq_object_to_zval_no_addref(PQresultInstanceData(res, php_pqconn_event), &return_value TSRMLS_CC);
 141
 142                                 }
 143                         }
 144                         smart_str_free(&cmd);
 145                         php_pqconn_notify_listeners(obj->intern->conn TSRMLS_CC);
 146                 }
 147         }
 148 }
 149
 150 static void php_pqcur_object_free(void *o TSRMLS_DC)
 151 {
 152         php_pqcur_object_t *obj = o;
 153 #if DBG_GC
 154         fprintf(stderr, "FREE cur(#%d) %p (conn: %p)\n", obj->zv.handle, obj, obj->intern->conn);
 155 #endif
 156         if (obj->intern) {
 157                 cur_close(obj, 0, 1 TSRMLS_CC);
 158                 php_pq_object_delref(obj->intern->conn TSRMLS_CC);
 159                 efree(obj->intern->decl);
 160                 efree(obj->intern->name);
 161                 efree(obj->intern);
 162                 obj->intern = NULL;
 163         }
 164         zend_object_std_dtor((zend_object *) o TSRMLS_CC);
 165         efree(obj);
 166 }
 167
 168 zend_object_value php_pqcur_create_object_ex(zend_class_entry *ce, php_pqcur_t *intern, php_pqcur_object_t **ptr TSRMLS_DC)
 169 {
 170         php_pqcur_object_t *o;
 171
 172         o = ecalloc(1, sizeof(*o));
 173         zend_object_std_init((zend_object *) o, ce TSRMLS_CC);
 174         object_properties_init((zend_object *) o, ce);
 175         o->prophandler = &php_pqcur_object_prophandlers;
 176
 177         if (ptr) {
 178                 *ptr = o;
 179         }
 180
 181         if (intern) {
 182                 o->intern = intern;
 183         }
 184
 185         o->zv.handle = zend_objects_store_put((zend_object *) o, NULL, php_pqcur_object_free, NULL TSRMLS_CC);
 186         o->zv.handlers = &php_pqcur_object_handlers;
 187
 188         return o->zv;
 189 }
 190
 191 static zend_object_value php_pqcur_create_object(zend_class_entry *class_type TSRMLS_DC)
 192 {
 193         return php_pqcur_create_object_ex(class_type, NULL, NULL TSRMLS_CC);
 194 }
 195
 196 static void php_pqcur_object_read_name(zval *object, void *o, zval *return_value TSRMLS_DC)
 197 {
 198         php_pqcur_object_t *obj = o;
 199
 200         RETVAL_STRING(obj->intern->name, 1);
 201 }
 202
 203 static void php_pqcur_object_read_connection(zval *object, void *o, zval *return_value TSRMLS_DC)
 204 {
 205         php_pqcur_object_t *obj = o;
 206
 207         php_pq_object_to_zval(obj->intern->conn, &return_value TSRMLS_CC);
 208 }
 209
 210 static void php_pqcur_object_read_flags(zval *object, void *o, zval *return_value TSRMLS_DC)
 211 {
 212         php_pqcur_object_t *obj = o;
 213
 214         RETVAL_LONG(obj->intern->flags);
 215 }
 216
 217 char *php_pqcur_declare_str(const char *name_str, size_t name_len, unsigned flags, const char *query_str, size_t query_len)
 218 {
 219         size_t decl_len = name_len + query_len + sizeof("DECLARE  BINARY INSENSITIVE NO SCROLL CURSOR WITH HOLD FOR ");
 220         char *decl_str;
 221
 222         decl_str = emalloc(decl_len);
 223         decl_len = slprintf(decl_str, decl_len, "DECLARE %s %s %s %s CURSOR %s FOR %s",
 224                         name_str,
 225                         (flags & PHP_PQ_DECLARE_BINARY) ? "BINARY" : "",
 226                         (flags & PHP_PQ_DECLARE_INSENSITIVE) ? "INSENSITIVE" : "",
 227                         (flags & PHP_PQ_DECLARE_NO_SCROLL) ? "NO SCROLL" :
 228                                         (flags & PHP_PQ_DECLARE_SCROLL) ? "SCROLL" : "",
 229                         (flags & PHP_PQ_DECLARE_WITH_HOLD) ? "WITH HOLD" : "",
 230                         query_str
 231         );
 232         return decl_str;
 233 }
 234
 235 ZEND_BEGIN_ARG_INFO_EX(ai_pqcur___construct, 0, 0, 4)
 236         ZEND_ARG_OBJ_INFO(0, connection, pq\\Connection, 0)
 237         ZEND_ARG_INFO(0, name)
 238         ZEND_ARG_INFO(0, flags)
 239         ZEND_ARG_INFO(0, query)
 240         ZEND_ARG_INFO(0, async)
 241 ZEND_END_ARG_INFO();
 242 static PHP_METHOD(pqcur, __construct) {
 243         zend_error_handling zeh;
 244         char *name_str, *query_str;
 245         int name_len, query_len;
 246         long flags;
 247         zval *zconn;
 248         STATUS rv;
 249         zend_bool async = 0;
 250
 251         zend_replace_error_handling(EH_THROW, exce(EX_INVALID_ARGUMENT), &zeh TSRMLS_CC);
 252         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);
 253         zend_restore_error_handling(&zeh TSRMLS_CC);
 254
 255         if (SUCCESS == rv) {
 256                 php_pqcur_object_t *obj = zend_object_store_get_object(getThis() TSRMLS_CC);
 257                 php_pqconn_object_t *conn_obj = zend_object_store_get_object(zconn TSRMLS_CC);
 258
 259                 if (obj->intern) {
 260                         throw_exce(EX_BAD_METHODCALL TSRMLS_CC, "pq\\Cursor already initialized");
 261                 } if (!conn_obj->intern) {
 262                         throw_exce(EX_UNINITIALIZED TSRMLS_CC, "pq\\Connection not initialized");
 263                 } else {
 264                         char *decl = php_pqcur_declare_str(name_str, name_len, flags, query_str, query_len);
 265
 266                         if (async) {
 267                                 rv = php_pqconn_declare_async(zconn, conn_obj, decl TSRMLS_CC);
 268                         } else {
 269                                 rv = php_pqconn_declare(zconn, conn_obj, decl TSRMLS_CC);
 270                         }
 271
 272                         if (SUCCESS != rv) {
 273                                 efree(decl);
 274                         } else {
 275                                 php_pqcur_t *cur = ecalloc(1, sizeof(*cur));
 276
 277                                 php_pq_object_addref(conn_obj TSRMLS_CC);
 278                                 cur->conn = conn_obj;
 279                                 cur->open = 1;
 280                                 cur->name = estrdup(name_str);
 281                                 cur->decl = decl;
 282                                 cur->flags = flags;
 283                                 obj->intern = cur;
 284                         }
 285                 }
 286         }
 287 }
 288
 289 ZEND_BEGIN_ARG_INFO_EX(ai_pqcur_open, 0, 0, 0)
 290 ZEND_END_ARG_INFO();
 291 static PHP_METHOD(pqcur, open)
 292 {
 293         cur_open(INTERNAL_FUNCTION_PARAM_PASSTHRU, 0);
 294 }
 295
 296 ZEND_BEGIN_ARG_INFO_EX(ai_pqcur_openAsync, 0, 0, 0)
 297 ZEND_END_ARG_INFO();
 298 static PHP_METHOD(pqcur, openAsync)
 299 {
 300         cur_open(INTERNAL_FUNCTION_PARAM_PASSTHRU, 1);
 301 }
 302
 303 ZEND_BEGIN_ARG_INFO_EX(ai_pqcur_close, 0, 0, 0)
 304 ZEND_END_ARG_INFO();
 305 static PHP_METHOD(pqcur, close)
 306 {
 307         zend_error_handling zeh;
 308         STATUS rv;
 309
 310         zend_replace_error_handling(EH_THROW, exce(EX_INVALID_ARGUMENT), &zeh TSRMLS_CC);
 311         rv = zend_parse_parameters_none();
 312         zend_restore_error_handling(&zeh TSRMLS_CC);
 313
 314         if (rv == SUCCESS) {
 315                 php_pqcur_object_t *obj = zend_object_store_get_object(getThis() TSRMLS_CC);
 316
 317                 if (!obj->intern) {
 318                         throw_exce(EX_UNINITIALIZED TSRMLS_CC, "pq\\Cursor not initialized");
 319                 } else {
 320                         cur_close(obj, 0, 0 TSRMLS_CC);
 321                 }
 322         }
 323 }
 324
 325 ZEND_BEGIN_ARG_INFO_EX(ai_pqcur_closeAsync, 0, 0, 0)
 326 ZEND_END_ARG_INFO();
 327 static PHP_METHOD(pqcur, closeAsync)
 328 {
 329         zend_error_handling zeh;
 330         STATUS rv;
 331
 332         zend_replace_error_handling(EH_THROW, exce(EX_INVALID_ARGUMENT), &zeh TSRMLS_CC);
 333         rv = zend_parse_parameters_none();
 334         zend_restore_error_handling(&zeh TSRMLS_CC);
 335
 336         if (rv == SUCCESS) {
 337                 php_pqcur_object_t *obj = zend_object_store_get_object(getThis() TSRMLS_CC);
 338
 339                 if (!obj->intern) {
 340                         throw_exce(EX_UNINITIALIZED TSRMLS_CC, "pq\\Cursor not initialized");
 341                 } else {
 342                         cur_close(obj, 1, 0 TSRMLS_CC);
 343                 }
 344         }
 345 }
 346
 347 ZEND_BEGIN_ARG_INFO_EX(ai_pqcur_fetch, 0, 0, 1)
 348         ZEND_ARG_INFO(0, spec)
 349 ZEND_END_ARG_INFO();
 350 static PHP_METHOD(pqcur, fetch)
 351 {
 352         cur_fetch_or_move(INTERNAL_FUNCTION_PARAM_PASSTHRU, "fetch", 0);
 353 }
 354
 355 ZEND_BEGIN_ARG_INFO_EX(ai_pqcur_move, 0, 0, 0)
 356         ZEND_ARG_INFO(0, spec)
 357 ZEND_END_ARG_INFO();
 358 static PHP_METHOD(pqcur, move)
 359 {
 360         cur_fetch_or_move(INTERNAL_FUNCTION_PARAM_PASSTHRU, "move", 0);
 361 }
 362
 363 ZEND_BEGIN_ARG_INFO_EX(ai_pqcur_fetchAsync, 0, 0, 0)
 364         ZEND_ARG_INFO(0, spec)
 365         ZEND_ARG_INFO(0, callback)
 366 ZEND_END_ARG_INFO();
 367 static PHP_METHOD(pqcur, fetchAsync)
 368 {
 369         cur_fetch_or_move(INTERNAL_FUNCTION_PARAM_PASSTHRU, "fetch", 1);
 370 }
 371
 372 ZEND_BEGIN_ARG_INFO_EX(ai_pqcur_moveAsync, 0, 0, 0)
 373         ZEND_ARG_INFO(0, spec)
 374         ZEND_ARG_INFO(0, callback)
 375 ZEND_END_ARG_INFO();
 376 static PHP_METHOD(pqcur, moveAsync)
 377 {
 378         cur_fetch_or_move(INTERNAL_FUNCTION_PARAM_PASSTHRU, "move", 1);
 379 }
 380
 381 static zend_function_entry php_pqcur_methods[] = {
 382         PHP_ME(pqcur, __construct, ai_pqcur___construct, ZEND_ACC_PUBLIC|ZEND_ACC_CTOR)
 383         PHP_ME(pqcur, open, ai_pqcur_open, ZEND_ACC_PUBLIC)
 384         PHP_ME(pqcur, openAsync, ai_pqcur_open, ZEND_ACC_PUBLIC)
 385         PHP_ME(pqcur, close, ai_pqcur_close, ZEND_ACC_PUBLIC)
 386         PHP_ME(pqcur, closeAsync, ai_pqcur_closeAsync, ZEND_ACC_PUBLIC)
 387         PHP_ME(pqcur, fetch, ai_pqcur_fetch, ZEND_ACC_PUBLIC)
 388         PHP_ME(pqcur, move, ai_pqcur_move, ZEND_ACC_PUBLIC)
 389         PHP_ME(pqcur, fetchAsync, ai_pqcur_fetchAsync, ZEND_ACC_PUBLIC)
 390         PHP_ME(pqcur, moveAsync, ai_pqcur_moveAsync, ZEND_ACC_PUBLIC)
 391         {NULL, NULL, NULL}
 392 };
 393
 394 PHP_MSHUTDOWN_FUNCTION(pqcur)
 395 {
 396         zend_hash_destroy(&php_pqcur_object_prophandlers);
 397         return SUCCESS;
 398 }
 399
 400 PHP_MINIT_FUNCTION(pqcur)
 401 {
 402         zend_class_entry ce = {0};
 403         php_pq_object_prophandler_t ph = {0};
 404
 405         INIT_NS_CLASS_ENTRY(ce, "pq", "Cursor", php_pqcur_methods);
 406         php_pqcur_class_entry = zend_register_internal_class_ex(&ce, NULL, NULL TSRMLS_CC);
 407         php_pqcur_class_entry->create_object = php_pqcur_create_object;
 408
 409         memcpy(&php_pqcur_object_handlers, zend_get_std_object_handlers(), sizeof(zend_object_handlers));
 410         php_pqcur_object_handlers.read_property = php_pq_object_read_prop;
 411         php_pqcur_object_handlers.write_property = php_pq_object_write_prop;
 412         php_pqcur_object_handlers.clone_obj = NULL;
 413         php_pqcur_object_handlers.get_property_ptr_ptr = NULL;
 414         php_pqcur_object_handlers.get_gc = NULL;
 415         php_pqcur_object_handlers.get_properties = php_pq_object_properties;
 416         php_pqcur_object_handlers.get_debug_info = php_pq_object_debug_info;
 417
 418         zend_hash_init(&php_pqcur_object_prophandlers, 2, NULL, NULL, 1);
 419
 420         zend_declare_class_constant_long(php_pqcur_class_entry, ZEND_STRL("BINARY"), PHP_PQ_DECLARE_BINARY TSRMLS_CC);
 421         zend_declare_class_constant_long(php_pqcur_class_entry, ZEND_STRL("INSENSITIVE"), PHP_PQ_DECLARE_INSENSITIVE TSRMLS_CC);
 422         zend_declare_class_constant_long(php_pqcur_class_entry, ZEND_STRL("WITH_HOLD"), PHP_PQ_DECLARE_WITH_HOLD TSRMLS_CC);
 423         zend_declare_class_constant_long(php_pqcur_class_entry, ZEND_STRL("SCROLL"), PHP_PQ_DECLARE_SCROLL TSRMLS_CC);
 424         zend_declare_class_constant_long(php_pqcur_class_entry, ZEND_STRL("NO_SCROLL"), PHP_PQ_DECLARE_NO_SCROLL TSRMLS_CC);
 425
 426         zend_declare_property_null(php_pqcur_class_entry, ZEND_STRL("name"), ZEND_ACC_PUBLIC TSRMLS_CC);
 427         ph.read = php_pqcur_object_read_name;
 428         zend_hash_add(&php_pqcur_object_prophandlers, "name", sizeof("name"), (void *) &ph, sizeof(ph), NULL);
 429
 430         zend_declare_property_null(php_pqcur_class_entry, ZEND_STRL("connection"), ZEND_ACC_PUBLIC TSRMLS_CC);
 431         ph.read = php_pqcur_object_read_connection;
 432         zend_hash_add(&php_pqcur_object_prophandlers, "connection", sizeof("connection"), (void *) &ph, sizeof(ph), NULL);
 433
 434         zend_declare_property_null(php_pqcur_class_entry, ZEND_STRL("flags"), ZEND_ACC_PUBLIC TSRMLS_CC);
 435         ph.read = php_pqcur_object_read_flags;
 436         zend_hash_add(&php_pqcur_object_prophandlers, "flags", sizeof("flags"), (void *) &ph, sizeof(ph), NULL);
 437
 438         return SUCCESS;
 439 }
 440
 441 /*
 442  * Local variables:
 443  * tab-width: 4
 444  * c-basic-offset: 4
 445  * End:
 446  * vim600: noet sw=4 ts=4 fdm=marker
 447  * vim<600: noet sw=4 ts=4
 448  */