| /* ==================================================================== |
| * The Apache Software License, Version 1.1 |
| * |
| * Copyright (c) 2000-2001 The Apache Software Foundation. All rights |
| * reserved. |
| * |
| * Redistribution and use in source and binary forms, with or without |
| * modification, are permitted provided that the following conditions |
| * are met: |
| * |
| * 1. Redistributions of source code must retain the above copyright |
| * notice, this list of conditions and the following disclaimer. |
| * |
| * 2. Redistributions in binary form must reproduce the above copyright |
| * notice, this list of conditions and the following disclaimer in |
| * the documentation and/or other materials provided with the |
| * distribution. |
| * |
| * 3. The end-user documentation included with the redistribution, |
| * if any, must include the following acknowledgment: |
| * "This product includes software developed by the |
| * Apache Software Foundation (http://www.apache.org/)." |
| * Alternately, this acknowledgment may appear in the software itself, |
| * if and wherever such third-party acknowledgments normally appear. |
| * |
| * 4. The names "Apache" and "Apache Software Foundation" must |
| * not be used to endorse or promote products derived from this |
| * software without prior written permission. For written |
| * permission, please contact apache@apache.org. |
| * |
| * 5. Products derived from this software may not be called "Apache", |
| * nor may "Apache" appear in their name, without prior written |
| * permission of the Apache Software Foundation. |
| * |
| * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED |
| * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES |
| * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE |
| * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR |
| * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, |
| * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT |
| * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF |
| * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND |
| * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, |
| * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT |
| * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF |
| * SUCH DAMAGE. |
| * ==================================================================== |
| * |
| * This software consists of voluntary contributions made by many |
| * individuals on behalf of the Apache Software Foundation. For more |
| * information on the Apache Software Foundation, please see |
| * <http://www.apache.org/>. |
| */ |
| |
| #include "apr_strings.h" |
| #define APR_WANT_MEMFUNC |
| #include "apr_want.h" |
| |
| #if APR_HAVE_STDLIB_H |
| #include <stdlib.h> /* for abort() */ |
| #endif |
| |
| #include "apr_dbm_private.h" |
| |
| |
| /* this is used in a few places to define a noop "function". it is needed |
| to stop "no effect" warnings from GCC. */ |
| #define NOOP_FUNCTION if (0) ; else |
| |
| /* ### define defaults for now; these will go away in a while */ |
| #define REGISTER_CLEANUP(dbm, pdatum) NOOP_FUNCTION |
| #define SET_FILE(pdb, f) ((pdb)->file = (f)) |
| |
| /* |
| * We pick up all varieties of Berkeley DB through db.h (included through |
| * apu_select_dbm.h). This code has been compiled/tested against DB1, |
| * DB_185, DB2, and DB3. |
| */ |
| |
| #if defined(DB_VERSION_MAJOR) && (DB_VERSION_MAJOR == 3) |
| #define DB_VER 3 |
| #elif defined(DB_VERSION_MAJOR) && (DB_VERSION_MAJOR == 2) |
| #define DB_VER 2 |
| #else |
| #define DB_VER 1 |
| #endif |
| |
| typedef struct { |
| DB *bdb; |
| #if DB_VER != 1 |
| DBC *curs; |
| #endif |
| } real_file_t; |
| |
| |
| #undef SET_FILE |
| #define SET_FILE(pdb, f) ((pdb)->file = apr_pmemdup((pdb)->pool, \ |
| &(f), sizeof(f))) |
| |
| typedef DBT cvt_datum_t; |
| #define CONVERT_DATUM(cvt, pinput) (memset(&(cvt), 0, sizeof(cvt)), \ |
| (cvt).data = (pinput)->dptr, \ |
| (cvt).size = (pinput)->dsize) |
| |
| typedef DBT result_datum_t; |
| #define RETURN_DATUM(poutput, rd) ((poutput)->dptr = (rd).data, \ |
| (poutput)->dsize = (rd).size) |
| |
| #if DB_VER == 1 |
| #define TXN_ARG |
| #else |
| #define TXN_ARG NULL, |
| #endif |
| |
| #define GET_BDB(f) (((real_file_t *)(f))->bdb) |
| |
| #if DB_VER == 1 |
| #define APR_DBM_CLOSE(f) ((*GET_BDB(f)->close)(GET_BDB(f))) |
| #else |
| #define APR_DBM_CLOSE(f) ((*GET_BDB(f)->close)(GET_BDB(f), 0)) |
| #endif |
| |
| #define do_fetch(bdb, k, v) ((*(bdb)->get)(bdb, TXN_ARG &(k), &(v), 0)) |
| #define APR_DBM_FETCH(f, k, v) db2s(do_fetch(GET_BDB(f), k, v)) |
| #define APR_DBM_STORE(f, k, v) db2s((*GET_BDB(f)->put)(GET_BDB(f), TXN_ARG &(k), &(v), 0)) |
| #define APR_DBM_DELETE(f, k) db2s((*GET_BDB(f)->del)(GET_BDB(f), TXN_ARG &(k), 0)) |
| #define APR_DBM_FIRSTKEY(f, k) do_firstkey(f, &(k)) |
| #define APR_DBM_NEXTKEY(f, k, nk) do_nextkey(f, &(k), &(nk)) |
| #define APR_DBM_FREEDPTR(dptr) NOOP_FUNCTION |
| |
| #if DB_VER == 1 |
| #include <sys/fcntl.h> |
| #define APR_DBM_DBMODE_RO O_RDONLY |
| #define APR_DBM_DBMODE_RW O_RDWR |
| #define APR_DBM_DBMODE_RWCREATE (O_CREAT | O_RDWR) |
| #define APR_DBM_DBMODE_RWTRUNC (O_CREAT | O_RDWR|O_TRUNC) |
| #else |
| #define APR_DBM_DBMODE_RO DB_RDONLY |
| #define APR_DBM_DBMODE_RW 0 |
| #define APR_DBM_DBMODE_RWCREATE DB_CREATE |
| #define APR_DBM_DBMODE_RWTRUNC DB_TRUNCATE |
| #endif /* DBVER == 1 */ |
| |
| /* map a DB error to an apr_status_t */ |
| static apr_status_t db2s(int dberr) |
| { |
| if (dberr != 0) { |
| /* ### need to fix this */ |
| return APR_OS_START_USEERR+dberr; |
| } |
| |
| return APR_SUCCESS; |
| } |
| |
| /* handle the FIRSTKEY functionality */ |
| static apr_status_t do_firstkey(real_file_t *f, DBT *pkey) |
| { |
| int dberr; |
| DBT data; |
| |
| memset(pkey,0,sizeof(DBT)); |
| |
| memset(&data,0,sizeof(DBT)); |
| #if DB_VER == 1 |
| dberr = (*f->bdb->seq)(f->bdb, pkey, &data, R_FIRST); |
| #else |
| if ((dberr = (*f->bdb->cursor)(f->bdb, NULL, &f->curs |
| #if DB_VER == 3 |
| , 0 |
| #endif |
| )) == 0) { |
| dberr = (*f->curs->c_get)(f->curs, pkey, &data, DB_FIRST); |
| if (dberr == DB_NOTFOUND) { |
| memset(pkey, 0, sizeof(*pkey)); |
| (*f->curs->c_close)(f->curs); |
| f->curs = NULL; |
| return APR_SUCCESS; |
| } |
| } |
| #endif |
| |
| return db2s(dberr); |
| } |
| |
| /* handle the NEXTKEY functionality */ |
| static apr_status_t do_nextkey(real_file_t *f, DBT *pkey, DBT *pnext) |
| { |
| int dberr; |
| DBT data = { 0 }; |
| |
| memset(pnext, 0, sizeof(*pnext)); |
| |
| #if DB_VER == 1 |
| dberr = (*f->bdb->seq)(f->bdb, pkey, &data, R_NEXT); |
| if (dberr == RET_SPECIAL) |
| return APR_SUCCESS; |
| #else |
| if (f->curs == NULL) |
| return APR_EINVAL; |
| |
| dberr = (*f->curs->c_get)(f->curs, pkey, &data, DB_NEXT); |
| if (dberr == DB_NOTFOUND) { |
| (*f->curs->c_close)(f->curs); |
| f->curs = NULL; |
| return APR_SUCCESS; |
| } |
| #endif |
| |
| pnext->data = pkey->data; |
| pnext->size = pkey->size; |
| |
| return db2s(dberr); |
| } |
| |
| static apr_status_t set_error(apr_dbm_t *dbm, apr_status_t dbm_said) |
| { |
| apr_status_t rv = APR_SUCCESS; |
| |
| /* ### ignore whatever the DBM said (dbm_said); ask it explicitly */ |
| |
| if (dbm_said == APR_SUCCESS) { |
| dbm->errcode = 0; |
| dbm->errmsg = NULL; |
| } |
| else { |
| /* ### need to fix. dberr was tossed in db2s(). */ |
| /* ### use db_strerror() */ |
| dbm->errcode = dbm_said; |
| dbm->errmsg = db_strerror( dbm_said - APR_OS_START_USEERR); |
| rv = dbm_said; |
| } |
| |
| return rv; |
| } |
| |
| /* -------------------------------------------------------------------------- |
| ** |
| ** DEFINE THE VTABLE FUNCTIONS FOR BERKELEY DB |
| ** |
| ** ### we may need three sets of these: db1, db2, db3 |
| */ |
| |
| static apr_status_t vt_db_open(apr_dbm_t **pdb, const char *pathname, |
| apr_int32_t mode, apr_fileperms_t perm, |
| apr_pool_t *pool) |
| { |
| real_file_t file; |
| int dbmode; |
| |
| *pdb = NULL; |
| |
| switch (mode) { |
| case APR_DBM_READONLY: |
| dbmode = APR_DBM_DBMODE_RO; |
| break; |
| case APR_DBM_READWRITE: |
| dbmode = APR_DBM_DBMODE_RW; |
| break; |
| case APR_DBM_RWCREATE: |
| dbmode = APR_DBM_DBMODE_RWCREATE; |
| break; |
| case APR_DBM_RWTRUNC: |
| dbmode = APR_DBM_DBMODE_RWTRUNC; |
| break; |
| default: |
| return APR_EINVAL; |
| } |
| |
| { |
| int dberr; |
| |
| #if DB_VER == 3 |
| if ((dberr = db_create(&file.bdb, NULL, 0)) == 0) { |
| if ((dberr = (*file.bdb->open)(file.bdb, pathname, NULL, |
| DB_HASH, dbmode, |
| apr_posix_perms2mode(perm))) != 0) { |
| /* close the DB handler */ |
| (void) (*file.bdb->close)(file.bdb, 0); |
| } |
| } |
| file.curs = NULL; |
| #elif DB_VER == 2 |
| dberr = db_open(pathname, DB_HASH, dbmode, apr_posix_perms2mode(perm), |
| NULL, NULL, &file.bdb); |
| file.curs = NULL; |
| #else |
| file.bdb = dbopen(pathname, dbmode, apr_posix_perms2mode(perm), |
| DB_HASH, NULL); |
| if (file.bdb == NULL) |
| return APR_EGENERAL; /* ### need a better error */ |
| dberr = 0; |
| #endif |
| if (dberr != 0) |
| return db2s(dberr); |
| } |
| |
| /* we have an open database... return it */ |
| *pdb = apr_pcalloc(pool, sizeof(**pdb)); |
| (*pdb)->pool = pool; |
| (*pdb)->type = &apr_dbm_type_db; |
| SET_FILE(*pdb, file); |
| |
| /* ### register a cleanup to close the DBM? */ |
| |
| return APR_SUCCESS; |
| } |
| |
| static void vt_db_close(apr_dbm_t *dbm) |
| { |
| APR_DBM_CLOSE(dbm->file); |
| } |
| |
| static apr_status_t vt_db_fetch(apr_dbm_t *dbm, apr_datum_t key, |
| apr_datum_t * pvalue) |
| { |
| apr_status_t rv; |
| cvt_datum_t ckey; |
| result_datum_t rd = { 0 }; |
| |
| CONVERT_DATUM(ckey, &key); |
| rv = APR_DBM_FETCH(dbm->file, ckey, rd); |
| RETURN_DATUM(pvalue, rd); |
| |
| REGISTER_CLEANUP(dbm, pvalue); |
| |
| /* store the error info into DBM, and return a status code. Also, note |
| that *pvalue should have been cleared on error. */ |
| return set_error(dbm, rv); |
| } |
| |
| static apr_status_t vt_db_store(apr_dbm_t *dbm, apr_datum_t key, |
| apr_datum_t value) |
| { |
| apr_status_t rv; |
| cvt_datum_t ckey; |
| cvt_datum_t cvalue; |
| |
| CONVERT_DATUM(ckey, &key); |
| CONVERT_DATUM(cvalue, &value); |
| rv = APR_DBM_STORE(dbm->file, ckey, cvalue); |
| |
| /* store any error info into DBM, and return a status code. */ |
| return set_error(dbm, rv); |
| } |
| |
| static apr_status_t vt_db_del(apr_dbm_t *dbm, apr_datum_t key) |
| { |
| apr_status_t rv; |
| cvt_datum_t ckey; |
| |
| CONVERT_DATUM(ckey, &key); |
| rv = APR_DBM_DELETE(dbm->file, ckey); |
| |
| /* store any error info into DBM, and return a status code. */ |
| return set_error(dbm, rv); |
| } |
| |
| static int vt_db_exists(apr_dbm_t *dbm, apr_datum_t key) |
| { |
| DBT ckey = { 0 }; /* converted key */ |
| DBT data = { 0 }; |
| int dberr; |
| |
| ckey.data = key.dptr; |
| ckey.size = key.dsize; |
| |
| dberr = do_fetch(GET_BDB(dbm->file), ckey, data); |
| |
| /* note: the result data is "loaned" to us; we don't need to free it */ |
| |
| /* DB returns DB_NOTFOUND if it doesn't exist. but we want to say |
| that *any* error means it doesn't exist. */ |
| return dberr == 0; |
| } |
| |
| static apr_status_t vt_db_firstkey(apr_dbm_t *dbm, apr_datum_t * pkey) |
| { |
| apr_status_t rv; |
| result_datum_t rd; |
| |
| rv = APR_DBM_FIRSTKEY(dbm->file, rd); |
| RETURN_DATUM(pkey, rd); |
| |
| REGISTER_CLEANUP(dbm, pkey); |
| |
| /* store any error info into DBM, and return a status code. */ |
| return set_error(dbm, rv); |
| } |
| |
| static apr_status_t vt_db_nextkey(apr_dbm_t *dbm, apr_datum_t * pkey) |
| { |
| apr_status_t rv; |
| cvt_datum_t ckey; |
| result_datum_t rd; |
| |
| CONVERT_DATUM(ckey, pkey); |
| rv = APR_DBM_NEXTKEY(dbm->file, ckey, rd); |
| RETURN_DATUM(pkey, rd); |
| |
| REGISTER_CLEANUP(dbm, pkey); |
| |
| /* store any error info into DBM, and return a status code. */ |
| return set_error(dbm, APR_SUCCESS); |
| } |
| |
| static void vt_db_freedatum(apr_dbm_t *dbm, apr_datum_t data) |
| { |
| APR_DBM_FREEDPTR(data.dptr); |
| } |
| |
| static void vt_db_usednames(apr_pool_t *pool, const char *pathname, |
| const char **used1, const char **used2) |
| { |
| *used1 = apr_pstrdup(pool, pathname); |
| *used2 = NULL; |
| } |
| |
| |
| APU_DECLARE_DATA const apr_dbm_type_t apr_dbm_type_db = { |
| "db", |
| |
| vt_db_open, |
| vt_db_close, |
| vt_db_fetch, |
| vt_db_store, |
| vt_db_del, |
| vt_db_exists, |
| vt_db_firstkey, |
| vt_db_nextkey, |
| vt_db_freedatum, |
| vt_db_usednames |
| }; |