aolserver/nsdb/dbdrv.c

/*
 * The contents of this file are subject to the AOLserver Public License
 * Version 1.1 (the "License"); you may not use this file except in
 * compliance with the License. You may obtain a copy of the License at
 * http://aolserver.com/.
 *
 * Software distributed under the License is distributed on an "AS IS"
 * basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
 * the License for the specific language governing rights and limitations
 * under the License.
 *
 * The Original Code is AOLserver Code and related documentation
 * distributed by AOL.
 * 
 * The Initial Developer of the Original Code is America Online,
 * Inc. Portions created by AOL are Copyright (C) 1999 America Online,
 * Inc. All Rights Reserved.
 *
 * Alternatively, the contents of this file may be used under the terms
 * of the GNU General Public License (the "GPL"), in which case the
 * provisions of GPL are applicable instead of those above.  If you wish
 * to allow use of your version of this file only under the terms of the
 * GPL and not to allow others to use your version of this file under the
 * License, indicate your decision by deleting the provisions above and
 * replace them with the notice and other provisions required by the GPL.
 * If you do not delete the provisions above, a recipient may use your
 * version of this file under either the License or the GPL.
 */


/* 
 * dbdrv.c --
 *
 *      Routines for handling the loadable db driver interface.
 */

static const char *RCSID = "@(#) $Header: /cvsroot-fuse/aolserver/aolserver/nsdb/dbdrv.c,v 1.2 2004/06/20 15:54:01 seryakov Exp $, compiled: " __DATE__ " " __TIME__;

#include "db.h"

/*
 * The following typedefs define the functions provided by
 * loadable drivers.
 */

typedef int (InitProc) (char *server, char *module, char *driver);
typedef char *(NameProc) (Ns_DbHandle *);
typedef char *(TypeProc) (Ns_DbHandle *);
typedef int (OpenProc) (Ns_DbHandle *);
typedef void (CloseProc) (Ns_DbHandle *);
typedef int (DMLProc) (Ns_DbHandle *, char *sql);
typedef Ns_Set *(SelectProc) (Ns_DbHandle *, char *sql);
typedef int (<a href="/cvs/aolserver/aolserver/nsd/exec.c#A_ExecProc">ExecProc</a>) (Ns_DbHandle *, char *sql);
typedef Ns_Set *(BindProc) (Ns_DbHandle *);
typedef int (GetProc) (Ns_DbHandle *, Ns_Set *);
typedef int (FlushProc) (Ns_DbHandle *);
typedef int (CancelProc) (Ns_DbHandle *);
typedef int (ResetProc) (Ns_DbHandle *);
typedef int (SpStartProc) (Ns_DbHandle *handle, char *procname);
typedef int (SpSetParamProc) (Ns_DbHandle *handle, char *args);
typedef int (SpExecProc) (Ns_DbHandle *handle);
typedef int (SpReturnCodeProc) (Ns_DbHandle *dbhandle, char *returnCode,
                                int bufsize);
typedef Ns_Set *(SpGetParamsProc) (Ns_DbHandle *handle);

/*
 * The following structure specifies the driver-specific functions
 * to call for each Ns_Db routine.
 */

typedef struct DbDriver {
    char        *name;
    int          registered;
    InitProc    *initProc;
    NameProc    *nameProc;
    TypeProc    *typeProc;
    OpenProc    *openProc;
    CloseProc   *closeProc;
    DMLProc     *dmlProc;
    SelectProc  *selectProc;
    <a href="/cvs/aolserver/aolserver/nsd/exec.c#A_ExecProc">ExecProc</a>    *execProc;
    BindProc    *bindProc;
    GetProc     *getProc;
    FlushProc   *flushProc;
    CancelProc  *cancelProc;
    ResetProc   *resetProc;
    SpStartProc *spstartProc;
    SpSetParamProc   *spsetparamProc;
    SpExecProc       *spexecProc;
    SpReturnCodeProc *spreturncodeProc;
    SpGetParamsProc  *spgetparamsProc;
} DbDriver;
    
/*
 * Static variables defined in this file
 */

static Tcl_HashTable driversTable;


/*
 *----------------------------------------------------------------------
 *
 * <a href="/cvs/aolserver/aolserver/nsdb/dbdrv.c#A_Ns_DbRegisterDriver">Ns_DbRegisterDriver</a> --
 *
 *      Register db procs for a driver.  This routine is called by
 *      driver modules when loaded.
 *
 * Results:
 *      NS_OK if procs registered, NS_ERROR otherwise.
 *
 * Side effects:
 *      Driver structure is allocated and function pointers are set
 *      to the given array of procs.
 *
 *----------------------------------------------------------------------
 */

