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.
20 #include "apu_config.h"
23 #include "apr_pools.h"
25 #include "apr_strings.h"
27 #include "apr_thread_mutex.h"
29 #include "apr_atomic.h"
31 #include "apu_internal.h"
32 #include "apr_dbd_internal.h"
34 #include "apu_version.h"
36 static apr_hash_t *drivers = NULL;
37 static apr_uint32_t initialised = 0, in_init = 1;
39 #define CLEANUP_CAST (apr_status_t (*)(void*))
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.
50 static apr_thread_mutex_t* mutex = NULL;
51 APU_DECLARE(apr_status_t) apr_dbd_mutex_lock()
53 return apr_thread_mutex_lock(mutex);
55 APU_DECLARE(apr_status_t) apr_dbd_mutex_unlock()
57 return apr_thread_mutex_unlock(mutex);
60 APU_DECLARE(apr_status_t) apr_dbd_mutex_lock() {
63 APU_DECLARE(apr_status_t) apr_dbd_mutex_unlock() {
69 #define DRIVER_LOAD(name,driver,pool) \
71 extern const apr_dbd_driver_t driver; \
72 apr_hash_set(drivers,name,APR_HASH_KEY_STRING,&driver); \
79 static apr_status_t apr_dbd_term(void *ptr)
81 /* set drivers to NULL so init can work again */
84 /* Everything else we need is handled by cleanups registered
85 * when we created mutexes and loaded DSOs
90 APU_DECLARE(apr_status_t) apr_dbd_init(apr_pool_t *pool)
92 apr_status_t ret = APR_SUCCESS;
95 if (apr_atomic_inc32(&initialised)) {
96 apr_atomic_set32(&initialised, 1); /* prevent wrap-around */
98 while (apr_atomic_read32(&in_init)) /* wait until we get fully inited */
104 /* Top level pool scope, need process-scope lifetime */
105 for (parent = apr_pool_parent_get(pool);
106 parent && parent != pool;
107 parent = apr_pool_parent_get(pool))
110 /* deprecate in 2.0 - permit implicit initialization */
114 drivers = apr_hash_make(pool);
117 ret = apr_thread_mutex_create(&mutex, APR_THREAD_MUTEX_DEFAULT, pool);
118 /* This already registers a pool cleanup */
123 /* Load statically-linked drivers: */
125 DRIVER_LOAD("mysql", apr_dbd_mysql_driver, pool);
128 DRIVER_LOAD("pgsql", apr_dbd_pgsql_driver, pool);
131 DRIVER_LOAD("sqlite3", apr_dbd_sqlite3_driver, pool);
134 DRIVER_LOAD("sqlite2", apr_dbd_sqlite2_driver, pool);
137 DRIVER_LOAD("oracle", apr_dbd_oracle_driver, pool);
140 DRIVER_LOAD("freetds", apr_dbd_freetds_driver, pool);
143 DRIVER_LOAD("odbc", apr_dbd_odbc_driver, pool);
145 #if APU_HAVE_SOME_OTHER_BACKEND
146 DRIVER_LOAD("firebird", apr_dbd_other_driver, pool);
148 #endif /* APU_DSO_BUILD */
150 apr_pool_cleanup_register(pool, NULL, apr_dbd_term,
151 apr_pool_cleanup_null);
153 apr_atomic_dec32(&in_init);
158 APU_DECLARE(apr_status_t) apr_dbd_get_driver(apr_pool_t *pool, const char *name,
159 const apr_dbd_driver_t **driver)
164 apr_dso_handle_sym_t symbol;
169 rv = apu_dso_mutex_lock();
174 *driver = apr_hash_get(drivers, name, APR_HASH_KEY_STRING);
177 apu_dso_mutex_unlock();
183 /* The driver DSO must have exactly the same lifetime as the
184 * drivers hash table; ignore the passed-in pool */
185 pool = apr_hash_pool_get(drivers);
188 apr_snprintf(modname, sizeof(modname), "dbd%s.nlm", name);
189 #elif defined(WIN32) || defined(__CYGWIN__)
190 apr_snprintf(modname, sizeof(modname),
191 "apr_dbd_%s-" APU_STRINGIFY(APU_MAJOR_VERSION) ".dll", name);
193 apr_snprintf(modname, sizeof(modname),
194 "apr_dbd_%s-" APU_STRINGIFY(APU_MAJOR_VERSION) ".so", name);
196 apr_snprintf(symname, sizeof(symname), "apr_dbd_%s_driver", name);
197 rv = apu_dso_load(NULL, &symbol, modname, symname, pool);
198 if (rv == APR_SUCCESS || rv == APR_EINIT) { /* previously loaded?!? */
200 name = apr_pstrdup(pool, name);
201 apr_hash_set(drivers, name, APR_HASH_KEY_STRING, *driver);
203 if ((*driver)->init) {
204 (*driver)->init(pool);
207 apu_dso_mutex_unlock();
209 #else /* not builtin and !APU_DSO_BUILD => not implemented */
216 APU_DECLARE(apr_status_t) apr_dbd_open_ex(const apr_dbd_driver_t *driver,
217 apr_pool_t *pool, const char *params,
222 *handle = (driver->open)(pool, params, error);
223 if (*handle == NULL) {
226 rv = apr_dbd_check_conn(driver, pool, *handle);
227 if ((rv != APR_SUCCESS) && (rv != APR_ENOTIMPL)) {
228 /* XXX: rv is APR error code, but apr_dbd_error() takes int! */
230 *error = apr_dbd_error(driver, *handle, rv);
232 apr_dbd_close(driver, *handle);
238 APU_DECLARE(apr_status_t) apr_dbd_open(const apr_dbd_driver_t *driver,
239 apr_pool_t *pool, const char *params,
242 return apr_dbd_open_ex(driver,pool,params,handle,NULL);
245 APU_DECLARE(int) apr_dbd_transaction_start(const apr_dbd_driver_t *driver,
246 apr_pool_t *pool, apr_dbd_t *handle,
247 apr_dbd_transaction_t **trans)
249 int ret = driver->start_transaction(pool, handle, trans);
251 apr_pool_cleanup_register(pool, *trans,
252 CLEANUP_CAST driver->end_transaction,
253 apr_pool_cleanup_null);
258 APU_DECLARE(int) apr_dbd_transaction_end(const apr_dbd_driver_t *driver,
260 apr_dbd_transaction_t *trans)
262 apr_pool_cleanup_kill(pool, trans, CLEANUP_CAST driver->end_transaction);
263 return driver->end_transaction(trans);
266 APU_DECLARE(int) apr_dbd_transaction_mode_get(const apr_dbd_driver_t *driver,
267 apr_dbd_transaction_t *trans)
269 return driver->transaction_mode_get(trans);
272 APU_DECLARE(int) apr_dbd_transaction_mode_set(const apr_dbd_driver_t *driver,
273 apr_dbd_transaction_t *trans,
276 return driver->transaction_mode_set(trans, mode);
279 APU_DECLARE(apr_status_t) apr_dbd_close(const apr_dbd_driver_t *driver,
282 return driver->close(handle);
285 APU_DECLARE(const char*) apr_dbd_name(const apr_dbd_driver_t *driver)
290 APU_DECLARE(void*) apr_dbd_native_handle(const apr_dbd_driver_t *driver,
293 return driver->native_handle(handle);
296 APU_DECLARE(int) apr_dbd_check_conn(const apr_dbd_driver_t *driver,
300 return driver->check_conn(pool, handle);
303 APU_DECLARE(int) apr_dbd_set_dbname(const apr_dbd_driver_t *driver,
305 apr_dbd_t *handle, const char *name)
307 return driver->set_dbname(pool,handle,name);
310 APU_DECLARE(int) apr_dbd_query(const apr_dbd_driver_t *driver,
312 int *nrows, const char *statement)
314 return driver->query(handle,nrows,statement);
317 APU_DECLARE(int) apr_dbd_select(const apr_dbd_driver_t *driver,
319 apr_dbd_t *handle, apr_dbd_results_t **res,
320 const char *statement, int random)
322 return driver->select(pool,handle,res,statement,random);
325 APU_DECLARE(int) apr_dbd_num_cols(const apr_dbd_driver_t *driver,
326 apr_dbd_results_t *res)
328 return driver->num_cols(res);
331 APU_DECLARE(int) apr_dbd_num_tuples(const apr_dbd_driver_t *driver,
332 apr_dbd_results_t *res)
334 return driver->num_tuples(res);
337 APU_DECLARE(int) apr_dbd_get_row(const apr_dbd_driver_t *driver,
339 apr_dbd_results_t *res, apr_dbd_row_t **row,
342 return driver->get_row(pool,res,row,rownum);
345 APU_DECLARE(const char*) apr_dbd_get_entry(const apr_dbd_driver_t *driver,
346 apr_dbd_row_t *row, int col)
348 return driver->get_entry(row,col);
351 APU_DECLARE(const char*) apr_dbd_get_name(const apr_dbd_driver_t *driver,
352 apr_dbd_results_t *res, int col)
354 return driver->get_name(res,col);
357 APU_DECLARE(const char*) apr_dbd_error(const apr_dbd_driver_t *driver,
358 apr_dbd_t *handle, int errnum)
360 return driver->error(handle,errnum);
363 APU_DECLARE(const char*) apr_dbd_escape(const apr_dbd_driver_t *driver,
364 apr_pool_t *pool, const char *string,
367 return driver->escape(pool,string,handle);
370 APU_DECLARE(int) apr_dbd_prepare(const apr_dbd_driver_t *driver,
372 apr_dbd_t *handle, const char *query,
374 apr_dbd_prepared_t **statement)
377 int i, nargs = 0, nvals = 0;
382 if (!driver->pformat) {
386 /* find the number of parameters in the query */
387 for (q = query; *q; q++) {
389 if (apr_isalpha(q[1])) {
391 } else if (q[1] == '%') {
398 qlen = strlen(query) +
399 nargs * (strlen(driver->pformat) + sizeof(nargs) * 3 + 2) + 1;
400 pq = apr_palloc(pool, qlen);
401 t = apr_pcalloc(pool, sizeof(*t) * nargs);
403 for (p = pq, q = query, i = 0; *q; q++) {
405 if (apr_isalpha(q[1])) {
407 case 'd': t[i] = APR_DBD_TYPE_INT; break;
408 case 'u': t[i] = APR_DBD_TYPE_UINT; break;
409 case 'f': t[i] = APR_DBD_TYPE_FLOAT; break;
414 case 'd': t[i] = APR_DBD_TYPE_TINY; q += 2; break;
415 case 'u': t[i] = APR_DBD_TYPE_UTINY; q += 2; break;
418 case 'd': t[i] = APR_DBD_TYPE_SHORT; q++; break;
419 case 'u': t[i] = APR_DBD_TYPE_USHORT; q++; break;
426 case 'd': t[i] = APR_DBD_TYPE_LONGLONG; q += 2; break;
427 case 'u': t[i] = APR_DBD_TYPE_ULONGLONG; q += 2; break;
430 case 'd': t[i] = APR_DBD_TYPE_LONG; q++; break;
431 case 'u': t[i] = APR_DBD_TYPE_ULONG; q++; break;
432 case 'f': t[i] = APR_DBD_TYPE_DOUBLE; q++; break;
438 case 't': t[i] = APR_DBD_TYPE_TEXT; q += 2; break;
439 case 'i': t[i] = APR_DBD_TYPE_TIME; q += 2; break;
440 case 'd': t[i] = APR_DBD_TYPE_DATE; q += 2; break;
441 case 'a': t[i] = APR_DBD_TYPE_DATETIME; q += 2; break;
442 case 's': t[i] = APR_DBD_TYPE_TIMESTAMP; q += 2; break;
443 case 'z': t[i] = APR_DBD_TYPE_ZTIMESTAMP; q += 2; break;
444 case 'b': t[i] = APR_DBD_TYPE_BLOB; q += 2; break;
445 case 'c': t[i] = APR_DBD_TYPE_CLOB; q += 2; break;
446 case 'n': t[i] = APR_DBD_TYPE_NULL; q += 2; break;
454 case APR_DBD_TYPE_NONE: /* by default, we expect strings */
455 t[i] = APR_DBD_TYPE_STRING;
457 case APR_DBD_TYPE_BLOB:
458 case APR_DBD_TYPE_CLOB: /* three (3) more values passed in */
465 /* insert database specific parameter reference */
466 p += apr_snprintf(p, qlen - (p - pq), driver->pformat, ++i);
467 } else if (q[1] == '%') { /* reduce %% to % */
478 return driver->prepare(pool,handle,pq,label,nargs,nvals,t,statement);
481 APU_DECLARE(int) apr_dbd_pquery(const apr_dbd_driver_t *driver,
483 apr_dbd_t *handle, int *nrows,
484 apr_dbd_prepared_t *statement,
485 int nargs, const char **args)
487 return driver->pquery(pool,handle,nrows,statement,args);
490 APU_DECLARE(int) apr_dbd_pselect(const apr_dbd_driver_t *driver,
492 apr_dbd_t *handle, apr_dbd_results_t **res,
493 apr_dbd_prepared_t *statement, int random,
494 int nargs, const char **args)
496 return driver->pselect(pool,handle,res,statement,random,args);
499 APU_DECLARE_NONSTD(int) apr_dbd_pvquery(const apr_dbd_driver_t *driver,
501 apr_dbd_t *handle, int *nrows,
502 apr_dbd_prepared_t *statement, ...)
506 va_start(args, statement);
507 ret = driver->pvquery(pool,handle,nrows,statement,args);
512 APU_DECLARE_NONSTD(int) apr_dbd_pvselect(const apr_dbd_driver_t *driver,
513 apr_pool_t *pool, apr_dbd_t *handle,
514 apr_dbd_results_t **res,
515 apr_dbd_prepared_t *statement,
520 va_start(args, random);
521 ret = driver->pvselect(pool,handle,res,statement,random,args);
526 APU_DECLARE(int) apr_dbd_pbquery(const apr_dbd_driver_t *driver,
528 apr_dbd_t *handle, int *nrows,
529 apr_dbd_prepared_t *statement,
532 return driver->pbquery(pool,handle,nrows,statement,args);
535 APU_DECLARE(int) apr_dbd_pbselect(const apr_dbd_driver_t *driver,
537 apr_dbd_t *handle, apr_dbd_results_t **res,
538 apr_dbd_prepared_t *statement, int random,
541 return driver->pbselect(pool,handle,res,statement,random,args);
544 APU_DECLARE_NONSTD(int) apr_dbd_pvbquery(const apr_dbd_driver_t *driver,
546 apr_dbd_t *handle, int *nrows,
547 apr_dbd_prepared_t *statement, ...)
551 va_start(args, statement);
552 ret = driver->pvbquery(pool,handle,nrows,statement,args);
557 APU_DECLARE_NONSTD(int) apr_dbd_pvbselect(const apr_dbd_driver_t *driver,
558 apr_pool_t *pool, apr_dbd_t *handle,
559 apr_dbd_results_t **res,
560 apr_dbd_prepared_t *statement,
565 va_start(args, random);
566 ret = driver->pvbselect(pool,handle,res,statement,random,args);
571 APU_DECLARE(apr_status_t) apr_dbd_datum_get(const apr_dbd_driver_t *driver,
572 apr_dbd_row_t *row, int col,
573 apr_dbd_type_e type, void *data)
575 return driver->datum_get(row,col,type,data);