php-src/ext/pdo_odbc/odbc_stmt.c
Calvin Buckley 0d584c32c5
pdo_odbc: Don't fetch 256 byte blocks for long columns (#10809)
* pdo_odbc: Don't fetch 256 byte blocks for long columns

Fetching 256 byte blocks can confuse some drivers with conversion
routines. That, and it seems to me the round trips to and from a
database could be a major performance impact.

Instead, we try to fetch all at once, and continue fetching if a
driver somehow has more for us.

This has been tested with a problematic case with the Db2i driver
with stateful MBCS encodings.

See GH-10733 for discussion about this and issues it can resolve.

* change to separate by 256 bytes, when C->fetched_len == SQL_NO_TOTAL

change to separate by 256 bytes, when C->fetched_len == SQL_NO_TOTAL

changed from 256 byte to 2048 byte buf block.

* Make long column buffer size single define

Could be configurable maybe, but best to avoid magic numbers even for a
compile-time constant.

* Use ZendMM page size minus zend_string overhead

Change recommended by Christoph.

Probably a little better performance wise I have to guess.

* [skip ci] Update comment to mention constant

* Update UPGRADING for PDO_ODBC change

mention GH issues in UPGRADING too

* Update NEWS for PDO_ODBC change

---------

Co-authored-by: SakiTakamachi <saki@sakiot.com>
2025-07-10 13:03:11 -03:00

897 lines
23 KiB
C