static void
<a href="/cvs/aolserver/aolserver/nsdb/dbdrv.c#A_UnsupProcId">UnsupProcId</a>(char *name)
{
    <a href="/cvs/aolserver/aolserver/nsd/log.c#A_Ns_Log">Ns_Log</a>(Warning, "dbdrv: unsupported function id '%s'", name);
}

int
<a href="/cvs/aolserver/aolserver/nsdb/dbdrv.c#A_Ns_DbRegisterDriver">Ns_DbRegisterDriver</a>(char *driver, Ns_DbProc *procs)
{
    Tcl_HashEntry *hPtr;
    DbDriver *driverPtr = NULL;

    hPtr = Tcl_FindHashEntry(&driversTable, driver);
    if (hPtr == NULL) {
        <a href="/cvs/aolserver/aolserver/nsd/log.c#A_Ns_Log">Ns_Log</a>(Error, "dbdrv: no such driver '%s'", driver);
        return NS_ERROR;
    }
    driverPtr = (DbDriver *) Tcl_GetHashValue(hPtr);
    if (driverPtr->registered) {
        <a href="/cvs/aolserver/aolserver/nsd/log.c#A_Ns_Log">Ns_Log</a>(Error, "dbdrv: a driver is already registered as '%s'",
               driver);
        return NS_ERROR;
    }
    driverPtr->registered = 1;
    
    while (procs->func != NULL) {
        switch (procs->id) {
            case DbFn_ServerInit:
                driverPtr->initProc = (InitProc *) procs->func;
                break;
            case DbFn_Name:
                driverPtr->nameProc = (NameProc *) procs->func;
                break;
            case DbFn_DbType:
                driverPtr->typeProc = (TypeProc *) procs->func;
                break;
            case DbFn_OpenDb:
                driverPtr->openProc = (OpenProc *) procs->func;
                break;
            case DbFn_CloseDb:
                driverPtr->closeProc = (CloseProc *) procs->func;
                break;
            case DbFn_DML:
                driverPtr->dmlProc = (DMLProc *) procs->func;
                break;
            case DbFn_Select:
                driverPtr->selectProc = (SelectProc *) procs->func;
                break;
            case DbFn_GetRow:
                driverPtr->getProc = (GetProc *) procs->func;
                break;
            case DbFn_Flush:
                driverPtr->flushProc = (FlushProc *) procs->func;
                break;
            case DbFn_Cancel:
                driverPtr->cancelProc = (CancelProc *) procs->func;
                break;
            case DbFn_Exec:
                driverPtr->execProc = (<a href="/cvs/aolserver/aolserver/nsd/exec.c#A_ExecProc">ExecProc</a> *) procs->func;
                break;
            case DbFn_BindRow:
                driverPtr->bindProc = (BindProc *) procs->func;
                break;
            case DbFn_ResetHandle:
                driverPtr->resetProc = (ResetProc *) procs->func;
                break;

            case DbFn_SpStart:
                driverPtr->spstartProc = (SpStartProc *) procs->func;
                break;
                
            case DbFn_SpSetParam:
                driverPtr->spsetparamProc = (SpSetParamProc *) procs->func;
                break;

            case DbFn_SpExec:
                driverPtr->spexecProc = (SpExecProc *) procs->func;
                break;

            case DbFn_SpReturnCode:
                driverPtr->spreturncodeProc = (SpReturnCodeProc *) procs->func;
                break;

            case DbFn_SpGetParams:
                driverPtr->spgetparamsProc = (SpGetParamsProc *) procs->func;
                break;

            /*
             * The following functions are no longer supported.
             */

            case DbFn_End:
                <a href="/cvs/aolserver/aolserver/nsdb/dbdrv.c#A_UnsupProcId">UnsupProcId</a>("End");
                break;
                
            case DbFn_GetTableInfo:
                <a href="/cvs/aolserver/aolserver/nsdb/dbdrv.c#A_UnsupProcId">UnsupProcId</a>("GetTableInfo");
                break;
                
            case DbFn_TableList:
                <a href="/cvs/aolserver/aolserver/nsdb/dbdrv.c#A_UnsupProcId">UnsupProcId</a>("TableList");
                break;
                
            case DbFn_BestRowId:
                <a href="/cvs/aolserver/aolserver/nsdb/dbdrv.c#A_UnsupProcId">UnsupProcId</a>("BestRowId");
                break;
                
            default:
                <a href="/cvs/aolserver/aolserver/nsd/log.c#A_Ns_Log">Ns_Log</a>(Error, "dbdrv: unknown driver id '%d'", procs->id);
                return NS_ERROR;
                break;
        }
        ++procs;
    }

    return NS_OK;
}


