granicus.if.org Git - apache/blob - modules/database/mod_dbd.c

   1 /* Copyright 2003-5 The Apache Software Foundation or its licensors, as
   2  * applicable.
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * 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 /* Overview of what this is and does:
  18  * http://www.apache.org/~niq/dbd.html
  19  * or
  20  * http://apache.webthing.com/database/
  21  */
  22
  23 #include <ctype.h>
  24
  25 #include "http_protocol.h"
  26 #include "http_config.h"
  27 #include "http_log.h"
  28 #include "apr_reslist.h"
  29 #include "apr_strings.h"
  30 #include "apr_dbd.h"
  31 #include "mod_dbd.h"
  32
  33 extern module AP_MODULE_DECLARE_DATA dbd_module;
  34
  35 /************ svr cfg: manage db connection pool ****************/
  36
  37 typedef struct dbd_prepared {
  38     const char *label;
  39     const char *query;
  40     struct dbd_prepared *next;
  41 } dbd_prepared;
  42 typedef struct svr_cfg {
  43     const char *name;
  44     const char *params;
  45     int persist;
  46     dbd_prepared *prepared;
  47 #if APR_HAS_THREADS
  48     apr_reslist_t *dbpool;
  49     int nmin;
  50     int nkeep;
  51     int nmax;
  52     int exptime;
  53 #else
  54     ap_dbd_t *conn;
  55 #endif
  56 } svr_cfg;
  57
  58 typedef enum { cmd_name, cmd_params, cmd_persist,
  59                cmd_min, cmd_keep, cmd_max, cmd_exp
  60 } cmd_parts;
  61
  62
  63 #define ISINT(val) \
  64         for (p = val; *p; ++p)        \
  65                 if (!isdigit(*p))        \
  66                         return "Argument must be numeric!"
  67 static const char *dbd_param(cmd_parms *cmd, void *cfg, const char *val)
  68 {
  69     const char *p;
  70     const apr_dbd_driver_t *driver = NULL;
  71     svr_cfg *svr = (svr_cfg*) ap_get_module_config
  72         (cmd->server->module_config, &dbd_module);
  73
  74     switch ((long) cmd->info) {
  75     case cmd_name:
  76         svr->name = val;
  77         /* loading the driver involves once-only dlloading that is
  78          * best done at server startup.  This also guarantees that
  79          * load_driver won't return an error later.
  80          */
  81         switch (apr_dbd_get_driver(cmd->pool, svr->name, &driver)) {
  82         case APR_ENOTIMPL:
  83             return apr_psprintf(cmd->pool, "DBD: No driver for %s", svr->name);
  84         case APR_EDSOOPEN:
  85             return apr_psprintf(cmd->pool,
  86                                 "DBD: Can't load driver file apr_dbd_%s.so",
  87                                 svr->name);
  88         case APR_ESYMNOTFOUND:
  89             return apr_psprintf(cmd->pool,
  90                                 "DBD: Failed to load driver apr_dbd_%s_driver",
  91                                 svr->name);
  92         }
  93         break;
  94     case cmd_params:
  95         svr->params = val;
  96         break;
  97     case cmd_persist:
  98         ISINT(val);
  99         svr->persist = atoi(val);
 100         break;
 101 #if APR_HAS_THREADS
 102     case cmd_min:
 103         ISINT(val);
 104         svr->nmin = atoi(val);
 105         break;
 106     case cmd_keep:
 107         ISINT(val);
 108         svr->nkeep = atoi(val);
 109         break;
 110     case cmd_max:
 111         ISINT(val);
 112         svr->nmax = atoi(val);
 113         break;
 114     case cmd_exp:
 115         ISINT(val);
 116         svr->exptime = atoi(val);
 117         break;
 118 #endif
 119     }
 120     return NULL;
 121 }
 122 void ap_dbd_prepare(server_rec *s, const char *query, const char *label)
 123 {
 124     svr_cfg *svr = ap_get_module_config(s->module_config, &dbd_module);
 125     dbd_prepared *prepared = apr_pcalloc(s->process->pool, sizeof(dbd_prepared));
 126     prepared->label = label;
 127     prepared->query = query;
 128     prepared->next = svr->prepared;
 129     svr->prepared = prepared;
 130 }
 131 static const char *dbd_prepare(cmd_parms *cmd, void *cfg, const char *query,
 132                                const char *label)
 133 {
 134     ap_dbd_prepare(cmd->server, query, label);
 135     return NULL;
 136 }
 137 static const command_rec dbd_cmds[] = {
 138     AP_INIT_TAKE1("DBDriver", dbd_param, (void*)cmd_name, RSRC_CONF,
 139                   "SQL Driver"),
 140     AP_INIT_TAKE1("DBDParams", dbd_param, (void*)cmd_params, RSRC_CONF,
 141                   "SQL Driver Params"),
 142     AP_INIT_TAKE1("DBDPersist", dbd_param, (void*)cmd_persist, RSRC_CONF,
 143                   "Use persistent connection/pool"),
 144     AP_INIT_TAKE2("DBDPrepareSQL", dbd_prepare, NULL, RSRC_CONF,
 145                   "Prepared SQL statement, label"),
 146 #if APR_HAS_THREADS
 147     AP_INIT_TAKE1("DBDMin", dbd_param, (void*)cmd_min, RSRC_CONF,
 148                   "Minimum number of connections"),
 149     AP_INIT_TAKE1("DBDKeep", dbd_param, (void*)cmd_keep, RSRC_CONF,
 150                   "Maximum number of sustained connections"),
 151     AP_INIT_TAKE1("DBDMax", dbd_param, (void*)cmd_max, RSRC_CONF,
 152                   "Maximum number of connections"),
 153     AP_INIT_TAKE1("DBDExptime", dbd_param, (void*)cmd_exp, RSRC_CONF,
 154                   "Keepalive time for idle connections"),
 155 #endif
 156     {NULL}
 157 };
 158 #define DEFAULT_NMIN 0
 159 #define DEFAULT_NMAX 5
 160 #define DEFAULT_NKEEP 1
 161 #define DEFAULT_EXPTIME 120
 162 #define COND_PARAM(x,val) \
 163     if (cfg->x == val) {              \
 164         cfg->x = ((svr_cfg*)base)->x; \
 165     }
 166 #define COND_PARAM0(x) COND_PARAM(x,0)
 167 #define COND_PARAM1(x) COND_PARAM(x,-1)
 168 static void *dbd_merge(apr_pool_t *pool, void *base, void *add) {
 169     svr_cfg *cfg = apr_pmemdup(pool, add, sizeof(svr_cfg));
 170     COND_PARAM0(name);
 171     COND_PARAM0(params);
 172     COND_PARAM1(persist);
 173 #if APR_HAS_THREADS
 174     COND_PARAM(nmin, DEFAULT_NMIN);
 175     COND_PARAM(nkeep, DEFAULT_NKEEP);
 176     COND_PARAM(nmax, DEFAULT_NMAX);
 177     COND_PARAM(exptime, DEFAULT_EXPTIME);
 178 #endif
 179     return cfg;
 180 }
 181 #undef COND_PARAM
 182 #undef COND_PARAM0
 183 #undef COND_PARAM1
 184 static void *dbd_cfg(apr_pool_t *p, server_rec *x)
 185 {
 186     svr_cfg *svr = (svr_cfg*) apr_pcalloc(p, sizeof(svr_cfg));
 187     svr->persist = -1;
 188 #if APR_HAS_THREADS
 189     svr->nmin = DEFAULT_NMIN;
 190     svr->nkeep = DEFAULT_NKEEP;
 191     svr->nmax = DEFAULT_NMAX;
 192     svr->exptime = DEFAULT_EXPTIME;
 193 #endif
 194     return svr;
 195 }
 196 static apr_status_t dbd_prepared_init(apr_pool_t *pool, svr_cfg *svr,
 197                                       ap_dbd_t *dbd)
 198 {
 199     dbd_prepared *p;
 200     apr_status_t ret = APR_SUCCESS;
 201     apr_dbd_prepared_t *stmt = NULL;
 202     dbd->prepared = apr_hash_make(pool);
 203
 204     for (p = svr->prepared; p; p = p->next) {
 205         if (apr_dbd_prepare(dbd->driver, pool, dbd->handle, p->query,
 206                             p->label, &stmt) == 0) {
 207             apr_hash_set(dbd->prepared, p->label, APR_HASH_KEY_STRING, stmt);
 208         }
 209         else {
 210             ret = APR_EGENERAL;
 211         }
 212     }
 213     return ret;
 214 }
 215 /************ svr cfg: manage db connection pool ****************/
 216 /* an apr_reslist_constructor for SQL connections
 217  * Also use this for opening in non-reslist modes, since it gives
 218  * us all the error-handling in one place.
 219  */
 220 static apr_status_t dbd_construct(void **db, void *params, apr_pool_t *pool)
 221 {
 222     svr_cfg *svr = (svr_cfg*) params;
 223     ap_dbd_t *rec = apr_pcalloc(pool, sizeof(ap_dbd_t));
 224     apr_status_t rv = apr_dbd_get_driver(pool, svr->name, &rec->driver);
 225
 226 /* Error-checking get_driver isn't necessary now (because it's done at
 227  * config-time).  But in case that changes in future ...
 228  */
 229     switch (rv) {
 230     case APR_ENOTIMPL:
 231         ap_log_perror(APLOG_MARK, APLOG_CRIT, 0, pool,
 232                       "DBD: driver for %s not available", svr->name);
 233         return rv;
 234     case APR_EDSOOPEN:
 235         ap_log_perror(APLOG_MARK, APLOG_CRIT, 0, pool,
 236                       "DBD: can't find driver for %s", svr->name);
 237         return rv;
 238     case APR_ESYMNOTFOUND:
 239         ap_log_perror(APLOG_MARK, APLOG_CRIT, 0, pool,
 240                       "DBD: driver for %s is invalid or corrupted", svr->name);
 241         return rv;
 242     default:
 243         ap_log_perror(APLOG_MARK, APLOG_CRIT, 0, pool,
 244                       "DBD: mod_dbd not compatible with apr in get_driver");
 245         return rv;
 246     case APR_SUCCESS:
 247         break;
 248     }
 249
 250     rv = apr_dbd_open(rec->driver, pool, svr->params, &rec->handle);
 251     switch (rv) {
 252     case APR_EGENERAL:
 253         ap_log_perror(APLOG_MARK, APLOG_CRIT, 0, pool,
 254                       "DBD: Can't connect to %s[%s]", svr->name, svr->params);
 255         return rv;
 256     default:
 257         ap_log_perror(APLOG_MARK, APLOG_CRIT, 0, pool,
 258                       "DBD: mod_dbd not compatible with apr in open");
 259         return rv;
 260     case APR_SUCCESS:
 261         break;
 262     }
 263     *db = rec;
 264     rv = dbd_prepared_init(pool, svr, rec);
 265     return rv;
 266 }
 267 #if APR_HAS_THREADS
 268 static apr_status_t dbd_destruct(void *sql, void *params, apr_pool_t *pool)
 269 {
 270     ap_dbd_t *rec = sql;
 271     return apr_dbd_close(rec->driver, rec->handle);
 272 }
 273
 274 static apr_status_t dbd_setup(apr_pool_t *pool, server_rec *s)
 275 {
 276     svr_cfg *svr = ap_get_module_config(s->module_config, &dbd_module);
 277     apr_status_t rv = apr_reslist_create(&svr->dbpool, svr->nmin, svr->nkeep,
 278                                          svr->nmax, svr->exptime,
 279                                          dbd_construct, dbd_destruct,
 280                                          svr, pool);
 281     if (rv == APR_SUCCESS) {
 282         apr_pool_cleanup_register(pool, svr->dbpool,
 283                                   (void*)apr_reslist_destroy,
 284                                   apr_pool_cleanup_null);
 285     }
 286     else {
 287         ap_log_perror(APLOG_MARK, APLOG_CRIT, 0, pool,
 288                       "DBD Pool: failed to initialise");
 289     }
 290     return rv;
 291 }
 292
 293 #endif
 294
 295
 296 /* Functions we export for modules to use:
 297         - open acquires a connection from the pool (opens one if necessary)
 298         - close releases it back in to the pool
 299 */
 300 #define arec ((ap_dbd_t*)rec)
 301 #if APR_HAS_THREADS
 302 ap_dbd_t* ap_dbd_open(apr_pool_t *pool, server_rec *s)
 303 {
 304     void *rec = NULL;
 305     svr_cfg *svr = ap_get_module_config(s->module_config, &dbd_module);
 306     apr_status_t rv = APR_SUCCESS;
 307     const char *errmsg;
 308
 309     if (!svr->persist) {
 310         /* Return a once-only connection */
 311         rv = dbd_construct(&rec, svr, s->process->pool);
 312         return (rv == APR_SUCCESS) ? arec : NULL;
 313     }
 314
 315     if (!svr->dbpool) {
 316         if (dbd_setup(s->process->pool, s) != APR_SUCCESS) {
 317             return NULL;
 318         }
 319     }
 320     if (apr_reslist_acquire(svr->dbpool, &rec) != APR_SUCCESS) {
 321         ap_log_perror(APLOG_MARK, APLOG_ERR, 0, pool,
 322                       "Failed to acquire DBD connection from pool!");
 323         return NULL;
 324     }
 325     rv = apr_dbd_check_conn(arec->driver, pool, arec->handle);
 326     if ((rv != APR_SUCCESS) && (rv != APR_ENOTIMPL)) {
 327         errmsg = apr_dbd_error(arec->driver, arec->handle, rv);
 328         if (!errmsg) {
 329             errmsg = "(unknown)";
 330         }
 331         ap_log_perror(APLOG_MARK, APLOG_ERR, 0, pool,
 332                       "DBD[%s] Error: %s", svr->name, errmsg );
 333         apr_reslist_invalidate(svr->dbpool, rec);
 334         return NULL;
 335     }
 336     return arec;
 337 }
 338 #else
 339 ap_dbd_t* ap_dbd_open(apr_pool_t *pool, server_rec *s)
 340 {
 341     apr_status_t rv = APR_SUCCESS;
 342     const char *errmsg;
 343     void *rec = NULL;
 344     svr_cfg *svr = ap_get_module_config(s->module_config, &dbd_module);
 345
 346     if (!svr->persist) {
 347         /* Return a once-only connection */
 348         rv = dbd_construct(&rec, svr, s->process->pool);
 349         return (rv == APR_SUCCESS) ? arec : NULL;
 350     }
 351
 352 /* since we're in nothread-land, we can mess with svr->conn with impunity */
 353 /* If we have a persistent connection and it's good, we'll use it */
 354     if (svr->conn) {
 355         rv = apr_dbd_check_conn(svr->conn->driver, pool, svr->conn->handle);
 356         if ((rv != APR_SUCCESS) && (rv != APR_ENOTIMPL)) {
 357             errmsg = apr_dbd_error(arec->driver, arec->handle, rv);
 358             if (!errmsg) {
 359                 errmsg = "(unknown)";
 360             }
 361             ap_log_perror(APLOG_MARK, APLOG_ERR, 0, pool,
 362                           "DBD[%s] Error: %s", svr->name, errmsg);
 363             svr->conn = NULL;
 364         }
 365     }
 366 /* We don't have a connection right now, so we'll open one */
 367     if (!svr->conn) {
 368         rv = dbd_construct(&rec, svr, s->process->pool);
 369         svr->conn = (rv == APR_SUCCESS) ? arec : NULL;
 370     }
 371     return svr->conn;
 372 }
 373 #endif
 374 void ap_dbd_close(server_rec *s, ap_dbd_t *sql)
 375 {
 376     svr_cfg *svr = ap_get_module_config(s->module_config, &dbd_module);
 377     if (!svr->persist) {
 378         apr_dbd_close(sql->driver, sql->handle);
 379     }
 380 #if APR_HAS_THREADS
 381     else {
 382         apr_reslist_release(svr->dbpool, sql);
 383     }
 384 #endif
 385 }
 386 static apr_status_t dbd_close(void *CONN)
 387 {
 388     ap_dbd_t *conn = CONN;
 389     return apr_dbd_close(conn->driver, conn->handle);
 390 }
 391 #if APR_HAS_THREADS
 392 typedef struct {
 393     ap_dbd_t *conn;
 394     apr_reslist_t *dbpool;
 395 } dbd_pool_rec;
 396 static apr_status_t dbd_release(void *REQ)
 397 {
 398     dbd_pool_rec *req = REQ;
 399     apr_reslist_release(req->dbpool, req->conn);
 400     return APR_SUCCESS;
 401 }
 402 ap_dbd_t *ap_dbd_acquire(request_rec *r)
 403 {
 404     svr_cfg *svr;
 405     dbd_pool_rec *req = ap_get_module_config(r->request_config, &dbd_module);
 406     if (!req) {
 407         req = apr_palloc(r->pool, sizeof(dbd_pool_rec));
 408         req->conn = ap_dbd_open(r->pool, r->server);
 409         if (req->conn) {
 410             svr = ap_get_module_config(r->server->module_config, &dbd_module);
 411             ap_set_module_config(r->request_config, &dbd_module, req);
 412             if (svr->persist) {
 413                 req->dbpool = svr->dbpool;
 414                 apr_pool_cleanup_register(r->pool, req, dbd_release,
 415                                           apr_pool_cleanup_null);
 416             }
 417             else {
 418                 apr_pool_cleanup_register(r->pool, req->conn, dbd_close,
 419                                           apr_pool_cleanup_null);
 420             }
 421         }
 422     }
 423     return req->conn;
 424 }
 425 ap_dbd_t *ap_dbd_cacquire(conn_rec *c)
 426 {
 427     svr_cfg *svr;
 428     dbd_pool_rec *req = ap_get_module_config(c->conn_config, &dbd_module);
 429     if (!req) {
 430         req = apr_palloc(c->pool, sizeof(dbd_pool_rec));
 431         req->conn = ap_dbd_open(c->pool, c->base_server);
 432         if (req->conn) {
 433             svr = ap_get_module_config(c->base_server->module_config, &dbd_module);
 434             ap_set_module_config(c->conn_config, &dbd_module, req);
 435             if (svr->persist) {
 436                 req->dbpool = svr->dbpool;
 437                 apr_pool_cleanup_register(c->pool, req, dbd_release,
 438                                           apr_pool_cleanup_null);
 439             }
 440             else {
 441                 apr_pool_cleanup_register(c->pool, req->conn, dbd_close,
 442                                           apr_pool_cleanup_null);
 443             }
 444         }
 445     }
 446     return req->conn;
 447 }
 448 #else
 449 ap_dbd_t *ap_dbd_acquire(request_rec *r)
 450 {
 451     svr_cfg *svr;
 452     ap_dbd_t *ret = ap_get_module_config(r->request_config, &dbd_module);
 453     if (!ret) {
 454         svr = ap_get_module_config(r->server->module_config, &dbd_module);
 455         ret = ap_dbd_open(r->pool, r->server);
 456         if (ret) {
 457             ap_set_module_config(r->request_config, &dbd_module, ret);
 458             if (!svr->persist) {
 459                 apr_pool_cleanup_register(r->pool, svr->conn, dbd_close,
 460                                           apr_pool_cleanup_null);
 461             }
 462             /* if persist then dbd_open registered cleanup on proc pool */
 463         }
 464     }
 465     return ret;
 466 }
 467 ap_dbd_t *ap_dbd_cacquire(conn_rec *c)
 468 {
 469     svr_cfg *svr;
 470     ap_dbd_t *ret = ap_get_module_config(c->conn_config, &dbd_module);
 471     if (!ret) {
 472         svr = ap_get_module_config(c->base_server->module_config, &dbd_module);
 473         ret = ap_dbd_open(c->pool, c->base_server);
 474         if (ret) {
 475             ap_set_module_config(c->conn_config, &dbd_module, ret);
 476             if (!svr->persist) {
 477                 apr_pool_cleanup_register(c->pool, svr->conn, dbd_close,
 478                                           apr_pool_cleanup_null);
 479             }
 480             /* if persist then dbd_open registered cleanup on proc pool */
 481         }
 482     }
 483     return ret;
 484 }
 485 #endif
 486
 487 static void dbd_hooks(apr_pool_t *pool)
 488 {
 489 #if APR_HAS_THREADS
 490     ap_hook_child_init((void*)dbd_setup, NULL, NULL, APR_HOOK_MIDDLE);
 491 #endif
 492     APR_REGISTER_OPTIONAL_FN(ap_dbd_open);
 493     APR_REGISTER_OPTIONAL_FN(ap_dbd_close);
 494     APR_REGISTER_OPTIONAL_FN(ap_dbd_acquire);
 495     APR_REGISTER_OPTIONAL_FN(ap_dbd_cacquire);
 496     APR_REGISTER_OPTIONAL_FN(ap_dbd_prepare);
 497     apr_dbd_init(pool);
 498 }
 499
 500 module AP_MODULE_DECLARE_DATA dbd_module = {
 501     STANDARD20_MODULE_STUFF,
 502     NULL,
 503     NULL,
 504     dbd_cfg,
 505     dbd_merge,
 506     dbd_cmds,
 507     dbd_hooks
 508 };