root/trunk/sdbo/odbc_etc.d

/********************************************************
 *                                                      *
 * Copyright (c) 2004 Wolfgang Borgsmüller (wb@sapo.pt) *
 *                                                      *
 * Usage of the works is permitted provided that this   *
 * instrument is retained with the works, so that any   *
 * entity that uses the works is notified of this       *
 * instrument.                                          *
 *                                                      *
 * DISCLAIMER: THE WORKS ARE WITHOUT WARRANTY.          *
 *                                                      *
 * [2004, Fair License: rhid.com/fair]                  *
 ********************************************************/

/*! \if never
*/

module sdbo.odbc_etc;

private import std.string;
private import std.stdio;

version(linux) {
    version = bundled_headers;
}

version(bundled_headers) {
    private import sdbo._odbc_headers.sql;
    private import sdbo._odbc_headers.sqlext;
    private import sdbo._odbc_headers.sqltypes;
    version(Windows) {
        private import sdbo._odbc_headers.odbc32dll;
    }
    
} else {
    private import std.c.windows.sql;
    private import std.c.windows.sqlext;
    private import std.c.windows.sqltypes;
    private import std.c.windows.odbc32dll;
}



/*! \endif
*/


/*! \brief Odbc Message with sql states, native errors, text messages
 *
 * Records returned from a diagnistic call
 *
 */

public class OdbcMessage {
    
    char[5][] sqlStates;
    int[] nativeErrors;
    char[][] messages;
    
    
    /*! \brief Returns the number of diag records.
    */
    public int recCount()
    {
        return sqlStates.length;
    }

    /*! \brief Returns the sql state for a diag record.
    */
    public char[] sqlState(int diagrec = 0)
    {
        assert(diagrec < sqlStates.length);
        
        char[] state;
        state.length = 5;
        state[0..5] = sqlStates[diagrec][0..5];
        return state;
    }
    
    /*! \brief Returns the native error for a diag record.
    */
    public int nativeError(int diagrec = 0)
    {
        assert(diagrec < nativeErrors.length);
        return nativeErrors[diagrec];
    }
    
    /*! \brief Returns the message for a diag record.
    */
    public char[] message(int diagrec = 0)
    {
        assert(diagrec < messages.length);
        return messages[diagrec];
    }
    

    
    /*! \brief Returns all informations in a string.
    */
    public char[] toString()
    {
        char[] msgs;
        for(int i=0; i < messages.length; i++) {
            msgs ~= sqlState(i) ~ " " ~ .toString(nativeErrors[i]) ~ " " ~ messages[i] ~ "\n";
        }
        
        return msgs;
    }

    /*! \brief Resets the message discarting all records.
    */
    public void reset()
    {
        messages.length = 0;
        nativeErrors.length = 0;
        sqlStates.length = 0;
    }
    

    
}


/*! \brief Single column specification
 *
 * A ColumnSpec is returned by the getColumnSpec function of the SqlResult object.
 * 
 * The struct members describe name, type, size, 
 * digits, if it is nullable, and the numeric sql data type.
 *
 * 
 */

public struct ColumnSpec
{
    /*! \brief Name of the column.
    */
    public char[] name;
    /*! \brief Type of the column.
    */
    public char[] type;
    /*! \brief Size of the column.
    */
    public ushort csize;
    /*! \brief Digits of the column.
    */
    public short digits;
    /*! \brief Nullable
    */
    public short nullable;
    /*! \brief Numeric sql type of the column.
    */
    public short numericType;
    /*! \brief Octet length of the column.
    */
    public uint octetLength;
}



/*! \brief Exception thrown if an odbc call returns with error.
 *
 * Each SqlException carries the odbc diagnistics messages.
 *
 * toString() and print() return/print the name of the failed odbc call 
 * and available diagnistics messages.
 *
 *
 */

public class SqlException : Exception 
{
    