/*
 *----------------------------------------------------------------------
 *
 * <a href="/cvs/aolserver/aolserver/nsdb/dbdrv.c#A_Ns_DbDriverName">Ns_DbDriverName</a> --
 *
 *      Return the string name of the driver.
 *
 * Results:
 *      String name.
 *
 * Side effects:
 *      None.
 *
 *----------------------------------------------------------------------
 */

char *
<a href="/cvs/aolserver/aolserver/nsdb/dbdrv.c#A_Ns_DbDriverName">Ns_DbDriverName</a>(Ns_DbHandle *handle)
{
    DbDriver *driverPtr = <a href="/cvs/aolserver/aolserver/nsdb/dbinit.c#A_NsDbGetDriver">NsDbGetDriver</a>(handle);
    char *name = NULL;

    if (driverPtr != NULL && driverPtr->nameProc != NULL) {

        name = (*driverPtr->nameProc)(handle);
    }

    return name;
}


/*
 *----------------------------------------------------------------------
 *
 * Ns_DbDriverType --
 *
 *      Return the string name of the database type (e.g., "sybase").
 *
 * Results:
 *      String name.
 *
 * Side effects:
 *      None.
 *
 *----------------------------------------------------------------------
 */

char *
<a href="/cvs/aolserver/aolserver/nsdb/dbdrv.c#A_Ns_DbDriverDbType">Ns_DbDriverDbType</a>(Ns_DbHandle *handle)
{
    DbDriver *driverPtr = <a href="/cvs/aolserver/aolserver/nsdb/dbinit.c#A_NsDbGetDriver">NsDbGetDriver</a>(handle);
    
    if (driverPtr == NULL ||
        driverPtr->typeProc == NULL ||
        handle->connected == NS_FALSE) {

        return NULL;
    }

    return (*driverPtr->typeProc)(handle);
}


/*
 *----------------------------------------------------------------------
 *
 * <a href="/cvs/aolserver/aolserver/nsdb/dbdrv.c#A_Ns_DbDML">Ns_DbDML</a> --
 *
 *      Execute an SQL statement which is expected to be DML.
 *
 * Results:
 *      NS_OK or NS_ERROR.
 *
 * Side effects:
 *      SQL is sent to database for evaluation.
 *
 *----------------------------------------------------------------------
 */

int
<a href="/cvs/aolserver/aolserver/nsdb/dbdrv.c#A_Ns_DbDML">Ns_DbDML</a>(Ns_DbHandle *handle, char *sql)
{
    DbDriver *driverPtr = <a href="/cvs/aolserver/aolserver/nsdb/dbinit.c#A_NsDbGetDriver">NsDbGetDriver</a>(handle);
    int status = NS_ERROR;

    if (driverPtr != NULL && handle->connected) {

        if (driverPtr->execProc != NULL) {
            status = <a href="/cvs/aolserver/aolserver/nsdb/dbdrv.c#A_Ns_DbExec">Ns_DbExec</a>(handle, sql);
            if (status == NS_DML) {
                status = NS_OK;
            } else {
                if (status == NS_ROWS) {
                    <a href="/cvs/aolserver/aolserver/nsdb/dbutil.c#A_Ns_DbSetException">Ns_DbSetException</a>(handle, "NSDB",
                            "Query was not a DML or DDL command.");
                    <a href="/cvs/aolserver/aolserver/nsdb/dbdrv.c#A_Ns_DbFlush">Ns_DbFlush</a>(handle);
                }
                status = NS_ERROR;
            }
        } else if (driverPtr->dmlProc != NULL) {
            status = (*driverPtr->dmlProc)(handle, sql);
            <a href="/cvs/aolserver/aolserver/nsdb/dbinit.c#A_NsDbLogSql">NsDbLogSql</a>(handle, sql);
        }
    }
    
    return status;
}


/*
 *----------------------------------------------------------------------
 *
 * <a href="/cvs/aolserver/aolserver/nsdb/dbdrv.c#A_Ns_DbSelect">Ns_DbSelect</a> --
 *
 *      Execute an SQL statement which is expected to return rows.
 *
 * Results:
 *      Pointer to Ns_Set of selected columns or NULL on error.
 *
 * Side effects:
 *      SQL is sent to database for evaluation.
 *
 *----------------------------------------------------------------------
 */

