///////////////////////////////////////////////////////////////////////////////
-// Name: db.cpp
+// Name: src/common/db.cpp
// Purpose: Implementation of the wxDb class. The wxDb class represents a connection
// to an ODBC data source. The wxDb class allows operations on the data
// source such as opening and closing the data source.
// Licence: wxWindows licence
///////////////////////////////////////////////////////////////////////////////
-/*
-// SYNOPSIS START
-// SYNOPSIS STOP
-*/
-
#include "wx/wxprec.h"
#ifdef __BORLANDC__
#pragma hdrstop
#endif
-#ifdef DBDEBUG_CONSOLE
- #include "wx/ioswrap.h"
-#endif
+#if wxUSE_ODBC
#ifndef WX_PRECOMP
- #include "wx/string.h"
#include "wx/object.h"
#include "wx/list.h"
+ #include "wx/string.h"
#include "wx/utils.h"
#include "wx/log.h"
+ #include "wx/app.h"
#endif
+
+#ifdef DBDEBUG_CONSOLE
+ #include "wx/ioswrap.h"
+#endif
+
#include "wx/filefn.h"
#include "wx/wxchar.h"
-#if wxUSE_ODBC
-
#include <stdio.h>
#include <string.h>
#include <assert.h>
#include "wx/db.h"
+// FIXME-UTF8: get rid of this after switching to Unicode-only builds:
+#if wxUSE_UNICODE
+ #define WXSQLCAST(s) ((SQLTCHAR FAR *)(wchar_t*)(s).wchar_str())
+#else
+ #define WXSQLCAST(s) ((SQLTCHAR FAR *)(char*)(s).char_str())
+#endif
+
// DLL options compatibility check:
-#include "wx/app.h"
WX_CHECK_BUILD_OPTIONS("wxODBC")
WXDLLIMPEXP_DATA_ODBC(wxDbList*) PtrBegDbList = 0;
wxChar const *SQL_CATALOG_FILENAME = wxT("catalog.txt");
#ifdef __WXDEBUG__
+ #include "wx/thread.h"
+
extern wxList TablesInUse;
+ extern wxCriticalSection csTablesInUse;
#endif
// SQL Log defaults to be used by GetDbConnection
void wxDbConnectInf::SetDsn(const wxString &dsn)
{
- wxASSERT(dsn.Length() < WXSIZEOF(Dsn));
+ wxASSERT(dsn.length() < WXSIZEOF(Dsn));
wxStrncpy(Dsn, dsn, WXSIZEOF(Dsn)-1);
Dsn[WXSIZEOF(Dsn)-1] = 0; // Prevent buffer overrun
void wxDbConnectInf::SetUserID(const wxString &uid)
{
- wxASSERT(uid.Length() < WXSIZEOF(Uid));
+ wxASSERT(uid.length() < WXSIZEOF(Uid));
wxStrncpy(Uid, uid, WXSIZEOF(Uid)-1);
Uid[WXSIZEOF(Uid)-1] = 0; // Prevent buffer overrun
} // wxDbConnectInf::SetUserID()
void wxDbConnectInf::SetPassword(const wxString &password)
{
- wxASSERT(password.Length() < WXSIZEOF(AuthStr));
+ wxASSERT(password.length() < WXSIZEOF(AuthStr));
wxStrncpy(AuthStr, password, WXSIZEOF(AuthStr)-1);
AuthStr[WXSIZEOF(AuthStr)-1] = 0; // Prevent buffer overrun
void wxDbConnectInf::SetConnectionStr(const wxString &connectStr)
{
- wxASSERT(connectStr.Length() < WXSIZEOF(ConnectionStr));
+ wxASSERT(connectStr.length() < WXSIZEOF(ConnectionStr));
useConnectionStr = wxStrlen(connectStr) > 0;
if ((i_sqlDataType == SQL_VARCHAR)
#if wxUSE_UNICODE
#if defined(SQL_WCHAR)
- || (i_sqlDataType == SQL_WCHAR)
+ || (i_sqlDataType == SQL_WCHAR)
#endif
#if defined(SQL_WVARCHAR)
|| (i_sqlDataType == SQL_WVARCHAR)
// immediately, as the value is not good after
// this function has left scope.
//
-const wxChar *wxDb::convertUserID(const wxChar *userID, wxString &UserID)
+void wxDb::convertUserID(const wxChar *userID, wxString &UserID)
{
if (userID)
{
if ((Dbms() == dbmsORACLE) ||
(Dbms() == dbmsMAXDB))
UserID = UserID.Upper();
-
- return UserID.c_str();
} // wxDb::convertUserID()
// These are the possible SQL types we check for use agains the datasource we are connected
// to for the purpose of determining which data type to use for the MEMO column types
- // (a type which allow to store large strings; like VARCHAR just with a bigger precision)
+ // (a type which allow to store large strings; like VARCHAR just with a bigger precision)
//
// NOTE: The first type in this enumeration that is determined to be supported by the
// datasource/driver is the one that will be used.
bool wxDb::Open(const wxString& inConnectStr, bool failOnDataTypeUnsupported)
{
- wxASSERT(inConnectStr.Length());
+ wxASSERT(inConnectStr.length());
return Open(inConnectStr, NULL, failOnDataTypeUnsupported);
}
bool wxDb::Open(const wxString& inConnectStr, SQLHWND parentWnd, bool failOnDataTypeUnsupported)
{
- dsn = wxT("");
- uid = wxT("");
- authStr = wxT("");
+ dsn = wxEmptyString;
+ uid = wxEmptyString;
+ authStr = wxEmptyString;
RETCODE retcode;
inConnectionStr = inConnectStr;
- retcode = SQLDriverConnect(hdbc, parentWnd, (SQLTCHAR FAR *)inConnectionStr.c_str(),
- (SWORD)inConnectionStr.Length(), (SQLTCHAR FAR *)outConnectBuffer,
- sizeof(outConnectBuffer), &outConnectBufferLen, SQL_DRIVER_COMPLETE );
+ retcode = SQLDriverConnect(hdbc, parentWnd, WXSQLCAST(inConnectionStr),
+ (SWORD)inConnectionStr.length(), (SQLTCHAR FAR *)outConnectBuffer,
+ WXSIZEOF(outConnectBuffer), &outConnectBufferLen, SQL_DRIVER_COMPLETE );
if ((retcode != SQL_SUCCESS) &&
(retcode != SQL_SUCCESS_WITH_INFO))
/********** wxDb::Open() **********/
bool wxDb::Open(const wxString &Dsn, const wxString &Uid, const wxString &AuthStr, bool failOnDataTypeUnsupported)
{
- wxASSERT(Dsn.Length());
+ wxASSERT(!Dsn.empty());
dsn = Dsn;
uid = Uid;
authStr = AuthStr;
- inConnectionStr = wxT("");
- outConnectionStr = wxT("");
+ inConnectionStr = wxEmptyString;
+ outConnectionStr = wxEmptyString;
RETCODE retcode;
}
// Connect to the data source
- retcode = SQLConnect(hdbc, (SQLTCHAR FAR *) dsn.c_str(), SQL_NTS,
- (SQLTCHAR FAR *) uid.c_str(), SQL_NTS,
- (SQLTCHAR FAR *) authStr.c_str(), SQL_NTS);
+ retcode = SQLConnect(hdbc,
+ WXSQLCAST(dsn), SQL_NTS,
+ WXSQLCAST(uid), SQL_NTS,
+ WXSQLCAST(authStr), SQL_NTS);
if ((retcode != SQL_SUCCESS) &&
(retcode != SQL_SUCCESS_WITH_INFO))
// Use the connection string if one is present
if (dbConnectInf->UseConnectionStr())
- return Open(GetConnectionInStr(), failOnDataTypeUnsupported);
+ return Open(dbConnectInf->GetConnectionStr(), failOnDataTypeUnsupported);
else
return Open(dbConnectInf->GetDsn(), dbConnectInf->GetUserID(),
dbConnectInf->GetPassword(), failOnDataTypeUnsupported);
inConnectionStr = copyDb->GetConnectionInStr();
- retcode = SQLDriverConnect(hdbc, NULL, (SQLTCHAR FAR *)inConnectionStr.c_str(),
- (SWORD)inConnectionStr.Length(), (SQLTCHAR FAR *)outConnectBuffer,
- sizeof(outConnectBuffer), &outConnectBufferLen, SQL_DRIVER_COMPLETE);
+ retcode = SQLDriverConnect(hdbc, NULL, WXSQLCAST(inConnectionStr),
+ (SWORD)inConnectionStr.length(), (SQLTCHAR FAR *)outConnectBuffer,
+ WXSIZEOF(outConnectBuffer), &outConnectBufferLen, SQL_DRIVER_COMPLETE);
if ((retcode != SQL_SUCCESS) &&
(retcode != SQL_SUCCESS_WITH_INFO))
else
{
// Connect to the data source
- retcode = SQLConnect(hdbc, (SQLTCHAR FAR *) dsn.c_str(), SQL_NTS,
- (SQLTCHAR FAR *) uid.c_str(), SQL_NTS,
- (SQLTCHAR FAR *) authStr.c_str(), SQL_NTS);
+ retcode = SQLConnect(hdbc,
+ WXSQLCAST(dsn), SQL_NTS,
+ WXSQLCAST(uid), SQL_NTS,
+ WXSQLCAST(authStr), SQL_NTS);
}
if ((retcode != SQL_SUCCESS) &&
wxASSERT(nTables == 0);
#ifdef __WXDEBUG__
- wxTablesInUse *tiu;
- wxList::compatibility_iterator pNode;
- pNode = TablesInUse.GetFirst();
- wxString s,s2;
- while (pNode)
{
- tiu = (wxTablesInUse *)pNode->GetData();
- if (tiu->pDb == this)
+ wxCriticalSectionLocker lock(csTablesInUse);
+ wxTablesInUse *tiu;
+ wxList::compatibility_iterator pNode;
+ pNode = TablesInUse.GetFirst();
+ wxString s,s2;
+ while (pNode)
{
- s.Printf(wxT("(%-20s) tableID:[%6lu] pDb:[%p]"), tiu->tableName,tiu->tableID,tiu->pDb);
- s2.Printf(wxT("Orphaned table found using pDb:[%p]"),this);
- wxLogDebug(s.c_str(),s2.c_str());
+ tiu = (wxTablesInUse *)pNode->GetData();
+ if (tiu->pDb == this)
+ {
+ s.Printf(wxT("(%-20s) tableID:[%6lu] pDb:[%p]"),
+ tiu->tableName, tiu->tableID, wx_static_cast(void*, tiu->pDb));
+ s2.Printf(wxT("Orphaned table found using pDb:[%p]"), wx_static_cast(void*, this));
+ wxLogDebug(s.c_str(),s2.c_str());
+ }
+ pNode = pNode->GetNext();
}
- pNode = pNode->GetNext();
}
#endif
while (SQLError(aHenv, aHdbc, aHstmt, (SQLTCHAR FAR *) sqlState, &nativeError, (SQLTCHAR FAR *) errorMsg, SQL_MAX_MESSAGE_LENGTH - 1, &cbErrorMsg) == SQL_SUCCESS)
{
- odbcErrMsg.Printf(wxT("SQL State = %s\nNative Error Code = %li\nError Message = %s\n"), sqlState, nativeError, errorMsg);
+ odbcErrMsg.Printf(wxT("SQL State = %s\nNative Error Code = %li\nError Message = %s\n"),
+ sqlState, (long)nativeError, errorMsg);
logError(odbcErrMsg, sqlState);
if (!silent)
{
{
wxString odbcErrMsg;
- odbcErrMsg.Printf(wxT("SQL State = %s\nNative Error Code = %li\nError Message = %s\n"), sqlState, nativeError, errorMsg);
+ odbcErrMsg.Printf(wxT("SQL State = %s\nNative Error Code = %li\nError Message = %s\n"),
+ sqlState, (long)nativeError, errorMsg);
logError(odbcErrMsg, sqlState);
if (silent)
/********** wxDb::logError() **********/
void wxDb::logError(const wxString &errMsg, const wxString &SQLState)
{
- wxASSERT(errMsg.Length());
+ wxASSERT(errMsg.length());
static int pLast = -1;
int dbStatus;
wxStrncpy(errorList[pLast], errMsg, DB_MAX_ERROR_MSG_LEN);
errorList[pLast][DB_MAX_ERROR_MSG_LEN] = 0;
- if (SQLState.Length())
+ if (SQLState.length())
if ((dbStatus = TranslateSqlState(SQLState)) != DB_ERR_FUNCTION_SEQUENCE_ERROR)
DB_STATUS = dbStatus;
sqlStmt = wxT("CREATE VIEW ");
sqlStmt += viewName;
- if (colList.Length())
+ if (colList.length())
{
sqlStmt += wxT(" (");
sqlStmt += colList;
cout << endl << sqlStmt.c_str() << endl;
#endif
- if (SQLExecDirect(hstmt, (SQLTCHAR FAR *) sqlStmt.c_str(), SQL_NTS) != SQL_SUCCESS)
+ if (SQLExecDirect(hstmt, WXSQLCAST(sqlStmt), SQL_NTS) != SQL_SUCCESS)
{
// Check for "Base table not found" error and ignore
GetNextError(henv, hdbc, hstmt);
SQLFreeStmt(hstmt, SQL_CLOSE);
- retcode = SQLExecDirect(hstmt, (SQLTCHAR FAR *) pSqlStmt.c_str(), SQL_NTS);
+ retcode = SQLExecDirect(hstmt, WXSQLCAST(pSqlStmt), SQL_NTS);
if (retcode == SQL_SUCCESS ||
(Dbms() == dbmsDB2 && (retcode == SQL_SUCCESS_WITH_INFO || retcode == SQL_NO_DATA_FOUND)))
{
break;
case SQL_LONGVARCHAR:
pColInf[colNum].dbDataType = DB_DATA_TYPE_MEMO;
- break;
+ break;
case SQL_TINYINT:
case SQL_SMALLINT:
case SQL_INTEGER:
retcode = SQLPrimaryKeys(hstmt,
NULL, 0, /* Catalog name */
NULL, 0, /* Schema name */
- (SQLTCHAR FAR *) tableName.c_str(), SQL_NTS); /* Table name */
+ WXSQLCAST(tableName), SQL_NTS); /* Table name */
/*---------------------------------------------------------------------*/
/* Fetch and display the result set. This will be a list of the */
retcode = SQLForeignKeys(hstmt,
NULL, 0, /* Primary catalog */
NULL, 0, /* Primary schema */
- (SQLTCHAR FAR *)tableName.c_str(), SQL_NTS,/* Primary table */
+ WXSQLCAST(tableName), SQL_NTS,/* Primary table */
NULL, 0, /* Foreign catalog */
NULL, 0, /* Foreign schema */
NULL, 0); /* Foreign table */
NULL, 0, /* Primary table */
NULL, 0, /* Foreign catalog */
NULL, 0, /* Foreign schema */
- (SQLTCHAR *)tableName.c_str(), SQL_NTS);/* Foreign table */
+ WXSQLCAST(tableName), SQL_NTS);/* Foreign table */
/*---------------------------------------------------------------------*/
/* Fetch and display the result set. This will be all of the */
{
retcode = SQLColumns(hstmt,
NULL, 0, // All qualifiers
- (SQLTCHAR *) UserID.c_str(), SQL_NTS, // Owner
- (SQLTCHAR *) TableName.c_str(), SQL_NTS,
+ WXSQLCAST(UserID), SQL_NTS, // Owner
+ WXSQLCAST(TableName), SQL_NTS,
NULL, 0); // All columns
}
else
retcode = SQLColumns(hstmt,
NULL, 0, // All qualifiers
NULL, 0, // Owner
- (SQLTCHAR *) TableName.c_str(), SQL_NTS,
+ WXSQLCAST(TableName), SQL_NTS,
NULL, 0); // All columns
}
if (retcode != SQL_SUCCESS)
{
retcode = SQLColumns(hstmt,
NULL, 0, // All qualifiers
- (SQLTCHAR *) UserID.c_str(), SQL_NTS, // Owner
- (SQLTCHAR *) TableName.c_str(), SQL_NTS,
+ WXSQLCAST(UserID), SQL_NTS, // Owner
+ WXSQLCAST(TableName), SQL_NTS,
NULL, 0); // All columns
}
else
retcode = SQLColumns(hstmt,
NULL, 0, // All qualifiers
NULL, 0, // Owner
- (SQLTCHAR *) TableName.c_str(), SQL_NTS,
+ WXSQLCAST(TableName), SQL_NTS,
NULL, 0); // All columns
}
if (retcode != SQL_SUCCESS)
case SQL_CHAR:
colInf[colNo].dbDataType = DB_DATA_TYPE_VARCHAR;
break;
- case SQL_LONGVARCHAR:
+ case SQL_LONGVARCHAR:
colInf[colNo].dbDataType = DB_DATA_TYPE_MEMO;
- break;
+ break;
case SQL_TINYINT:
case SQL_SMALLINT:
case SQL_INTEGER:
{
retcode = SQLColumns(hstmt,
NULL, 0, // All qualifiers
- (SQLTCHAR *) UserID.c_str(), SQL_NTS, // Owner
- (SQLTCHAR *) TableName.c_str(), SQL_NTS,
+ WXSQLCAST(UserID), SQL_NTS, // Owner
+ WXSQLCAST(TableName), SQL_NTS,
NULL, 0); // All columns
}
else
retcode = SQLColumns(hstmt,
NULL, 0, // All qualifiers
NULL, 0, // Owner
- (SQLTCHAR *) TableName.c_str(), SQL_NTS,
+ WXSQLCAST(TableName), SQL_NTS,
NULL, 0); // All columns
}
if (retcode != SQL_SUCCESS)
{
retcode = SQLTables(hstmt,
NULL, 0, // All qualifiers
- (SQLTCHAR *) UserID.c_str(), SQL_NTS, // User specified
+ WXSQLCAST(UserID), SQL_NTS, // User specified
NULL, 0, // All tables
NULL, 0); // All columns
}
* to avoid undesired unbinding of columns.
*/
{
- wxASSERT(fileName.Length());
+ wxASSERT(fileName.length());
RETCODE retcode;
SQLLEN cb;
{
retcode = SQLColumns(hstmt,
NULL, 0, // All qualifiers
- (SQLTCHAR *) UserID.c_str(), SQL_NTS, // User specified
+ WXSQLCAST(UserID), SQL_NTS, // User specified
NULL, 0, // All tables
NULL, 0); // All columns
}
* userID != "" ... UserID set equal to 'userID'
*/
{
- wxASSERT(tableName.Length());
+ wxASSERT(tableName.length());
wxString TableName;
if (Dbms() == dbmsDBASE)
{
wxString dbName;
- if (tablePath.Length())
+ if (tablePath.length())
dbName.Printf(wxT("%s/%s.dbf"), tablePath.c_str(), tableName.c_str());
else
dbName.Printf(wxT("%s.dbf"), tableName.c_str());
{
retcode = SQLTables(hstmt,
NULL, 0, // All qualifiers
- (SQLTCHAR *) UserID.c_str(), SQL_NTS, // Only tables owned by this user
- (SQLTCHAR FAR *)TableName.c_str(), SQL_NTS,
+ WXSQLCAST(UserID), SQL_NTS, // Only tables owned by this user
+ WXSQLCAST(TableName), SQL_NTS,
NULL, 0); // All table types
}
else
retcode = SQLTables(hstmt,
NULL, 0, // All qualifiers
NULL, 0, // All owners
- (SQLTCHAR FAR *)TableName.c_str(), SQL_NTS,
+ WXSQLCAST(TableName), SQL_NTS,
NULL, 0); // All table types
}
if (retcode != SQL_SUCCESS)
bool wxDb::TablePrivileges(const wxString &tableName, const wxString &priv, const wxChar *userID,
const wxChar *schema, const wxString &WXUNUSED(tablePath))
{
- wxASSERT(tableName.Length());
+ wxASSERT(tableName.length());
wxDbTablePrivilegeInfo result;
SQLLEN cbRetVal;
{
retcode = SQLTablePrivileges(hstmt,
NULL, 0, // Catalog
- (SQLTCHAR FAR *)Schema.c_str(), SQL_NTS, // Schema
- (SQLTCHAR FAR *)TableName.c_str(), SQL_NTS);
+ WXSQLCAST(Schema), SQL_NTS, // Schema
+ WXSQLCAST(TableName), SQL_NTS);
}
else
{
retcode = SQLTablePrivileges(hstmt,
NULL, 0, // Catalog
NULL, 0, // Schema
- (SQLTCHAR FAR *)TableName.c_str(), SQL_NTS);
+ WXSQLCAST(TableName), SQL_NTS);
}
#ifdef DBDEBUG_CONSOLE
bool wxDb::SetSqlLogging(wxDbSqlLogState state, const wxString &filename, bool append)
{
wxASSERT(state == sqlLogON || state == sqlLogOFF);
- wxASSERT(state == sqlLogOFF || filename.Length());
+ wxASSERT(state == sqlLogOFF || filename.length());
if (state == sqlLogON)
{
/********** wxDb::WriteSqlLog() **********/
bool wxDb::WriteSqlLog(const wxString &logMsg)
{
- wxASSERT(logMsg.Length());
+ wxASSERT(logMsg.length());
if (fpSqlLog == 0 || sqlLogState == sqlLogOFF)
return false;
int dataType, ULONG columnLength,
const wxString &optionalParam)
{
- wxASSERT(tableName.Length());
- wxASSERT(columnName.Length());
+ wxASSERT(tableName.length());
+ wxASSERT(columnName.length());
wxASSERT((dataType == DB_DATA_TYPE_VARCHAR && columnLength > 0) ||
dataType != DB_DATA_TYPE_VARCHAR);
}
// for passing things like "NOT NULL"
- if (optionalParam.Length())
+ if (optionalParam.length())
{
sqlStmt += wxT(" ");
sqlStmt += optionalParam;
} // wxDb::ModifyColumn()
+/********** wxDb::EscapeSqlChars() **********/
+wxString wxDb::EscapeSqlChars(const wxString& valueOrig)
+{
+ wxString value(valueOrig);
+ switch (Dbms())
+ {
+ case dbmsACCESS:
+ // Access doesn't seem to care about backslashes, so only escape single quotes.
+ value.Replace(wxT("'"), wxT("''"));
+ break;
+
+ default:
+ // All the others are supposed to be the same for now, add special
+ // handling for them if necessary
+ value.Replace(wxT("\\"), wxT("\\\\"));
+ value.Replace(wxT("'"), wxT("\\'"));
+ break;
+ }
+
+ return value;
+} // wxDb::EscapeSqlChars()
+
/********** wxDbGetConnection() **********/
wxDb WXDLLIMPEXP_ODBC *wxDbGetConnection(wxDbConnectInf *pDbConfig, bool FwdOnlyCursors)