cpl_odbc.h

Go to the documentation of this file.

/******************************************************************************
 *
 * Project:  OGR ODBC Driver
 * Purpose:  Declarations for ODBC Access Cover API.
 * Author:   Frank Warmerdam, warmerdam@pobox.com
 *
 ******************************************************************************
 * Copyright (c) 2003, Frank Warmerdam
 *
 * SPDX-License-Identifier: MIT
 ****************************************************************************/
 
#ifndef CPL_ODBC_H_INCLUDED
#define CPL_ODBC_H_INCLUDED
 
#include "cpl_port.h"
 
#ifdef _WIN32
#include <windows.h>
#endif
 
#include <sql.h>
#include <sqlext.h>
#include <odbcinst.h>
#include "cpl_string.h"

#ifdef PATH_MAX
#define ODBC_FILENAME_MAX PATH_MAX
#else
#define ODBC_FILENAME_MAX (255 + 1) /* Max path length */
#endif


class CPL_DLL CPLODBCDriverInstaller
{
    char m_szPathOut[ODBC_FILENAME_MAX];
    char m_szError[SQL_MAX_MESSAGE_LENGTH];
    DWORD m_nErrorCode;
    DWORD m_nUsageCount;
 
    static bool FindMdbToolsDriverLib(CPLString &osDriverFile);
    static bool LibraryExists(const char *pszLibPath);
 
  public:
    // Default constructor.
    CPLODBCDriverInstaller();

    int InstallDriver(const char *pszDriver, const char *pszPathIn,
                      WORD fRequest = ODBC_INSTALL_COMPLETE);

    static void InstallMdbToolsDriver();

    int RemoveDriver(const char *pszDriverName, int fRemoveDSN = FALSE);

    int GetUsageCount() const
    {
        return m_nUsageCount;
    }

    const char *GetPathOut() const
    {
        return m_szPathOut;
    }

    const char *GetLastError() const
    {
        return m_szError;
    }

    DWORD GetLastErrorCode() const
    {
        return m_nErrorCode;
    }
};
 
class CPLODBCStatement;
 
/* On MSVC SQLULEN is missing in some cases (i.e. VC6)
** but it is always a #define so test this way.   On Unix
** it is a typedef so we can't always do this.
*/
#if defined(_MSC_VER) && !defined(SQLULEN) && !defined(_WIN64)
#define MISSING_SQLULEN
#endif

#if !defined(MISSING_SQLULEN)
/* ODBC types to support 64 bit compilation */
#define CPL_SQLULEN SQLULEN
#define CPL_SQLLEN SQLLEN
#else
#define CPL_SQLULEN SQLUINTEGER
#define CPL_SQLLEN SQLINTEGER
#endif /* ifdef SQLULEN */

 
class CPL_DLL CPLODBCSession
{
 
    CPL_DISALLOW_COPY_ASSIGN(CPLODBCSession)
 
    
  protected:
    CPLString m_osLastError{};
    HENV m_hEnv = nullptr;
    HDBC m_hDBC = nullptr;
    int m_bInTransaction = false;
    int m_bAutoCommit = true;
 
  public:
    CPLODBCSession();
    ~CPLODBCSession();
 
    int EstablishSession(const char *pszDSN, const char *pszUserid,
                         const char *pszPassword);
    const char *GetLastError();
 
    // Transaction handling
 
    int ClearTransaction();
    int BeginTransaction();
    int CommitTransaction();
    int RollbackTransaction();

    int IsInTransaction()
    {
        return m_bInTransaction;
    }
 
    // Essentially internal.
 
    int CloseSession();
 
    int Failed(int, HSTMT = nullptr);

    HDBC GetConnection()
    {
        return m_hDBC;
    }

    HENV GetEnvironment()
    {
        return m_hEnv;
    }
 
    bool ConnectToMsAccess(const char *pszName,
                           const char *pszDSNStringTemplate);
};

 
class CPL_DLL CPLODBCStatement
{
 
    CPL_DISALLOW_COPY_ASSIGN(CPLODBCStatement)
 
    
  protected:
    int m_nFlags = 0;
 
    CPLODBCSession *m_poSession = nullptr;
    HSTMT m_hStmt = nullptr;
 
    SQLSMALLINT m_nColCount = 0;
    char **m_papszColNames = nullptr;
    SQLSMALLINT *m_panColType = nullptr;
    char **m_papszColTypeNames = nullptr;
    CPL_SQLULEN *m_panColSize = nullptr;
    SQLSMALLINT *m_panColPrecision = nullptr;
    SQLSMALLINT *m_panColNullable = nullptr;
    char **m_papszColColumnDef = nullptr;
 
    char **m_papszColValues = nullptr;
    CPL_SQLLEN *m_panColValueLengths = nullptr;
    double *m_padColValuesAsDouble = nullptr;
 
    int Failed(int);
 
    char *m_pszStatement = nullptr;
    size_t m_nStatementMax = 0;
    size_t m_nStatementLen = 0;
 
  public:
    enum Flag
    {
        RetrieveNumericColumnsAsDouble = 1 << 0,
    };
 
    explicit CPLODBCStatement(CPLODBCSession *, int flags = 0);
    ~CPLODBCStatement();

    HSTMT GetStatement()
    {
        return m_hStmt;
    }

    int Flags() const
    {
        return m_nFlags;
    }
 
    // Command buffer related.
    void Clear();
    void AppendEscaped(const char *);
    void Append(const char *);
    void Append(const std::string &);
    // cppcheck-suppress functionStatic
    void Append(int);
    void Append(double);
    int Appendf(CPL_FORMAT_STRING(const char *), ...)
        CPL_PRINT_FUNC_FORMAT(2, 3);

    const char *GetCommand()
    {
        return m_pszStatement;
    }
 
    int ExecuteSQL(const char * = nullptr);
 
    // Results fetching
    int Fetch(int nOrientation = SQL_FETCH_NEXT, int nOffset = 0);
    void ClearColumnData();
 
    int GetColCount();
    const char *GetColName(int);
    short GetColType(int);
    const char *GetColTypeName(int);
    short GetColSize(int);
    short GetColPrecision(int);
    short GetColNullable(int);
    const char *GetColColumnDef(int);
 
    int GetColId(const char *) const;
    const char *GetColData(int, const char * = nullptr);
    const char *GetColData(const char *, const char * = nullptr);
    int GetColDataLength(int);
 
    double GetColDataAsDouble(int) const;
    double GetColDataAsDouble(const char *) const;
 
    int GetRowCountAffected();
 
    // Fetch special metadata.
    int GetColumns(const char *pszTable, const char *pszCatalog = nullptr,
                   const char *pszSchema = nullptr);
    int GetPrimaryKeys(const char *pszTable, const char *pszCatalog = nullptr,
                       const char *pszSchema = nullptr);
 
    int GetTables(const char *pszCatalog = nullptr,
                  const char *pszSchema = nullptr);
 
    void DumpResult(FILE *fp, int bShowSchema = FALSE);
 
    static CPLString GetTypeName(int);
    static SQLSMALLINT GetTypeMapping(SQLSMALLINT);
 
    int CollectResultsInfo();
};
 
#endif