Ns_Set *
<a href="/cvs/aolserver/aolserver/nsdb/dbdrv.c#A_Ns_DbSelect">Ns_DbSelect</a>(Ns_DbHandle *handle, char *sql)
{
    DbDriver *driverPtr = <a href="/cvs/aolserver/aolserver/nsdb/dbinit.c#A_NsDbGetDriver">NsDbGetDriver</a>(handle);
    Ns_Set *setPtr = NULL;

    if (driverPtr != NULL && handle->connected) {

        if (driverPtr->execProc != NULL) {
            if (<a href="/cvs/aolserver/aolserver/nsdb/dbdrv.c#A_Ns_DbExec">Ns_DbExec</a>(handle, sql) == NS_ROWS) {
                setPtr = <a href="/cvs/aolserver/aolserver/nsdb/dbdrv.c#A_Ns_DbBindRow">Ns_DbBindRow</a>(handle);
            } else {
            if(!handle->dsExceptionMsg.length)  
                <a href="/cvs/aolserver/aolserver/nsdb/dbutil.c#A_Ns_DbSetException">Ns_DbSetException</a>(handle, "NSDB",
                        "Query was not a statement returning rows.");
            }
        } else if (driverPtr->selectProc != NULL) {
            <a href="/cvs/aolserver/aolserver/nsd/set.c#A_Ns_SetTrunc">Ns_SetTrunc</a>(handle->row, 0);
            setPtr = (*driverPtr->selectProc)(handle, sql);     
            <a href="/cvs/aolserver/aolserver/nsdb/dbinit.c#A_NsDbLogSql">NsDbLogSql</a>(handle, sql);
        }
    }
    
    return setPtr;
}


/*
 *----------------------------------------------------------------------
 *
 * <a href="/cvs/aolserver/aolserver/nsdb/dbdrv.c#A_Ns_DbExec">Ns_DbExec</a> --
 *
 *      Execute an SQL statement.
 *
 * Results:
 *      NS_DML, NS_ROWS, or NS_ERROR.
 *
 * Side effects:
 *      SQL is sent to database for evaluation.
 *
 *----------------------------------------------------------------------
 */

int
<a href="/cvs/aolserver/aolserver/nsdb/dbdrv.c#A_Ns_DbExec">Ns_DbExec</a>(Ns_DbHandle *handle, char *sql)
{
    DbDriver *driverPtr = <a href="/cvs/aolserver/aolserver/nsdb/dbinit.c#A_NsDbGetDriver">NsDbGetDriver</a>(handle);
    int status = NS_ERROR;
    
    if (handle->connected &&
        driverPtr != NULL &&
        driverPtr->execProc != NULL) {

        status = (*driverPtr->execProc)(handle, sql);
        <a href="/cvs/aolserver/aolserver/nsdb/dbinit.c#A_NsDbLogSql">NsDbLogSql</a>(handle, sql);
    }

    return status;
}


/*
 *----------------------------------------------------------------------
 *
 * <a href="/cvs/aolserver/aolserver/nsdb/dbdrv.c#A_Ns_DbBindRow">Ns_DbBindRow</a> --
 *
 *      Bind the column names from a pending result set.  This routine
 *      is normally called right after an <a href="/cvs/aolserver/aolserver/nsdb/dbdrv.c#A_Ns_DbExec">Ns_DbExec</a> if the result
 *      was NS_ROWS.
 *
 * Results:
 *      Pointer to Ns_Set.
 *
 * Side effects:
 *      Column names of result rows are set in the Ns_Set. 
 *
 *----------------------------------------------------------------------
 */

Ns_Set *
<a href="/cvs/aolserver/aolserver/nsdb/dbdrv.c#A_Ns_DbBindRow">Ns_DbBindRow</a>(Ns_DbHandle *handle)
{
    DbDriver *driverPtr = <a href="/cvs/aolserver/aolserver/nsdb/dbinit.c#A_NsDbGetDriver">NsDbGetDriver</a>(handle);
    Ns_Set *setPtr = NULL;

    if (handle->connected &&
        driverPtr != NULL &&
        driverPtr->bindProc != NULL) {

        <a href="/cvs/aolserver/aolserver/nsd/set.c#A_Ns_SetTrunc">Ns_SetTrunc</a>(handle->row, 0);
        setPtr = (*driverPtr->bindProc)(handle);
    }
    
    return setPtr;
}