    public static RETCODE checkRetcode(RETCODE rc, char[] msg, void* h, int hType, OdbcMessage diag = null)
    {
        
        if(rc == SQL_SUCCESS)
            return rc;
        
        else if(rc == SQL_SUCCESS_WITH_INFO) {
            
            /* get info */
            
            if(diag) 
                getMessage(diag, h, hType);
            
            return rc;
            
        } else if(rc == SQL_ERROR) {
            
            throw new SqlException(msg, h, hType);
        }
        
        return rc;

    }
    

    private static void getMessage(OdbcMessage odbcmessage, void* h, int hType)
    {
        short retLen = 0;
        int record = 1;
        
        odbcmessage.messages.length = 1;
        odbcmessage.nativeErrors.length=1;
        odbcmessage.sqlStates.length = 1;
        
        odbcmessage.messages[0].length = 2048;
        
        char[1024] buf;
        
        while(SQLGetDiagRec (
                hType, 
                h, 
                record, 
                odbcmessage.sqlStates[record-1], 
                &(odbcmessage.nativeErrors[record-1]),
                cast(SQLCHAR*) buf,
                buf.length,
                &retLen
                ) == SQL_SUCCESS)
        {
            
            odbcmessage.messages[record-1].length = retLen;
            odbcmessage.messages[record-1][0..length] = buf[0..retLen];
            retLen = 0;
            
            record++;
            odbcmessage.messages.length = record;
            odbcmessage.nativeErrors.length=record;
            odbcmessage.sqlStates.length = record;

            odbcmessage.messages[record-1].length = 2048;
        }
        odbcmessage.messages.length = odbcmessage.messages.length - 1;
        odbcmessage.nativeErrors.length=odbcmessage.nativeErrors.length - 1;
        odbcmessage.sqlStates.length = odbcmessage.sqlStates.length - 1;
    }
    

    
    OdbcMessage odbcmessage;
    
    this(char[] msg, void* h, int hType) { 
        super(msg); 
        odbcmessage = new OdbcMessage;
        getMessage(odbcmessage, h, hType);
    }
    
    
    /*! \brief Returns the sql state for a diag record.
    */
    public char[] sqlState(int diagrec = 0)
    {
        return odbcmessage.sqlState(diagrec);
    }
    
    /*! \brief Returns the native error for a diag record.
    */
    public int nativeError(int diagrec = 0)
    {
        return odbcmessage.nativeError(diagrec);
    }
    
    /*! \brief Returns the message for a diag record.
    */
    public char[] message(int diagrec = 0)
    {
        return odbcmessage.message(diagrec);
    }
    
    /*! \brief Returns all informations in a string.
    */
    public char[] toString()
    {
        return msg ~ " failed! Diagnostics records:\n" ~ odbcmessage.toString();

    }
    

    
    void print() 
    {
        fprintf(stderr, toStringz(toString()));
    }
    
}



/*! \if never
*/


