1 /* Licensed to the Apache Software Foundation (ASF) under one or more
2 * contributor license agreements. See the NOTICE file distributed with
3 * this work for additional information regarding copyright ownership.
4 * The ASF licenses this file to You under the Apache License, Version 2.0
5 * (the "License"); you may not use this file except in compliance with
6 * the License. You may obtain a copy of the License at
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
21 #include "apr_strings.h"
22 #include "apr_buckets.h"
24 #include "apr_file_io.h"
25 #include "apr_file_info.h"
26 #include "apr_dbd_internal.h"
27 #include "apr_thread_proc.h"
28 #include "apu_version.h"
29 #include "apu_config.h"
33 /* If library is ODBC-V2, use macros for limited ODBC-V2 support
34 * No random access in V2.
37 #define ODBCVER 0x0200
38 #include "apr_dbd_odbc_v2.h"
41 /* standard ODBC include files */
45 #elif defined(HAVE_ODBC_SQL_H)
47 #include <odbc/sqlext.h>
51 * MSVC6 does not support intptr_t (C99)
52 * APR does not have a signed inptr type until 2.0 (r1557720)
54 #if defined(_MSC_VER) && _MSC_VER < 1400
55 #if APR_SIZEOF_VOIDP == 8
56 #define ODBC_INTPTR_T apr_int64_t
58 #define ODBC_INTPTR_T apr_int32_t
61 #define ODBC_INTPTR_T intptr_t
65 /* Driver name is "odbc" and the entry point is 'apr_dbd_odbc_driver'
66 * unless ODBC_DRIVER_NAME is defined and it is linked with another db library which
67 * is ODBC source-compatible. e.g. DB2, Informix, TimesTen, mysql.
69 #ifndef ODBC_DRIVER_NAME
70 #define ODBC_DRIVER_NAME odbc
72 #define STRINGIFY(x) #x
73 #define NAMIFY2(n) apr_dbd_##n##_driver
74 #define NAMIFY1(n) NAMIFY2(n)
75 #define ODBC_DRIVER_STRING STRINGIFY(ODBC_DRIVER_NAME)
76 #define ODBC_DRIVER_ENTRY NAMIFY1(ODBC_DRIVER_NAME)
78 /* Required APR version for this driver */
79 #define DRIVER_APU_VERSION_MAJOR APU_MAJOR_VERSION
80 #define DRIVER_APU_VERSION_MINOR APU_MINOR_VERSION
82 static SQLHANDLE henv = NULL; /* ODBC ENV handle is process-wide */
84 /* Use a CHECK_ERROR macro so we can grab the source line numbers
87 static void check_error(apr_dbd_t *a, const char *step, SQLRETURN rc,
88 SQLSMALLINT type, SQLHANDLE h, int line);
89 #define CHECK_ERROR(a,s,r,t,h) check_error(a,s,r,t,h, __LINE__)
91 #define SOURCE_FILE __FILE__ /* source file for error messages */
92 #define MAX_ERROR_STRING 1024 /* max length of message in dbc */
93 #define MAX_COLUMN_NAME 256 /* longest column name recognized */
94 #define DEFAULT_BUFFER_SIZE 1024 /* value for defaultBufferSize */
97 #define DEFAULTSEPS " \t\r\n,="
98 #define CSINGLEQUOTE '\''
99 #define SSINGLEQUOTE "\'"
101 #define TEXTMODE 1 /* used for text (APR 1.2) mode params */
102 #define BINARYMODE 0 /* used for binary (APR 1.3+) mode params */
104 /* Identify datatypes which are LOBs
105 * - DB2 DRDA driver uses undefined types -98 and -99 for CLOB & BLOB
107 #define IS_LOB(t) (t == SQL_LONGVARCHAR \
108 || t == SQL_LONGVARBINARY || t == SQL_VARBINARY \
109 || t == -98 || t == -99)
111 /* These types are CLOBs
112 * - DB2 DRDA driver uses undefined type -98 for CLOB
115 (t == SQL_LONGVARCHAR || t == -98)
117 /* Convert a SQL result to an APR result */
118 #define APR_FROM_SQL_RESULT(rc) \
119 (SQL_SUCCEEDED(rc) ? APR_SUCCESS : APR_EGENERAL)
121 /* DBD opaque structures */
124 SQLHANDLE dbc; /* SQL connection handle - NULL after close */
125 apr_pool_t *pool; /* connection lifetime pool */
126 char *dbname; /* ODBC datasource */
129 char lastError[MAX_ERROR_STRING];
130 int defaultBufferSize; /* used for CLOBs in text mode,
131 * and when fld size is indeterminate */
132 ODBC_INTPTR_T transaction_mode;
133 ODBC_INTPTR_T dboptions; /* driver options re SQLGetData */
134 ODBC_INTPTR_T default_transaction_mode;
135 int can_commit; /* controls end_trans behavior */
138 struct apr_dbd_results_t
140 SQLHANDLE stmt; /* parent sql statement handle */
141 SQLHANDLE dbc; /* parent sql connection handle */
142 apr_pool_t *pool; /* pool from query or select */
143 apr_dbd_t *apr_dbd; /* parent DBD connection handle */
144 int random; /* random access requested */
145 int ncols; /* number of columns */
146 int isclosed; /* cursor has been closed */
147 char **colnames; /* array of column names (NULL until used) */
148 SQLPOINTER *colptrs; /* pointers to column data */
149 SQLINTEGER *colsizes; /* sizes for columns (enough for txt or bin) */
150 SQLINTEGER *coltextsizes; /* max-sizes if converted to text */
151 SQLSMALLINT *coltypes; /* array of SQL data types for columns */
152 SQLLEN *colinds; /* array of SQL data indicator/strlens */
153 int *colstate; /* array of column states
154 * - avail, bound, present, unavail
156 int *all_data_fetched; /* flags data as all fetched, for LOBs */
157 void *data; /* buffer for all data for one row */
160 enum /* results column states */
162 COL_AVAIL, /* data may be retrieved with SQLGetData */
163 COL_PRESENT, /* data has been retrieved with SQLGetData */
164 COL_BOUND, /* column is bound to colptr */
165 COL_RETRIEVED, /* all data from column has been returned */
166 COL_UNAVAIL /* column is unavailable because ODBC driver
167 * requires that columns be retrieved
168 * in ascending order and a higher col
173 struct apr_dbd_row_t {
174 SQLHANDLE stmt; /* parent ODBC statement handle */
175 SQLHANDLE dbc; /* parent ODBC connection handle */
176 apr_pool_t *pool; /* pool from get_row */
177 apr_dbd_results_t *res;
180 struct apr_dbd_transaction_t {
181 SQLHANDLE dbc; /* parent ODBC connection handle */
182 apr_dbd_t *apr_dbd; /* parent DBD connection handle */
185 struct apr_dbd_prepared_t {
186 SQLHANDLE stmt; /* ODBC statement handle */
187 SQLHANDLE dbc; /* parent ODBC connection handle */
191 int *types; /* array of DBD data types */
194 static void odbc_lob_bucket_destroy(void *data);
195 static apr_status_t odbc_lob_bucket_setaside(apr_bucket *e, apr_pool_t *pool);
196 static apr_status_t odbc_lob_bucket_read(apr_bucket *e, const char **str,
197 apr_size_t *len, apr_read_type_e block);
199 /* the ODBC LOB bucket type */
200 static const apr_bucket_type_t odbc_bucket_type = {
201 "ODBC_LOB", 5, APR_BUCKET_DATA,
202 odbc_lob_bucket_destroy,
203 odbc_lob_bucket_read,
204 odbc_lob_bucket_setaside,
205 apr_bucket_shared_split,
206 apr_bucket_shared_copy
209 /* ODBC LOB bucket data */
211 /** Ref count for shared bucket */
212 apr_bucket_refcount refcount;
213 const apr_dbd_row_t *row;
218 /* SQL datatype mappings to DBD datatypes
219 * These tables must correspond *exactly* to the apr_dbd_type_e enum
223 /* ODBC "C" types to DBD datatypes */
224 static SQLSMALLINT const sqlCtype[] = {
225 SQL_C_DEFAULT, /* APR_DBD_TYPE_NONE */
226 SQL_C_STINYINT, /* APR_DBD_TYPE_TINY, \%hhd */
227 SQL_C_UTINYINT, /* APR_DBD_TYPE_UTINY, \%hhu */
228 SQL_C_SSHORT, /* APR_DBD_TYPE_SHORT, \%hd */
229 SQL_C_USHORT, /* APR_DBD_TYPE_USHORT, \%hu */
230 SQL_C_SLONG, /* APR_DBD_TYPE_INT, \%d */
231 SQL_C_ULONG, /* APR_DBD_TYPE_UINT, \%u */
232 SQL_C_SLONG, /* APR_DBD_TYPE_LONG, \%ld */
233 SQL_C_ULONG, /* APR_DBD_TYPE_ULONG, \%lu */
234 SQL_C_SBIGINT, /* APR_DBD_TYPE_LONGLONG, \%lld */
235 SQL_C_UBIGINT, /* APR_DBD_TYPE_ULONGLONG, \%llu */
236 SQL_C_FLOAT, /* APR_DBD_TYPE_FLOAT, \%f */
237 SQL_C_DOUBLE, /* APR_DBD_TYPE_DOUBLE, \%lf */
238 SQL_C_CHAR, /* APR_DBD_TYPE_STRING, \%s */
239 SQL_C_CHAR, /* APR_DBD_TYPE_TEXT, \%pDt */
240 SQL_C_CHAR, /*SQL_C_TYPE_TIME, APR_DBD_TYPE_TIME, \%pDi */
241 SQL_C_CHAR, /*SQL_C_TYPE_DATE, APR_DBD_TYPE_DATE, \%pDd */
242 SQL_C_CHAR, /*SQL_C_TYPE_TIMESTAMP, APR_DBD_TYPE_DATETIME, \%pDa */
243 SQL_C_CHAR, /*SQL_C_TYPE_TIMESTAMP, APR_DBD_TYPE_TIMESTAMP, \%pDs */
244 SQL_C_CHAR, /*SQL_C_TYPE_TIMESTAMP, APR_DBD_TYPE_ZTIMESTAMP, \%pDz */
245 SQL_LONGVARBINARY, /* APR_DBD_TYPE_BLOB, \%pDb */
246 SQL_LONGVARCHAR, /* APR_DBD_TYPE_CLOB, \%pDc */
247 SQL_TYPE_NULL /* APR_DBD_TYPE_NULL \%pDn */
249 #define NUM_APR_DBD_TYPES (sizeof(sqlCtype) / sizeof(sqlCtype[0]))
251 /* ODBC Base types to DBD datatypes */
252 static SQLSMALLINT const sqlBaseType[] = {
253 SQL_C_DEFAULT, /* APR_DBD_TYPE_NONE */
254 SQL_TINYINT, /* APR_DBD_TYPE_TINY, \%hhd */
255 SQL_TINYINT, /* APR_DBD_TYPE_UTINY, \%hhu */
256 SQL_SMALLINT, /* APR_DBD_TYPE_SHORT, \%hd */
257 SQL_SMALLINT, /* APR_DBD_TYPE_USHORT, \%hu */
258 SQL_INTEGER, /* APR_DBD_TYPE_INT, \%d */
259 SQL_INTEGER, /* APR_DBD_TYPE_UINT, \%u */
260 SQL_INTEGER, /* APR_DBD_TYPE_LONG, \%ld */
261 SQL_INTEGER, /* APR_DBD_TYPE_ULONG, \%lu */
262 SQL_BIGINT, /* APR_DBD_TYPE_LONGLONG, \%lld */
263 SQL_BIGINT, /* APR_DBD_TYPE_ULONGLONG, \%llu */
264 SQL_FLOAT, /* APR_DBD_TYPE_FLOAT, \%f */
265 SQL_DOUBLE, /* APR_DBD_TYPE_DOUBLE, \%lf */
266 SQL_CHAR, /* APR_DBD_TYPE_STRING, \%s */
267 SQL_CHAR, /* APR_DBD_TYPE_TEXT, \%pDt */
268 SQL_CHAR, /*SQL_TIME, APR_DBD_TYPE_TIME, \%pDi */
269 SQL_CHAR, /*SQL_DATE, APR_DBD_TYPE_DATE, \%pDd */
270 SQL_CHAR, /*SQL_TIMESTAMP, APR_DBD_TYPE_DATETIME, \%pDa */
271 SQL_CHAR, /*SQL_TIMESTAMP, APR_DBD_TYPE_TIMESTAMP, \%pDs */
272 SQL_CHAR, /*SQL_TIMESTAMP, APR_DBD_TYPE_ZTIMESTAMP, \%pDz */
273 SQL_LONGVARBINARY, /* APR_DBD_TYPE_BLOB, \%pDb */
274 SQL_LONGVARCHAR, /* APR_DBD_TYPE_CLOB, \%pDc */
275 SQL_TYPE_NULL /* APR_DBD_TYPE_NULL \%pDn */
278 /* result sizes for DBD datatypes (-1 for null-terminated) */
279 static int const sqlSizes[] = {
281 sizeof(char), /**< \%hhd out: char* */
282 sizeof(unsigned char), /**< \%hhu out: unsigned char* */
283 sizeof(short), /**< \%hd out: short* */
284 sizeof(unsigned short), /**< \%hu out: unsigned short* */
285 sizeof(int), /**< \%d out: int* */
286 sizeof(unsigned int), /**< \%u out: unsigned int* */
287 sizeof(long), /**< \%ld out: long* */
288 sizeof(unsigned long), /**< \%lu out: unsigned long* */
289 sizeof(apr_int64_t), /**< \%lld out: apr_int64_t* */
290 sizeof(apr_uint64_t), /**< \%llu out: apr_uint64_t* */
291 sizeof(float), /**< \%f out: float* */
292 sizeof(double), /**< \%lf out: double* */
293 -1, /**< \%s out: char** */
294 -1, /**< \%pDt out: char** */
295 -1, /**< \%pDi out: char** */
296 -1, /**< \%pDd out: char** */
297 -1, /**< \%pDa out: char** */
298 -1, /**< \%pDs out: char** */
299 -1, /**< \%pDz out: char** */
300 sizeof(apr_bucket_brigade), /**< \%pDb out: apr_bucket_brigade* */
301 sizeof(apr_bucket_brigade), /**< \%pDc out: apr_bucket_brigade* */
302 0 /**< \%pDn : in: void*, out: void** */
309 /* close any open results for the connection */
310 static apr_status_t odbc_close_results(void *d)
312 apr_dbd_results_t *dbr = (apr_dbd_results_t *)d;
313 SQLRETURN rc = SQL_SUCCESS;
315 if (dbr && dbr->apr_dbd && dbr->apr_dbd->dbc) {
317 rc = SQLCloseCursor(dbr->stmt);
320 return APR_FROM_SQL_RESULT(rc);
323 /* close the ODBC statement handle from a prepare */
324 static apr_status_t odbc_close_pstmt(void *s)
326 SQLRETURN rc = APR_SUCCESS;
327 apr_dbd_prepared_t *statement = s;
329 /* stmt is closed if connection has already been closed */
331 SQLHANDLE hstmt = statement->stmt;
333 if (hstmt && statement->apr_dbd && statement->apr_dbd->dbc) {
334 rc = SQLFreeHandle(SQL_HANDLE_STMT, hstmt);
336 statement->stmt = NULL;
338 return APR_FROM_SQL_RESULT(rc);
341 /* close: close/release a connection obtained from open() */
342 static apr_status_t odbc_close(apr_dbd_t *handle)
344 SQLRETURN rc = SQL_SUCCESS;
347 rc = SQLDisconnect(handle->dbc);
348 CHECK_ERROR(handle, "SQLDisconnect", rc, SQL_HANDLE_DBC, handle->dbc);
349 rc = SQLFreeHandle(SQL_HANDLE_DBC, handle->dbc);
350 CHECK_ERROR(handle, "SQLFreeHandle (DBC)", rc, SQL_HANDLE_ENV, henv);
353 return APR_FROM_SQL_RESULT(rc);
356 /* odbc_close re-defined for passing to pool cleanup */
357 static apr_status_t odbc_close_cleanup(void *handle)
359 return odbc_close((apr_dbd_t *)handle);
362 /* close the ODBC environment handle at process termination */
363 static apr_status_t odbc_close_env(SQLHANDLE henv)
367 rc = SQLFreeHandle(SQL_HANDLE_ENV, henv);
369 return APR_FROM_SQL_RESULT(rc);
372 /* setup the arrays in results for all the returned columns */
373 static SQLRETURN odbc_set_result_column(int icol, apr_dbd_results_t *res,
377 ODBC_INTPTR_T maxsize, textsize, realsize, type, isunsigned = 1;
379 /* discover the sql type */
380 rc = SQLColAttribute(stmt, icol + 1, SQL_DESC_UNSIGNED, NULL, 0, NULL,
381 (SQLPOINTER)&isunsigned);
382 isunsigned = (isunsigned == SQL_TRUE);
384 rc = SQLColAttribute(stmt, icol + 1, SQL_DESC_TYPE, NULL, 0, NULL,
386 if (!SQL_SUCCEEDED(rc) || type == SQL_UNKNOWN_TYPE) {
387 /* MANY ODBC v2 datasources only supply CONCISE_TYPE */
388 rc = SQLColAttribute(stmt, icol + 1, SQL_DESC_CONCISE_TYPE, NULL,
389 0, NULL, (SQLPOINTER)&type);
392 if (!SQL_SUCCEEDED(rc)) {
393 /* if still unknown make it CHAR */
402 /* fix these numeric binary types up as signed/unsigned for C types */
403 type += (isunsigned) ? SQL_UNSIGNED_OFFSET : SQL_SIGNED_OFFSET;
405 /* LOB types are not changed to C types */
406 case SQL_LONGVARCHAR:
407 type = SQL_LONGVARCHAR;
409 case SQL_LONGVARBINARY:
410 type = SQL_LONGVARBINARY;
419 /* DBD wants times as strings */
427 res->coltypes[icol] = (SQLSMALLINT)type;
429 /* size if retrieved as text */
430 rc = SQLColAttribute(stmt, icol + 1, SQL_DESC_DISPLAY_SIZE, NULL, 0,
431 NULL, (SQLPOINTER)&textsize);
432 if (!SQL_SUCCEEDED(rc) || textsize < 0) {
433 textsize = res->apr_dbd->defaultBufferSize;
435 /* for null-term, which sometimes isn't included */
439 rc = SQLColAttribute(stmt, icol + 1, SQL_DESC_OCTET_LENGTH, NULL, 0,
440 NULL, (SQLPOINTER)&realsize);
441 if (!SQL_SUCCEEDED(rc)) {
445 maxsize = (textsize > realsize) ? textsize : realsize;
446 if (IS_LOB(type) || maxsize <= 0) {
447 /* LOB types are never bound and have a NULL colptr for binary.
448 * Ingore their real (1-2gb) length & use a default - the larger
449 * of defaultBufferSize or APR_BUCKET_BUFF_SIZE.
450 * If not a LOB, but simply unknown length - always use defaultBufferSize.
452 maxsize = res->apr_dbd->defaultBufferSize;
453 if (IS_LOB(type) && maxsize < APR_BUCKET_BUFF_SIZE) {
454 maxsize = APR_BUCKET_BUFF_SIZE;
457 res->colptrs[icol] = NULL;
458 res->colstate[icol] = COL_AVAIL;
459 res->colsizes[icol] = (SQLINTEGER)maxsize;
463 res->colptrs[icol] = apr_pcalloc(res->pool, maxsize);
464 res->colsizes[icol] = (SQLINTEGER)maxsize;
465 if (res->apr_dbd->dboptions & SQL_GD_BOUND) {
466 /* we are allowed to call SQLGetData if we need to */
467 rc = SQLBindCol(stmt, icol + 1, res->coltypes[icol],
468 res->colptrs[icol], maxsize,
469 &(res->colinds[icol]));
470 CHECK_ERROR(res->apr_dbd, "SQLBindCol", rc, SQL_HANDLE_STMT,
472 res->colstate[icol] = SQL_SUCCEEDED(rc) ? COL_BOUND : COL_AVAIL;
475 /* this driver won't allow us to call SQLGetData on bound
476 * columns - so don't bind any
478 res->colstate[icol] = COL_AVAIL;
485 /* create and populate an apr_dbd_results_t for a select */
486 static SQLRETURN odbc_create_results(apr_dbd_t *handle, SQLHANDLE hstmt,
487 apr_pool_t *pool, const int random,
488 apr_dbd_results_t **res)
493 *res = apr_pcalloc(pool, sizeof(apr_dbd_results_t));
494 (*res)->stmt = hstmt;
495 (*res)->dbc = handle->dbc;
497 (*res)->random = random;
498 (*res)->apr_dbd = handle;
499 rc = SQLNumResultCols(hstmt, &ncols);
500 CHECK_ERROR(handle, "SQLNumResultCols", rc, SQL_HANDLE_STMT, hstmt);
501 (*res)->ncols = ncols;
503 if (SQL_SUCCEEDED(rc)) {
506 (*res)->colnames = apr_pcalloc(pool, ncols * sizeof(char *));
507 (*res)->colptrs = apr_pcalloc(pool, ncols * sizeof(void *));
508 (*res)->colsizes = apr_pcalloc(pool, ncols * sizeof(SQLINTEGER));
509 (*res)->coltypes = apr_pcalloc(pool, ncols * sizeof(SQLSMALLINT));
510 (*res)->colinds = apr_pcalloc(pool, ncols * sizeof(SQLLEN));
511 (*res)->colstate = apr_pcalloc(pool, ncols * sizeof(int));
512 (*res)->ncols = ncols;
514 for (i = 0; i < ncols; i++) {
515 odbc_set_result_column(i, (*res), hstmt);
522 /* bind a parameter - input params only, does not support output parameters */
523 static SQLRETURN odbc_bind_param(apr_pool_t *pool,
524 apr_dbd_prepared_t *statement, const int narg,
525 const SQLSMALLINT type, int *argp,
526 const void **args, const int textmode)
529 SQLSMALLINT baseType, cType;
533 static SQLLEN nullValue = SQL_NULL_DATA;
534 static SQLSMALLINT inOut = SQL_PARAM_INPUT; /* only input params */
536 /* bind a NULL data value */
537 if (args[*argp] == NULL || type == APR_DBD_TYPE_NULL) {
541 len = sizeof(SQLINTEGER);
542 indicator = &nullValue;
545 /* bind a non-NULL data value */
547 if (type < 0 || type >= NUM_APR_DBD_TYPES) {
551 baseType = sqlBaseType[type];
552 cType = sqlCtype[type];
556 ptr = (void *)args[*argp];
557 len = (SQLULEN) * (apr_size_t *)args[*argp + 1];
558 cType = (IS_CLOB(cType)) ? SQL_C_CHAR : SQL_C_DEFAULT;
559 (*argp) += 4; /* LOBs consume 4 args (last two are unused) */
568 ptr = (void *)args[*argp];
569 len = (SQLULEN)strlen(ptr);
572 ptr = apr_palloc(pool, sizeof(unsigned char));
573 len = sizeof(unsigned char);
574 *(unsigned char *)ptr =
576 atoi(args[*argp]) : *(unsigned char *)args[*argp]);
579 ptr = apr_palloc(pool, sizeof(short));
582 (textmode ? atoi(args[*argp]) : *(short *)args[*argp]);
585 ptr = apr_palloc(pool, sizeof(int));
588 (textmode ? atol(args[*argp]) : *(long *)args[*argp]);
591 ptr = apr_palloc(pool, sizeof(float));
595 (float)atof(args[*argp]) : *(float *)args[*argp]);
598 ptr = apr_palloc(pool, sizeof(double));
599 len = sizeof(double);
601 (textmode ? atof(args[*argp]) : *(double *)
605 ptr = apr_palloc(pool, sizeof(apr_int64_t));
606 len = sizeof(apr_int64_t);
607 *(apr_int64_t *)ptr =
609 apr_atoi64(args[*argp]) : *(apr_int64_t *)args[*argp]);
614 (*argp)++; /* non LOBs consume one argument */
617 rc = SQLBindParameter(statement->stmt, narg, inOut, cType,
618 baseType, len, 0, ptr, len, indicator);
619 CHECK_ERROR(statement->apr_dbd, "SQLBindParameter", rc, SQL_HANDLE_STMT,
624 /* LOB / Bucket Brigade functions */
626 /* bucket type specific destroy */
627 static void odbc_lob_bucket_destroy(void *data)
629 odbc_bucket *bd = data;
631 if (apr_bucket_shared_destroy(bd))
635 /* set aside a bucket if possible */
636 static apr_status_t odbc_lob_bucket_setaside(apr_bucket *e, apr_pool_t *pool)
638 odbc_bucket *bd = (odbc_bucket *)e->data;
640 /* Unlikely - but if the row pool is ancestor of this pool then it is OK */
641 if (apr_pool_is_ancestor(bd->row->pool, pool))
644 return apr_bucket_setaside_notimpl(e, pool);
647 /* split a bucket into a heap bucket followed by a LOB bkt w/remaining data */
648 static apr_status_t odbc_lob_bucket_read(apr_bucket *e, const char **str,
649 apr_size_t *len, apr_read_type_e block)
652 SQLLEN len_indicator;
654 odbc_bucket *bd = (odbc_bucket *)e->data;
657 int bufsize = bd->row->res->apr_dbd->defaultBufferSize;
660 /* C type is CHAR for CLOBs, DEFAULT for BLOBs */
661 type = bd->row->res->coltypes[bd->col];
662 type = (type == SQL_LONGVARCHAR) ? SQL_C_CHAR : SQL_C_DEFAULT;
664 /* LOB buffers are always at least APR_BUCKET_BUFF_SIZE,
665 * but they may be much bigger per the BUFSIZE parameter.
667 if (bufsize < APR_BUCKET_BUFF_SIZE)
668 bufsize = APR_BUCKET_BUFF_SIZE;
670 buf = apr_bucket_alloc(bufsize, e->list);
674 rc = SQLGetData(bd->row->res->stmt, bd->col + 1,
678 CHECK_ERROR(bd->row->res->apr_dbd, "SQLGetData", rc,
679 SQL_HANDLE_STMT, bd->row->res->stmt);
681 if (rc == SQL_NO_DATA || len_indicator == SQL_NULL_DATA || len_indicator < 0)
684 if (SQL_SUCCEEDED(rc) || rc == SQL_NO_DATA) {
686 if (rc == SQL_SUCCESS_WITH_INFO
687 && (len_indicator == SQL_NO_TOTAL || len_indicator >= bufsize)) {
688 /* not the last read = a full buffer. CLOBs have a null terminator */
689 *len = bufsize - (IS_CLOB(bd->type) ? 1 : 0 );
694 /* the last read - len_indicator is supposed to be the length,
695 * but some driver get this wrong and return the total length.
696 * We try to handle both interpretations.
698 *len = (len_indicator > bufsize
699 && len_indicator >= (SQLLEN)e->start)
700 ? (len_indicator - (SQLLEN)e->start) : len_indicator;
706 /* Create a new LOB bucket to append and append it */
707 nxt = apr_bucket_alloc(sizeof(apr_bucket *), e->list);
708 APR_BUCKET_INIT(nxt);
711 nxt->type = &odbc_bucket_type;
712 nxt->free = apr_bucket_free;
714 nxt->start = e->start + *len;
715 APR_BUCKET_INSERT_AFTER(e, nxt);
718 odbc_lob_bucket_destroy(e->data);
720 /* make current bucket into a heap bucket */
721 apr_bucket_heap_make(e, buf, *len, apr_bucket_free);
724 /* No data is success in this context */
727 return APR_FROM_SQL_RESULT(rc);
730 /* Create a bucket brigade on the row pool for a LOB column */
731 static apr_status_t odbc_create_bucket(const apr_dbd_row_t *row, const int col,
732 SQLSMALLINT type, apr_bucket_brigade *bb)
734 apr_bucket_alloc_t *list = bb->bucket_alloc;
735 apr_bucket *b = apr_bucket_alloc(sizeof(*b), list);
736 odbc_bucket *bd = apr_bucket_alloc(sizeof(odbc_bucket), list);
737 apr_bucket *eos = apr_bucket_eos_create(list);
744 b->type = &odbc_bucket_type;
745 b->free = apr_bucket_free;
747 /* LOB lengths are unknown in ODBC */
748 b = apr_bucket_shared_make(b, bd, 0, -1);
750 APR_BRIGADE_INSERT_TAIL(bb, b);
751 APR_BRIGADE_INSERT_TAIL(bb, eos);
756 /* returns a data pointer for a column, returns NULL for NULL value,
757 * return -1 if data not available
759 static void *odbc_get(const apr_dbd_row_t *row, const int col,
760 const SQLSMALLINT sqltype)
764 int state = row->res->colstate[col];
765 ODBC_INTPTR_T options = row->res->apr_dbd->dboptions;
770 case (COL_RETRIEVED):
775 if (sqltype == row->res->coltypes[col]) {
776 /* same type and we already have the data */
777 row->res->colstate[col] = COL_RETRIEVED;
778 return (row->res->colinds[col] == SQL_NULL_DATA) ?
779 NULL : row->res->colptrs[col];
783 /* we need to get the data now */
784 if (!(options & SQL_GD_ANY_ORDER)) {
785 /* this ODBC driver requires columns to be retrieved in order,
786 * so we attempt to get every prior un-gotten non-LOB column
789 for (i = 0; i < col; i++) {
790 if (row->res->colstate[i] == COL_AVAIL) {
791 if (IS_LOB(row->res->coltypes[i]))
792 row->res->colstate[i] = COL_UNAVAIL;
794 odbc_get(row, i, row->res->coltypes[i]);
795 row->res->colstate[i] = COL_PRESENT;
801 if ((state == COL_BOUND && !(options & SQL_GD_BOUND)))
802 /* this driver won't let us re-get bound columns */
805 /* a LOB might not have a buffer allocated yet - so create one */
806 if (!row->res->colptrs[col])
807 row->res->colptrs[col] = apr_pcalloc(row->pool, row->res->colsizes[col]);
809 rc = SQLGetData(row->res->stmt, col + 1, sqltype, row->res->colptrs[col],
810 row->res->colsizes[col], &indicator);
811 CHECK_ERROR(row->res->apr_dbd, "SQLGetData", rc, SQL_HANDLE_STMT,
813 if (indicator == SQL_NULL_DATA || rc == SQL_NO_DATA)
816 if (SQL_SUCCEEDED(rc)) {
817 /* whatever it was originally, it is now this sqltype */
818 row->res->coltypes[col] = sqltype;
819 /* this allows getting CLOBs in text mode by calling get_entry
820 * until it returns NULL
822 row->res->colstate[col] =
823 (rc == SQL_SUCCESS_WITH_INFO) ? COL_AVAIL : COL_RETRIEVED;
824 return row->res->colptrs[col];
830 /* Parse the parameter string for open */
831 static apr_status_t odbc_parse_params(apr_pool_t *pool, const char *params,
832 int *connect, SQLCHAR **datasource,
833 SQLCHAR **user, SQLCHAR **password,
834 int *defaultBufferSize, int *nattrs,
835 int **attrs, ODBC_INTPTR_T **attrvals)
837 char *seps, *last, *next, *name[MAX_PARAMS], *val[MAX_PARAMS];
838 int nparams = 0, i, j;
840 *attrs = apr_pcalloc(pool, MAX_PARAMS * sizeof(char *));
841 *attrvals = apr_pcalloc(pool, MAX_PARAMS * sizeof(ODBC_INTPTR_T));
844 name[nparams] = apr_strtok(apr_pstrdup(pool, params), seps, &last);
846 /* no params is OK here - let connect return a more useful error msg */
851 if (last[strspn(last, seps)] == CSINGLEQUOTE) {
852 last += strspn(last, seps);
855 val[nparams] = apr_strtok(NULL, seps, &last);
859 next = apr_strtok(NULL, seps, &last);
863 if (nparams >= MAX_PARAMS) {
864 /* too many parameters, no place to store */
867 name[nparams] = next;
870 for (j = i = 0; i < nparams; i++) {
871 if (!apr_strnatcasecmp(name[i], "CONNECT")) {
872 *datasource = (SQLCHAR *)apr_pstrdup(pool, val[i]);
875 else if (!apr_strnatcasecmp(name[i], "DATASOURCE")) {
876 *datasource = (SQLCHAR *)apr_pstrdup(pool, val[i]);
879 else if (!apr_strnatcasecmp(name[i], "USER")) {
880 *user = (SQLCHAR *)apr_pstrdup(pool, val[i]);
882 else if (!apr_strnatcasecmp(name[i], "PASSWORD")) {
883 *password = (SQLCHAR *)apr_pstrdup(pool, val[i]);
885 else if (!apr_strnatcasecmp(name[i], "BUFSIZE")) {
886 *defaultBufferSize = atoi(val[i]);
888 else if (!apr_strnatcasecmp(name[i], "ACCESS")) {
889 if (!apr_strnatcasecmp(val[i], "READ_ONLY"))
890 (*attrvals)[j] = SQL_MODE_READ_ONLY;
891 else if (!apr_strnatcasecmp(val[i], "READ_WRITE"))
892 (*attrvals)[j] = SQL_MODE_READ_WRITE;
895 (*attrs)[j++] = SQL_ATTR_ACCESS_MODE;
897 else if (!apr_strnatcasecmp(name[i], "CTIMEOUT")) {
898 (*attrvals)[j] = atoi(val[i]);
899 (*attrs)[j++] = SQL_ATTR_LOGIN_TIMEOUT;
901 else if (!apr_strnatcasecmp(name[i], "STIMEOUT")) {
902 (*attrvals)[j] = atoi(val[i]);
903 (*attrs)[j++] = SQL_ATTR_CONNECTION_TIMEOUT;
905 else if (!apr_strnatcasecmp(name[i], "TXMODE")) {
906 if (!apr_strnatcasecmp(val[i], "READ_UNCOMMITTED"))
907 (*attrvals)[j] = SQL_TXN_READ_UNCOMMITTED;
908 else if (!apr_strnatcasecmp(val[i], "READ_COMMITTED"))
909 (*attrvals)[j] = SQL_TXN_READ_COMMITTED;
910 else if (!apr_strnatcasecmp(val[i], "REPEATABLE_READ"))
911 (*attrvals)[j] = SQL_TXN_REPEATABLE_READ;
912 else if (!apr_strnatcasecmp(val[i], "SERIALIZABLE"))
913 (*attrvals)[j] = SQL_TXN_SERIALIZABLE;
914 else if (!apr_strnatcasecmp(val[i], "DEFAULT"))
918 (*attrs)[j++] = SQL_ATTR_TXN_ISOLATION;
924 return (*datasource && *defaultBufferSize) ? APR_SUCCESS : SQL_ERROR;
927 /* common handling after ODBC calls - save error info (code and text) in dbc */
928 static void check_error(apr_dbd_t *dbc, const char *step, SQLRETURN rc,
929 SQLSMALLINT type, SQLHANDLE h, int line)
932 SQLCHAR sqlstate[128];
934 SQLSMALLINT reslength;
935 char *res, *p, *end, *logval = NULL;
938 /* set info about last error in dbc - fast return for SQL_SUCCESS */
939 if (rc == SQL_SUCCESS) {
940 char successMsg[] = "[dbd_odbc] SQL_SUCCESS ";
941 apr_size_t successMsgLen = sizeof successMsg - 1;
943 dbc->lasterrorcode = SQL_SUCCESS;
944 apr_cpystrn(dbc->lastError, successMsg, sizeof dbc->lastError);
945 apr_cpystrn(dbc->lastError + successMsgLen, step,
946 sizeof dbc->lastError - successMsgLen);
950 case SQL_INVALID_HANDLE:
951 res = "SQL_INVALID_HANDLE";
956 case SQL_SUCCESS_WITH_INFO:
957 res = "SQL_SUCCESS_WITH_INFO";
959 case SQL_STILL_EXECUTING:
960 res = "SQL_STILL_EXECUTING";
963 res = "SQL_NEED_DATA";
969 res = "unrecognized SQL return code";
971 /* these two returns are expected during normal execution */
972 if (rc != SQL_SUCCESS_WITH_INFO && rc != SQL_NO_DATA
973 && dbc->can_commit != APR_DBD_TRANSACTION_IGNORE_ERRORS) {
974 dbc->can_commit = APR_DBD_TRANSACTION_ROLLBACK;
977 end = p + sizeof(dbc->lastError);
978 dbc->lasterrorcode = rc;
979 p += sprintf(p, "[dbd_odbc] %.64s returned %.30s (%d) at %.24s:%d ",
980 step, res, rc, SOURCE_FILE, line - 1);
981 for (i = 1, rc = 0; rc == 0; i++) {
982 rc = SQLGetDiagRec(type, h, i, sqlstate, &native, buffer,
983 sizeof(buffer), &reslength);
984 if (SQL_SUCCEEDED(rc) && (p < (end - 280)))
985 p += sprintf(p, "%.256s %.20s ", buffer, sqlstate);
987 apr_env_get(&logval, "apr_dbd_odbc_log", dbc->pool);
988 /* if env var was set or call was init/open (no dbname) - log to stderr */
989 if (logval || !dbc->dbname ) {
990 char timestamp[APR_CTIME_LEN];
993 apr_ctime(timestamp, apr_time_now());
994 apr_file_open_stderr(&se, dbc->pool);
995 apr_file_printf(se, "[%s] %s\n", timestamp, dbc->lastError);
999 static APR_INLINE int odbc_check_rollback(apr_dbd_t *handle)
1001 if (handle->can_commit == APR_DBD_TRANSACTION_ROLLBACK) {
1002 handle->lasterrorcode = SQL_ERROR;
1003 apr_cpystrn(handle->lastError, "[dbd_odbc] Rollback pending ",
1004 sizeof handle->lastError);
1011 * public functions per DBD driver API
1014 /** init: allow driver to perform once-only initialisation. **/
1015 static void odbc_init(apr_pool_t *pool)
1019 apr_version_t apuver;
1021 apu_version(&apuver);
1022 if (apuver.major != DRIVER_APU_VERSION_MAJOR
1023 || apuver.minor != DRIVER_APU_VERSION_MINOR) {
1026 apr_file_open_stderr(&se, pool);
1027 apr_file_printf(se, "Incorrect " ODBC_DRIVER_STRING " dbd driver version\n"
1028 "Attempt to load APU version %d.%d driver with APU version %d.%d\n",
1029 DRIVER_APU_VERSION_MAJOR, DRIVER_APU_VERSION_MINOR,
1030 apuver.major, apuver.minor);
1037 step = "SQLAllocHandle (SQL_HANDLE_ENV)";
1038 rc = SQLAllocHandle(SQL_HANDLE_ENV, SQL_NULL_HANDLE, &henv);
1039 apr_pool_cleanup_register(pool, henv, odbc_close_env, apr_pool_cleanup_null);
1040 if (SQL_SUCCEEDED(rc)) {
1041 step = "SQLSetEnvAttr";
1042 rc = SQLSetEnvAttr(henv,SQL_ATTR_ODBC_VERSION,
1043 (SQLPOINTER)SQL_OV_ODBC3, 0);
1047 SQLHANDLE err_h = henv;
1049 tmp_dbc.pool = pool;
1050 tmp_dbc.dbname = NULL;
1051 CHECK_ERROR(&tmp_dbc, step, rc, SQL_HANDLE_ENV, err_h);
1055 /** native_handle: return the native database handle of the underlying db **/
1056 static void *odbc_native_handle(apr_dbd_t *handle)
1061 /** open: obtain a database connection from the server rec. **/
1063 /* It would be more efficient to allocate a single statement handle
1064 * here - but SQL_ATTR_CURSOR_SCROLLABLE must be set before
1065 * SQLPrepare, and we don't know whether random-access is
1066 * specified until SQLExecute so we cannot.
1069 static apr_dbd_t *odbc_open(apr_pool_t *pool, const char *params, const char **error)
1072 SQLHANDLE hdbc = NULL;
1076 int defaultBufferSize = DEFAULT_BUFFER_SIZE;
1077 SQLHANDLE err_h = NULL;
1078 SQLCHAR *datasource = (SQLCHAR *)"", *user = (SQLCHAR *)"",
1079 *password = (SQLCHAR *)"";
1080 int nattrs = 0, *attrs = NULL, connect = 0;
1081 ODBC_INTPTR_T *attrvals = NULL;
1083 err_step = "SQLAllocHandle (SQL_HANDLE_DBC)";
1084 err_htype = SQL_HANDLE_ENV;
1086 rc = SQLAllocHandle(SQL_HANDLE_DBC, henv, &hdbc);
1087 if (SQL_SUCCEEDED(rc)) {
1088 err_step = "Invalid DBD Parameters - open";
1089 err_htype = SQL_HANDLE_DBC;
1091 rc = odbc_parse_params(pool, params, &connect, &datasource, &user,
1092 &password, &defaultBufferSize, &nattrs, &attrs,
1095 if (SQL_SUCCEEDED(rc)) {
1096 for (i = 0; i < nattrs && SQL_SUCCEEDED(rc); i++) {
1097 err_step = "SQLSetConnectAttr (from DBD Parameters)";
1098 err_htype = SQL_HANDLE_DBC;
1100 rc = SQLSetConnectAttr(hdbc, attrs[i], (SQLPOINTER)attrvals[i], 0);
1103 if (SQL_SUCCEEDED(rc)) {
1108 err_step = "SQLDriverConnect";
1109 err_htype = SQL_HANDLE_DBC;
1111 rc = SQLDriverConnect(hdbc, NULL, datasource,
1112 (SQLSMALLINT)strlen((char *)datasource),
1113 out, sizeof(out), &outlen, SQL_DRIVER_NOPROMPT);
1116 err_step = "SQLConnect";
1117 err_htype = SQL_HANDLE_DBC;
1119 rc = SQLConnect(hdbc, datasource,
1120 (SQLSMALLINT)strlen((char *)datasource),
1121 user, (SQLSMALLINT)strlen((char *)user),
1122 password, (SQLSMALLINT)strlen((char *)password));
1125 if (SQL_SUCCEEDED(rc)) {
1126 handle = apr_pcalloc(pool, sizeof(apr_dbd_t));
1127 handle->dbname = apr_pstrdup(pool, (char *)datasource);
1129 handle->pool = pool;
1130 handle->defaultBufferSize = defaultBufferSize;
1131 CHECK_ERROR(handle, "SQLConnect", rc, SQL_HANDLE_DBC, handle->dbc);
1132 handle->default_transaction_mode = 0;
1133 handle->can_commit = APR_DBD_TRANSACTION_IGNORE_ERRORS;
1134 SQLGetInfo(hdbc, SQL_DEFAULT_TXN_ISOLATION,
1135 &(handle->default_transaction_mode), sizeof(ODBC_INTPTR_T), NULL);
1136 handle->transaction_mode = handle->default_transaction_mode;
1137 SQLGetInfo(hdbc, SQL_GETDATA_EXTENSIONS ,&(handle->dboptions),
1138 sizeof(ODBC_INTPTR_T), NULL);
1139 apr_pool_cleanup_register(pool, handle, odbc_close_cleanup, apr_pool_cleanup_null);
1145 tmp_dbc.pool = pool;
1146 tmp_dbc.dbname = NULL;
1147 CHECK_ERROR(&tmp_dbc, err_step, rc, err_htype, err_h);
1149 *error = apr_pstrdup(pool, tmp_dbc.lastError);
1151 SQLFreeHandle(SQL_HANDLE_DBC, hdbc);
1156 /** check_conn: check status of a database connection **/
1157 static apr_status_t odbc_check_conn(apr_pool_t *pool, apr_dbd_t *handle)
1162 rc = SQLGetConnectAttr(handle->dbc, SQL_ATTR_CONNECTION_DEAD, &isDead,
1163 sizeof(SQLUINTEGER), NULL);
1164 CHECK_ERROR(handle, "SQLGetConnectAttr (SQL_ATTR_CONNECTION_DEAD)", rc,
1165 SQL_HANDLE_DBC, handle->dbc);
1166 /* if driver cannot check connection, say so */
1167 if (rc != SQL_SUCCESS)
1168 return APR_ENOTIMPL;
1170 return (isDead == SQL_CD_FALSE) ? APR_SUCCESS : APR_EGENERAL;
1173 /** set_dbname: select database name. May be a no-op if not supported. **/
1174 static int odbc_set_dbname(apr_pool_t*pool, apr_dbd_t *handle,
1177 if (apr_strnatcmp(name, handle->dbname)) {
1178 return APR_EGENERAL; /* It's illegal to change dbname in ODBC */
1180 CHECK_ERROR(handle, "set_dbname (no-op)", SQL_SUCCESS, SQL_HANDLE_DBC,
1182 return APR_SUCCESS; /* OK if it's the same name */
1185 /** transaction: start a transaction. May be a no-op. **/
1186 static int odbc_start_transaction(apr_pool_t *pool, apr_dbd_t *handle,
1187 apr_dbd_transaction_t **trans)
1189 SQLRETURN rc = SQL_SUCCESS;
1191 if (handle->transaction_mode) {
1192 rc = SQLSetConnectAttr(handle->dbc, SQL_ATTR_TXN_ISOLATION,
1193 (SQLPOINTER)handle->transaction_mode, 0);
1194 CHECK_ERROR(handle, "SQLSetConnectAttr (SQL_ATTR_TXN_ISOLATION)", rc,
1195 SQL_HANDLE_DBC, handle->dbc);
1197 if (SQL_SUCCEEDED(rc)) {
1198 /* turn off autocommit for transactions */
1199 rc = SQLSetConnectAttr(handle->dbc, SQL_ATTR_AUTOCOMMIT,
1200 SQL_AUTOCOMMIT_OFF, 0);
1201 CHECK_ERROR(handle, "SQLSetConnectAttr (SQL_ATTR_AUTOCOMMIT)", rc,
1202 SQL_HANDLE_DBC, handle->dbc);
1204 if (SQL_SUCCEEDED(rc)) {
1205 *trans = apr_palloc(pool, sizeof(apr_dbd_transaction_t));
1206 (*trans)->dbc = handle->dbc;
1207 (*trans)->apr_dbd = handle;
1209 handle->can_commit = APR_DBD_TRANSACTION_COMMIT;
1210 return APR_FROM_SQL_RESULT(rc);
1213 /** end_transaction: end a transaction **/
1214 static int odbc_end_transaction(apr_dbd_transaction_t *trans)
1217 int action = (trans->apr_dbd->can_commit != APR_DBD_TRANSACTION_ROLLBACK)
1218 ? SQL_COMMIT : SQL_ROLLBACK;
1220 rc = SQLEndTran(SQL_HANDLE_DBC, trans->dbc, action);
1221 CHECK_ERROR(trans->apr_dbd, "SQLEndTran", rc, SQL_HANDLE_DBC, trans->dbc);
1222 if (SQL_SUCCEEDED(rc)) {
1223 rc = SQLSetConnectAttr(trans->dbc, SQL_ATTR_AUTOCOMMIT,
1224 (SQLPOINTER)SQL_AUTOCOMMIT_ON, 0);
1225 CHECK_ERROR(trans->apr_dbd, "SQLSetConnectAttr (SQL_ATTR_AUTOCOMMIT)",
1226 rc, SQL_HANDLE_DBC, trans->dbc);
1228 trans->apr_dbd->can_commit = APR_DBD_TRANSACTION_IGNORE_ERRORS;
1229 return APR_FROM_SQL_RESULT(rc);
1232 /** query: execute an SQL statement which doesn't return a result set **/
1233 static int odbc_query(apr_dbd_t *handle, int *nrows, const char *statement)
1236 SQLHANDLE hstmt = NULL;
1237 size_t len = strlen(statement);
1239 if (odbc_check_rollback(handle))
1240 return APR_EGENERAL;
1242 rc = SQLAllocHandle(SQL_HANDLE_STMT, handle->dbc, &hstmt);
1243 CHECK_ERROR(handle, "SQLAllocHandle (STMT)", rc, SQL_HANDLE_DBC,
1245 if (!SQL_SUCCEEDED(rc))
1246 return APR_FROM_SQL_RESULT(rc);
1248 rc = SQLExecDirect(hstmt, (SQLCHAR *)statement, (SQLINTEGER)len);
1249 CHECK_ERROR(handle, "SQLExecDirect", rc, SQL_HANDLE_STMT, hstmt);
1251 if (SQL_SUCCEEDED(rc)) {
1254 rc = SQLRowCount(hstmt, &rowcount);
1255 *nrows = (int)rowcount;
1256 CHECK_ERROR(handle, "SQLRowCount", rc, SQL_HANDLE_STMT, hstmt);
1259 SQLFreeHandle(SQL_HANDLE_STMT, hstmt);
1260 return APR_FROM_SQL_RESULT(rc);
1263 /** select: execute an SQL statement which returns a result set **/
1264 static int odbc_select(apr_pool_t *pool, apr_dbd_t *handle,
1265 apr_dbd_results_t **res, const char *statement,
1270 apr_dbd_prepared_t *stmt;
1271 size_t len = strlen(statement);
1273 if (odbc_check_rollback(handle))
1274 return APR_EGENERAL;
1276 rc = SQLAllocHandle(SQL_HANDLE_STMT, handle->dbc, &hstmt);
1277 CHECK_ERROR(handle, "SQLAllocHandle (STMT)", rc, SQL_HANDLE_DBC,
1279 if (!SQL_SUCCEEDED(rc))
1280 return APR_FROM_SQL_RESULT(rc);
1281 /* Prepare an apr_dbd_prepared_t for pool cleanup, even though this
1282 * is not a prepared statement. We want the same cleanup mechanism.
1284 stmt = apr_pcalloc(pool, sizeof(apr_dbd_prepared_t));
1285 stmt->apr_dbd = handle;
1286 stmt->dbc = handle->dbc;
1288 apr_pool_cleanup_register(pool, stmt, odbc_close_pstmt, apr_pool_cleanup_null);
1290 rc = SQLSetStmtAttr(hstmt, SQL_ATTR_CURSOR_SCROLLABLE,
1291 (SQLPOINTER)SQL_SCROLLABLE, 0);
1292 CHECK_ERROR(handle, "SQLSetStmtAttr (SQL_ATTR_CURSOR_SCROLLABLE)", rc,
1293 SQL_HANDLE_STMT, hstmt);
1295 if (SQL_SUCCEEDED(rc)) {
1296 rc = SQLExecDirect(hstmt, (SQLCHAR *)statement, (SQLINTEGER)len);
1297 CHECK_ERROR(handle, "SQLExecDirect", rc, SQL_HANDLE_STMT, hstmt);
1299 if (SQL_SUCCEEDED(rc)) {
1300 rc = odbc_create_results(handle, hstmt, pool, random, res);
1301 apr_pool_cleanup_register(pool, *res,
1302 odbc_close_results, apr_pool_cleanup_null);
1304 return APR_FROM_SQL_RESULT(rc);
1307 /** num_cols: get the number of columns in a results set **/
1308 static int odbc_num_cols(apr_dbd_results_t *res)
1313 /** num_tuples: get the number of rows in a results set **/
1314 static int odbc_num_tuples(apr_dbd_results_t *res)
1319 rc = SQLRowCount(res->stmt, &nrows);
1320 CHECK_ERROR(res->apr_dbd, "SQLRowCount", rc, SQL_HANDLE_STMT, res->stmt);
1321 return SQL_SUCCEEDED(rc) ? (int)nrows : -1;
1324 /** get_row: get a row from a result set **/
1325 static int odbc_get_row(apr_pool_t *pool, apr_dbd_results_t *res,
1326 apr_dbd_row_t **row, int rownum)
1332 *row = apr_pcalloc(pool, sizeof(apr_dbd_row_t));
1333 (*row)->stmt = res->stmt;
1334 (*row)->dbc = res->dbc;
1336 (*row)->pool = res->pool;
1338 /* mark all the columns as needing SQLGetData unless they are bound */
1339 for (c = 0; c < res->ncols; c++) {
1340 if (res->colstate[c] != COL_BOUND) {
1341 res->colstate[c] = COL_AVAIL;
1343 /* some drivers do not null-term zero-len CHAR data */
1344 if (res->colptrs[c])
1345 *(char *)res->colptrs[c] = 0;
1348 if (res->random && (rownum > 0)) {
1349 fetchtype = "SQLFetchScroll";
1350 rc = SQLFetchScroll(res->stmt, SQL_FETCH_ABSOLUTE, rownum);
1353 fetchtype = "SQLFetch";
1354 rc = SQLFetch(res->stmt);
1356 CHECK_ERROR(res->apr_dbd, fetchtype, rc, SQL_HANDLE_STMT, res->stmt);
1357 (*row)->stmt = res->stmt;
1358 if (!SQL_SUCCEEDED(rc) && !res->random) {
1359 /* early close on any error (usually SQL_NO_DATA) if fetching
1360 * sequentially to release resources ASAP
1362 odbc_close_results(res);
1365 return SQL_SUCCEEDED(rc) ? 0 : -1;
1368 /** datum_get: get a binary entry from a row **/
1369 static apr_status_t odbc_datum_get(const apr_dbd_row_t *row, int col,
1370 apr_dbd_type_e dbdtype, void *data)
1372 SQLSMALLINT sqltype;
1376 if (col >= row->res->ncols)
1377 return APR_EGENERAL;
1379 if (dbdtype < 0 || dbdtype >= NUM_APR_DBD_TYPES) {
1380 data = NULL; /* invalid type */
1381 return APR_EGENERAL;
1384 len = sqlSizes[dbdtype];
1385 sqltype = sqlCtype[dbdtype];
1387 /* must not memcpy a brigade, sentinals are relative to orig loc */
1388 if (IS_LOB(sqltype))
1389 return odbc_create_bucket(row, col, sqltype, data);
1391 p = odbc_get(row, col, sqltype);
1392 if (p == (void *)-1)
1393 return APR_EGENERAL;
1396 return APR_ENOENT; /* SQL NULL value */
1399 *(char**)data = (char *)p;
1401 memcpy(data, p, len);
1407 /** get_entry: get an entry from a row (string data) **/
1408 static const char *odbc_get_entry(const apr_dbd_row_t *row, int col)
1412 if (col >= row->res->ncols)
1415 p = odbc_get(row, col, SQL_C_CHAR);
1417 /* NULL or invalid (-1) */
1418 if (p == NULL || p == (void *)-1)
1421 return apr_pstrdup(row->pool, p);
1424 /** error: get current error message (if any) **/
1425 static const char *odbc_error(apr_dbd_t *handle, int errnum)
1427 return (handle) ? handle->lastError : "[dbd_odbc]No error message available";
1430 /** escape: escape a string so it is safe for use in query/select **/
1431 static const char *odbc_escape(apr_pool_t *pool, const char *s,
1434 char *newstr, *src, *dst, *sq;
1437 /* return the original if there are no single-quotes */
1438 if (!(sq = strchr(s, '\'')))
1440 /* count the single-quotes and allocate a new buffer */
1441 for (qcount = 1; (sq = strchr(sq + 1, '\'')); )
1443 newstr = apr_palloc(pool, strlen(s) + qcount + 1);
1445 /* move chars, doubling all single-quotes */
1447 for (dst = newstr; *src; src++) {
1448 if ((*dst++ = *src) == '\'')
1455 /** prepare: prepare a statement **/
1456 static int odbc_prepare(apr_pool_t *pool, apr_dbd_t *handle,
1457 const char *query, const char *label, int nargs,
1458 int nvals, apr_dbd_type_e *types,
1459 apr_dbd_prepared_t **statement)
1462 size_t len = strlen(query);
1464 if (odbc_check_rollback(handle))
1465 return APR_EGENERAL;
1467 *statement = apr_pcalloc(pool, sizeof(apr_dbd_prepared_t));
1468 (*statement)->dbc = handle->dbc;
1469 (*statement)->apr_dbd = handle;
1470 (*statement)->nargs = nargs;
1471 (*statement)->nvals = nvals;
1472 (*statement)->types =
1473 apr_pmemdup(pool, types, nargs * sizeof(apr_dbd_type_e));
1474 rc = SQLAllocHandle(SQL_HANDLE_STMT, handle->dbc, &((*statement)->stmt));
1475 apr_pool_cleanup_register(pool, *statement,
1476 odbc_close_pstmt, apr_pool_cleanup_null);
1477 CHECK_ERROR(handle, "SQLAllocHandle (STMT)", rc,
1478 SQL_HANDLE_DBC, handle->dbc);
1479 rc = SQLPrepare((*statement)->stmt, (SQLCHAR *)query, (SQLINTEGER)len);
1480 CHECK_ERROR(handle, "SQLPrepare", rc, SQL_HANDLE_STMT,
1481 (*statement)->stmt);
1482 return APR_FROM_SQL_RESULT(rc);
1485 /** pquery: query using a prepared statement + args **/
1486 static int odbc_pquery(apr_pool_t *pool, apr_dbd_t *handle, int *nrows,
1487 apr_dbd_prepared_t *statement, const char **args)
1489 SQLRETURN rc = SQL_SUCCESS;
1492 if (odbc_check_rollback(handle))
1493 return APR_EGENERAL;
1495 for (i = argp = 0; i < statement->nargs && SQL_SUCCEEDED(rc); i++) {
1496 rc = odbc_bind_param(pool, statement, i + 1, statement->types[i],
1497 &argp, (const void **)args, TEXTMODE);
1499 if (SQL_SUCCEEDED(rc)) {
1500 rc = SQLExecute(statement->stmt);
1501 CHECK_ERROR(handle, "SQLExecute", rc, SQL_HANDLE_STMT,
1504 if (SQL_SUCCEEDED(rc)) {
1507 rc = SQLRowCount(statement->stmt, &rowcount);
1508 *nrows = (int)rowcount;
1509 CHECK_ERROR(handle, "SQLRowCount", rc, SQL_HANDLE_STMT,
1512 return APR_FROM_SQL_RESULT(rc);
1515 /** pvquery: query using a prepared statement + args **/
1516 static int odbc_pvquery(apr_pool_t *pool, apr_dbd_t *handle, int *nrows,
1517 apr_dbd_prepared_t *statement, va_list args)
1519 const char **values;
1522 values = apr_palloc(pool, sizeof(*values) * statement->nvals);
1523 for (i = 0; i < statement->nvals; i++)
1524 values[i] = va_arg(args, const char *);
1525 return odbc_pquery(pool, handle, nrows, statement, values);
1528 /** pselect: select using a prepared statement + args **/
1529 static int odbc_pselect(apr_pool_t *pool, apr_dbd_t *handle,
1530 apr_dbd_results_t **res, apr_dbd_prepared_t *statement,
1531 int random, const char **args)
1533 SQLRETURN rc = SQL_SUCCESS;
1536 if (odbc_check_rollback(handle))
1537 return APR_EGENERAL;
1540 rc = SQLSetStmtAttr(statement->stmt, SQL_ATTR_CURSOR_SCROLLABLE,
1541 (SQLPOINTER)SQL_SCROLLABLE, 0);
1542 CHECK_ERROR(handle, "SQLSetStmtAttr (SQL_ATTR_CURSOR_SCROLLABLE)",
1543 rc, SQL_HANDLE_STMT, statement->stmt);
1545 if (SQL_SUCCEEDED(rc)) {
1546 for (i = argp = 0; i < statement->nargs && SQL_SUCCEEDED(rc); i++) {
1547 rc = odbc_bind_param(pool, statement, i + 1, statement->types[i],
1548 &argp, (const void **)args, TEXTMODE);
1551 if (SQL_SUCCEEDED(rc)) {
1552 rc = SQLExecute(statement->stmt);
1553 CHECK_ERROR(handle, "SQLExecute", rc, SQL_HANDLE_STMT,
1556 if (SQL_SUCCEEDED(rc)) {
1557 rc = odbc_create_results(handle, statement->stmt, pool, random, res);
1558 apr_pool_cleanup_register(pool, *res,
1559 odbc_close_results, apr_pool_cleanup_null);
1561 return APR_FROM_SQL_RESULT(rc);
1564 /** pvselect: select using a prepared statement + args **/
1565 static int odbc_pvselect(apr_pool_t *pool, apr_dbd_t *handle,
1566 apr_dbd_results_t **res,
1567 apr_dbd_prepared_t *statement, int random,
1570 const char **values;
1573 values = apr_palloc(pool, sizeof(*values) * statement->nvals);
1574 for (i = 0; i < statement->nvals; i++)
1575 values[i] = va_arg(args, const char *);
1576 return odbc_pselect(pool, handle, res, statement, random, values);
1579 /** get_name: get a column title from a result set **/
1580 static const char *odbc_get_name(const apr_dbd_results_t *res, int col)
1583 char buffer[MAX_COLUMN_NAME];
1584 SQLSMALLINT colnamelength, coltype, coldecimal, colnullable;
1587 if (col >= res->ncols)
1588 return NULL; /* bogus column number */
1589 if (res->colnames[col] != NULL)
1590 return res->colnames[col]; /* we already retrieved it */
1591 rc = SQLDescribeCol(res->stmt, col + 1,
1592 (SQLCHAR *)buffer, sizeof(buffer), &colnamelength,
1593 &coltype, &colsize, &coldecimal, &colnullable);
1594 CHECK_ERROR(res->apr_dbd, "SQLDescribeCol", rc,
1595 SQL_HANDLE_STMT, res->stmt);
1596 res->colnames[col] = apr_pstrdup(res->pool, buffer);
1597 return res->colnames[col];
1600 /** transaction_mode_get: get the mode of transaction **/
1601 static int odbc_transaction_mode_get(apr_dbd_transaction_t *trans)
1603 return (int)trans->apr_dbd->can_commit;
1606 /** transaction_mode_set: set the mode of transaction **/
1607 static int odbc_transaction_mode_set(apr_dbd_transaction_t *trans, int mode)
1609 int legal = ( APR_DBD_TRANSACTION_IGNORE_ERRORS
1610 | APR_DBD_TRANSACTION_COMMIT
1611 | APR_DBD_TRANSACTION_ROLLBACK);
1613 if ((mode & legal) != mode)
1614 return APR_EGENERAL;
1616 trans->apr_dbd->can_commit = mode;
1620 /** pbquery: query using a prepared statement + binary args **/
1621 static int odbc_pbquery(apr_pool_t *pool, apr_dbd_t *handle, int *nrows,
1622 apr_dbd_prepared_t *statement, const void **args)
1624 SQLRETURN rc = SQL_SUCCESS;
1627 if (odbc_check_rollback(handle))
1628 return APR_EGENERAL;
1630 for (i = argp = 0; i < statement->nargs && SQL_SUCCEEDED(rc); i++)
1631 rc = odbc_bind_param(pool, statement, i + 1, statement->types[i],
1632 &argp, args, BINARYMODE);
1634 if (SQL_SUCCEEDED(rc)) {
1635 rc = SQLExecute(statement->stmt);
1636 CHECK_ERROR(handle, "SQLExecute", rc, SQL_HANDLE_STMT,
1639 if (SQL_SUCCEEDED(rc)) {
1642 rc = SQLRowCount(statement->stmt, &rowcount);
1643 *nrows = (int)rowcount;
1644 CHECK_ERROR(handle, "SQLRowCount", rc, SQL_HANDLE_STMT,
1647 return APR_FROM_SQL_RESULT(rc);
1650 /** pbselect: select using a prepared statement + binary args **/
1651 static int odbc_pbselect(apr_pool_t *pool, apr_dbd_t *handle,
1652 apr_dbd_results_t **res,
1653 apr_dbd_prepared_t *statement,
1654 int random, const void **args)
1656 SQLRETURN rc = SQL_SUCCESS;
1659 if (odbc_check_rollback(handle))
1660 return APR_EGENERAL;
1663 rc = SQLSetStmtAttr(statement->stmt, SQL_ATTR_CURSOR_SCROLLABLE,
1664 (SQLPOINTER)SQL_SCROLLABLE, 0);
1665 CHECK_ERROR(handle, "SQLSetStmtAttr (SQL_ATTR_CURSOR_SCROLLABLE)",
1666 rc, SQL_HANDLE_STMT, statement->stmt);
1668 if (SQL_SUCCEEDED(rc)) {
1669 for (i = argp = 0; i < statement->nargs && SQL_SUCCEEDED(rc); i++) {
1670 rc = odbc_bind_param(pool, statement, i + 1, statement->types[i],
1671 &argp, args, BINARYMODE);
1674 if (SQL_SUCCEEDED(rc)) {
1675 rc = SQLExecute(statement->stmt);
1676 CHECK_ERROR(handle, "SQLExecute", rc, SQL_HANDLE_STMT,
1679 if (SQL_SUCCEEDED(rc)) {
1680 rc = odbc_create_results(handle, statement->stmt, pool, random, res);
1681 apr_pool_cleanup_register(pool, *res,
1682 odbc_close_results, apr_pool_cleanup_null);
1685 return APR_FROM_SQL_RESULT(rc);
1688 /** pvbquery: query using a prepared statement + binary args **/
1689 static int odbc_pvbquery(apr_pool_t *pool, apr_dbd_t *handle, int *nrows,
1690 apr_dbd_prepared_t *statement, va_list args)
1692 const char **values;
1695 values = apr_palloc(pool, sizeof(*values) * statement->nvals);
1696 for (i = 0; i < statement->nvals; i++)
1697 values[i] = va_arg(args, const char *);
1698 return odbc_pbquery(pool, handle, nrows, statement, (const void **)values);
1701 /** pvbselect: select using a prepared statement + binary args **/
1702 static int odbc_pvbselect(apr_pool_t *pool, apr_dbd_t *handle,
1703 apr_dbd_results_t **res,
1704 apr_dbd_prepared_t *statement,
1705 int random, va_list args)
1707 const char **values;
1710 values = apr_palloc(pool, sizeof(*values) * statement->nvals);
1711 for (i = 0; i < statement->nvals; i++)
1712 values[i] = va_arg(args, const char *);
1713 return odbc_pbselect(pool, handle, res, statement, random, (const void **)values);
1716 APU_MODULE_DECLARE_DATA const apr_dbd_driver_t ODBC_DRIVER_ENTRY = {
1724 odbc_start_transaction,
1725 odbc_end_transaction,
1740 odbc_transaction_mode_get,
1741 odbc_transaction_mode_set,