/*
 *----------------------------------------------------------------------
 *
 * <a href="/cvs/aolserver/aolserver/nsdb/dbdrv.c#A_Ns_DbGetRow">Ns_DbGetRow</a> --
 *
 *      Fetch the next row waiting in a result set.  This routine
 *      is normally called repeatedly after an <a href="/cvs/aolserver/aolserver/nsdb/dbdrv.c#A_Ns_DbSelect">Ns_DbSelect</a> or
 *      an <a href="/cvs/aolserver/aolserver/nsdb/dbdrv.c#A_Ns_DbExec">Ns_DbExec</a> and <a href="/cvs/aolserver/aolserver/nsdb/dbdrv.c#A_Ns_DbBindRow">Ns_DbBindRow</a>.
 *
 * Results:
 *      NS_END_DATA if there are no more rows, NS_OK or NS_ERROR
 *      otherwise.
 *
 * Side effects:
 *      The values of the given set are filled in with those of the
 *      next row.
 *
 *----------------------------------------------------------------------
 */
int
<a href="/cvs/aolserver/aolserver/nsdb/dbdrv.c#A_Ns_DbGetRow">Ns_DbGetRow</a>(Ns_DbHandle *handle, Ns_Set *row)
{
    DbDriver *driverPtr = <a href="/cvs/aolserver/aolserver/nsdb/dbinit.c#A_NsDbGetDriver">NsDbGetDriver</a>(handle);
    int status = NS_ERROR;

    if (handle->connected &&
        driverPtr != NULL &&
        driverPtr->getProc != NULL) {

        status = (*driverPtr->getProc)(handle, row);
    }
    
    return status;
}


/*
 *----------------------------------------------------------------------
 *
 * <a href="/cvs/aolserver/aolserver/nsdb/dbdrv.c#A_Ns_DbFlush">Ns_DbFlush</a> --
 *
 *      Flush rows pending in a result set.
 *
 * Results:
 *      NS_OK or NS_ERROR.
 *
 * Side effects:
 *      Rows waiting in the result set are dumped, perhaps by simply
 *      fetching them over one by one.
 *
 *----------------------------------------------------------------------
 */

int
<a href="/cvs/aolserver/aolserver/nsdb/dbdrv.c#A_Ns_DbFlush">Ns_DbFlush</a>(Ns_DbHandle *handle)
{
    DbDriver *driverPtr = <a href="/cvs/aolserver/aolserver/nsdb/dbinit.c#A_NsDbGetDriver">NsDbGetDriver</a>(handle);
    int status = NS_ERROR;

    if (handle->connected &&
        driverPtr != NULL &&
        driverPtr->flushProc != NULL) {

        status = (*driverPtr->flushProc)(handle);
    }
    
    return status;
}


/*
 *----------------------------------------------------------------------
 *
 * <a href="/cvs/aolserver/aolserver/nsdb/dbdrv.c#A_Ns_DbCancel">Ns_DbCancel</a> --
 *
 *      Cancel the execution of a select and dump pending rows.
 *
 * Results:
 *      NS_OK or NS_ERROR.
 *
 * Side effects:
 *      Depending on the driver, a running select call which executes
 *      as rows are fetched may be interrupted.
 *
 *----------------------------------------------------------------------
 */

int
<a href="/cvs/aolserver/aolserver/nsdb/dbdrv.c#A_Ns_DbCancel">Ns_DbCancel</a>(Ns_DbHandle *handle)
{
    DbDriver *driverPtr = <a href="/cvs/aolserver/aolserver/nsdb/dbinit.c#A_NsDbGetDriver">NsDbGetDriver</a>(handle);
    int status = NS_ERROR;

    if (handle->connected &&
        driverPtr != NULL &&
        driverPtr->cancelProc != NULL) {

        status = (*driverPtr->cancelProc)(handle);
    }
    
    return status;
}


/*
 *----------------------------------------------------------------------
 *
 * <a href="/cvs/aolserver/aolserver/nsdb/dbdrv.c#A_Ns_DbResetHandle">Ns_DbResetHandle</a> --
 *
 *      Reset a handle after a cancel operation.
 *
 * Results:
 *      NS_OK or NS_ERROR.
 *
 * Side effects:
 *      Handle is available for new commands.
 *
 *----------------------------------------------------------------------
 */

