remove superfluous error text in pgres errors
[m6w6/ext-pq] / src / php_pq.c
index 24230abd3fc0e3c083a97d320f9812b307824882..f1db28f16fbf006074b62aee8bafaeb771fe17c1 100644 (file)
@@ -1,23 +1,15 @@
 /*
-  +----------------------------------------------------------------------+
-  | PHP Version 5                                                        |
-  +----------------------------------------------------------------------+
-  | Copyright (c) 1997-2012 The PHP Group                                |
-  +----------------------------------------------------------------------+
-  | This source file is subject to version 3.01 of the PHP license,      |
-  | that is bundled with this package in the file LICENSE, and is        |
-  | available through the world-wide-web at the following url:           |
-  | http://www.php.net/license/3_01.txt                                  |
-  | If you did not receive a copy of the PHP license and are unable to   |
-  | obtain it through the world-wide-web, please send a note to          |
-  | license@php.net so we can mail you a copy immediately.               |
-  +----------------------------------------------------------------------+
-  | Author:                                                              |
-  +----------------------------------------------------------------------+
+    +--------------------------------------------------------------------+
+    | PECL :: pq                                                         |
+    +--------------------------------------------------------------------+
+    | Redistribution and use in source and binary forms, with or without |
+    | modification, are permitted provided that the conditions mentioned |
+    | in the accompanying LICENSE file are met.                          |
+    +--------------------------------------------------------------------+
+    | Copyright (c) 2013, Michael Wallner <mike@php.net>                |
+    +--------------------------------------------------------------------+
 */
 
-/* $Id$ */
-
 #ifdef HAVE_CONFIG_H
 #      include "config.h"
 #endif
