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 7 * 8 * http://www.apache.org/licenses/LICENSE-2.0 9 * 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. 15 */ 16 17#include <ctype.h> 18#include <stdio.h> 19 20#include "apu_config.h" 21#include "apu.h" 22 23#include "apr_pools.h" 24#include "apr_dso.h" 25#include "apr_strings.h" 26#include "apr_hash.h" 27#include "apr_thread_mutex.h" 28#include "apr_lib.h" 29#include "apr_atomic.h" 30 31#include "apu_internal.h" 32#include "apr_dbd_internal.h" 33#include "apr_dbd.h" 34#include "apu_version.h" 35 36static apr_hash_t *drivers = NULL; 37static apr_uint32_t initialised = 0, in_init = 1; 38 39#define CLEANUP_CAST (apr_status_t (*)(void*)) 40 41#if APR_HAS_THREADS 42/* deprecated, but required for existing providers. Existing and new 43 * providers should be refactored to use a provider-specific mutex so 44 * that different providers do not block one another. 45 * In APR 1.3 this is no longer used for dso module loading, and 46 * apu_dso_mutex_[un]lock is used instead. 47 * In APR 2.0 this should become entirely local to libaprutil-2.so and 48 * no longer be exported. 49 */ 50static apr_thread_mutex_t* mutex = NULL; 51APU_DECLARE(apr_status_t) apr_dbd_mutex_lock() 52{ 53 return apr_thread_mutex_lock(mutex); 54} 55APU_DECLARE(apr_status_t) apr_dbd_mutex_unlock() 56{ 57 return apr_thread_mutex_unlock(mutex); 58} 59#else 60APU_DECLARE(apr_status_t) apr_dbd_mutex_lock() { 61 return APR_SUCCESS; 62} 63APU_DECLARE(apr_status_t) apr_dbd_mutex_unlock() { 64 return APR_SUCCESS; 65} 66#endif 67 68#if !APU_DSO_BUILD 69#define DRIVER_LOAD(name,driver,pool) \ 70 { \ 71 extern const apr_dbd_driver_t driver; \ 72 apr_hash_set(drivers,name,APR_HASH_KEY_STRING,&driver); \ 73 if (driver.init) { \ 74 driver.init(pool); \ 75 } \ 76 } 77#endif 78 79static apr_status_t apr_dbd_term(void *ptr) 80{ 81 /* set drivers to NULL so init can work again */ 82 drivers = NULL; 83 84 /* Everything else we need is handled by cleanups registered 85 * when we created mutexes and loaded DSOs 86 */ 87 return APR_SUCCESS; 88} 89 90APU_DECLARE(apr_status_t) apr_dbd_init(apr_pool_t *pool) 91{ 92 apr_status_t ret = APR_SUCCESS; 93 apr_pool_t *parent; 94 95 if (apr_atomic_inc32(&initialised)) { 96 apr_atomic_set32(&initialised, 1); /* prevent wrap-around */ 97 98 while (apr_atomic_read32(&in_init)) /* wait until we get fully inited */ 99 ; 100 101 return APR_SUCCESS; 102 } 103 104 /* Top level pool scope, need process-scope lifetime */ 105 for (parent = pool; parent; parent = apr_pool_parent_get(pool)) 106 pool = parent; 107#if APU_DSO_BUILD 108 /* deprecate in 2.0 - permit implicit initialization */ 109 apu_dso_init(pool); 110#endif 111 112 drivers = apr_hash_make(pool); 113 114#if APR_HAS_THREADS 115 ret = apr_thread_mutex_create(&mutex, APR_THREAD_MUTEX_DEFAULT, pool); 116 /* This already registers a pool cleanup */ 117#endif 118 119#if !APU_DSO_BUILD 120 121 /* Load statically-linked drivers: */ 122#if APU_HAVE_MYSQL 123 DRIVER_LOAD("mysql", apr_dbd_mysql_driver, pool); 124#endif 125#if APU_HAVE_PGSQL 126 DRIVER_LOAD("pgsql", apr_dbd_pgsql_driver, pool); 127#endif 128#if APU_HAVE_SQLITE3 129 DRIVER_LOAD("sqlite3", apr_dbd_sqlite3_driver, pool); 130#endif 131#if APU_HAVE_SQLITE2 132 DRIVER_LOAD("sqlite2", apr_dbd_sqlite2_driver, pool); 133#endif 134#if APU_HAVE_ORACLE 135 DRIVER_LOAD("oracle", apr_dbd_oracle_driver, pool); 136#endif 137#if APU_HAVE_FREETDS 138 DRIVER_LOAD("freetds", apr_dbd_freetds_driver, pool); 139#endif 140#if APU_HAVE_ODBC 141 DRIVER_LOAD("odbc", apr_dbd_odbc_driver, pool); 142#endif 143#if APU_HAVE_SOME_OTHER_BACKEND 144 DRIVER_LOAD("firebird", apr_dbd_other_driver, pool); 145#endif 146#endif /* APU_DSO_BUILD */ 147 148 apr_pool_cleanup_register(pool, NULL, apr_dbd_term, 149 apr_pool_cleanup_null); 150 151 apr_atomic_dec32(&in_init); 152 153 return ret; 154} 155 156APU_DECLARE(apr_status_t) apr_dbd_get_driver(apr_pool_t *pool, const char *name, 157 const apr_dbd_driver_t **driver) 158{ 159#if APU_DSO_BUILD 160 char modname[32]; 161 char symname[34]; 162 apr_dso_handle_sym_t symbol; 163#endif 164 apr_status_t rv; 165 166#if APU_DSO_BUILD 167 rv = apu_dso_mutex_lock(); 168 if (rv) { 169 return rv; 170 } 171#endif 172 *driver = apr_hash_get(drivers, name, APR_HASH_KEY_STRING); 173 if (*driver) { 174#if APU_DSO_BUILD 175 apu_dso_mutex_unlock(); 176#endif 177 return APR_SUCCESS; 178 } 179 180#if APU_DSO_BUILD 181 /* The driver DSO must have exactly the same lifetime as the 182 * drivers hash table; ignore the passed-in pool */ 183 pool = apr_hash_pool_get(drivers); 184 185#if defined(NETWARE) 186 apr_snprintf(modname, sizeof(modname), "dbd%s.nlm", name); 187#elif defined(WIN32) 188 apr_snprintf(modname, sizeof(modname), 189 "apr_dbd_%s-" APU_STRINGIFY(APU_MAJOR_VERSION) ".dll", name); 190#else 191 apr_snprintf(modname, sizeof(modname), 192 "apr_dbd_%s-" APU_STRINGIFY(APU_MAJOR_VERSION) ".so", name); 193#endif 194 apr_snprintf(symname, sizeof(symname), "apr_dbd_%s_driver", name); 195 rv = apu_dso_load(NULL, &symbol, modname, symname, pool); 196 if (rv == APR_SUCCESS || rv == APR_EINIT) { /* previously loaded?!? */ 197 *driver = symbol; 198 name = apr_pstrdup(pool, name); 199 apr_hash_set(drivers, name, APR_HASH_KEY_STRING, *driver); 200 rv = APR_SUCCESS; 201 if ((*driver)->init) { 202 (*driver)->init(pool); 203 } 204 } 205 apu_dso_mutex_unlock(); 206 207#else /* not builtin and !APR_HAS_DSO => not implemented */ 208 rv = APR_ENOTIMPL; 209#endif 210 211 return rv; 212} 213 214APU_DECLARE(apr_status_t) apr_dbd_open_ex(const apr_dbd_driver_t *driver, 215 apr_pool_t *pool, const char *params, 216 apr_dbd_t **handle, 217 const char **error) 218{ 219 apr_status_t rv; 220 *handle = (driver->open)(pool, params, error); 221 if (*handle == NULL) { 222 return APR_EGENERAL; 223 } 224 rv = apr_dbd_check_conn(driver, pool, *handle); 225 if ((rv != APR_SUCCESS) && (rv != APR_ENOTIMPL)) { 226 /* XXX: rv is APR error code, but apr_dbd_error() takes int! */ 227 if (error) { 228 *error = apr_dbd_error(driver, *handle, rv); 229 } 230 apr_dbd_close(driver, *handle); 231 return APR_EGENERAL; 232 } 233 return APR_SUCCESS; 234} 235 236APU_DECLARE(apr_status_t) apr_dbd_open(const apr_dbd_driver_t *driver, 237 apr_pool_t *pool, const char *params, 238 apr_dbd_t **handle) 239{ 240 return apr_dbd_open_ex(driver,pool,params,handle,NULL); 241} 242 243APU_DECLARE(int) apr_dbd_transaction_start(const apr_dbd_driver_t *driver, 244 apr_pool_t *pool, apr_dbd_t *handle, 245 apr_dbd_transaction_t **trans) 246{ 247 int ret = driver->start_transaction(pool, handle, trans); 248 if (*trans) { 249 apr_pool_cleanup_register(pool, *trans, 250 CLEANUP_CAST driver->end_transaction, 251 apr_pool_cleanup_null); 252 } 253 return ret; 254} 255 256APU_DECLARE(int) apr_dbd_transaction_end(const apr_dbd_driver_t *driver, 257 apr_pool_t *pool, 258 apr_dbd_transaction_t *trans) 259{ 260 apr_pool_cleanup_kill(pool, trans, CLEANUP_CAST driver->end_transaction); 261 return driver->end_transaction(trans); 262} 263 264APU_DECLARE(int) apr_dbd_transaction_mode_get(const apr_dbd_driver_t *driver, 265 apr_dbd_transaction_t *trans) 266{ 267 return driver->transaction_mode_get(trans); 268} 269 270APU_DECLARE(int) apr_dbd_transaction_mode_set(const apr_dbd_driver_t *driver, 271 apr_dbd_transaction_t *trans, 272 int mode) 273{ 274 return driver->transaction_mode_set(trans, mode); 275} 276 277APU_DECLARE(apr_status_t) apr_dbd_close(const apr_dbd_driver_t *driver, 278 apr_dbd_t *handle) 279{ 280 return driver->close(handle); 281} 282 283APU_DECLARE(const char*) apr_dbd_name(const apr_dbd_driver_t *driver) 284{ 285 return driver->name; 286} 287 288APU_DECLARE(void*) apr_dbd_native_handle(const apr_dbd_driver_t *driver, 289 apr_dbd_t *handle) 290{ 291 return driver->native_handle(handle); 292} 293 294APU_DECLARE(int) apr_dbd_check_conn(const apr_dbd_driver_t *driver, 295 apr_pool_t *pool, 296 apr_dbd_t *handle) 297{ 298 return driver->check_conn(pool, handle); 299} 300 301APU_DECLARE(int) apr_dbd_set_dbname(const apr_dbd_driver_t *driver, 302 apr_pool_t *pool, 303 apr_dbd_t *handle, const char *name) 304{ 305 return driver->set_dbname(pool,handle,name); 306} 307 308APU_DECLARE(int) apr_dbd_query(const apr_dbd_driver_t *driver, 309 apr_dbd_t *handle, 310 int *nrows, const char *statement) 311{ 312 return driver->query(handle,nrows,statement); 313} 314 315APU_DECLARE(int) apr_dbd_select(const apr_dbd_driver_t *driver, 316 apr_pool_t *pool, 317 apr_dbd_t *handle, apr_dbd_results_t **res, 318 const char *statement, int random) 319{ 320 return driver->select(pool,handle,res,statement,random); 321} 322 323APU_DECLARE(int) apr_dbd_num_cols(const apr_dbd_driver_t *driver, 324 apr_dbd_results_t *res) 325{ 326 return driver->num_cols(res); 327} 328 329APU_DECLARE(int) apr_dbd_num_tuples(const apr_dbd_driver_t *driver, 330 apr_dbd_results_t *res) 331{ 332 return driver->num_tuples(res); 333} 334 335APU_DECLARE(int) apr_dbd_get_row(const apr_dbd_driver_t *driver, 336 apr_pool_t *pool, 337 apr_dbd_results_t *res, apr_dbd_row_t **row, 338 int rownum) 339{ 340 return driver->get_row(pool,res,row,rownum); 341} 342 343APU_DECLARE(const char*) apr_dbd_get_entry(const apr_dbd_driver_t *driver, 344 apr_dbd_row_t *row, int col) 345{ 346 return driver->get_entry(row,col); 347} 348 349APU_DECLARE(const char*) apr_dbd_get_name(const apr_dbd_driver_t *driver, 350 apr_dbd_results_t *res, int col) 351{ 352 return driver->get_name(res,col); 353} 354 355APU_DECLARE(const char*) apr_dbd_error(const apr_dbd_driver_t *driver, 356 apr_dbd_t *handle, int errnum) 357{ 358 return driver->error(handle,errnum); 359} 360 361APU_DECLARE(const char*) apr_dbd_escape(const apr_dbd_driver_t *driver, 362 apr_pool_t *pool, const char *string, 363 apr_dbd_t *handle) 364{ 365 return driver->escape(pool,string,handle); 366} 367 368APU_DECLARE(int) apr_dbd_prepare(const apr_dbd_driver_t *driver, 369 apr_pool_t *pool, 370 apr_dbd_t *handle, const char *query, 371 const char *label, 372 apr_dbd_prepared_t **statement) 373{ 374 size_t qlen; 375 int i, nargs = 0, nvals = 0; 376 char *p, *pq; 377 const char *q; 378 apr_dbd_type_e *t; 379 380 if (!driver->pformat) { 381 return APR_ENOTIMPL; 382 } 383 384 /* find the number of parameters in the query */ 385 for (q = query; *q; q++) { 386 if (q[0] == '%') { 387 if (apr_isalpha(q[1])) { 388 nargs++; 389 } else if (q[1] == '%') { 390 q++; 391 } 392 } 393 } 394 nvals = nargs; 395 396 qlen = strlen(query) + 397 nargs * (strlen(driver->pformat) + sizeof(nargs) * 3 + 2) + 1; 398 pq = apr_palloc(pool, qlen); 399 t = apr_pcalloc(pool, sizeof(*t) * nargs); 400 401 for (p = pq, q = query, i = 0; *q; q++) { 402 if (q[0] == '%') { 403 if (apr_isalpha(q[1])) { 404 switch (q[1]) { 405 case 'd': t[i] = APR_DBD_TYPE_INT; break; 406 case 'u': t[i] = APR_DBD_TYPE_UINT; break; 407 case 'f': t[i] = APR_DBD_TYPE_FLOAT; break; 408 case 'h': 409 switch (q[2]) { 410 case 'h': 411 switch (q[3]){ 412 case 'd': t[i] = APR_DBD_TYPE_TINY; q += 2; break; 413 case 'u': t[i] = APR_DBD_TYPE_UTINY; q += 2; break; 414 } 415 break; 416 case 'd': t[i] = APR_DBD_TYPE_SHORT; q++; break; 417 case 'u': t[i] = APR_DBD_TYPE_USHORT; q++; break; 418 } 419 break; 420 case 'l': 421 switch (q[2]) { 422 case 'l': 423 switch (q[3]){ 424 case 'd': t[i] = APR_DBD_TYPE_LONGLONG; q += 2; break; 425 case 'u': t[i] = APR_DBD_TYPE_ULONGLONG; q += 2; break; 426 } 427 break; 428 case 'd': t[i] = APR_DBD_TYPE_LONG; q++; break; 429 case 'u': t[i] = APR_DBD_TYPE_ULONG; q++; break; 430 case 'f': t[i] = APR_DBD_TYPE_DOUBLE; q++; break; 431 } 432 break; 433 case 'p': 434 if (q[2] == 'D') { 435 switch (q[3]) { 436 case 't': t[i] = APR_DBD_TYPE_TEXT; q += 2; break; 437 case 'i': t[i] = APR_DBD_TYPE_TIME; q += 2; break; 438 case 'd': t[i] = APR_DBD_TYPE_DATE; q += 2; break; 439 case 'a': t[i] = APR_DBD_TYPE_DATETIME; q += 2; break; 440 case 's': t[i] = APR_DBD_TYPE_TIMESTAMP; q += 2; break; 441 case 'z': t[i] = APR_DBD_TYPE_ZTIMESTAMP; q += 2; break; 442 case 'b': t[i] = APR_DBD_TYPE_BLOB; q += 2; break; 443 case 'c': t[i] = APR_DBD_TYPE_CLOB; q += 2; break; 444 case 'n': t[i] = APR_DBD_TYPE_NULL; q += 2; break; 445 } 446 } 447 break; 448 } 449 q++; 450 451 switch (t[i]) { 452 case APR_DBD_TYPE_NONE: /* by default, we expect strings */ 453 t[i] = APR_DBD_TYPE_STRING; 454 break; 455 case APR_DBD_TYPE_BLOB: 456 case APR_DBD_TYPE_CLOB: /* three (3) more values passed in */ 457 nvals += 3; 458 break; 459 default: 460 break; 461 } 462 463 /* insert database specific parameter reference */ 464 p += apr_snprintf(p, qlen - (p - pq), driver->pformat, ++i); 465 } else if (q[1] == '%') { /* reduce %% to % */ 466 *p++ = *q++; 467 } else { 468 *p++ = *q; 469 } 470 } else { 471 *p++ = *q; 472 } 473 } 474 *p = '\0'; 475 476 return driver->prepare(pool,handle,pq,label,nargs,nvals,t,statement); 477} 478 479APU_DECLARE(int) apr_dbd_pquery(const apr_dbd_driver_t *driver, 480 apr_pool_t *pool, 481 apr_dbd_t *handle, int *nrows, 482 apr_dbd_prepared_t *statement, 483 int nargs, const char **args) 484{ 485 return driver->pquery(pool,handle,nrows,statement,args); 486} 487 488APU_DECLARE(int) apr_dbd_pselect(const apr_dbd_driver_t *driver, 489 apr_pool_t *pool, 490 apr_dbd_t *handle, apr_dbd_results_t **res, 491 apr_dbd_prepared_t *statement, int random, 492 int nargs, const char **args) 493{ 494 return driver->pselect(pool,handle,res,statement,random,args); 495} 496 497APU_DECLARE_NONSTD(int) apr_dbd_pvquery(const apr_dbd_driver_t *driver, 498 apr_pool_t *pool, 499 apr_dbd_t *handle, int *nrows, 500 apr_dbd_prepared_t *statement, ...) 501{ 502 int ret; 503 va_list args; 504 va_start(args, statement); 505 ret = driver->pvquery(pool,handle,nrows,statement,args); 506 va_end(args); 507 return ret; 508} 509 510APU_DECLARE_NONSTD(int) apr_dbd_pvselect(const apr_dbd_driver_t *driver, 511 apr_pool_t *pool, apr_dbd_t *handle, 512 apr_dbd_results_t **res, 513 apr_dbd_prepared_t *statement, 514 int random, ...) 515{ 516 int ret; 517 va_list args; 518 va_start(args, random); 519 ret = driver->pvselect(pool,handle,res,statement,random,args); 520 va_end(args); 521 return ret; 522} 523 524APU_DECLARE(int) apr_dbd_pbquery(const apr_dbd_driver_t *driver, 525 apr_pool_t *pool, 526 apr_dbd_t *handle, int *nrows, 527 apr_dbd_prepared_t *statement, 528 const void **args) 529{ 530 return driver->pbquery(pool,handle,nrows,statement,args); 531} 532 533APU_DECLARE(int) apr_dbd_pbselect(const apr_dbd_driver_t *driver, 534 apr_pool_t *pool, 535 apr_dbd_t *handle, apr_dbd_results_t **res, 536 apr_dbd_prepared_t *statement, int random, 537 const void **args) 538{ 539 return driver->pbselect(pool,handle,res,statement,random,args); 540} 541 542APU_DECLARE_NONSTD(int) apr_dbd_pvbquery(const apr_dbd_driver_t *driver, 543 apr_pool_t *pool, 544 apr_dbd_t *handle, int *nrows, 545 apr_dbd_prepared_t *statement, ...) 546{ 547 int ret; 548 va_list args; 549 va_start(args, statement); 550 ret = driver->pvbquery(pool,handle,nrows,statement,args); 551 va_end(args); 552 return ret; 553} 554 555APU_DECLARE_NONSTD(int) apr_dbd_pvbselect(const apr_dbd_driver_t *driver, 556 apr_pool_t *pool, apr_dbd_t *handle, 557 apr_dbd_results_t **res, 558 apr_dbd_prepared_t *statement, 559 int random, ...) 560{ 561 int ret; 562 va_list args; 563 va_start(args, random); 564 ret = driver->pvbselect(pool,handle,res,statement,random,args); 565 va_end(args); 566 return ret; 567} 568 569APU_DECLARE(apr_status_t) apr_dbd_datum_get(const apr_dbd_driver_t *driver, 570 apr_dbd_row_t *row, int col, 571 apr_dbd_type_e type, void *data) 572{ 573 return driver->datum_get(row,col,type,data); 574} 575