version(Windows) {

/* odbc */

package char[]    odbc32dll   = "odbc32.dll";
private HINSTANCE hODBC32DLL = null;

void freeOdbc32dll()
{
    FreeLibrary(hODBC32DLL);
    throw new Exception("Library free'd!");
}

bit probeOdbc32dll()
{
    
    if(hODBC32DLL != null) 
        return true;
    
    hODBC32DLL = LoadLibraryA( std.string.toStringz( odbc32dll ) );
    
    if ( hODBC32DLL <= cast(HINSTANCE)0 )
    {
        hODBC32DLL = null;

        return false;
    } 
    
    SQLAllocConnect     = cast(pfn_SQLAllocConnect)GetProcAddress(hODBC32DLL, "SQLAllocConnect"); 
    
    SQLAllocEnv         = cast(pfn_SQLAllocEnv)GetProcAddress( hODBC32DLL, "SQLAllocEnv" ); 
    SQLAllocHandle      = cast(pfn_SQLAllocHandle)GetProcAddress( hODBC32DLL, "SQLAllocHandle" );
    SQLAllocStmt        = cast(pfn_SQLAllocStmt)GetProcAddress( hODBC32DLL, "SQLAllocStmt" ); 
    SQLBindCol          = cast(pfn_SQLBindCol)GetProcAddress( hODBC32DLL, "SQLBindCol" );
    SQLBindParam        = cast(pfn_SQLBindParam)GetProcAddress( hODBC32DLL, "SQLBindParam" );
    SQLBindParameter    = cast(pfn_SQLBindParameter)GetProcAddress( hODBC32DLL, "SQLBindParameter" );
    SQLBrowseConnect    = cast(pfn_SQLBrowseConnect)GetProcAddress( hODBC32DLL, "SQLBrowseConnect" );
    SQLBulkOperations   = cast(pfn_SQLBulkOperations)GetProcAddress( hODBC32DLL, "SQLBulkOperations" );
    SQLCancel           = cast(pfn_SQLCancel)GetProcAddress( hODBC32DLL, "SQLCancel" );    
    SQLCloseCursor      = cast(pfn_SQLCloseCursor)GetProcAddress( hODBC32DLL, "SQLCloseCursor" );    
    SQLColAttribute     = cast(pfn_SQLColAttribute)GetProcAddress( hODBC32DLL, "SQLColAttribute" );
    SQLColAttributes    = cast(pfn_SQLColAttributes)GetProcAddress( hODBC32DLL, "SQLColAttributes" );
    SQLColumnPrivileges = cast(pfn_SQLColumnPrivileges)GetProcAddress( hODBC32DLL, "SQLColumnPrivileges" );
    SQLColumns          = cast(pfn_SQLColumns)GetProcAddress( hODBC32DLL, "SQLColumns" ); 
    SQLConnect          = cast(pfn_SQLConnect)GetProcAddress( hODBC32DLL, "SQLConnect" ); 
    SQLCopyDesc         = cast(pfn_SQLCopyDesc)GetProcAddress( hODBC32DLL, "SQLCopyDesc" ); 
    SQLDataSources      = cast(pfn_SQLDataSources)GetProcAddress( hODBC32DLL, "SQLDataSources" ); 
    SQLDescribeCol      = cast(pfn_SQLDescribeCol)GetProcAddress( hODBC32DLL, "SQLDescribeCol" );
    SQLDescribeParam    = cast(pfn_SQLDescribeParam)GetProcAddress( hODBC32DLL, "SQLDescribeParam" );
    SQLDisconnect       = cast(pfn_SQLDisconnect)GetProcAddress( hODBC32DLL, "SQLDisconnect" ); 
    SQLDriverConnect    = cast(pfn_SQLDriverConnect)GetProcAddress( hODBC32DLL, "SQLDriverConnect" ); 
    SQLDrivers          = cast(pfn_SQLDrivers)GetProcAddress( hODBC32DLL, "SQLDrivers" );
    SQLEndTran          = cast(pfn_SQLEndTran)GetProcAddress( hODBC32DLL, "SQLEndTran" );
    SQLError            = cast(pfn_SQLError)GetProcAddress( hODBC32DLL, "SQLError" );
    SQLExecDirect       = cast(pfn_SQLExecDirect)GetProcAddress( hODBC32DLL, "SQLExecDirect" );
    SQLExecute          = cast(pfn_SQLExecute)GetProcAddress( hODBC32DLL, "SQLExecute" );
    SQLExtendedFetch    = cast(pfn_SQLExtendedFetch)GetProcAddress( hODBC32DLL, "SQLExtendedFetch" );
    SQLFetch            = cast(pfn_SQLFetch)GetProcAddress( hODBC32DLL, "SQLFetch" );
    SQLFetchScroll      = cast(pfn_SQLFetchScroll)GetProcAddress( hODBC32DLL, "SQLFetchScroll" );
    SQLForeignKeys      = cast(pfn_SQLForeignKeys)GetProcAddress( hODBC32DLL, "SQLForeignKeys" );
    SQLFreeConnect      = cast(pfn_SQLFreeConnect)GetProcAddress( hODBC32DLL, "SQLFreeConnect" ); 
    SQLFreeEnv          = cast(pfn_SQLFreeEnv)GetProcAddress( hODBC32DLL, "SQLFreeEnv" ); 
    SQLFreeHandle       = cast(pfn_SQLFreeHandle)GetProcAddress( hODBC32DLL, "SQLFreeHandle" );
    SQLFreeStmt         = cast(pfn_SQLFreeStmt)GetProcAddress( hODBC32DLL, "SQLFreeStmt" );
    SQLGetConnectAttr   = cast(pfn_SQLGetConnectAttr)GetProcAddress( hODBC32DLL, "SQLGetConnectAttr" );
    SQLGetConnectOption = cast(pfn_SQLGetConnectOption)GetProcAddress( hODBC32DLL, "SQLGetConnectOption" );
    SQLGetCursorName    = cast(pfn_SQLGetCursorName)GetProcAddress( hODBC32DLL, "SQLGetCursorName" );
    SQLGetData          = cast(pfn_SQLGetData)GetProcAddress( hODBC32DLL, "SQLGetData" );
    SQLGetDescField     = cast(pfn_SQLGetDescField)GetProcAddress( hODBC32DLL, "SQLGetDescField" );
    SQLGetDescRec       = cast(pfn_SQLGetDescRec)GetProcAddress( hODBC32DLL, "SQLGetDescRec" );
    SQLGetDiagField     = cast(pfn_SQLGetDiagField)GetProcAddress( hODBC32DLL, "SQLGetDiagField" );
    SQLGetDiagRec       = cast(pfn_SQLGetDiagRec)GetProcAddress( hODBC32DLL, "SQLGetDiagRec" );
    SQLGetEnvAttr       = cast(pfn_SQLGetEnvAttr)GetProcAddress( hODBC32DLL, "SQLGetEnvAttr" );
    SQLGetFunctions     = cast(pfn_SQLGetFunctions)GetProcAddress( hODBC32DLL, "SQLGetFunctions" );
    SQLGetStmtAttr      = cast(pfn_SQLGetStmtAttr)GetProcAddress( hODBC32DLL, "SQLGetStmtAttr" );
    SQLGetStmtOption    = cast(pfn_SQLGetStmtOption)GetProcAddress( hODBC32DLL, "SQLGetStmtOption" );
    SQLGetTypeInfo      = cast(pfn_SQLGetTypeInfo)GetProcAddress( hODBC32DLL, "SQLGetTypeInfo" );
    SQLMoreResults      = cast(pfn_SQLMoreResults)GetProcAddress( hODBC32DLL, "SQLMoreResults" );
    SQLNativeSql        = cast(pfn_SQLNativeSql)GetProcAddress( hODBC32DLL, "SQLNativeSql" );
    SQLNumParams        = cast(pfn_SQLNumParams)GetProcAddress( hODBC32DLL, "SQLNumParams" );
    SQLNumResultCols    = cast(pfn_SQLNumResultCols)GetProcAddress( hODBC32DLL, "SQLNumResultCols" );
    SQLParamData        = cast(pfn_SQLParamData)GetProcAddress( hODBC32DLL, "SQLParamData" );
    SQLParamOptions     = cast(pfn_SQLParamOptions)GetProcAddress( hODBC32DLL, "SQLParamOptions" );
    SQLPrepare          = cast(pfn_SQLPrepare)GetProcAddress( hODBC32DLL, "SQLPrepare" );
    SQLPrimaryKeys      = cast(pfn_SQLPrimaryKeys)GetProcAddress( hODBC32DLL, "SQLPrimaryKeys" );
    SQLProcedureColumns = cast(pfn_SQLProcedureColumns)GetProcAddress( hODBC32DLL, "SQLProcedureColumns" );
    SQLProcedures       = cast(pfn_SQLProcedures)GetProcAddress( hODBC32DLL, "SQLProcedures" );
    SQLPutData          = cast(pfn_SQLPutData)GetProcAddress( hODBC32DLL, "SQLPutData" );
    SQLRowCount         = cast(pfn_SQLRowCount)GetProcAddress( hODBC32DLL, "SQLRowCount" );
    SQLSetConnectAttr   = cast(pfn_SQLSetConnectAttr)GetProcAddress( hODBC32DLL, "SQLSetConnectAttr" );
    SQLSetConnectOption = cast(pfn_SQLSetConnectOption)GetProcAddress( hODBC32DLL, "SQLSetConnectOption" );
    SQLSetCursorName    = cast(pfn_SQLSetCursorName)GetProcAddress( hODBC32DLL, "SQLSetCursorName" );
    SQLSetDescField     = cast(pfn_SQLSetDescField)GetProcAddress( hODBC32DLL, "SQLSetDescField" );
    SQLSetDescRec       = cast(pfn_SQLSetDescRec)GetProcAddress( hODBC32DLL, "SQLSetDescRec" );
    SQLSetEnvAttr       = cast(pfn_SQLSetEnvAttr)GetProcAddress( hODBC32DLL, "SQLSetEnvAttr" );
    SQLSetParam         = cast(pfn_SQLSetParam)GetProcAddress( hODBC32DLL, "SQLSetParam" );
    SQLSetPos           = cast(pfn_SQLSetPos)GetProcAddress( hODBC32DLL, "SQLSetPos" );
    SQLSetStmtAttr      = cast(pfn_SQLSetStmtAttr)GetProcAddress( hODBC32DLL, "SQLSetStmtAttr" );
    SQLSetStmtOption    = cast(pfn_SQLSetStmtOption)GetProcAddress( hODBC32DLL, "SQLSetStmtOption" );
    SQLSpecialColumns   = cast(pfn_SQLSpecialColumns)GetProcAddress( hODBC32DLL, "SQLSpecialColumns" );
    SQLStatistics       = cast(pfn_SQLStatistics)GetProcAddress( hODBC32DLL, "SQLStatistics" );
    SQLTablePrivileges  = cast(pfn_SQLTablePrivileges)GetProcAddress( hODBC32DLL, "SQLTablePrivileges" );
    SQLTables           = cast(pfn_SQLTables)GetProcAddress( hODBC32DLL, "SQLTables" );
    SQLTransact         = cast(pfn_SQLTransact)GetProcAddress( hODBC32DLL, "SQLTransact" );

    
    return true;
}


/*! \endif
*/

    pfn_SQLAllocConnect     SQLAllocConnect     ; 
    pfn_SQLAllocEnv         SQLAllocEnv         ; 
    pfn_SQLAllocHandle      SQLAllocHandle      ;
    pfn_SQLAllocStmt        SQLAllocStmt        ; 
    pfn_SQLBindCol          SQLBindCol          ;
    pfn_SQLBindParam        SQLBindParam        ;
    pfn_SQLBindParameter    SQLBindParameter    ;
    pfn_SQLBrowseConnect    SQLBrowseConnect    ;
    pfn_SQLBulkOperations   SQLBulkOperations   ;
    pfn_SQLCancel           SQLCancel           ;    
    pfn_SQLCloseCursor      SQLCloseCursor      ;    
    pfn_SQLColAttribute     SQLColAttribute     ;
    pfn_SQLColAttributes    SQLColAttributes    ;
    pfn_SQLColumnPrivileges SQLColumnPrivileges ;
    pfn_SQLColumns          SQLColumns          ; 
    pfn_SQLConnect          SQLConnect          ; 
    pfn_SQLCopyDesc         SQLCopyDesc         ; 
    pfn_SQLDataSources      SQLDataSources      ; 
    pfn_SQLDescribeCol      SQLDescribeCol      ;
    pfn_SQLDescribeParam    SQLDescribeParam    ;
    pfn_SQLDisconnect       SQLDisconnect       ; 
    pfn_SQLDriverConnect    SQLDriverConnect    ; 
    pfn_SQLDrivers          SQLDrivers          ;
    pfn_SQLEndTran          SQLEndTran          ;
    pfn_SQLError            SQLError            ;
    pfn_SQLExecDirect       SQLExecDirect       ;
    pfn_SQLExecute          SQLExecute          ;
    pfn_SQLExtendedFetch    SQLExtendedFetch    ;
    pfn_SQLFetch            SQLFetch            ;
    pfn_SQLFetchScroll      SQLFetchScroll      ;
    pfn_SQLForeignKeys      SQLForeignKeys      ;
    pfn_SQLFreeConnect      SQLFreeConnect      ; 
    pfn_SQLFreeEnv          SQLFreeEnv          ; 
    pfn_SQLFreeHandle       SQLFreeHandle       ;
    pfn_SQLFreeStmt         SQLFreeStmt         ;
    pfn_SQLGetConnectAttr   SQLGetConnectAttr   ;
    pfn_SQLGetConnectOption SQLGetConnectOption ;
    pfn_SQLGetCursorName    SQLGetCursorName    ;
    pfn_SQLGetData          SQLGetData          ;
    pfn_SQLGetDescField     SQLGetDescField     ;
    pfn_SQLGetDescRec       SQLGetDescRec       ;
    pfn_SQLGetDiagField     SQLGetDiagField     ;
    pfn_SQLGetDiagRec       SQLGetDiagRec       ;
    pfn_SQLGetEnvAttr       SQLGetEnvAttr       ;
    pfn_SQLGetFunctions     SQLGetFunctions     ;
    pfn_SQLGetStmtAttr      SQLGetStmtAttr      ;
    pfn_SQLGetStmtOption    SQLGetStmtOption    ;
    pfn_SQLGetTypeInfo      SQLGetTypeInfo      ;
    pfn_SQLMoreResults      SQLMoreResults      ;
    pfn_SQLNativeSql        SQLNativeSql        ;
    pfn_SQLNumParams        SQLNumParams        ;
    pfn_SQLNumResultCols    SQLNumResultCols    ;
    pfn_SQLParamData        SQLParamData        ;
    pfn_SQLParamOptions     SQLParamOptions     ;
    pfn_SQLPrepare          SQLPrepare          ;
    pfn_SQLPrimaryKeys      SQLPrimaryKeys      ;
    pfn_SQLProcedureColumns SQLProcedureColumns ;
    pfn_SQLProcedures       SQLProcedures       ;
    pfn_SQLPutData          SQLPutData          ;
    pfn_SQLRowCount         SQLRowCount         ;
    pfn_SQLSetConnectAttr   SQLSetConnectAttr   ;
    pfn_SQLSetConnectOption SQLSetConnectOption ;
    pfn_SQLSetCursorName    SQLSetCursorName    ;
    pfn_SQLSetDescField     SQLSetDescField     ;
    pfn_SQLSetDescRec       SQLSetDescRec       ;
    pfn_SQLSetEnvAttr       SQLSetEnvAttr       ;
    pfn_SQLSetParam         SQLSetParam         ;
    pfn_SQLSetPos           SQLSetPos           ;
    pfn_SQLSetStmtAttr      SQLSetStmtAttr      ;
    pfn_SQLSetStmtOption    SQLSetStmtOption    ;
    pfn_SQLSpecialColumns   SQLSpecialColumns   ;
    pfn_SQLStatistics       SQLStatistics       ;
    pfn_SQLTablePrivileges  SQLTablePrivileges  ;
    pfn_SQLTables           SQLTables           ;
    pfn_SQLTransact         SQLTransact         ;


} // version(Windows)