int
<a href="/cvs/aolserver/aolserver/nsdb/dbdrv.c#A_Ns_DbResetHandle">Ns_DbResetHandle</a> (Ns_DbHandle *handle)
{
    DbDriver *driverPtr = <a href="/cvs/aolserver/aolserver/nsdb/dbinit.c#A_NsDbGetDriver">NsDbGetDriver</a>(handle);
    int status = NS_ERROR;

    if (handle->connected &&
        driverPtr != NULL &&
        driverPtr->resetProc != NULL) {

        status = (*driverPtr->resetProc)(handle);
    }
    
    return status;
}


/*
 *----------------------------------------------------------------------
 *
 * <a href="/cvs/aolserver/aolserver/nsdb/dbdrv.c#A_NsDbLoadDriver">NsDbLoadDriver</a> --
 *
 *      Load a database driver for one or more pools.
 *
 * Results:
 *      Pointer to driver structure or NULL on error.
 *
 * Side effects:
 *      Driver module file may be mapped into the process.
 *
 *----------------------------------------------------------------------
 */

struct DbDriver *
<a href="/cvs/aolserver/aolserver/nsdb/dbdrv.c#A_NsDbLoadDriver">NsDbLoadDriver</a>(char *driver)
{
    Tcl_HashEntry  *hPtr;
    char           *module, *path;
    int             new;
    DbDriver       *driverPtr;
    static int      initialized = NS_FALSE;

    if (initialized == NS_FALSE) {
        Tcl_InitHashTable(&driversTable, TCL_STRING_KEYS);
        initialized = NS_TRUE;
    }

    hPtr = Tcl_CreateHashEntry(&driversTable, driver, &new);
    if (new == 0) {
        driverPtr = (DbDriver *) Tcl_GetHashValue(hPtr);
    } else {
        driverPtr = ns_malloc(sizeof(DbDriver));
        memset(driverPtr, 0, sizeof(DbDriver));
        driverPtr->name = Tcl_GetHashKey(&driversTable, hPtr);
        Tcl_SetHashValue(hPtr, driverPtr);
        module = <a href="/cvs/aolserver/aolserver/nsd/config.c#A_Ns_ConfigGetValue">Ns_ConfigGetValue</a>("ns/db/drivers", driver);
        if (module == NULL) {
            <a href="/cvs/aolserver/aolserver/nsd/log.c#A_Ns_Log">Ns_Log</a>(Error, "dbdrv: no such driver '%s'", driver);
        } else {
            path = <a href="/cvs/aolserver/aolserver/nsd/config.c#A_Ns_ConfigGetPath">Ns_ConfigGetPath</a>(NULL, NULL, "db", "driver", driver, NULL);
            if (<a href="/cvs/aolserver/aolserver/nsd/modload.c#A_Ns_ModuleLoad">Ns_ModuleLoad</a>(driver, path, module, "<a href="/cvs/aolserver/nsodbc/nsodbc.c#A_Ns_DbDriverInit">Ns_DbDriverInit</a>")
                    != NS_OK) {
                <a href="/cvs/aolserver/aolserver/nsd/log.c#A_Ns_Log">Ns_Log</a>(Error, "dbdrv: failed to load driver '%s'",
                       driver);
            }
        }
    }
    if (driverPtr->registered == 0) {
        return NULL;
    }

    return driverPtr;
}


/*
 *----------------------------------------------------------------------
 *
 * NsDbServerInit --
 *
 *      Invoke driver provided server init proc (e.g., to add driver
 *      specific Tcl commands).
 *
 * Results:
 *      None.
 *
 * Side effects:
 *      None.
 *
 *----------------------------------------------------------------------
 */

void
<a href="/cvs/aolserver/aolserver/nsdb/dbdrv.c#A_NsDbDriverInit">NsDbDriverInit</a>(char *server, DbDriver *driverPtr)
{
    if (driverPtr->initProc != NULL &&
        ((*driverPtr->initProc) (server, "db", driverPtr->name)) != NS_OK) {

        <a href="/cvs/aolserver/aolserver/nsd/log.c#A_Ns_Log">Ns_Log</a>(Warning, "dbdrv: init proc failed for driver '%s'",
               driverPtr->name);
    }
}


/*
 *----------------------------------------------------------------------
 *
 * <a href="/cvs/aolserver/aolserver/nsdb/dbdrv.c#A_NsDbOpen">NsDbOpen</a> --
 *
 *      Open a connection to the database.  This routine is called
 *      from the pool routines in dbinit.c.
 *
 * Results:
 *      NS_OK or NS_ERROR.
 *
 * Side effects:
 *      Database may be connected by driver specific routine.
 *
 *----------------------------------------------------------------------
 */

int
<a href="/cvs/aolserver/aolserver/nsdb/dbdrv.c#A_NsDbOpen">NsDbOpen</a>(Ns_DbHandle *handle)
{
    DbDriver *driverPtr = <a href="/cvs/aolserver/aolserver/nsdb/dbinit.c#A_NsDbGetDriver">NsDbGetDriver</a>(handle);

    <a href="/cvs/aolserver/aolserver/nsd/log.c#A_Ns_Log">Ns_Log</a>(Notice, "dbdrv: opening database '%s:%s'", handle->driver,
           handle->datasource);
    if (driverPtr == NULL ||
        driverPtr->openProc == NULL ||
        (*driverPtr->openProc) (handle) != NS_OK) {

        <a href="/cvs/aolserver/aolserver/nsd/log.c#A_Ns_Log">Ns_Log</a>(Error, "dbdrv: failed to open database '%s:%s'",
               handle->driver, handle->datasource);
        handle->connected = NS_FALSE;
        return NS_ERROR;
    }

    return NS_OK;
}


/*
 *----------------------------------------------------------------------
 *
 * <a href="/cvs/aolserver/aolserver/nsdb/dbdrv.c#A_NsDbClose">NsDbClose</a> --
 *
 *      Close a connection to the database.  This routine is called
 *      from the pool routines in dbinit.c
 *
 * Results:
 *      None.
 *
 * Side effects:
 *      None.
 *
 *----------------------------------------------------------------------
 */

void
<a href="/cvs/aolserver/aolserver/nsdb/dbdrv.c#A_NsDbClose">NsDbClose</a>(Ns_DbHandle *handle)
{
    DbDriver *driverPtr = <a href="/cvs/aolserver/aolserver/nsdb/dbinit.c#A_NsDbGetDriver">NsDbGetDriver</a>(handle);
    
    if (handle->connected &&
        driverPtr != NULL &&
        driverPtr->closeProc != NULL) {

        (*driverPtr->closeProc)(handle);
    }
}


/*
 *----------------------------------------------------------------------
 *
 * <a href="/cvs/aolserver/aolserver/nsdb/dbdrv.c#A_Ns_DbSpStart">Ns_DbSpStart</a> --
 *
 *      Start execution of a stored procedure. 
 *
 * Results:
 *      NS_OK/NS_ERROR. 
 *
 * Side effects:
 *      Begins an SP; see <a href="/cvs/aolserver/aolserver/nsdb/dbdrv.c#A_Ns_DbSpExec">Ns_DbSpExec</a>. 
 *
 *----------------------------------------------------------------------
 */

int
<a href="/cvs/aolserver/aolserver/nsdb/dbdrv.c#A_Ns_DbSpStart">Ns_DbSpStart</a>(Ns_DbHandle *handle, char *procname)
{
    DbDriver *driverPtr = <a href="/cvs/aolserver/aolserver/nsdb/dbinit.c#A_NsDbGetDriver">NsDbGetDriver</a>(handle);
    int status = NS_ERROR;

    if (handle->connected &&
        driverPtr != NULL &&
        driverPtr->spstartProc != NULL) {

        status = (*driverPtr->spstartProc)(handle, procname);
    }

    return status;
}


/*
 *----------------------------------------------------------------------
 *
 * <a href="/cvs/aolserver/aolserver/nsdb/dbdrv.c#A_Ns_DbSpSetParam">Ns_DbSpSetParam</a> --
 *
 *      Set a parameter in a store procedure; must have executed 
 *      <a href="/cvs/aolserver/aolserver/nsdb/dbdrv.c#A_Ns_DbSpStart">Ns_DbSpStart</a> first. paramname looks like "@x", paramtype is 
 *      like "int" or "varchar", inout is "in" or "out", value is 
 *      like "123". 
 *
 * Results:
 *      NS_OK/NS_ERROR 
 *
 * Side effects:
 *      None. 
 *
 *----------------------------------------------------------------------
 */

int
<a href="/cvs/aolserver/aolserver/nsdb/dbdrv.c#A_Ns_DbSpSetParam">Ns_DbSpSetParam</a>(Ns_DbHandle *handle, char *paramname, char *paramtype,
                char *inout, char *value)
{
    DbDriver   *driverPtr = <a href="/cvs/aolserver/aolserver/nsdb/dbinit.c#A_NsDbGetDriver">NsDbGetDriver</a>(handle);
    int         status = NS_ERROR;
    Ns_DString  args;

    if (handle->connected &&
        driverPtr != NULL &&
        driverPtr->spsetparamProc != NULL) {

        <a href="/cvs/aolserver/aolserver/nsd/dstring.c#A_Ns_DStringInit">Ns_DStringInit</a>(&args);
        <a href="/cvs/aolserver/aolserver/nsd/dstring.c#A_Ns_DStringVarAppend">Ns_DStringVarAppend</a>(&args, paramname, " ", paramtype, " ", inout, " ",
                            value, NULL);
        status = (*driverPtr->spsetparamProc)(handle, args.string);
        <a href="/cvs/aolserver/aolserver/nsd/dstring.c#A_Ns_DStringFree">Ns_DStringFree</a>(&args);
    }

    return status;
}


/*
 *----------------------------------------------------------------------
 *
 * <a href="/cvs/aolserver/aolserver/nsdb/dbdrv.c#A_Ns_DbSpExec">Ns_DbSpExec</a> --
 *
 *      Run an Sp begun with <a href="/cvs/aolserver/aolserver/nsdb/dbdrv.c#A_Ns_DbSpStart">Ns_DbSpStart</a> 
 *
 * Results:
 *      NS_OK/NS_ERROR 
 *
 * Side effects:
 *      None. 
 *
 *----------------------------------------------------------------------
 */

int
<a href="/cvs/aolserver/aolserver/nsdb/dbdrv.c#A_Ns_DbSpExec">Ns_DbSpExec</a>(Ns_DbHandle *handle)
{
    DbDriver *driverPtr = <a href="/cvs/aolserver/aolserver/nsdb/dbinit.c#A_NsDbGetDriver">NsDbGetDriver</a>(handle);
    int       status = NS_ERROR;

    if (handle->connected &&
        driverPtr != NULL &&
        driverPtr->spexecProc != NULL) {

        status = (*driverPtr->spexecProc)(handle);
    }

    return status;
}


/*
 *----------------------------------------------------------------------
 *
 * <a href="/cvs/aolserver/aolserver/nsdb/dbdrv.c#A_Ns_DbSpReturnCode">Ns_DbSpReturnCode</a> --
 *
 *      Get the return code from an SP after <a href="/cvs/aolserver/aolserver/nsdb/dbdrv.c#A_Ns_DbSpExec">Ns_DbSpExec</a> 
 *
 * Results:
 *      NS_OK/NSERROR 
 *
 * Side effects:
 *      The return code is put into the passed-in buffer, which must 
 *      be at least bufsize in length. 
 *
 *----------------------------------------------------------------------
 */

int
<a href="/cvs/aolserver/aolserver/nsdb/dbdrv.c#A_Ns_DbSpReturnCode">Ns_DbSpReturnCode</a>(Ns_DbHandle *handle, char *returnCode, int bufsize)
{
    DbDriver *driverPtr = <a href="/cvs/aolserver/aolserver/nsdb/dbinit.c#A_NsDbGetDriver">NsDbGetDriver</a>(handle);
    int       status = NS_ERROR;

    if (handle->connected &&
        driverPtr != NULL &&
        driverPtr->spreturncodeProc != NULL) {

        status = (*driverPtr->spreturncodeProc)(handle, returnCode, bufsize);
    }

    return status;
}


/*
 *----------------------------------------------------------------------
 *
 * <a href="/cvs/aolserver/aolserver/nsdb/dbdrv.c#A_Ns_DbSpGetParams">Ns_DbSpGetParams</a> --
 *
 *      Get output parameters after running an SP w/ <a href="/cvs/aolserver/aolserver/nsdb/dbdrv.c#A_Ns_DbSpExec">Ns_DbSpExec</a>. 
 *
 * Results:
 *      NULL or a newly allocated set with output params in it. 
 *
 * Side effects:
 *      Allocs its return value and its members. 
 *
 *----------------------------------------------------------------------
 */

Ns_Set *
<a href="/cvs/aolserver/aolserver/nsdb/dbdrv.c#A_Ns_DbSpGetParams">Ns_DbSpGetParams</a>(Ns_DbHandle *handle)
{
    DbDriver *driverPtr = <a href="/cvs/aolserver/aolserver/nsdb/dbinit.c#A_NsDbGetDriver">NsDbGetDriver</a>(handle);
    Ns_Set   *aset = NULL;

    <a href="/cvs/aolserver/aolserver/nsd/set.c#A_Ns_SetTrunc">Ns_SetTrunc</a>(handle->row, 0);
    if (handle->connected &&
        driverPtr != NULL &&
        driverPtr->spgetparamsProc != NULL) {

        aset = (*driverPtr->spgetparamsProc)(handle);
    }

    return aset;
}