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