/*
+----------------------------------------------------------------------+
| Copyright (c) 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: |
| https://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: Wez Furlong <wez@php.net> |
+----------------------------------------------------------------------+
*/
#ifdef HAVE_CONFIG_H
#include <config.h>
#endif
#include "php.h"
#include "php_ini.h"
#include "ext/standard/info.h"
#include "ext/pdo/php_pdo.h"
#include "ext/pdo/php_pdo_driver.h"
#include "php_pdo_odbc.h"
#include "php_pdo_odbc_int.h"
/* Buffer size; bigger columns than this become a "long column" */
#define LONG_COLUMN_BUFFER_SIZE (ZEND_MM_PAGE_SIZE- ZSTR_MAX_OVERHEAD)
enum pdo_odbc_conv_result {
PDO_ODBC_CONV_NOT_REQUIRED,
PDO_ODBC_CONV_OK,
PDO_ODBC_CONV_FAIL
};
static int pdo_odbc_sqltype_is_unicode(pdo_odbc_stmt *S, SQLSMALLINT sqltype)
{
if (!S->assume_utf8) return 0;
switch (sqltype) {
#ifdef SQL_WCHAR
case SQL_WCHAR:
return 1;
#endif
#ifdef SQL_WLONGVARCHAR
case SQL_WLONGVARCHAR:
return 1;
#endif
#ifdef SQL_WVARCHAR
case SQL_WVARCHAR:
return 1;
#endif
default:
return 0;
}
}
static int pdo_odbc_utf82ucs2(pdo_stmt_t *stmt, int is_unicode, const char *buf,
zend_ulong buflen, zend_ulong *outlen)
{
#ifdef PHP_WIN32
if (is_unicode && buflen) {
pdo_odbc_stmt *S = (pdo_odbc_stmt*)stmt->driver_data;
DWORD ret;
ret = MultiByteToWideChar(CP_UTF8, 0, buf, buflen, NULL, 0);
if (ret == 0) {
/*printf("%s:%d %d [%d] %.*s\n", __FILE__, __LINE__, GetLastError(), buflen, buflen, buf);*/
return PDO_ODBC_CONV_FAIL;
}
ret *= sizeof(WCHAR);
if (S->convbufsize <= ret) {
S->convbufsize = ret + sizeof(WCHAR);
S->convbuf = erealloc(S->convbuf, S->convbufsize);
}
ret = MultiByteToWideChar(CP_UTF8, 0, buf, buflen, (LPWSTR)S->convbuf, S->convbufsize / sizeof(WCHAR));
if (ret == 0) {
/*printf("%s:%d %d [%d] %.*s\n", __FILE__, __LINE__, GetLastError(), buflen, buflen, buf);*/
return PDO_ODBC_CONV_FAIL;
}
ret *= sizeof(WCHAR);
*outlen = ret;
return PDO_ODBC_CONV_OK;
}
#endif
return PDO_ODBC_CONV_NOT_REQUIRED;
}
static int pdo_odbc_ucs22utf8(int is_unicode, zval *result)
{
#ifdef PHP_WIN32
ZEND_ASSERT(Z_TYPE_P(result) == IS_STRING);
if (is_unicode && Z_STRLEN_P(result) != 0) {
DWORD ret;
ret = WideCharToMultiByte(CP_UTF8, 0, (LPCWSTR) Z_STRVAL_P(result), Z_STRLEN_P(result)/sizeof(WCHAR), NULL, 0, NULL, NULL);
if (ret == 0) {
return PDO_ODBC_CONV_FAIL;
}
zend_string *str = zend_string_alloc(ret, 0);
ret = WideCharToMultiByte(CP_UTF8, 0, (LPCWSTR) Z_STRVAL_P(result), Z_STRLEN_P(result)/sizeof(WCHAR), ZSTR_VAL(str), ZSTR_LEN(str), NULL, NULL);
if (ret == 0) {
zend_string_efree(str);
return PDO_ODBC_CONV_FAIL;
}
ZSTR_VAL(str)[ret] = '\0';
zval_ptr_dtor_str(result);
ZVAL_STR(result, str);
return PDO_ODBC_CONV_OK;
}
#endif
return PDO_ODBC_CONV_NOT_REQUIRED;
}
static void free_cols(pdo_stmt_t *stmt, pdo_odbc_stmt *S)
{
if (S->cols) {
int i;
for (i = 0; i < S->col_count; i++) {
if (S->cols[i].data) {
efree(S->cols[i].data);
}
}
efree(S->cols);
S->cols = NULL;
S->col_count = 0;
}
}
static int odbc_stmt_dtor(pdo_stmt_t *stmt)
{
pdo_odbc_stmt *S = (pdo_odbc_stmt*)stmt->driver_data;
if (S->stmt != SQL_NULL_HANDLE && php_pdo_stmt_valid_db_obj_handle(stmt)) {
if (stmt->executed) {
SQLCloseCursor(S->stmt);
}
SQLFreeHandle(SQL_HANDLE_STMT, S->stmt);
S->stmt = SQL_NULL_HANDLE;
}
free_cols(stmt, S);
if (S->convbuf) {
efree(S->convbuf);
}
efree(S);
return 1;
}
static int odbc_stmt_execute(pdo_stmt_t *stmt)
{
RETCODE rc, rc1;
pdo_odbc_stmt *S = (pdo_odbc_stmt*)stmt->driver_data;
char *buf = NULL;
SQLLEN row_count = -1;
if (stmt->executed) {
SQLCloseCursor(S->stmt);
}
rc = SQLExecute(S->stmt);
while (rc == SQL_NEED_DATA) {
struct pdo_bound_param_data *param;
rc = SQLParamData(S->stmt, (SQLPOINTER*)&param);
if (rc == SQL_NEED_DATA) {
php_stream *stm;
int len;
pdo_odbc_param *P;
zval *parameter;
P = (pdo_odbc_param*)param->driver_data;
if (Z_ISREF(param->parameter)) {
parameter = Z_REFVAL(param->parameter);
} else {
parameter = &param->parameter;
}
if (Z_TYPE_P(parameter) != IS_RESOURCE) {
/* they passed in a string */
zend_ulong ulen;
convert_to_string(parameter);
switch (pdo_odbc_utf82ucs2(stmt, P->is_unicode,
Z_STRVAL_P(parameter),
Z_STRLEN_P(parameter),
&ulen)) {
case PDO_ODBC_CONV_NOT_REQUIRED:
rc1 = SQLPutData(S->stmt, Z_STRVAL_P(parameter),
Z_STRLEN_P(parameter));
if (rc1 != SQL_SUCCESS && rc1 != SQL_SUCCESS_WITH_INFO) {
rc = rc1;
}
break;
case PDO_ODBC_CONV_OK:
rc1 = SQLPutData(S->stmt, S->convbuf, ulen);
if (rc1 != SQL_SUCCESS && rc1 != SQL_SUCCESS_WITH_INFO) {
rc = rc1;
}
break;
case PDO_ODBC_CONV_FAIL:
pdo_odbc_stmt_error("error converting input string");
SQLCloseCursor(S->stmt);
if (buf) {
efree(buf);
}
return 0;
}
continue;
}
/* we assume that LOBs are binary and don't need charset
* conversion */
php_stream_from_zval_no_verify(stm, parameter);
if (!stm) {
/* shouldn't happen either */
pdo_odbc_stmt_error("input LOB is no longer a stream");
SQLCloseCursor(S->stmt);
if (buf) {
efree(buf);
}
return 0;
}
/* now suck data from the stream and stick it into the database */
if (buf == NULL) {
buf = emalloc(8192);
}
do {
len = php_stream_read(stm, buf, 8192);
if (len == 0) {
break;
}
rc1 = SQLPutData(S->stmt, buf, len);
if (rc1 != SQL_SUCCESS && rc1 != SQL_SUCCESS_WITH_INFO) {
rc = rc1;
}
} while (1);
}
}
if (buf) {
efree(buf);
}
switch (rc) {
case SQL_SUCCESS:
break;
case SQL_NO_DATA_FOUND:
case SQL_SUCCESS_WITH_INFO:
pdo_odbc_stmt_error("SQLExecute");
break;
default:
pdo_odbc_stmt_error("SQLExecute");
return 0;
}
SQLRowCount(S->stmt, &row_count);
stmt->row_count = row_count;
if (S->cols == NULL) {
/* do first-time-only definition of bind/mapping stuff */
SQLSMALLINT colcount;
/* how many columns do we have ? */
SQLNumResultCols(S->stmt, &colcount);
stmt->column_count = S->col_count = (int)colcount;
S->cols = ecalloc(colcount, sizeof(pdo_odbc_column));
S->going_long = 0;
}
return 1;
}
static int odbc_stmt_param_hook(pdo_stmt_t *stmt, struct pdo_bound_param_data *param,
enum pdo_param_event event_type)
{
pdo_odbc_stmt *S = (pdo_odbc_stmt*)stmt->driver_data;
RETCODE rc;
SQLSMALLINT sqltype = 0, ctype = 0, scale = 0, nullable = 0;
SQLULEN precision = 0;
pdo_odbc_param *P;
zval *parameter;
/* we're only interested in parameters for prepared SQL right now */
if (param->is_param) {
switch (event_type) {
case PDO_PARAM_EVT_FETCH_PRE:
case PDO_PARAM_EVT_FETCH_POST:
case PDO_PARAM_EVT_NORMALIZE:
/* Do nothing */
break;
case PDO_PARAM_EVT_FREE:
P = param->driver_data;
if (P) {
efree(P);
}
break;
case PDO_PARAM_EVT_ALLOC:
{
/* figure out what we're doing */
switch (PDO_PARAM_TYPE(param->param_type)) {
case PDO_PARAM_LOB:
break;
case PDO_PARAM_STMT:
return 0;
default:
break;
}
rc = SQLDescribeParam(S->stmt, (SQLUSMALLINT) param->paramno+1, &sqltype, &precision, &scale, &nullable);
if (rc != SQL_SUCCESS && rc != SQL_SUCCESS_WITH_INFO) {
/* MS Access, for instance, doesn't support SQLDescribeParam,
* so we need to guess */
switch (PDO_PARAM_TYPE(param->param_type)) {
case PDO_PARAM_INT:
sqltype = SQL_INTEGER;
break;
case PDO_PARAM_LOB:
sqltype = SQL_LONGVARBINARY;
break;
default:
sqltype = SQL_LONGVARCHAR;
}
precision = 4000;
scale = 5;
nullable = 1;
if (param->max_value_len > 0) {
precision = param->max_value_len;
}
}
if (sqltype == SQL_BINARY || sqltype == SQL_VARBINARY || sqltype == SQL_LONGVARBINARY) {
ctype = SQL_C_BINARY;
} else {
ctype = SQL_C_CHAR;
}
P = emalloc(sizeof(*P));
param->driver_data = P;
P->len = 0; /* is re-populated each EXEC_PRE */
P->outbuf = NULL;
P->is_unicode = pdo_odbc_sqltype_is_unicode(S, sqltype);
if (P->is_unicode) {
/* avoid driver auto-translation: we'll do it ourselves */
ctype = SQL_C_BINARY;
}
if ((param->param_type & PDO_PARAM_INPUT_OUTPUT) == PDO_PARAM_INPUT_OUTPUT) {
P->paramtype = SQL_PARAM_INPUT_OUTPUT;
} else if (param->max_value_len <= 0) {
P->paramtype = SQL_PARAM_INPUT;
} else {
P->paramtype = SQL_PARAM_OUTPUT;
}
if (P->paramtype != SQL_PARAM_INPUT) {
if (PDO_PARAM_TYPE(param->param_type) != PDO_PARAM_NULL) {
/* need an explicit buffer to hold result */
P->len = param->max_value_len > 0 ? param->max_value_len : precision;
if (P->is_unicode) {
P->len *= 2;
}
P->outbuf = emalloc(P->len + (P->is_unicode ? 2:1));
}
}
if (PDO_PARAM_TYPE(param->param_type) == PDO_PARAM_LOB && P->paramtype != SQL_PARAM_INPUT) {
pdo_odbc_stmt_error("Can't bind a lob for output");
return 0;
}
rc = SQLBindParameter(S->stmt, (SQLUSMALLINT) param->paramno+1,
P->paramtype, ctype, sqltype, precision, scale,
P->paramtype == SQL_PARAM_INPUT ?
(SQLPOINTER)param :
P->outbuf,
P->len,
&P->len
);
if (rc == SQL_SUCCESS || rc == SQL_SUCCESS_WITH_INFO) {
return 1;
}
pdo_odbc_stmt_error("SQLBindParameter");
return 0;
}
case PDO_PARAM_EVT_EXEC_PRE:
P = param->driver_data;
if (!Z_ISREF(param->parameter)) {
parameter = &param->parameter;
} else {
parameter = Z_REFVAL(param->parameter);
}
if (PDO_PARAM_TYPE(param->param_type) == PDO_PARAM_LOB) {
if (Z_TYPE_P(parameter) == IS_RESOURCE) {
php_stream *stm;
php_stream_statbuf sb;
php_stream_from_zval_no_verify(stm, parameter);
if (!stm) {
return 0;
}
if (0 == php_stream_stat(stm, &sb)) {
if (P->outbuf) {
int len, amount;
char *ptr = P->outbuf;
char *end = P->outbuf + P->len;
P->len = 0;
do {
amount = end - ptr;
if (amount == 0) {
break;
}
if (amount > 8192)
amount = 8192;
len = php_stream_read(stm, ptr, amount);
if (len == 0) {
break;
}
ptr += len;
P->len += len;
} while (1);
} else {
P->len = SQL_LEN_DATA_AT_EXEC(sb.sb.st_size);
}
} else {
if (P->outbuf) {
P->len = 0;
} else {
P->len = SQL_LEN_DATA_AT_EXEC(0);
}
}
} else {
convert_to_string(parameter);
if (P->outbuf) {
P->len = Z_STRLEN_P(parameter);
memcpy(P->outbuf, Z_STRVAL_P(parameter), P->len);
} else {
P->len = SQL_LEN_DATA_AT_EXEC(Z_STRLEN_P(parameter));
}
}
} else if (Z_TYPE_P(parameter) == IS_NULL || PDO_PARAM_TYPE(param->param_type) == PDO_PARAM_NULL) {
P->len = SQL_NULL_DATA;
} else {
convert_to_string(parameter);
if (P->outbuf) {
zend_ulong ulen;
switch (pdo_odbc_utf82ucs2(stmt, P->is_unicode,
Z_STRVAL_P(parameter),
Z_STRLEN_P(parameter),
&ulen)) {
case PDO_ODBC_CONV_FAIL:
case PDO_ODBC_CONV_NOT_REQUIRED:
P->len = Z_STRLEN_P(parameter);
memcpy(P->outbuf, Z_STRVAL_P(parameter), P->len);
break;
case PDO_ODBC_CONV_OK:
P->len = ulen;
memcpy(P->outbuf, S->convbuf, P->len);
break;
}
} else {
P->len = SQL_LEN_DATA_AT_EXEC(Z_STRLEN_P(parameter));
}
}
return 1;
case PDO_PARAM_EVT_EXEC_POST:
P = param->driver_data;
if (P->outbuf) {
if (Z_ISREF(param->parameter)) {
parameter = Z_REFVAL(param->parameter);
} else {
parameter = &param->parameter;
}
zval_ptr_dtor(parameter);
if (P->len >= 0) {
ZVAL_STRINGL(parameter, P->outbuf, P->len);
switch (pdo_odbc_ucs22utf8(P->is_unicode, parameter)) {
case PDO_ODBC_CONV_FAIL:
/* something fishy, but allow it to come back as binary */
case PDO_ODBC_CONV_NOT_REQUIRED:
break;
case PDO_ODBC_CONV_OK:
break;
}
} else {
ZVAL_NULL(parameter);
}
}
return 1;
}
}
return 1;
}
static int odbc_stmt_fetch(pdo_stmt_t *stmt,
enum pdo_fetch_orientation ori, zend_long offset)
{
RETCODE rc;
SQLSMALLINT odbcori;
pdo_odbc_stmt *S = (pdo_odbc_stmt*)stmt->driver_data;
switch (ori) {
case PDO_FETCH_ORI_NEXT: odbcori = SQL_FETCH_NEXT; break;
case PDO_FETCH_ORI_PRIOR: odbcori = SQL_FETCH_PRIOR; break;
case PDO_FETCH_ORI_FIRST: odbcori = SQL_FETCH_FIRST; break;
case PDO_FETCH_ORI_LAST: odbcori = SQL_FETCH_LAST; break;
case PDO_FETCH_ORI_ABS: odbcori = SQL_FETCH_ABSOLUTE; break;
case PDO_FETCH_ORI_REL: odbcori = SQL_FETCH_RELATIVE; break;
default:
strcpy(stmt->error_code, "HY106");
return 0;
}
rc = SQLFetchScroll(S->stmt, odbcori, offset);
if (rc == SQL_SUCCESS) {
return 1;
}
if (rc == SQL_SUCCESS_WITH_INFO) {
pdo_odbc_stmt_error("SQLFetchScroll");
return 1;
}
if (rc == SQL_NO_DATA) {
/* pdo_odbc_stmt_error("SQLFetchScroll"); */
return 0;
}
pdo_odbc_stmt_error("SQLFetchScroll");
return 0;
}
static int odbc_stmt_describe(pdo_stmt_t *stmt, int colno)
{
pdo_odbc_stmt *S = (pdo_odbc_stmt*)stmt->driver_data;
struct pdo_column_data *col = &stmt->columns[colno];
RETCODE rc;
SQLSMALLINT colnamelen;
SQLULEN colsize;
SQLLEN displaysize = 0;
rc = SQLDescribeCol(S->stmt, colno+1, (SQLCHAR *) S->cols[colno].colname,
sizeof(S->cols[colno].colname)-1, &colnamelen,
&S->cols[colno].coltype, &colsize, NULL, NULL);
/* This fixes a known issue with SQL Server and (max) lengths,
may affect others as well. If we are SQL_VARCHAR,
SQL_VARBINARY, or SQL_WVARCHAR (or any of the long variations)
and zero is returned from colsize then consider it long */
if (0 == colsize &&
(S->cols[colno].coltype == SQL_VARCHAR ||
S->cols[colno].coltype == SQL_LONGVARCHAR ||
#ifdef SQL_WVARCHAR
S->cols[colno].coltype == SQL_WVARCHAR ||
#endif
#ifdef SQL_WLONGVARCHAR
S->cols[colno].coltype == SQL_WLONGVARCHAR ||
#endif
S->cols[colno].coltype == SQL_VARBINARY ||
S->cols[colno].coltype == SQL_LONGVARBINARY)) {
S->going_long = 1;
}
if (rc != SQL_SUCCESS) {
pdo_odbc_stmt_error("SQLDescribeCol");
if (rc != SQL_SUCCESS_WITH_INFO) {
return 0;
}
}
rc = SQLColAttribute(S->stmt, colno+1,
SQL_DESC_DISPLAY_SIZE,
NULL, 0, NULL, &displaysize);
if (rc != SQL_SUCCESS) {
pdo_odbc_stmt_error("SQLColAttribute");
if (rc != SQL_SUCCESS_WITH_INFO) {
return 0;
}
}
colsize = displaysize;
col->maxlen = S->cols[colno].datalen = colsize;
col->name = zend_string_init(S->cols[colno].colname, colnamelen, 0);
S->cols[colno].is_unicode = pdo_odbc_sqltype_is_unicode(S, S->cols[colno].coltype);
/* tell ODBC to put it straight into our buffer, but only if it
* isn't "long" data, and only if we haven't already bound a long
* column. */
if (colsize < LONG_COLUMN_BUFFER_SIZE && !S->going_long) {
S->cols[colno].data = emalloc(colsize+1);
S->cols[colno].is_long = 0;
rc = SQLBindCol(S->stmt, colno+1,
S->cols[colno].is_unicode ? SQL_C_BINARY : SQL_C_CHAR,
S->cols[colno].data,
S->cols[colno].datalen+1, &S->cols[colno].fetched_len);
if (rc != SQL_SUCCESS) {
pdo_odbc_stmt_error("SQLBindCol");
return 0;
}
} else {
/* allocate a smaller buffer to keep around for smaller
* "long" columns */
S->cols[colno].data = emalloc(LONG_COLUMN_BUFFER_SIZE);
S->going_long = 1;
S->cols[colno].is_long = 1;
}
return 1;
}
static int odbc_stmt_get_column_meta(pdo_stmt_t *stmt, zend_long colno, zval *return_value)
{
array_init(return_value);
add_assoc_long(return_value, "pdo_type", PDO_PARAM_STR);
return 1;
}
static int odbc_stmt_get_col(pdo_stmt_t *stmt, int colno, zval *result, enum pdo_param_type *type)
{
pdo_odbc_stmt *S = (pdo_odbc_stmt*)stmt->driver_data;
pdo_odbc_column *C = &S->cols[colno];
/* if it is a column containing "long" data, perform late binding now */
if (C->is_long) {
SQLLEN orig_fetched_len = SQL_NULL_DATA;
RETCODE rc;
/* fetch it into C->data, which is allocated with a length
* of the page size minus zend_string overhead (LONG_COLUMN_BUFFER_SIZE);
* if there is more to be had, we then allocate
* bigger buffer for the caller to free */
rc = SQLGetData(S->stmt, colno+1, C->is_unicode ? SQL_C_BINARY : SQL_C_CHAR, C->data,
LONG_COLUMN_BUFFER_SIZE, &C->fetched_len);
orig_fetched_len = C->fetched_len;
if (rc == SQL_SUCCESS && C->fetched_len < LONG_COLUMN_BUFFER_SIZE) {
/* all the data fit into our little buffer;
* jump down to the generic bound data case */
goto in_data;
}
if (rc == SQL_SUCCESS_WITH_INFO || rc == SQL_SUCCESS) {
/*
* This is a long column.
*
* Try to get as much as we can at once. If the
* driver somehow has more for us, get more. We'll
* assemble it into one big buffer at the end.
*
* N.B. with n and n+1 mentioned in the comments:
* n is the size returned without null terminator.
*
* The extension previously tried getting it in 256
* byte blocks, but this could have created trouble
* with some drivers.
*
* However, depending on the driver, fetched_len may
* not contain the number of bytes and SQL_NO_TOTAL
* may be passed.
* The behavior in this case is the same as before,
* dividing the data into blocks. However, it has been
* changed from 256 byte to LONG_COLUMN_BUFFER_SIZE.
*/
ssize_t to_fetch_len;
if (orig_fetched_len == SQL_NO_TOTAL) {
to_fetch_len = C->datalen > (LONG_COLUMN_BUFFER_SIZE - 1) ? (LONG_COLUMN_BUFFER_SIZE - 1) : C->datalen;
} else {
to_fetch_len = orig_fetched_len;
}
ssize_t to_fetch_byte = to_fetch_len + 1;
char *buf2 = emalloc(to_fetch_byte);
zend_string *str = zend_string_init(C->data, to_fetch_byte, 0);
size_t used = to_fetch_len;
do {
C->fetched_len = 0;
/* read block. n + 1 bytes => n bytes are actually read, the last 1 is NULL */
rc = SQLGetData(S->stmt, colno+1, C->is_unicode ? SQL_C_BINARY : SQL_C_CHAR, buf2, to_fetch_byte, &C->fetched_len);
/* adjust `used` in case we have proper length info from the driver */
if (orig_fetched_len >= 0 && C->fetched_len >= 0) {
SQLLEN fixed_used = orig_fetched_len - C->fetched_len;
if (fixed_used <= used + 1) {
used = fixed_used;
}
}
/* resize output buffer and reassemble block */
if (rc==SQL_SUCCESS_WITH_INFO || (rc==SQL_SUCCESS && C->fetched_len > to_fetch_len)) {
/* point 5, in section "Retrieving Data with SQLGetData" in http://msdn.microsoft.com/en-us/library/windows/desktop/ms715441(v=vs.85).aspx
states that if SQL_SUCCESS_WITH_INFO, fetched_len will be > n (greater than buf2's size)
(if a driver fails to follow that and wrote less than n bytes to buf2, this will AV or read garbage into buf) */
str = zend_string_realloc(str, used + to_fetch_byte, 0);
memcpy(ZSTR_VAL(str) + used, buf2, to_fetch_byte);
used = used + to_fetch_len;
} else if (rc==SQL_SUCCESS) {
str = zend_string_realloc(str, used + C->fetched_len, 0);
memcpy(ZSTR_VAL(str) + used, buf2, C->fetched_len);
used = used + C->fetched_len;
} else {
/* includes SQL_NO_DATA */
break;
}
} while (1);
efree(buf2);
/* NULL terminate the buffer once, when finished, for use with the rest of PHP */
ZSTR_VAL(str)[used] = '\0';
ZVAL_STR(result, str);
if (C->is_unicode) {
goto unicode_conv;
}
return 1;
}
/* something went caca */
return 1;
}
in_data:
/* check the indicator to ensure that the data is intact */
if (C->fetched_len == SQL_NULL_DATA) {
/* A NULL value */
ZVAL_NULL(result);
return 1;
} else if (C->fetched_len >= 0) {
/* it was stored perfectly */
ZVAL_STRINGL_FAST(result, C->data, C->fetched_len);
if (C->is_unicode) {
goto unicode_conv;
}
return 1;
} else {
/* no data? */
ZVAL_NULL(result);
return 1;
}
unicode_conv:
switch (pdo_odbc_ucs22utf8(C->is_unicode, result)) {
case PDO_ODBC_CONV_FAIL:
/* oh well. They can have the binary version of it */
case PDO_ODBC_CONV_NOT_REQUIRED:
/* shouldn't happen... */
return 1;
case PDO_ODBC_CONV_OK:
return 1;
}
return 1;
}
static int odbc_stmt_set_param(pdo_stmt_t *stmt, zend_long attr, zval *val)
{
SQLRETURN rc;
pdo_odbc_stmt *S = (pdo_odbc_stmt*)stmt->driver_data;
switch (attr) {
case PDO_ATTR_CURSOR_NAME:
convert_to_string(val);
rc = SQLSetCursorName(S->stmt, (SQLCHAR *) Z_STRVAL_P(val), Z_STRLEN_P(val));
if (rc == SQL_SUCCESS || rc == SQL_SUCCESS_WITH_INFO) {
return 1;
}
pdo_odbc_stmt_error("SQLSetCursorName");
return 0;
case PDO_ODBC_ATTR_ASSUME_UTF8:
S->assume_utf8 = zval_is_true(val);
return 0;
default:
strcpy(S->einfo.last_err_msg, "Unknown Attribute");
S->einfo.what = "setAttribute";
strcpy(S->einfo.last_state, "IM001");
return -1;
}
}
static int odbc_stmt_get_attr(pdo_stmt_t *stmt, zend_long attr, zval *val)
{
SQLRETURN rc;
pdo_odbc_stmt *S = (pdo_odbc_stmt*)stmt->driver_data;
switch (attr) {
case PDO_ATTR_CURSOR_NAME:
{
char buf[256];
SQLSMALLINT len = 0;
rc = SQLGetCursorName(S->stmt, (SQLCHAR *) buf, sizeof(buf), &len);
if (rc == SQL_SUCCESS || rc == SQL_SUCCESS_WITH_INFO) {
ZVAL_STRINGL(val, buf, len);
return 1;
}
pdo_odbc_stmt_error("SQLGetCursorName");
return 0;
}
case PDO_ODBC_ATTR_ASSUME_UTF8:
ZVAL_BOOL(val, S->assume_utf8 ? 1 : 0);
return 0;
default:
strcpy(S->einfo.last_err_msg, "Unknown Attribute");
S->einfo.what = "getAttribute";
strcpy(S->einfo.last_state, "IM001");
return -1;
}
}
static int odbc_stmt_next_rowset(pdo_stmt_t *stmt)
{
SQLRETURN rc;
SQLSMALLINT colcount;
pdo_odbc_stmt *S = (pdo_odbc_stmt*)stmt->driver_data;
/* NOTE: can't guarantee that output or input/output parameters
* are set until this fella returns SQL_NO_DATA, according to
* MSDN ODBC docs */
rc = SQLMoreResults(S->stmt);
if (rc != SQL_SUCCESS && rc != SQL_SUCCESS_WITH_INFO) {
return 0;
}
free_cols(stmt, S);
/* how many columns do we have ? */
SQLNumResultCols(S->stmt, &colcount);
stmt->column_count = S->col_count = (int)colcount;
S->cols = ecalloc(colcount, sizeof(pdo_odbc_column));
S->going_long = 0;
return 1;
}
static int odbc_stmt_close_cursor(pdo_stmt_t *stmt)
{
SQLRETURN rc;
pdo_odbc_stmt *S = (pdo_odbc_stmt*)stmt->driver_data;
rc = SQLCloseCursor(S->stmt);
if (rc != SQL_SUCCESS && rc != SQL_SUCCESS_WITH_INFO) {
return 0;
}
return 1;
}
const struct pdo_stmt_methods odbc_stmt_methods = {
odbc_stmt_dtor,
odbc_stmt_execute,
odbc_stmt_fetch,
odbc_stmt_describe,
odbc_stmt_get_col,
odbc_stmt_param_hook,
odbc_stmt_set_param,
odbc_stmt_get_attr,
odbc_stmt_get_column_meta,
odbc_stmt_next_rowset,
odbc_stmt_close_cursor
};