@@ -94,7 +86,7 @@ typedef struct php_pqconn_object {
        zend_object zo;
        PGconn *conn;
        int (*poller)(PGconn *);
-       unsigned blocking:1;
+       unsigned async:1;
 } php_pqconn_object_t;
 
 typedef enum php_pqres_fetch {
@@ -344,7 +336,7 @@ static zend_object_value php_pqconn_create_object_ex(zend_class_entry *ce, PGcon
 
        if (conn) {
                o->conn = conn;
-               o->blocking = !PQisnonblocking(o->conn);
+               o->async = !PQisnonblocking(o->conn);
        }
 
        ov.handle = zend_objects_store_put((zend_object *) o, NULL, php_pqconn_object_free, NULL TSRMLS_CC);
@@ -444,19 +436,6 @@ static void php_pqconn_object_read_transaction_status(void *o, zval *return_valu
        RETVAL_LONG(PQtransactionStatus(obj->conn));
 }
 
-static void php_pqconn_object_read_socket(void *o, zval *return_value TSRMLS_DC)
-{
-       php_pqconn_object_t *obj = o;
-       php_stream *stream;
-       int socket = PQsocket(obj->conn);
-
-       if ((stream = php_stream_fopen_from_fd(socket, "r+b", NULL))) {
-               php_stream_to_zval(stream, return_value);
-       } else {
-               RETVAL_NULL();
-       }
-}
-
 static void php_pqconn_object_read_error_message(void *o, zval *return_value TSRMLS_DC)
 {
        php_pqconn_object_t *obj = o;
@@ -485,14 +464,25 @@ static void php_pqconn_object_read_types(void *o, zval *return_value TSRMLS_DC)
        if (res) {
                if (PGRES_TUPLES_OK == PQresultStatus(res)) {
                        int r, rows;
+                       zval *byoid, *byname;
 
+                       MAKE_STD_ZVAL(byoid);
+                       MAKE_STD_ZVAL(byname);
+                       object_init(byoid);
+                       object_init(byname);
                        object_init(return_value);
                        for (r = 0, rows = PQntuples(res); r < rows; ++r) {
                                zval *row = php_pqres_row_to_zval(res, r, PHP_PQRES_FETCH_OBJECT TSRMLS_CC);
 
-                               add_property_zval(return_value, PQgetvalue(res, r, 1), row);
+                               add_property_zval(byoid, PQgetvalue(res, r, 0), row);
+                               add_property_zval(byname, PQgetvalue(res, r, 1), row);
                                zval_ptr_dtor(&row);
                        }
+
+                       add_property_zval(return_value, "byOid", byoid);
+                       add_property_zval(return_value, "byName", byname);
+                       zval_ptr_dtor(&byoid);
+                       zval_ptr_dtor(&byname);
                } else {
                        php_error_docref(NULL TSRMLS_CC, E_WARNING, "Could not fetch types: %s", PQresultErrorMessage(res));
                }
@@ -591,7 +581,7 @@ static zval *php_pqconn_object_read_prop(zval *object, zval *member, int type, c
 
        if (!obj->conn) {
                zend_error(E_WARNING, "Connection not initialized");
-       } else if (SUCCESS == zend_hash_find(&php_pqconn_object_prophandlers, Z_STRVAL_P(member), Z_STRLEN_P(member)+1, (void *) &handler)) {
+       } else if ((SUCCESS == zend_hash_find(&php_pqconn_object_prophandlers, Z_STRVAL_P(member), Z_STRLEN_P(member)+1, (void *) &handler)) && handler->read) {
                if (type == BP_VAR_R) {
                        ALLOC_ZVAL(return_value);
                        Z_SET_REFCOUNT_P(return_value, 0);
@@ -712,31 +702,61 @@ static void php_pqstm_object_write_prop(zval *object, zval *member, zval *value,
        }
 }
 
+static STATUS php_pqconn_update_socket(zval *this_ptr, php_pqconn_object_t *obj TSRMLS_DC)
+{
+       zval *zsocket, zmember;
+       php_stream *stream;
+       STATUS retval;
+       int socket;
+       
+       if (!obj) {
+               obj = zend_object_store_get_object(getThis() TSRMLS_CC);
+       }
+       
+       INIT_PZVAL(&zmember);
+       ZVAL_STRINGL(&zmember, "socket", sizeof("socket")-1, 0);
+       MAKE_STD_ZVAL(zsocket);
+       
+       if ((CONNECTION_BAD != PQstatus(obj->conn))
+       &&      (-1 < (socket = PQsocket(obj->conn)))
+       &&      (stream = php_stream_fopen_from_fd(socket, "r+b", NULL))) {
+               php_stream_to_zval(stream, zsocket);
+               retval = SUCCESS;
+       } else {
+               ZVAL_NULL(zsocket);
+               retval = FAILURE;
+       }
+       zend_get_std_object_handlers()->write_property(getThis(), &zmember, zsocket, NULL TSRMLS_CC);
+       zval_ptr_dtor(&zsocket);
+       
+       return retval;
+}
+
 ZEND_BEGIN_ARG_INFO_EX(ai_pqconn_construct, 0, 0, 1)
        ZEND_ARG_INFO(0, dsn)
-       ZEND_ARG_INFO(0, block)
+       ZEND_ARG_INFO(0, async)
 ZEND_END_ARG_INFO();
 static PHP_METHOD(pqconn, __construct) {
        zend_error_handling zeh;
        char *dsn_str;
        int dsn_len;
-       zend_bool block = 1;
+       zend_bool async = 0;
 
        zend_replace_error_handling(EH_THROW, NULL, &zeh TSRMLS_CC);
-       if (SUCCESS == zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s|b", &dsn_str, &dsn_len, &block)) {
+       if (SUCCESS == zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s|b", &dsn_str, &dsn_len, &async)) {
                php_pqconn_object_t *obj = zend_object_store_get_object(getThis() TSRMLS_CC);
 
                if (obj->conn) {
                        PQfinish(obj->conn);
                }
-               if ((obj->blocking = block)) {
-                       obj->conn = PQconnectdb(dsn_str);
-               } else {
+               if ((obj->async = async)) {
                        obj->conn = PQconnectStart(dsn_str);
                        obj->poller = (int (*)(PGconn*)) PQconnectPoll;
+               } else {
+                       obj->conn = PQconnectdb(dsn_str);
                }
-
-               if (CONNECTION_BAD == PQstatus(obj->conn)) {
+               
+               if (SUCCESS != php_pqconn_update_socket(getThis(), obj TSRMLS_CC)) {
                        php_error_docref(NULL TSRMLS_CC, E_WARNING, "Connection failed: %s", PQerrorMessage(obj->conn));
                }
        }
@@ -750,12 +770,19 @@ static PHP_METHOD(pqconn, reset) {
                php_pqconn_object_t *obj = zend_object_store_get_object(getThis() TSRMLS_CC);
 
                if (obj->conn) {
-                       if (obj->blocking) {
+                       if (obj->async) {
+                               if (PQresetStart(obj->conn)) {
+                                       obj->poller = (int (*)(PGconn*)) PQresetPoll;
+                                       RETURN_TRUE;
+                               }
+                       } else {
                                PQreset(obj->conn);
-                               RETURN_TRUE; /* probably ;) */
-                       } if (PQresetStart(obj->conn)) {
-                               obj->poller = (int (*)(PGconn*)) PQresetPoll;
-                               RETURN_TRUE;
+                               
+                               if (CONNECTION_OK == PQstatus(obj->conn)) {
+                                       RETURN_TRUE;
+                               } else {
+                                       php_error_docref(NULL TSRMLS_CC, E_WARNING, "Connection reset failed: %s", PQerrorMessage(obj->conn));
+                               }
                        }
                } else {
                        php_error_docref(NULL TSRMLS_CC, E_WARNING, "Connection not initialized");
@@ -772,7 +799,11 @@ static PHP_METHOD(pqconn, poll) {
 
                if (obj->conn) {
                        if (obj->poller) {
-                               RETURN_LONG(obj->poller(obj->conn));
+                               if (obj->poller == PQconsumeInput) {
+                                       RETURN_LONG(obj->poller(obj->conn) * PGRES_POLLING_OK);
+                               } else {
+                                       RETURN_LONG(obj->poller(obj->conn));
+                               }
                        } else {
                                php_error_docref(NULL TSRMLS_CC, E_WARNING, "No asynchronous operation active");
                        }
@@ -783,6 +814,19 @@ static PHP_METHOD(pqconn, poll) {
        }
 }
 
+static STATUS php_pqres_success(PGresult *res TSRMLS_DC)
+{
+       switch (PQresultStatus(res)) {
+       case PGRES_BAD_RESPONSE:
+       case PGRES_NONFATAL_ERROR:
+       case PGRES_FATAL_ERROR:
+               php_error_docref(NULL TSRMLS_CC, E_WARNING, "%s", PQresultErrorMessage(res));
+               return FAILURE;
+       default:
+               return SUCCESS;
+       }
+}
+
 ZEND_BEGIN_ARG_INFO_EX(ai_pqconn_exec, 0, 0, 1)
        ZEND_ARG_INFO(0, query)
 ZEND_END_ARG_INFO();
@@ -799,8 +843,10 @@ static PHP_METHOD(pqconn, exec) {
                        PGresult *res = PQexec(obj->conn, query_str);
 
                        if (res) {
-                               return_value->type = IS_OBJECT;
-                               return_value->value.obj = php_pqres_create_object_ex(php_pqres_class_entry, res, NULL TSRMLS_CC);
+                               if (SUCCESS == php_pqres_success(res TSRMLS_CC)) {
+                                       return_value->type = IS_OBJECT;
+                                       return_value->value.obj = php_pqres_create_object_ex(php_pqres_class_entry, res, NULL TSRMLS_CC);
+                               }
                        } else {
                                php_error_docref(NULL TSRMLS_CC, E_WARNING, "Could not execute query: %s", PQerrorMessage(obj->conn));
                        }
@@ -894,7 +940,7 @@ static PHP_METHOD(pqconn, execParams) {
                                zend_hash_apply_with_arguments(Z_ARRVAL_P(zparams) TSRMLS_CC, apply_to_param, 2, &tmp, &zdtor);
                        }
 
-                       res = PQexecParams(obj->conn, query_str, count, types, params, NULL, NULL, 0);
+                       res = PQexecParams(obj->conn, query_str, count, types, (const char *const*) params, NULL, NULL, 0);
 
                        zend_hash_destroy(&zdtor);
                        if (types) {
@@ -905,8 +951,10 @@ static PHP_METHOD(pqconn, execParams) {
                        }
 
                        if (res) {
-                               return_value->type = IS_OBJECT;
-                               return_value->value.obj = php_pqres_create_object_ex(php_pqres_class_entry, res, NULL TSRMLS_CC);
+                               if (SUCCESS == php_pqres_success(res TSRMLS_CC)) {
+                                       return_value->type = IS_OBJECT;
+                                       return_value->value.obj = php_pqres_create_object_ex(php_pqres_class_entry, res, NULL TSRMLS_CC);
+                               }
                        } else {
                                php_error_docref(NULL TSRMLS_CC, E_WARNING, "Could not execute query: %s", PQerrorMessage(obj->conn));
                        }
@@ -1009,7 +1057,7 @@ static zval **php_pqres_iteration(zval *this_ptr, php_pqres_object_t *obj, php_p
        return row ? row : NULL;
 }
 
-ZEND_BEGIN_ARG_INFO_EX(ai_pqres_fetch, 0, 0, 0)
+ZEND_BEGIN_ARG_INFO_EX(ai_pqres_fetch_row, 0, 0, 0)
        ZEND_ARG_INFO(0, fetch_type)
 ZEND_END_ARG_INFO();
 static PHP_METHOD(pqres, fetchRow) {
@@ -1030,8 +1078,55 @@ static PHP_METHOD(pqres, fetchRow) {
        zend_restore_error_handling(&zeh TSRMLS_CC);
 }
 
+static zval **column_at(zval *row, int col TSRMLS_DC)
+{
+       zval **data = NULL;
+       HashTable *ht = HASH_OF(row);
+       int count = zend_hash_num_elements(ht);
+
+       if (col < count) {
+               zend_hash_internal_pointer_reset(ht);
+               while (col-- > 0) {
+                       zend_hash_move_forward(ht);
+               }
+               zend_hash_get_current_data(ht, (void *) &data);
+       } else {
+               php_error_docref(NULL TSRMLS_CC, E_WARNING, "Column index %d does excess column count %d", col, count);
+       }
+       return data;
+}
+
+ZEND_BEGIN_ARG_INFO_EX(ai_pqres_fetch_col, 0, 0, 0)
+       ZEND_ARG_INFO(0, col_num)
+ZEND_END_ARG_INFO();
+static PHP_METHOD(pqres, fetchCol) {
+       zend_error_handling zeh;
+       long fetch_col = 0;
+
+       zend_replace_error_handling(EH_THROW, NULL, &zeh TSRMLS_CC);
+       if (SUCCESS == zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "|l", &fetch_col)) {
+               php_pqres_object_t *obj = zend_object_store_get_object(getThis() TSRMLS_CC);
+               zval **row = php_pqres_iteration(getThis(), obj, obj->iter ? obj->iter->fetch_type : 0 TSRMLS_CC);
+
+               if (row) {
+                       zval **col = column_at(*row, fetch_col TSRMLS_CC);
+
+                       if (col) {
+                               RETVAL_ZVAL(*col, 1, 0);
+                       } else {
+                               RETVAL_FALSE;
+                       }
+               } else {
+                       RETVAL_FALSE;
+               }
+       }
+       zend_restore_error_handling(&zeh TSRMLS_CC);
+
+}
+
 static zend_function_entry php_pqres_methods[] = {
-       PHP_ME(pqres, fetchRow, ai_pqres_fetch, ZEND_ACC_PUBLIC)
+       PHP_ME(pqres, fetchRow, ai_pqres_fetch_row, ZEND_ACC_PUBLIC)
+       PHP_ME(pqres, fetchCol, ai_pqres_fetch_col, ZEND_ACC_PUBLIC)
        {0}
 };
 
@@ -1093,7 +1188,7 @@ static PHP_METHOD(pqstm, exec) {
                                        zend_hash_apply_with_arguments(Z_ARRVAL_P(zparams) TSRMLS_CC, apply_to_param, 2, &tmp, &zdtor);
                                }
 
-                               res = PQexecPrepared(conn_obj->conn, obj->name, count, params, NULL, NULL, 0);
+                               res = PQexecPrepared(conn_obj->conn, obj->name, count, (const char *const*) params, NULL, NULL, 0);
 
                                if (params) {
                                        efree(params);
@@ -1101,8 +1196,10 @@ static PHP_METHOD(pqstm, exec) {
                                zend_hash_destroy(&zdtor);
 
                                if (res) {
-                                       return_value->type = IS_OBJECT;
-                                       return_value->value.obj = php_pqres_create_object_ex(php_pqres_class_entry, res, NULL TSRMLS_CC);
+                                       if (SUCCESS == php_pqres_success(res TSRMLS_CC)) {
+                                               return_value->type = IS_OBJECT;
+                                               return_value->value.obj = php_pqres_create_object_ex(php_pqres_class_entry, res, NULL TSRMLS_CC);
+                                       }
                                } else {
                                        php_error_docref(NULL TSRMLS_CC, E_WARNING, "Could not execute statement: %s", PQerrorMessage(conn_obj->conn));
                                }
@@ -1116,9 +1213,47 @@ static PHP_METHOD(pqstm, exec) {
        zend_restore_error_handling(&zeh TSRMLS_CC);
 }
 
+ZEND_BEGIN_ARG_INFO_EX(ai_pqstm_desc, 0, 0, 0)
+ZEND_END_ARG_INFO();
+static PHP_METHOD(pqstm, desc) {
+       zend_error_handling zeh;
+
+       zend_replace_error_handling(EH_THROW, NULL, &zeh TSRMLS_CC);
+       if (SUCCESS == zend_parse_parameters_none()) {
+               php_pqstm_object_t *obj = zend_object_store_get_object(getThis() TSRMLS_CC);
+
+               if (obj->conn && obj->name) {
+                       php_pqconn_object_t *conn_obj = zend_object_store_get_object(obj->conn TSRMLS_CC);
+
+                       if (conn_obj->conn) {
+                               PGresult *res = PQdescribePrepared(conn_obj->conn, obj->name);
+
+                               if (res) {
+                                       if (SUCCESS == php_pqres_success(res TSRMLS_CC)) {
+                                               int p, params;
+
+                                               array_init(return_value);
+                                               for (p = 0, params = PQnparams(res); p < params; ++p) {
+                                                       add_next_index_long(return_value, PQparamtype(res, p));
+                                               }
+                                       }
+                               } else {
+                                       php_error_docref(NULL TSRMLS_CC, E_WARNING, "Could not describe statement: %s", PQerrorMessage(conn_obj->conn));
+                               }
+                       } else {
+                               php_error_docref(NULL TSRMLS_CC, E_WARNING, "Connection not initialized");
+                       }
+               } else {
+                       php_error_docref(NULL TSRMLS_CC, E_WARNING, "Statement not initialized");
+               }
+       }
+       zend_restore_error_handling(&zeh TSRMLS_CC);
+}
+
 static zend_function_entry php_pqstm_methods[] = {
        PHP_ME(pqstm, __construct, ai_pqstm_construct, ZEND_ACC_PUBLIC|ZEND_ACC_CTOR)
        PHP_ME(pqstm, exec, ai_pqstm_exec, ZEND_ACC_PUBLIC)
+       PHP_ME(pqstm, desc, ai_pqstm_desc, ZEND_ACC_PUBLIC)
        {0}
 };
 
@@ -1146,7 +1281,7 @@ PHP_MINIT_FUNCTION(pq)
        zend_hash_add(&php_pqconn_object_prophandlers, "transactionStatus", sizeof("transactionStatus"), (void *) &ph, sizeof(ph), NULL);
 
        zend_declare_property_null(php_pqconn_class_entry, ZEND_STRL("socket"), ZEND_ACC_PUBLIC TSRMLS_CC);
-       ph.read = php_pqconn_object_read_socket;
+       ph.read = NULL; /* forward to std prophandler */
        zend_hash_add(&php_pqconn_object_prophandlers, "socket", sizeof("socket"), (void *) &ph, sizeof(ph), NULL);
 
        zend_declare_property_null(php_pqconn_class_entry, ZEND_STRL("errorMessage"), ZEND_ACC_PUBLIC TSRMLS_CC);