forked from OSGeo/gdal
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathcpl_odbc.cpp
2305 lines (1925 loc) · 74.3 KB
/
cpl_odbc.cpp
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/******************************************************************************
*
* Project: OGR ODBC Driver
* Purpose: Declarations for ODBC Access Cover API.
* Author: Frank Warmerdam, [email protected]
*
******************************************************************************
* Copyright (c) 2003, Frank Warmerdam
* Copyright (c) 2008, Even Rouault <even dot rouault at spatialys.com>
*
* Permission is hereby granted, free of charge, to any person obtaining a
* copy of this software and associated documentation files (the "Software"),
* to deal in the Software without restriction, including without limitation
* the rights to use, copy, modify, merge, publish, distribute, sublicense,
* and/or sell copies of the Software, and to permit persons to whom the
* Software is furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included
* in all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
* OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
* THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
* DEALINGS IN THE SOFTWARE.
****************************************************************************/
#include <wchar.h>
#include "cpl_odbc.h"
#include "cpl_vsi.h"
#include "cpl_string.h"
#include "cpl_error.h"
#include <limits>
#include <mutex>
#ifndef SQLColumns_TABLE_CAT
#define SQLColumns_TABLE_CAT 1
#define SQLColumns_TABLE_SCHEM 2
#define SQLColumns_TABLE_NAME 3
#define SQLColumns_COLUMN_NAME 4
#define SQLColumns_DATA_TYPE 5
#define SQLColumns_TYPE_NAME 6
#define SQLColumns_COLUMN_SIZE 7
#define SQLColumns_BUFFER_LENGTH 8
#define SQLColumns_DECIMAL_DIGITS 9
#define SQLColumns_NUM_PREC_RADIX 10
#define SQLColumns_NULLABLE 11
#define SQLColumns_REMARKS 12
#define SQLColumns_COLUMN_DEF 13
#define SQLColumns_SQL_DATA_TYPE 14
#define SQLColumns_SQL_DATETIME_SUB 15
#define SQLColumns_CHAR_OCTET_LENGTH 16
#define SQLColumns_ORDINAL_POSITION 17
#define SQLColumns_IS_NULLABLE 18
#endif // ndef SQLColumns_TABLE_CAT
/************************************************************************/
/* CPLODBCDriverInstaller() */
/************************************************************************/
CPLODBCDriverInstaller::CPLODBCDriverInstaller()
: m_nErrorCode(0), m_nUsageCount(0)
{
memset(m_szPathOut, '\0', ODBC_FILENAME_MAX);
memset(m_szError, '\0', SQL_MAX_MESSAGE_LENGTH);
}
/************************************************************************/
/* InstallDriver() */
/************************************************************************/
int CPLODBCDriverInstaller::InstallDriver(const char *pszDriver,
CPL_UNUSED const char *pszPathIn,
WORD fRequest)
{
CPLAssert(nullptr != pszDriver);
// Try to install driver to system-wide location.
if (FALSE == SQLInstallDriverEx(pszDriver, nullptr, m_szPathOut,
ODBC_FILENAME_MAX, nullptr, fRequest,
&m_nUsageCount))
{
const WORD nErrorNum = 1; // TODO - a function param?
// Failure is likely related to no write permissions to
// system-wide default location, so try to install to HOME.
static char *pszEnvIni = nullptr;
// Read HOME location.
const char *pszEnvHome = getenv("HOME");
CPLAssert(nullptr != pszEnvHome);
CPLDebug("ODBC", "HOME=%s", pszEnvHome);
const char *pszEnvOdbcSysIni = nullptr;
if (pszEnvIni == nullptr)
{
// record previous value, so we can rollback on failure
pszEnvOdbcSysIni = getenv("ODBCSYSINI");
// Set ODBCSYSINI variable pointing to HOME location.
const size_t nLen = strlen(pszEnvHome) + 12;
pszEnvIni = static_cast<char *>(CPLMalloc(nLen));
snprintf(pszEnvIni, nLen, "ODBCSYSINI=%s", pszEnvHome);
// A 'man putenv' shows that we cannot free pszEnvIni
// because the pointer is used directly by putenv in old glibc.
// coverity[tainted_string]
putenv(pszEnvIni);
CPLDebug("ODBC", "%s", pszEnvIni);
}
// Try to install ODBC driver in new location.
if (FALSE == SQLInstallDriverEx(pszDriver, pszEnvHome, m_szPathOut,
ODBC_FILENAME_MAX, nullptr, fRequest,
&m_nUsageCount))
{
// if installing the driver fails, we need to roll back the changes
// to ODBCSYSINI environment variable or all subsequent use of ODBC
// calls will fail
char *pszEnvRollback = nullptr;
if (pszEnvOdbcSysIni)
{
const size_t nLen = strlen(pszEnvOdbcSysIni) + 12;
pszEnvRollback = static_cast<char *>(CPLMalloc(nLen));
snprintf(pszEnvRollback, nLen, "ODBCSYSINI=%s",
pszEnvOdbcSysIni);
}
else
{
// ODBCSYSINI not previously set, so remove
#ifdef _MSC_VER
// for MSVC an environment variable is removed by setting to
// empty string
// https://docs.microsoft.com/en-us/cpp/c-runtime-library/reference/putenv-wputenv?view=vs-2019
pszEnvRollback = CPLStrdup("ODBCSYSINI=");
#else
// for gnuc an environment variable is removed by not including
// the equal sign
// https://man7.org/linux/man-pages/man3/putenv.3.html
pszEnvRollback = CPLStrdup("ODBCSYSINI");
#endif
}
// A 'man putenv' shows that we cannot free pszEnvRollback
// because the pointer is used directly by putenv in old glibc.
// coverity[tainted_string]
putenv(pszEnvRollback);
CPL_UNUSED RETCODE cRet =
SQLInstallerError(nErrorNum, &m_nErrorCode, m_szError,
SQL_MAX_MESSAGE_LENGTH, nullptr);
(void)cRet;
CPLAssert(SQL_SUCCESS == cRet || SQL_SUCCESS_WITH_INFO == cRet);
// FAIL
return FALSE;
}
}
// SUCCESS
return TRUE;
}
/************************************************************************/
/* FindMdbToolsDriverLib() */
/************************************************************************/
bool CPLODBCDriverInstaller::FindMdbToolsDriverLib(CPLString &osDriverFile)
{
const char *pszDrvCfg = CPLGetConfigOption("MDBDRIVER_PATH", nullptr);
if (nullptr != pszDrvCfg)
{
// Directory or file path
CPLString strLibPath(pszDrvCfg);
VSIStatBuf sStatBuf;
if (VSIStat(pszDrvCfg, &sStatBuf) == 0 && VSI_ISDIR(sStatBuf.st_mode))
{
// Find default library in custom directory
const char *pszDriverFile =
CPLFormFilename(pszDrvCfg, "libmdbodbc.so", nullptr);
CPLAssert(nullptr != pszDriverFile);
strLibPath = pszDriverFile;
}
if (LibraryExists(strLibPath.c_str()))
{
// Save custom driver path
osDriverFile = strLibPath;
return true;
}
}
// Check if we have a declaration of the driver in /etc/odbcinst.ini
GByte *pabyRet = nullptr;
CPL_IGNORE_RET_VAL(VSIIngestFile(nullptr, "/etc/odbcinst.ini", &pabyRet,
nullptr, 100 * 1000));
if (pabyRet)
{
const bool bFound = strstr(reinterpret_cast<const char *>(pabyRet),
"Microsoft Access Driver") != nullptr;
CPLFree(pabyRet);
if (bFound)
{
CPLDebug("ODBC", "Declaration of Microsoft Access Driver found in "
"/etc/odbcinst.ini");
return false;
}
}
// Default name and path of driver library
const char *const apszLibNames[] = {
"libmdbodbc.so", "libmdbodbc.so.0" /* for Ubuntu 8.04 support */
};
const char *const apzPaths[] = {
"/usr/lib/x86_64-linux-gnu/odbc", /* ubuntu 20.04 */
"/usr/lib64",
"/usr/lib64/odbc", /* fedora */
"/usr/local/lib64",
"/usr/lib",
"/usr/local/lib"};
// Try to find library in default paths
for (const char *pszPath : apzPaths)
{
for (const char *pszLibName : apszLibNames)
{
const char *pszDriverFile =
CPLFormFilename(pszPath, pszLibName, nullptr);
CPLAssert(nullptr != pszDriverFile);
if (LibraryExists(pszDriverFile))
{
// Save default driver path
osDriverFile = pszDriverFile;
return true;
}
}
}
CPLError(CE_Failure, CPLE_AppDefined,
"ODBC: MDB Tools driver not found!\n");
// Driver not found!
return false;
}
/************************************************************************/
/* LibraryExists() */
/************************************************************************/
bool CPLODBCDriverInstaller::LibraryExists(const char *pszLibPath)
{
CPLAssert(nullptr != pszLibPath);
VSIStatBuf stb;
if (0 == VSIStat(pszLibPath, &stb))
{
if (VSI_ISREG(stb.st_mode) || VSI_ISLNK(stb.st_mode))
{
return true;
}
}
return false;
}
/************************************************************************/
/* InstallMdbToolsDriver() */
/************************************************************************/
void CPLODBCDriverInstaller::InstallMdbToolsDriver()
{
#ifdef WIN32
return;
#else
static std::once_flag oofDriverInstallAttempted;
std::call_once(
oofDriverInstallAttempted,
[=]
{
//
// ODBCINST.INI NOTE:
// This operation requires write access to odbcinst.ini file
// located in directory pointed by ODBCINISYS variable.
// Usually, it points to /etc, so non-root users can overwrite this
// setting ODBCINISYS with location they have write access to, e.g.:
// $ export ODBCINISYS=$HOME/etc
// $ touch $ODBCINISYS/odbcinst.ini
//
// See: http://www.unixodbc.org/internals.html
//
CPLString osDriverFile;
if (FindMdbToolsDriverLib(osDriverFile))
{
CPLAssert(!osDriverFile.empty());
CPLDebug("ODBC", "MDB Tools driver: %s", osDriverFile.c_str());
std::string driver("Microsoft Access Driver (*.mdb)");
driver += '\0';
driver += "Driver=";
driver += osDriverFile; // Found by FindDriverLib()
driver += '\0';
driver += "FileUsage=1";
driver += '\0';
driver += '\0';
// Rregister driver
CPLODBCDriverInstaller dri;
if (!dri.InstallDriver(driver.c_str(), nullptr,
ODBC_INSTALL_COMPLETE))
{
// Report ODBC error
CPLError(CE_Failure, CPLE_AppDefined,
"ODBC: Unable to install MDB driver for ODBC, MDB "
"access may not supported: %s",
dri.GetLastError());
}
else
CPLDebug("ODBC",
"MDB Tools driver installed successfully!");
}
});
#endif
}
/************************************************************************/
/* RemoveDriver() */
/************************************************************************/
int CPLODBCDriverInstaller::RemoveDriver(const char *pszDriverName,
int fRemoveDSN)
{
CPLAssert(nullptr != pszDriverName);
if (FALSE == SQLRemoveDriver(pszDriverName, fRemoveDSN, &m_nUsageCount))
{
const WORD nErrorNum = 1; // TODO - a function param?
// Retrieve error code and message.
SQLInstallerError(nErrorNum, &m_nErrorCode, m_szError,
SQL_MAX_MESSAGE_LENGTH, nullptr);
return FALSE;
}
// SUCCESS
return TRUE;
}
/************************************************************************/
/* CPLODBCSession() */
/************************************************************************/
/** Constructor */
CPLODBCSession::CPLODBCSession()
{
}
/************************************************************************/
/* ~CPLODBCSession() */
/************************************************************************/
/** Destructor */
CPLODBCSession::~CPLODBCSession()
{
CloseSession();
}
/************************************************************************/
/* CloseSession() */
/************************************************************************/
/** Close session */
int CPLODBCSession::CloseSession()
{
if (m_hDBC != nullptr)
{
if (IsInTransaction())
CPLError(CE_Warning, CPLE_AppDefined,
"Closing session with active transactions.");
CPLDebug("ODBC", "SQLDisconnect()");
SQLDisconnect(m_hDBC);
SQLFreeConnect(m_hDBC);
m_hDBC = nullptr;
}
if (m_hEnv != nullptr)
{
SQLFreeEnv(m_hEnv);
m_hEnv = nullptr;
}
return TRUE;
}
/************************************************************************/
/* ClearTransaction() */
/************************************************************************/
/** Clear transaction */
int CPLODBCSession::ClearTransaction()
{
#if (ODBCVER >= 0x0300)
if (m_bAutoCommit)
return TRUE;
SQLUINTEGER bAutoCommit;
// See if we already in manual commit mode.
if (Failed(SQLGetConnectAttr(m_hDBC, SQL_ATTR_AUTOCOMMIT, &bAutoCommit,
sizeof(SQLUINTEGER), nullptr)))
return FALSE;
if (bAutoCommit == SQL_AUTOCOMMIT_OFF)
{
// Switch the connection to auto commit mode (default).
if (Failed(SQLSetConnectAttr(
m_hDBC, SQL_ATTR_AUTOCOMMIT,
reinterpret_cast<SQLPOINTER>(SQL_AUTOCOMMIT_ON), 0)))
return FALSE;
}
m_bInTransaction = FALSE;
m_bAutoCommit = TRUE;
#endif
return TRUE;
}
/************************************************************************/
/* CommitTransaction() */
/************************************************************************/
/** Begin transaction */
int CPLODBCSession::BeginTransaction()
{
#if (ODBCVER >= 0x0300)
SQLUINTEGER bAutoCommit;
// See if we already in manual commit mode.
if (Failed(SQLGetConnectAttr(m_hDBC, SQL_ATTR_AUTOCOMMIT, &bAutoCommit,
sizeof(SQLUINTEGER), nullptr)))
return FALSE;
if (bAutoCommit == SQL_AUTOCOMMIT_ON)
{
// Switch the connection to manual commit mode.
#ifdef HAVE_GCC_WARNING_ZERO_AS_NULL_POINTER_CONSTANT
#pragma GCC diagnostic push
#pragma GCC diagnostic ignored "-Wzero-as-null-pointer-constant"
#endif
if (Failed(SQLSetConnectAttr(
m_hDBC, SQL_ATTR_AUTOCOMMIT,
reinterpret_cast<SQLPOINTER>(SQL_AUTOCOMMIT_OFF), 0)))
return FALSE;
#ifdef HAVE_GCC_WARNING_ZERO_AS_NULL_POINTER_CONSTANT
#pragma GCC diagnostic pop
#endif
}
m_bInTransaction = TRUE;
m_bAutoCommit = FALSE;
#endif
return TRUE;
}
/************************************************************************/
/* CommitTransaction() */
/************************************************************************/
/** Commit transaction */
int CPLODBCSession::CommitTransaction()
{
#if (ODBCVER >= 0x0300)
if (m_bInTransaction)
{
if (Failed(SQLEndTran(SQL_HANDLE_DBC, m_hDBC, SQL_COMMIT)))
{
return FALSE;
}
m_bInTransaction = FALSE;
}
#endif
return TRUE;
}
/************************************************************************/
/* RollbackTransaction() */
/************************************************************************/
/** Rollback transaction */
int CPLODBCSession::RollbackTransaction()
{
#if (ODBCVER >= 0x0300)
if (m_bInTransaction)
{
// Rollback should not hide the previous error so Failed() is not
// called.
int nRetCode = SQLEndTran(SQL_HANDLE_DBC, m_hDBC, SQL_ROLLBACK);
m_bInTransaction = FALSE;
return (nRetCode == SQL_SUCCESS || nRetCode == SQL_SUCCESS_WITH_INFO);
}
#endif
return TRUE;
}
/************************************************************************/
/* Failed() */
/************************************************************************/
/** Test if a return code indicates failure, return TRUE if that
* is the case. Also update error text.
*
* ODBC error messages are reported in the following format:
* [SQLState]ErrorMessage(NativeErrorCode)
*
* Multiple error messages are delimited by ",".
*/
int CPLODBCSession::Failed(int nRetCode, HSTMT hStmt)
{
m_osLastError.clear();
if (nRetCode == SQL_SUCCESS || nRetCode == SQL_SUCCESS_WITH_INFO)
return FALSE;
SQLRETURN nDiagRetCode = SQL_SUCCESS;
for (SQLSMALLINT nRecNum = 1; nDiagRetCode == SQL_SUCCESS; ++nRecNum)
{
SQLCHAR achSQLState[5 + 1] = {};
SQLCHAR *pachCurErrMsg = static_cast<SQLCHAR *>(
CPLMalloc((SQL_MAX_MESSAGE_LENGTH + 1) * sizeof(SQLCHAR)));
SQLSMALLINT nTextLength = 0;
SQLINTEGER nNativeError = 0;
nDiagRetCode = SQLGetDiagRec(SQL_HANDLE_STMT, hStmt, nRecNum,
achSQLState, &nNativeError,
reinterpret_cast<SQLCHAR *>(pachCurErrMsg),
SQL_MAX_MESSAGE_LENGTH, &nTextLength);
if (nDiagRetCode == SQL_SUCCESS ||
nDiagRetCode == SQL_SUCCESS_WITH_INFO)
{
if (nTextLength >= SQL_MAX_MESSAGE_LENGTH)
{
// the buffer wasn't enough, retry
SQLSMALLINT nTextLength2 = 0;
pachCurErrMsg = static_cast<SQLCHAR *>(CPLRealloc(
pachCurErrMsg, (nTextLength + 1) * sizeof(SQLCHAR)));
nDiagRetCode = SQLGetDiagRec(
SQL_HANDLE_STMT, hStmt, nRecNum, achSQLState, &nNativeError,
reinterpret_cast<SQLCHAR *>(pachCurErrMsg), nTextLength,
&nTextLength2);
}
pachCurErrMsg[nTextLength] = '\0';
m_osLastError += CPLString().Printf(
"%s[%5s]%s(" CPL_FRMT_GIB ")",
(m_osLastError.empty() ? "" : ", "), achSQLState, pachCurErrMsg,
static_cast<GIntBig>(nNativeError));
}
CPLFree(pachCurErrMsg);
}
if (nRetCode == SQL_ERROR && m_bInTransaction)
RollbackTransaction();
return TRUE;
}
/************************************************************************/
/* ConnectToMsAccess() */
/************************************************************************/
/**
* Connects to a Microsoft Access database.
*
* @param pszName The file name of the Access database to connect to. This is
* not optional.
*
* @param pszDSNStringTemplate optional DSN string template for Microsoft Access
* ODBC Driver. If not specified, then a set of known driver templates will
* be used automatically as a fallback. If specified, it is the caller's
* responsibility to ensure that the template is correctly formatted.
*
* @return TRUE on success or FALSE on failure. Errors will automatically be
* reported via CPLError.
*
* @since GDAL 3.2
*/
bool CPLODBCSession::ConnectToMsAccess(const char *pszName,
const char *pszDSNStringTemplate)
{
const auto Connect =
[this, &pszName](const char *l_pszDSNStringTemplate, bool bVerboseError)
{
char *pszDSN = static_cast<char *>(
CPLMalloc(strlen(pszName) + strlen(l_pszDSNStringTemplate) + 100));
/* coverity[tainted_string] */
snprintf(pszDSN, strlen(pszName) + strlen(l_pszDSNStringTemplate) + 100,
l_pszDSNStringTemplate, pszName);
CPLDebug("ODBC", "EstablishSession(%s)", pszDSN);
int bError = !EstablishSession(pszDSN, nullptr, nullptr);
if (bError)
{
if (bVerboseError)
{
CPLError(CE_Failure, CPLE_AppDefined,
"Unable to initialize ODBC connection to DSN for %s,\n"
"%s",
pszDSN, GetLastError());
}
CPLFree(pszDSN);
return false;
}
CPLFree(pszDSN);
return true;
};
if (pszDSNStringTemplate)
{
return Connect(pszDSNStringTemplate, true);
}
for (const char *l_pszDSNStringTemplate :
{"DRIVER=Microsoft Access Driver (*.mdb, *.accdb);DBQ=%s",
"DRIVER=Microsoft Access Driver (*.mdb, *.accdb);DBQ=\"%s\"",
"DRIVER=Microsoft Access Driver (*.mdb);DBQ=%s",
"DRIVER=Microsoft Access Driver (*.mdb);DBQ=\"%s\""})
{
if (Connect(l_pszDSNStringTemplate, false))
return true;
}
CPLError(CE_Failure, CPLE_AppDefined,
"Unable to initialize ODBC connection to DSN for %s,\n"
"%s",
pszName, GetLastError());
return false;
}
/************************************************************************/
/* EstablishSession() */
/************************************************************************/
/**
* Connect to database and logon.
*
* @param pszDSN The name of the DSN being used to connect. This is not
* optional.
*
* @param pszUserid the userid to logon as, may be NULL if not not required,
* or provided by the DSN.
*
* @param pszPassword the password to logon with. May be NULL if not required
* or provided by the DSN.
*
* @return TRUE on success or FALSE on failure. Call GetLastError() to get
* details on failure.
*/
int CPLODBCSession::EstablishSession(const char *pszDSN, const char *pszUserid,
const char *pszPassword)
{
CloseSession();
if (Failed(SQLAllocEnv(&m_hEnv)))
return FALSE;
if (Failed(SQLAllocConnect(m_hEnv, &m_hDBC)))
{
CloseSession();
return FALSE;
}
#ifdef _MSC_VER
#pragma warning(push)
// warning C4996: 'SQLSetConnectOption': ODBC API: SQLSetConnectOption is
// deprecated. Please use SQLSetConnectAttr instead
#pragma warning(disable : 4996)
#endif
SQLSetConnectOption(m_hDBC, SQL_LOGIN_TIMEOUT, 30);
#ifdef _MSC_VER
#pragma warning(pop)
#endif
if (pszUserid == nullptr)
pszUserid = "";
if (pszPassword == nullptr)
pszPassword = "";
bool bFailed = false;
if (strstr(pszDSN, "=") != nullptr)
{
CPLDebug("ODBC", "SQLDriverConnect(%s)", pszDSN);
SQLCHAR szOutConnString[1024] = {};
SQLSMALLINT nOutConnStringLen = 0;
bFailed = CPL_TO_BOOL(Failed(SQLDriverConnect(
m_hDBC, nullptr,
reinterpret_cast<SQLCHAR *>(const_cast<char *>(pszDSN)),
static_cast<SQLSMALLINT>(strlen(pszDSN)), szOutConnString,
sizeof(szOutConnString), &nOutConnStringLen, SQL_DRIVER_NOPROMPT)));
}
else
{
CPLDebug("ODBC", "SQLConnect(%s)", pszDSN);
bFailed = CPL_TO_BOOL(Failed(SQLConnect(
m_hDBC, reinterpret_cast<SQLCHAR *>(const_cast<char *>(pszDSN)),
SQL_NTS, reinterpret_cast<SQLCHAR *>(const_cast<char *>(pszUserid)),
SQL_NTS,
reinterpret_cast<SQLCHAR *>(const_cast<char *>(pszPassword)),
SQL_NTS)));
}
if (bFailed)
{
CPLDebug("ODBC", "... failed: %s", GetLastError());
CloseSession();
return FALSE;
}
return TRUE;
}
/************************************************************************/
/* GetLastError() */
/************************************************************************/
/**
* Returns the last ODBC error message.
*
* @return pointer to an internal buffer with the error message in it.
* Do not free or alter. Will be an empty (but not NULL) string if there is
* no pending error info.
*/
const char *CPLODBCSession::GetLastError()
{
return m_osLastError.c_str();
}
/************************************************************************/
/* ==================================================================== */
/* CPLODBCStatement */
/* ==================================================================== */
/************************************************************************/
/************************************************************************/
/* CPLODBCStatement() */
/************************************************************************/
/**
* Constructor.
*
* The optional flags argument can be used to specify flags which control
* the behavior of the statement.
*/
CPLODBCStatement::CPLODBCStatement(CPLODBCSession *poSession, const int flags)
: m_nFlags(flags), m_poSession(poSession)
{
if (Failed(SQLAllocStmt(poSession->GetConnection(), &m_hStmt)))
{
m_hStmt = nullptr;
}
}
/************************************************************************/
/* ~CPLODBCStatement() */
/************************************************************************/
/** Destructor */
CPLODBCStatement::~CPLODBCStatement()
{
Clear();
if (m_hStmt != nullptr)
SQLFreeStmt(m_hStmt, SQL_DROP);
}
/************************************************************************/
/* ExecuteSQL() */
/************************************************************************/
/**
* Execute an SQL statement.
*
* This method will execute the passed (or stored) SQL statement,
* and initialize information about the resultset if there is one.
* If a NULL statement is passed, the internal stored statement that
* has been previously set via Append() or Appendf() calls will be used.
*
* @param pszStatement the SQL statement to execute, or NULL if the
* internally saved one should be used.
*
* @return TRUE on success or FALSE if there is an error. Error details
* can be fetched with OGRODBCSession::GetLastError().
*/
int CPLODBCStatement::ExecuteSQL(const char *pszStatement)
{
if (m_poSession == nullptr || m_hStmt == nullptr)
{
// We should post an error.
return FALSE;
}
if (pszStatement != nullptr)
{
Clear();
Append(pszStatement);
}
#if (ODBCVER >= 0x0300)
if (!m_poSession->IsInTransaction())
{
// Commit pending transactions and set to autocommit mode.
m_poSession->ClearTransaction();
}
#endif
// SQL_NTS=-3 is a valid value for SQLExecDirect.
// coverity[negative_returns]
if (Failed(SQLExecDirect(
m_hStmt, reinterpret_cast<SQLCHAR *>(m_pszStatement), SQL_NTS)))
return FALSE;
return CollectResultsInfo();
}
/************************************************************************/
/* CollectResultsInfo() */
/************************************************************************/
/** CollectResultsInfo */
int CPLODBCStatement::CollectResultsInfo()
{
if (m_poSession == nullptr || m_hStmt == nullptr)
{
// We should post an error.
return FALSE;
}
if (Failed(SQLNumResultCols(m_hStmt, &m_nColCount)))
return FALSE;
/* -------------------------------------------------------------------- */
/* Allocate per column information. */
/* -------------------------------------------------------------------- */
m_papszColNames =
static_cast<char **>(CPLCalloc(sizeof(char *), m_nColCount + 1));
m_papszColValues =
static_cast<char **>(CPLCalloc(sizeof(char *), m_nColCount + 1));
m_panColValueLengths = static_cast<CPL_SQLLEN *>(
CPLCalloc(sizeof(CPL_SQLLEN), m_nColCount + 1));
if (m_nFlags & Flag::RetrieveNumericColumnsAsDouble)
{
m_padColValuesAsDouble =
static_cast<double *>(CPLCalloc(sizeof(double), m_nColCount + 1));
}
else
{
m_padColValuesAsDouble = nullptr;
}
m_panColType =
static_cast<SQLSMALLINT *>(CPLCalloc(sizeof(SQLSMALLINT), m_nColCount));
m_papszColTypeNames =
static_cast<char **>(CPLCalloc(sizeof(char *), m_nColCount + 1));
m_panColSize =
static_cast<CPL_SQLULEN *>(CPLCalloc(sizeof(CPL_SQLULEN), m_nColCount));
m_panColPrecision =
static_cast<SQLSMALLINT *>(CPLCalloc(sizeof(SQLSMALLINT), m_nColCount));
m_panColNullable =
static_cast<SQLSMALLINT *>(CPLCalloc(sizeof(SQLSMALLINT), m_nColCount));
m_papszColColumnDef =
static_cast<char **>(CPLCalloc(sizeof(char *), m_nColCount + 1));
/* -------------------------------------------------------------------- */
/* Fetch column descriptions. */
/* -------------------------------------------------------------------- */
for (SQLUSMALLINT iCol = 0; iCol < m_nColCount; iCol++)
{
SQLCHAR szName[256] = {};
SQLSMALLINT nNameLength = 0;
if (Failed(SQLDescribeCol(m_hStmt, iCol + 1, szName, sizeof(szName),
&nNameLength, m_panColType + iCol,
m_panColSize + iCol, m_panColPrecision + iCol,
m_panColNullable + iCol)))
return FALSE;
szName[nNameLength] = '\0'; // Paranoid; the string should be
// null-terminated by the driver.
m_papszColNames[iCol] = CPLStrdup(reinterpret_cast<char *>(szName));
// SQLDescribeCol() fetches just a subset of column attributes.
// In addition to above data we need data type name.
if (Failed(SQLColAttribute(m_hStmt, iCol + 1, SQL_DESC_TYPE_NAME,
szName, sizeof(szName), &nNameLength,
nullptr)))
return FALSE;
szName[nNameLength] = '\0'; // Paranoid.
m_papszColTypeNames[iCol] = CPLStrdup(reinterpret_cast<char *>(szName));
#if DEBUG_VERBOSE
CPLDebug("ODBC", "%s %s %d", m_papszColNames[iCol], szName,
m_panColType[iCol]);
#endif
}
return TRUE;
}
/************************************************************************/
/* GetRowCountAffected() */
/************************************************************************/
/** GetRowCountAffected */
int CPLODBCStatement::GetRowCountAffected()
{
SQLLEN nResultCount = 0;
SQLRowCount(m_hStmt, &nResultCount);
return static_cast<int>(nResultCount);
}
/************************************************************************/
/* GetColCount() */
/************************************************************************/
/**
* Fetch the resultset column count.
*
* @return the column count, or zero if there is no resultset.
*/
int CPLODBCStatement::GetColCount()
{
return m_nColCount;
}
/************************************************************************/
/* GetColName() */
/************************************************************************/
/**
* Fetch a column name.
*
* @param iCol the zero based column index.
*
* @return NULL on failure (out of bounds column), or a pointer to an
* internal copy of the column name.
*/
const char *CPLODBCStatement::GetColName(int iCol)
{
if (iCol < 0 || iCol >= m_nColCount)
return nullptr;
return m_papszColNames[iCol];
}
/************************************************************************/
/* GetColType() */
/************************************************************************/
/**
* Fetch a column data type.