dbd/apr_dbd.c

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