git.m6w6.name Git - m6w6/ext-pq/blob - src/php_pqlob.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 <libpq-events.h>
  18 #include <libpq/libpq-fs.h>
  19 #include <php.h>
  20
  21 #include "php_pq.h"
  22 #include "php_pq_misc.h"
  23 #include "php_pq_object.h"
  24 #include "php_pqexc.h"
  25 #include "php_pqlob.h"
  26
  27 zend_class_entry *php_pqlob_class_entry;
  28 static zend_object_handlers php_pqlob_object_handlers;
  29 static HashTable php_pqlob_object_prophandlers;
  30
  31 static void php_pqlob_object_free(zend_object *o)
  32 {
  33         php_pqlob_object_t *obj = PHP_PQ_OBJ(NULL, o);
  34 #if DBG_GC
  35         fprintf(stderr, "FREE lob(#%d) %p (txn(#%d): %p)\n", obj->zo.handle, obj, obj->intern->txn->zo.handle, obj->intern->txn);
  36 #endif
  37         if (obj->intern) {
  38                 if (obj->intern->lofd) {
  39                         lo_close(obj->intern->txn->intern->conn->intern->conn, obj->intern->lofd);
  40                 }
  41                 /* invalidate the stream */
  42                 if (obj->intern->stream) {
  43                         zend_list_delete(obj->intern->stream->res);
  44                         obj->intern->stream = NULL;
  45                 }
  46                 php_pq_object_delref(obj->intern->txn);
  47                 efree(obj->intern);
  48                 obj->intern = NULL;
  49         }
  50         php_pq_object_dtor(o);
  51 }
  52
  53 php_pqlob_object_t *php_pqlob_create_object_ex(zend_class_entry *ce, php_pqlob_t *intern)
  54 {
  55         return php_pq_object_create(ce, intern, sizeof(php_pqlob_object_t),
  56                         &php_pqlob_object_handlers, &php_pqlob_object_prophandlers);
  57 }
  58
  59 static zend_object *php_pqlob_create_object(zend_class_entry *class_type)
  60 {
  61         return &php_pqlob_create_object_ex(class_type, NULL)->zo;
  62 }
  63
  64 static void php_pqlob_object_read_transaction(void *o, zval *return_value)
  65 {
  66         php_pqlob_object_t *obj = o;
  67
  68         php_pq_object_to_zval(obj->intern->txn, return_value);
  69 }
  70
  71 static void php_pqlob_object_gc_transaction(void *o, zval *return_value)
  72 {
  73         php_pqlob_object_t *obj = o;
  74         zval ztxn;
  75
  76         php_pq_object_to_zval_no_addref(obj->intern->txn, &ztxn);
  77         add_next_index_zval(return_value, &ztxn);
  78 }
  79
  80 static void php_pqlob_object_read_oid(void *o, zval *return_value)
  81 {
  82         php_pqlob_object_t *obj = o;
  83
  84         RETVAL_LONG(obj->intern->loid);
  85 }
  86
  87 static void php_pqlob_object_update_stream(php_pqlob_object_t *obj, zval *zstream);
  88
  89 static void php_pqlob_object_read_stream(void *o, zval *return_value)
  90 {
  91         php_pqlob_object_t *obj = o;
  92         zval zstream;
  93
  94         if (!obj->intern->stream) {
  95                 php_pqlob_object_update_stream(obj, &zstream);
  96         } else {
  97                 php_stream_to_zval(obj->intern->stream, &zstream);
  98         }
  99
 100         RETVAL_ZVAL(&zstream, 1, 0);
 101 }
 102
 103 static ssize_t php_pqlob_stream_write(php_stream *stream, const char *buffer, size_t length)
 104 {
 105         php_pqlob_object_t *obj = stream->abstract;
 106         ssize_t written = 0;
 107
 108         if (obj) {
 109                 written = lo_write(obj->intern->txn->intern->conn->intern->conn, obj->intern->lofd, buffer, length);
 110
 111                 if (written < 0) {
 112                         php_error_docref(NULL, E_WARNING, "Failed to write to LOB with oid=%u (%s)", obj->intern->loid, PHP_PQerrorMessage(obj->intern->txn->intern->conn->intern->conn));
 113                 }
 114
 115                 php_pqconn_notify_listeners(obj->intern->txn->intern->conn);
 116         }
 117
 118         return written;
 119 }
 120
 121 static ssize_t php_pqlob_stream_read(php_stream *stream, char *buffer, size_t length)
 122 {
 123         php_pqlob_object_t *obj = stream->abstract;
 124         ssize_t read = 0;
 125
 126         if (obj) {
 127
 128                 if (!buffer && !length) {
 129                         if (lo_tell(obj->intern->txn->intern->conn->intern->conn, obj->intern->lofd) == lo_lseek(obj->intern->txn->intern->conn->intern->conn, obj->intern->lofd, 0, SEEK_CUR)) {
 130                                 return EOF;
 131                         }
 132                 } else {
 133                         read = lo_read(obj->intern->txn->intern->conn->intern->conn, obj->intern->lofd, buffer, length);
 134
 135                         if (read < 0) {
 136                                 php_error_docref(NULL, E_WARNING, "Failed to read from LOB with oid=%d (%s)", obj->intern->loid, PHP_PQerrorMessage(obj->intern->txn->intern->conn->intern->conn));
 137                         }
 138                 }
 139
 140                 php_pqconn_notify_listeners(obj->intern->txn->intern->conn);
 141         }
 142
 143         return read;
 144 }
 145
 146 static ZEND_RESULT_CODE php_pqlob_stream_close(php_stream *stream, int close_handle)
 147 {
 148         return SUCCESS;
 149 }
 150
 151 static int php_pqlob_stream_flush(php_stream *stream)
 152 {
 153         return SUCCESS;
 154 }
 155
 156 static ZEND_RESULT_CODE php_pqlob_stream_seek(php_stream *stream, off_t offset, int whence, off_t *newoffset)
 157 {
 158         ZEND_RESULT_CODE rv = FAILURE;
 159         php_pqlob_object_t *obj = stream->abstract;
 160
 161         if (obj) {
 162                 int position = lo_lseek(obj->intern->txn->intern->conn->intern->conn, obj->intern->lofd, offset, whence);
 163
 164                 if (position < 0) {
 165                         php_error_docref(NULL, E_WARNING, "Failed to seek offset in LOB with oid=%d (%s)", obj->intern->loid, PHP_PQerrorMessage(obj->intern->txn->intern->conn->intern->conn));
 166                         rv = FAILURE;
 167                 } else {
 168                         *newoffset = position;
 169                         rv = SUCCESS;
 170                 }
 171
 172                 php_pqconn_notify_listeners(obj->intern->txn->intern->conn);
 173         }
 174
 175         return rv;
 176 }
 177
 178 static php_stream_ops php_pqlob_stream_ops = {
 179         /* stdio like functions - these are mandatory! */
 180         php_pqlob_stream_write,
 181         php_pqlob_stream_read,
 182         php_pqlob_stream_close,
 183         php_pqlob_stream_flush,
 184
 185         "pq\\LOB stream",
 186
 187         /* these are optional */
 188         php_pqlob_stream_seek,
 189         NULL, /* cast */
 190         NULL, /* stat */
 191         NULL, /* set_option */
 192 };
 193
 194 static void php_pqlob_object_update_stream(php_pqlob_object_t *obj, zval *zstream)
 195 {
 196         zval zobj, zmember;
 197
 198         ZVAL_STRINGL(&zmember, "stream", sizeof("stream")-1);
 199
 200         obj->intern->stream = php_stream_alloc(&php_pqlob_stream_ops, obj, NULL, "r+b");
 201         obj->intern->stream->flags |= PHP_STREAM_FLAG_NO_FCLOSE;
 202         php_stream_to_zval(obj->intern->stream, zstream);
 203
 204 #if PHP_VERSION_ID >= 80000
 205         zend_get_std_object_handlers()->write_property(&obj->zo, Z_STR(zmember), zstream, NULL);
 206 #else
 207         ZVAL_OBJ(&zobj, &obj->zo);
 208         zend_get_std_object_handlers()->write_property(&zobj, &zmember, zstream, NULL);
 209 #endif
 210         zval_ptr_dtor(&zmember);
 211 }
 212
 213 ZEND_BEGIN_ARG_INFO_EX(ai_pqlob_construct, 0, 0, 1)
 214         ZEND_ARG_OBJ_INFO(0, transaction, pq\\Transaction, 0)
 215         ZEND_ARG_INFO(0, oid)
 216         ZEND_ARG_INFO(0, mode)
 217 ZEND_END_ARG_INFO();
 218 static PHP_METHOD(pqlob, __construct) {
 219         zend_error_handling zeh;
 220         zval *ztxn;
 221         zend_long mode = INV_WRITE|INV_READ, loid = InvalidOid;
 222         ZEND_RESULT_CODE rv;
 223
 224         zend_replace_error_handling(EH_THROW, exce(EX_INVALID_ARGUMENT), &zeh);
 225         rv = zend_parse_parameters(ZEND_NUM_ARGS(), "O|ll", &ztxn, php_pqtxn_class_entry, &loid, &mode);
 226         zend_restore_error_handling(&zeh);
 227
 228         if (SUCCESS == rv) {
 229                 php_pqlob_object_t *obj = PHP_PQ_OBJ(getThis(), NULL);
 230                 php_pqtxn_object_t *txn_obj = PHP_PQ_OBJ(ztxn, NULL);
 231
 232                 if (obj->intern) {
 233                         throw_exce(EX_BAD_METHODCALL, "pq\\LOB already initialized");
 234                 } else if (!txn_obj->intern) {
 235                         throw_exce(EX_UNINITIALIZED, "pq\\Transaction not initialized");
 236                 } else if (!txn_obj->intern->open) {
 237                         throw_exce(EX_RUNTIME, "pq\\Transation already closed");
 238                 } else {
 239                         if (loid == InvalidOid) {
 240                                 loid = lo_creat(txn_obj->intern->conn->intern->conn, mode);
 241                         }
 242
 243                         if (loid == InvalidOid) {
 244                                 throw_exce(EX_RUNTIME, "Failed to create large object with mode '%s' (%s)", php_pq_strmode(mode), PHP_PQerrorMessage(txn_obj->intern->conn->intern->conn));
 245                         } else {
 246                                 int lofd = lo_open(txn_obj->intern->conn->intern->conn, loid, mode);
 247
 248                                 if (lofd < 0) {
 249                                         throw_exce(EX_RUNTIME, "Failed to open large object with oid=%u with mode '%s' (%s)", loid, php_pq_strmode(mode), PHP_PQerrorMessage(txn_obj->intern->conn->intern->conn));
 250                                 } else {
 251                                         obj->intern = ecalloc(1, sizeof(*obj->intern));
 252                                         obj->intern->lofd = lofd;
 253                                         obj->intern->loid = loid;
 254                                         php_pq_object_addref(txn_obj);
 255                                         obj->intern->txn = txn_obj;
 256                                 }
 257                         }
 258
 259                         php_pqconn_notify_listeners(txn_obj->intern->conn);
 260                 }
 261         }
 262 }
 263
 264 ZEND_BEGIN_ARG_INFO_EX(ai_pqlob_write, 0, 0, 1)
 265         ZEND_ARG_INFO(0, data)
 266 ZEND_END_ARG_INFO();
 267 static PHP_METHOD(pqlob, write) {
 268         zend_error_handling zeh;
 269         char *data_str;
 270         size_t data_len;
 271         ZEND_RESULT_CODE rv;
 272
 273         zend_replace_error_handling(EH_THROW, exce(EX_INVALID_ARGUMENT), &zeh);
 274         rv = zend_parse_parameters(ZEND_NUM_ARGS(), "s", &data_str, &data_len);
 275         zend_restore_error_handling(&zeh);
 276
 277         if (SUCCESS == rv) {
 278                 php_pqlob_object_t *obj = PHP_PQ_OBJ(getThis(), NULL);
 279
 280                 if (!obj->intern) {
 281                         throw_exce(EX_UNINITIALIZED, "pq\\LOB not initialized");
 282                 } else {
 283                         int written = lo_write(obj->intern->txn->intern->conn->intern->conn, obj->intern->lofd, data_str, data_len);
 284
 285                         if (written < 0) {
 286                                 throw_exce(EX_RUNTIME, "Failed to write to LOB with oid=%u (%s)", obj->intern->loid, PHP_PQerrorMessage(obj->intern->txn->intern->conn->intern->conn));
 287                         } else {
 288                                 RETVAL_LONG(written);
 289                         }
 290
 291                         php_pqconn_notify_listeners(obj->intern->txn->intern->conn);
 292                 }
 293         }
 294 }
 295
 296 ZEND_BEGIN_ARG_INFO_EX(ai_pqlob_read, 0, 0, 0)
 297         ZEND_ARG_INFO(0, length)
 298         ZEND_ARG_INFO(1, read)
 299 ZEND_END_ARG_INFO();
 300 static PHP_METHOD(pqlob, read) {
 301         zend_error_handling zeh;
 302         zend_long length = 0x1000;
 303         zval *zread = NULL;
 304         ZEND_RESULT_CODE rv;
 305
 306         zend_replace_error_handling(EH_THROW, exce(EX_INVALID_ARGUMENT), &zeh);
 307         rv = zend_parse_parameters(ZEND_NUM_ARGS(), "|lz!", &length, &zread);
 308         zend_restore_error_handling(&zeh);
 309
 310         if (SUCCESS == rv) {
 311                 php_pqlob_object_t *obj = PHP_PQ_OBJ(getThis(), NULL);
 312
 313                 if (!obj->intern) {
 314                         throw_exce(EX_UNINITIALIZED, "pq\\LOB not initialized");
 315                 } else {
 316                         zend_string *buffer = zend_string_alloc(length, 0);
 317                         int read = lo_read(obj->intern->txn->intern->conn->intern->conn, obj->intern->lofd, &buffer->val[0], length);
 318
 319                         if (read < 0) {
 320                                 zend_string_release(buffer);
 321                                 throw_exce(EX_RUNTIME, "Failed to read from LOB with oid=%d (%s)", obj->intern->loid, PHP_PQerrorMessage(obj->intern->txn->intern->conn->intern->conn));
 322                         } else {
 323                                 if (zread) {
 324                                         ZVAL_DEREF(zread);
 325                                         zval_dtor(zread);
 326                                         ZVAL_LONG(zread, read);
 327                                 }
 328                                 buffer->val[buffer->len = read] = '\0';
 329                                 RETVAL_STR(buffer);
 330                         }
 331
 332                         php_pqconn_notify_listeners(obj->intern->txn->intern->conn);
 333                 }
 334         }
 335 }
 336
 337 ZEND_BEGIN_ARG_INFO_EX(ai_pqlob_seek, 0, 0, 1)
 338         ZEND_ARG_INFO(0, offset)
 339         ZEND_ARG_INFO(0, whence)
 340 ZEND_END_ARG_INFO();
 341 static PHP_METHOD(pqlob, seek) {
 342         zend_error_handling zeh;
 343         zend_long offset, whence = SEEK_SET;
 344         ZEND_RESULT_CODE rv;
 345
 346         zend_replace_error_handling(EH_THROW, exce(EX_INVALID_ARGUMENT), &zeh);
 347         rv = zend_parse_parameters(ZEND_NUM_ARGS(), "l|l", &offset, &whence);
 348         zend_restore_error_handling(&zeh);
 349
 350         if (SUCCESS == rv) {
 351                 php_pqlob_object_t *obj = PHP_PQ_OBJ(getThis(), NULL);
 352
 353                 if (!obj->intern) {
 354                         throw_exce(EX_UNINITIALIZED, "pq\\LOB not initialized");
 355                 } else {
 356                         int position = lo_lseek(obj->intern->txn->intern->conn->intern->conn, obj->intern->lofd, offset, whence);
 357
 358                         if (position < 0) {
 359                                 throw_exce(EX_RUNTIME, "Failed to seek offset in LOB with oid=%d (%s)", obj->intern->loid,      PHP_PQerrorMessage(obj->intern->txn->intern->conn->intern->conn));
 360                         } else {
 361                                 RETVAL_LONG(position);
 362                         }
 363
 364                         php_pqconn_notify_listeners(obj->intern->txn->intern->conn);
 365                 }
 366         }
 367 }
 368
 369 ZEND_BEGIN_ARG_INFO_EX(ai_pqlob_tell, 0, 0, 0)
 370 ZEND_END_ARG_INFO();
 371 static PHP_METHOD(pqlob, tell) {
 372         zend_error_handling zeh;
 373         ZEND_RESULT_CODE rv;
 374
 375         zend_replace_error_handling(EH_THROW, exce(EX_INVALID_ARGUMENT), &zeh);
 376         rv = zend_parse_parameters_none();
 377         zend_restore_error_handling(&zeh);
 378
 379         if (SUCCESS == rv) {
 380                 php_pqlob_object_t *obj = PHP_PQ_OBJ(getThis(), NULL);
 381
 382                 if (!obj->intern) {
 383                         throw_exce(EX_UNINITIALIZED, "pq\\LOB not initialized");
 384                 } else {
 385                         int position = lo_tell(obj->intern->txn->intern->conn->intern->conn, obj->intern->lofd);
 386
 387                         if (position < 0) {
 388                                 throw_exce(EX_RUNTIME, "Failed to tell offset in LOB with oid=%d (%s)", obj->intern->loid, PHP_PQerrorMessage(obj->intern->txn->intern->conn->intern->conn));
 389                         } else {
 390                                 RETVAL_LONG(position);
 391                         }
 392
 393                         php_pqconn_notify_listeners(obj->intern->txn->intern->conn);
 394                 }
 395         }
 396 }
 397
 398 ZEND_BEGIN_ARG_INFO_EX(ai_pqlob_truncate, 0, 0, 0)
 399         ZEND_ARG_INFO(0, length)
 400 ZEND_END_ARG_INFO();
 401 static PHP_METHOD(pqlob, truncate) {
 402         zend_error_handling zeh;
 403         zend_long length = 0;
 404         ZEND_RESULT_CODE rv;
 405
 406         zend_replace_error_handling(EH_THROW, exce(EX_INVALID_ARGUMENT), &zeh);
 407         rv = zend_parse_parameters(ZEND_NUM_ARGS(), "|l", &length);
 408         zend_restore_error_handling(&zeh);
 409
 410         if (SUCCESS == rv) {
 411                 php_pqlob_object_t *obj = PHP_PQ_OBJ(getThis(), NULL);
 412
 413                 if (!obj->intern) {
 414                         throw_exce(EX_UNINITIALIZED, "pq\\LOB not initialized");
 415                 } else {
 416                         int rc = lo_truncate(obj->intern->txn->intern->conn->intern->conn, obj->intern->lofd, length);
 417
 418                         if (rc != 0) {
 419                                 throw_exce(EX_RUNTIME, "Failed to truncate LOB with oid=%d (%s)", obj->intern->loid, PHP_PQerrorMessage(obj->intern->txn->intern->conn->intern->conn));
 420                         }
 421
 422                         php_pqconn_notify_listeners(obj->intern->txn->intern->conn);
 423                 }
 424         }
 425 }
 426
 427 static zend_function_entry php_pqlob_methods[] = {
 428         PHP_ME(pqlob, __construct, ai_pqlob_construct, ZEND_ACC_PUBLIC)
 429         PHP_ME(pqlob, write, ai_pqlob_write, ZEND_ACC_PUBLIC)
 430         PHP_ME(pqlob, read, ai_pqlob_read, ZEND_ACC_PUBLIC)
 431         PHP_ME(pqlob, seek, ai_pqlob_seek, ZEND_ACC_PUBLIC)
 432         PHP_ME(pqlob, tell, ai_pqlob_tell, ZEND_ACC_PUBLIC)
 433         PHP_ME(pqlob, truncate, ai_pqlob_truncate, ZEND_ACC_PUBLIC)
 434         {0}
 435 };
 436
 437 PHP_MSHUTDOWN_FUNCTION(pqlob)
 438 {
 439         zend_hash_destroy(&php_pqlob_object_prophandlers);
 440         return SUCCESS;
 441 }
 442
 443 PHP_MINIT_FUNCTION(pqlob)
 444 {
 445         zend_class_entry ce = {0};
 446         php_pq_object_prophandler_t ph = {0};
 447
 448         INIT_NS_CLASS_ENTRY(ce, "pq", "LOB", php_pqlob_methods);
 449         php_pqlob_class_entry = zend_register_internal_class_ex(&ce, NULL);
 450         php_pqlob_class_entry->create_object = php_pqlob_create_object;
 451
 452         memcpy(&php_pqlob_object_handlers, zend_get_std_object_handlers(), sizeof(zend_object_handlers));
 453         php_pqlob_object_handlers.offset = XtOffsetOf(php_pqlob_object_t, zo);
 454         php_pqlob_object_handlers.free_obj = php_pqlob_object_free;
 455         php_pqlob_object_handlers.read_property = php_pq_object_read_prop;
 456         php_pqlob_object_handlers.write_property = php_pq_object_write_prop;
 457         php_pqlob_object_handlers.clone_obj = NULL;
 458         php_pqlob_object_handlers.get_property_ptr_ptr = php_pq_object_get_prop_ptr_null;
 459         php_pqlob_object_handlers.get_gc = php_pq_object_get_gc;
 460         php_pqlob_object_handlers.get_properties = php_pq_object_properties;
 461         php_pqlob_object_handlers.get_debug_info = php_pq_object_debug_info;
 462
 463         zend_hash_init(&php_pqlob_object_prophandlers, 3, NULL, php_pq_object_prophandler_dtor, 1);
 464
 465         zend_declare_property_null(php_pqlob_class_entry, ZEND_STRL("transaction"), ZEND_ACC_PUBLIC);
 466         ph.read = php_pqlob_object_read_transaction;
 467         ph.gc = php_pqlob_object_gc_transaction;
 468         zend_hash_str_add_mem(&php_pqlob_object_prophandlers, "transaction", sizeof("transaction")-1, (void *) &ph, sizeof(ph));
 469         ph.gc = NULL;
 470
 471         zend_declare_property_long(php_pqlob_class_entry, ZEND_STRL("oid"), InvalidOid, ZEND_ACC_PUBLIC);
 472         ph.read = php_pqlob_object_read_oid;
 473         zend_hash_str_add_mem(&php_pqlob_object_prophandlers, "oid", sizeof("oid")-1, (void *) &ph, sizeof(ph));
 474
 475         zend_declare_property_null(php_pqlob_class_entry, ZEND_STRL("stream"), ZEND_ACC_PUBLIC);
 476         ph.read = php_pqlob_object_read_stream;
 477         zend_hash_str_add_mem(&php_pqlob_object_prophandlers, "stream", sizeof("stream")-1, (void *) &ph, sizeof(ph));
 478
 479         zend_declare_class_constant_long(php_pqlob_class_entry, ZEND_STRL("INVALID_OID"), InvalidOid);
 480         zend_declare_class_constant_long(php_pqlob_class_entry, ZEND_STRL("R"), INV_READ);
 481         zend_declare_class_constant_long(php_pqlob_class_entry, ZEND_STRL("W"), INV_WRITE);
 482         zend_declare_class_constant_long(php_pqlob_class_entry, ZEND_STRL("RW"), INV_READ|INV_WRITE);
 483
 484         return SUCCESS;
 485 }
 486
 487 /*
 488  * Local variables:
 489  * tab-width: 4
 490  * c-basic-offset: 4
 491  * End:
 492  * vim600: noet sw=4 ts=4 fdm=marker
 493  * vim<600: noet sw=4 ts=4
 494  */