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
|
/**
* Licensed to the University Corporation for Advanced Internet
* Development, Inc. (UCAID) under one or more contributor license
* agreements. See the NOTICE file distributed with this work for
* additional information regarding copyright ownership.
*
* UCAID licenses this file to you under the Apache License,
* Version 2.0 (the "License"); you may not use this file except
* in compliance with the License. You may obtain a copy of the
* License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
* either express or implied. See the License for the specific
* language governing permissions and limitations under the License.
*/
/**
* odbc-store.cpp
*
* Storage Service using ODBC.
*/
#if defined (_MSC_VER) || defined(__BORLANDC__)
# include "config_win32.h"
#else
# include "config.h"
#endif
#ifdef WIN32
# define _CRT_NONSTDC_NO_DEPRECATE 1
# define _CRT_SECURE_NO_DEPRECATE 1
#endif
#ifdef WIN32
# define ODBCSTORE_EXPORTS __declspec(dllexport)
#else
# define ODBCSTORE_EXPORTS
#endif
#include <xmltooling/logging.h>
#include <xmltooling/unicode.h>
#include <xmltooling/XMLToolingConfig.h>
#include <xmltooling/util/NDC.h>
#include <xmltooling/util/StorageService.h>
#include <xmltooling/util/Threads.h>
#include <xmltooling/util/XMLHelper.h>
#include <xercesc/util/XMLUniDefs.hpp>
#include <sql.h>
#include <sqlext.h>
#include <boost/lexical_cast.hpp>
#include <boost/algorithm/string.hpp>
using namespace xmltooling::logging;
using namespace xmltooling;
using namespace xercesc;
using namespace boost;
using namespace std;
#define PLUGIN_VER_MAJOR 1
#define PLUGIN_VER_MINOR 1
#define LONGDATA_BUFLEN 16384
#define COLSIZE_CONTEXT 255
#define COLSIZE_ID 255
#define COLSIZE_STRING_VALUE 255
#define STRING_TABLE "strings"
#define TEXT_TABLE "texts"
/* table definitions
CREATE TABLE version (
major int NOT nullptr,
minor int NOT nullptr
)
CREATE TABLE strings (
context varchar(255) not null,
id varchar(255) not null,
expires datetime not null,
version int not null,
value varchar(255) not null,
PRIMARY KEY (context, id)
)
CREATE TABLE texts (
context varchar(255) not null,
id varchar(255) not null,
expires datetime not null,
version int not null,
value text not null,
PRIMARY KEY (context, id)
)
*/
namespace {
static const XMLCh cleanupInterval[] = UNICODE_LITERAL_15(c,l,e,a,n,u,p,I,n,t,e,r,v,a,l);
static const XMLCh isolationLevel[] = UNICODE_LITERAL_14(i,s,o,l,a,t,i,o,n,L,e,v,e,l);
static const XMLCh ConnectionString[] = UNICODE_LITERAL_16(C,o,n,n,e,c,t,i,o,n,S,t,r,i,n,g);
static const XMLCh RetryOnError[] = UNICODE_LITERAL_12(R,e,t,r,y,O,n,E,r,r,o,r);
static const XMLCh contextSize[] = UNICODE_LITERAL_11(c,o,n,t,e,x,t,S,i,z,e);
static const XMLCh keySize[] = UNICODE_LITERAL_7(k,e,y,S,i,z,e);
static const XMLCh stringSize[] = UNICODE_LITERAL_10(s,t,r,i,n,g,S,i,z,e);
// RAII for ODBC handles
struct ODBCConn {
ODBCConn(SQLHDBC conn) : handle(conn), autoCommit(true) {}
~ODBCConn() {
if (handle != SQL_NULL_HDBC) {
SQLRETURN sr = SQL_SUCCESS;
if (!autoCommit)
sr = SQLSetConnectAttr(handle, SQL_ATTR_AUTOCOMMIT, (SQLPOINTER)SQL_AUTOCOMMIT_ON, 0);
SQLDisconnect(handle);
SQLFreeHandle(SQL_HANDLE_DBC, handle);
if (!SQL_SUCCEEDED(sr))
throw IOException("Failed to commit connection and return to auto-commit mode.");
}
}
operator SQLHDBC() {return handle;}
SQLHDBC handle;
bool autoCommit;
};
class ODBCStorageService : public StorageService
{
public:
ODBCStorageService(const DOMElement* e);
virtual ~ODBCStorageService();
const Capabilities& getCapabilities() const {
return m_caps;
}
bool createString(const char* context, const char* key, const char* value, time_t expiration) {
return createRow(STRING_TABLE, context, key, value, expiration);
}
int readString(const char* context, const char* key, string* pvalue=nullptr, time_t* pexpiration=nullptr, int version=0) {
return readRow(STRING_TABLE, context, key, pvalue, pexpiration, version);
}
int updateString(const char* context, const char* key, const char* value=nullptr, time_t expiration=0, int version=0) {
return updateRow(STRING_TABLE, context, key, value, expiration, version);
}
bool deleteString(const char* context, const char* key) {
return deleteRow(STRING_TABLE, context, key);
}
bool createText(const char* context, const char* key, const char* value, time_t expiration) {
return createRow(TEXT_TABLE, context, key, value, expiration);
}
int readText(const char* context, const char* key, string* pvalue=nullptr, time_t* pexpiration=nullptr, int version=0) {
return readRow(TEXT_TABLE, context, key, pvalue, pexpiration, version);
}
int updateText(const char* context, const char* key, const char* value=nullptr, time_t expiration=0, int version=0) {
return updateRow(TEXT_TABLE, context, key, value, expiration, version);
}
bool deleteText(const char* context, const char* key) {
return deleteRow(TEXT_TABLE, context, key);
}
void reap(const char* context) {
reap(STRING_TABLE, context);
reap(TEXT_TABLE, context);
}
void updateContext(const char* context, time_t expiration) {
updateContext(STRING_TABLE, context, expiration);
updateContext(TEXT_TABLE, context, expiration);
}
void deleteContext(const char* context) {
deleteContext(STRING_TABLE, context);
deleteContext(TEXT_TABLE, context);
}
private:
bool createRow(const char *table, const char* context, const char* key, const char* value, time_t expiration);
int readRow(const char *table, const char* context, const char* key, string* pvalue, time_t* pexpiration, int version);
int updateRow(const char *table, const char* context, const char* key, const char* value, time_t expiration, int version);
bool deleteRow(const char *table, const char* context, const char* key);
void reap(const char* table, const char* context);
void updateContext(const char* table, const char* context, time_t expiration);
void deleteContext(const char* table, const char* context);
SQLHDBC getHDBC();
SQLHSTMT getHSTMT(SQLHDBC);
pair<SQLINTEGER,SQLINTEGER> getVersion(SQLHDBC);
pair<bool,bool> log_error(SQLHANDLE handle, SQLSMALLINT htype, const char* checkfor=nullptr);
static void* cleanup_fn(void*);
void cleanup();
Category& m_log;
Capabilities m_caps;
int m_cleanupInterval;
scoped_ptr<CondWait> shutdown_wait;
Thread* cleanup_thread;
bool shutdown;
SQLHENV m_henv;
string m_connstring;
long m_isolation;
bool m_wideVersion;
vector<SQLINTEGER> m_retries;
};
StorageService* ODBCStorageServiceFactory(const DOMElement* const & e)
{
return new ODBCStorageService(e);
}
// convert SQL timestamp to time_t
time_t timeFromTimestamp(SQL_TIMESTAMP_STRUCT expires)
{
time_t ret;
struct tm t;
t.tm_sec=expires.second;
t.tm_min=expires.minute;
t.tm_hour=expires.hour;
t.tm_mday=expires.day;
t.tm_mon=expires.month-1;
t.tm_year=expires.year-1900;
t.tm_isdst=0;
#if defined(HAVE_TIMEGM)
ret = timegm(&t);
#elif defined(WIN32)
ret = mktime(&t) - _timezone;
#else
ret = mktime(&t) - timezone;
#endif
return (ret);
}
// conver time_t to SQL string
void timestampFromTime(time_t t, char* ret)
{
#ifdef HAVE_GMTIME_R
struct tm res;
struct tm* ptime=gmtime_r(&t,&res);
#else
struct tm* ptime=gmtime(&t);
#endif
strftime(ret,32,"{ts '%Y-%m-%d %H:%M:%S'}",ptime);
}
class SQLString {
const char* m_src;
string m_copy;
public:
SQLString(const char* src) : m_src(src) {
if (strchr(src, '\'')) {
m_copy = src;
replace_all(m_copy, "'", "''");
}
}
operator const char*() const {
return tostr();
}
const char* tostr() const {
return m_copy.empty() ? m_src : m_copy.c_str();
}
};
};
ODBCStorageService::ODBCStorageService(const DOMElement* e) : m_log(Category::getInstance("XMLTooling.StorageService")),
m_caps(XMLHelper::getAttrInt(e, 255, contextSize), XMLHelper::getAttrInt(e, 255, keySize), XMLHelper::getAttrInt(e, 255, stringSize)),
m_cleanupInterval(XMLHelper::getAttrInt(e, 900, cleanupInterval)),
cleanup_thread(nullptr), shutdown(false), m_henv(SQL_NULL_HENV), m_isolation(SQL_TXN_SERIALIZABLE), m_wideVersion(false)
{
#ifdef _DEBUG
xmltooling::NDC ndc("ODBCStorageService");
#endif
string iso(XMLHelper::getAttrString(e, "SERIALIZABLE", isolationLevel));
if (iso == "SERIALIZABLE")
m_isolation = SQL_TXN_SERIALIZABLE;
else if (iso == "REPEATABLE_READ")
m_isolation = SQL_TXN_REPEATABLE_READ;
else if (iso == "READ_COMMITTED")
m_isolation = SQL_TXN_READ_COMMITTED;
else if (iso == "READ_UNCOMMITTED")
m_isolation = SQL_TXN_READ_UNCOMMITTED;
else
throw XMLToolingException("Unknown transaction isolationLevel property.");
if (m_henv == SQL_NULL_HENV) {
// Enable connection pooling.
SQLSetEnvAttr(SQL_NULL_HANDLE, SQL_ATTR_CONNECTION_POOLING, (void*)SQL_CP_ONE_PER_HENV, 0);
// Allocate the environment.
if (!SQL_SUCCEEDED(SQLAllocHandle(SQL_HANDLE_ENV, SQL_NULL_HANDLE, &m_henv)))
throw XMLToolingException("ODBC failed to initialize.");
// Specify ODBC 3.x
SQLSetEnvAttr(m_henv, SQL_ATTR_ODBC_VERSION, (void*)SQL_OV_ODBC3, 0);
m_log.info("ODBC initialized");
}
// Grab connection string from the configuration.
e = e ? XMLHelper::getFirstChildElement(e, ConnectionString) : nullptr;
auto_ptr_char arg(e ? e->getTextContent() : nullptr);
if (!arg.get() || !*arg.get()) {
SQLFreeHandle(SQL_HANDLE_ENV, m_henv);
throw XMLToolingException("ODBC StorageService requires ConnectionString element in configuration.");
}
m_connstring = arg.get();
// Connect and check version.
ODBCConn conn(getHDBC());
pair<SQLINTEGER,SQLINTEGER> v = getVersion(conn);
// Make sure we've got the right version.
if (v.first != PLUGIN_VER_MAJOR) {
SQLFreeHandle(SQL_HANDLE_ENV, m_henv);
m_log.crit("unknown database version: %d.%d", v.first, v.second);
throw XMLToolingException("Unknown database version for ODBC StorageService.");
}
if (v.first > 1 || v.second > 0) {
m_log.info("using 32-bit int type for version fields in tables");
m_wideVersion = true;
}
// Load any retry errors to check.
e = XMLHelper::getNextSiblingElement(e, RetryOnError);
while (e) {
if (e->hasChildNodes()) {
try {
int code = XMLString::parseInt(e->getTextContent());
m_retries.push_back(code);
m_log.info("will retry operations when native ODBC error (%d) is returned", code);
}
catch (XMLException&) {
m_log.error("skipping non-numeric ODBC retry code");
}
}
e = XMLHelper::getNextSiblingElement(e, RetryOnError);
}
if (m_cleanupInterval > 0) {
// Initialize the cleanup thread
shutdown_wait.reset(CondWait::create());
cleanup_thread = Thread::create(&cleanup_fn, (void*)this);
}
else {
m_log.info("no cleanup interval configured, no cleanup thread will be started");
}
}
ODBCStorageService::~ODBCStorageService()
{
shutdown = true;
if (shutdown_wait.get()) {
shutdown_wait->signal();
}
if (cleanup_thread) {
cleanup_thread->join(nullptr);
}
if (m_henv != SQL_NULL_HANDLE) {
SQLFreeHandle(SQL_HANDLE_ENV, m_henv);
}
}
pair<bool,bool> ODBCStorageService::log_error(SQLHANDLE handle, SQLSMALLINT htype, const char* checkfor)
{
SQLSMALLINT i = 0;
SQLINTEGER native;
SQLCHAR state[7];
SQLCHAR text[256];
SQLSMALLINT len;
SQLRETURN ret;
pair<bool,bool> res = make_pair(false,false);
do {
ret = SQLGetDiagRec(htype, handle, ++i, state, &native, text, sizeof(text), &len);
if (SQL_SUCCEEDED(ret)) {
m_log.error("ODBC Error: %s:%ld:%ld:%s", state, i, native, text);
for (vector<SQLINTEGER>::const_iterator n = m_retries.begin(); !res.first && n != m_retries.end(); ++n)
res.first = (*n == native);
if (checkfor && !strcmp(checkfor, (const char*)state))
res.second = true;
}
} while(SQL_SUCCEEDED(ret));
return res;
}
SQLHDBC ODBCStorageService::getHDBC()
{
#ifdef _DEBUG
xmltooling::NDC ndc("getHDBC");
#endif
// Get a handle.
SQLHDBC handle = SQL_NULL_HDBC;
SQLRETURN sr = SQLAllocHandle(SQL_HANDLE_DBC, m_henv, &handle);
if (!SQL_SUCCEEDED(sr) || handle == SQL_NULL_HDBC) {
m_log.error("failed to allocate connection handle");
log_error(m_henv, SQL_HANDLE_ENV);
throw IOException("ODBC StorageService failed to allocate a connection handle.");
}
sr = SQLDriverConnect(handle,nullptr,(SQLCHAR*)m_connstring.c_str(),m_connstring.length(),nullptr,0,nullptr,SQL_DRIVER_NOPROMPT);
if (!SQL_SUCCEEDED(sr)) {
m_log.error("failed to connect to database");
log_error(handle, SQL_HANDLE_DBC);
SQLFreeHandle(SQL_HANDLE_DBC, handle);
throw IOException("ODBC StorageService failed to connect to database.");
}
sr = SQLSetConnectAttr(handle, SQL_ATTR_TXN_ISOLATION, (SQLPOINTER)m_isolation, 0);
if (!SQL_SUCCEEDED(sr)) {
SQLDisconnect(handle);
SQLFreeHandle(SQL_HANDLE_DBC, handle);
throw IOException("ODBC StorageService failed to set transaction isolation level.");
}
return handle;
}
SQLHSTMT ODBCStorageService::getHSTMT(SQLHDBC conn)
{
SQLHSTMT hstmt = SQL_NULL_HSTMT;
SQLRETURN sr = SQLAllocHandle(SQL_HANDLE_STMT, conn, &hstmt);
if (!SQL_SUCCEEDED(sr) || hstmt == SQL_NULL_HSTMT) {
m_log.error("failed to allocate statement handle");
log_error(conn, SQL_HANDLE_DBC);
throw IOException("ODBC StorageService failed to allocate a statement handle.");
}
return hstmt;
}
pair<SQLINTEGER,SQLINTEGER> ODBCStorageService::getVersion(SQLHDBC conn)
{
// Grab the version number from the database.
SQLHSTMT stmt = getHSTMT(conn);
SQLRETURN sr = SQLExecDirect(stmt, (SQLCHAR*)"SELECT major,minor FROM version", SQL_NTS);
if (!SQL_SUCCEEDED(sr)) {
m_log.error("failed to read version from database");
log_error(stmt, SQL_HANDLE_STMT);
throw IOException("ODBC StorageService failed to read version from database.");
}
SQLINTEGER major;
SQLINTEGER minor;
SQLBindCol(stmt, 1, SQL_C_SLONG, &major, 0, nullptr);
SQLBindCol(stmt, 2, SQL_C_SLONG, &minor, 0, nullptr);
if ((sr = SQLFetch(stmt)) != SQL_NO_DATA)
return make_pair(major,minor);
m_log.error("no rows returned in version query");
throw IOException("ODBC StorageService failed to read version from database.");
}
bool ODBCStorageService::createRow(const char* table, const char* context, const char* key, const char* value, time_t expiration)
{
#ifdef _DEBUG
xmltooling::NDC ndc("createRow");
#endif
char timebuf[32];
timestampFromTime(expiration, timebuf);
// Get statement handle.
ODBCConn conn(getHDBC());
SQLHSTMT stmt = getHSTMT(conn);
string q = string("INSERT INTO ") + table + " VALUES (?,?," + timebuf + ",1,?)";
SQLRETURN sr = SQLPrepare(stmt, (SQLCHAR*)q.c_str(), SQL_NTS);
if (!SQL_SUCCEEDED(sr)) {
m_log.error("SQLPrepare failed (t=%s, c=%s, k=%s)", table, context, key);
log_error(stmt, SQL_HANDLE_STMT);
throw IOException("ODBC StorageService failed to insert record.");
}
m_log.debug("SQLPrepare succeeded. SQL: %s", q.c_str());
SQLLEN b_ind = SQL_NTS;
sr = SQLBindParam(stmt, 1, SQL_C_CHAR, SQL_VARCHAR, 255, 0, const_cast<char*>(context), &b_ind);
if (!SQL_SUCCEEDED(sr)) {
m_log.error("SQLBindParam failed (context = %s)", context);
log_error(stmt, SQL_HANDLE_STMT);
throw IOException("ODBC StorageService failed to insert record.");
}
m_log.debug("SQLBindParam succeeded (context = %s)", context);
sr = SQLBindParam(stmt, 2, SQL_C_CHAR, SQL_VARCHAR, 255, 0, const_cast<char*>(key), &b_ind);
if (!SQL_SUCCEEDED(sr)) {
m_log.error("SQLBindParam failed (key = %s)", key);
log_error(stmt, SQL_HANDLE_STMT);
throw IOException("ODBC StorageService failed to insert record.");
}
m_log.debug("SQLBindParam succeeded (key = %s)", key);
if (strcmp(table, TEXT_TABLE)==0)
sr = SQLBindParam(stmt, 3, SQL_C_CHAR, SQL_LONGVARCHAR, strlen(value), 0, const_cast<char*>(value), &b_ind);
else
sr = SQLBindParam(stmt, 3, SQL_C_CHAR, SQL_VARCHAR, 255, 0, const_cast<char*>(value), &b_ind);
if (!SQL_SUCCEEDED(sr)) {
m_log.error("SQLBindParam failed (value = %s)", value);
log_error(stmt, SQL_HANDLE_STMT);
throw IOException("ODBC StorageService failed to insert record.");
}
m_log.debug("SQLBindParam succeeded (value = %s)", value);
int attempts = 3;
pair<bool,bool> logres;
do {
logres = make_pair(false,false);
attempts--;
sr = SQLExecute(stmt);
if (SQL_SUCCEEDED(sr)) {
m_log.debug("SQLExecute of insert succeeded");
return true;
}
m_log.error("insert record failed (t=%s, c=%s, k=%s)", table, context, key);
logres = log_error(stmt, SQL_HANDLE_STMT, "23000");
if (logres.second) {
// Supposedly integrity violation.
// Try and delete any expired record still hanging around until the final attempt.
if (attempts > 0) {
reap(table, context);
logres.first = true; // force it to treat as a retryable error
continue;
}
return false;
}
} while (attempts && logres.first);
throw IOException("ODBC StorageService failed to insert record.");
}
int ODBCStorageService::readRow(const char *table, const char* context, const char* key, string* pvalue, time_t* pexpiration, int version)
{
#ifdef _DEBUG
xmltooling::NDC ndc("readRow");
#endif
// Get statement handle.
ODBCConn conn(getHDBC());
SQLHSTMT stmt = getHSTMT(conn);
// Prepare and exectute select statement.
char timebuf[32];
timestampFromTime(time(nullptr), timebuf);
SQLString scontext(context);
SQLString skey(key);
string q("SELECT version");
if (pexpiration)
q += ",expires";
if (pvalue) {
pvalue->erase();
q = q + ",CASE version WHEN " + lexical_cast<string>(version) + " THEN null ELSE value END";
}
q = q + " FROM " + table + " WHERE context='" + scontext.tostr() + "' AND id='" + skey.tostr() + "' AND expires > " + timebuf;
if (m_log.isDebugEnabled())
m_log.debug("SQL: %s", q.c_str());
SQLRETURN sr=SQLExecDirect(stmt, (SQLCHAR*)q.c_str(), SQL_NTS);
if (!SQL_SUCCEEDED(sr)) {
m_log.error("error searching for (t=%s, c=%s, k=%s)", table, context, key);
log_error(stmt, SQL_HANDLE_STMT);
throw IOException("ODBC StorageService search failed.");
}
SQLSMALLINT ver;
SQLINTEGER widever;
SQL_TIMESTAMP_STRUCT expiration;
if (m_wideVersion)
SQLBindCol(stmt, 1, SQL_C_SLONG, &widever, 0, nullptr);
else
SQLBindCol(stmt, 1, SQL_C_SSHORT, &ver, 0, nullptr);
if (pexpiration)
SQLBindCol(stmt, 2, SQL_C_TYPE_TIMESTAMP, &expiration, 0, nullptr);
if ((sr = SQLFetch(stmt)) == SQL_NO_DATA) {
if (m_log.isDebugEnabled())
m_log.debug("search returned no data (t=%s, c=%s, k=%s)", table, context, key);
return 0;
}
if (pexpiration)
*pexpiration = timeFromTimestamp(expiration);
if (version == (m_wideVersion ? widever : ver)) {
if (m_log.isDebugEnabled())
m_log.debug("versioned search detected no change (t=%s, c=%s, k=%s)", table, context, key);
return version; // nothing's changed, so just echo back the version
}
if (pvalue) {
SQLLEN len;
SQLCHAR buf[LONGDATA_BUFLEN];
while ((sr = SQLGetData(stmt, (pexpiration ? 3 : 2), SQL_C_CHAR, buf, sizeof(buf), &len)) != SQL_NO_DATA) {
if (!SQL_SUCCEEDED(sr)) {
m_log.error("error while reading text field from result set");
log_error(stmt, SQL_HANDLE_STMT);
throw IOException("ODBC StorageService search failed to read data from result set.");
}
pvalue->append((char*)buf);
}
}
return (m_wideVersion ? widever : ver);
}
int ODBCStorageService::updateRow(const char *table, const char* context, const char* key, const char* value, time_t expiration, int version)
{
#ifdef _DEBUG
xmltooling::NDC ndc("updateRow");
#endif
if (!value && !expiration)
throw IOException("ODBC StorageService given invalid update instructions.");
// Get statement handle. Disable auto-commit mode to wrap select + update.
ODBCConn conn(getHDBC());
SQLRETURN sr = SQLSetConnectAttr(conn, SQL_ATTR_AUTOCOMMIT, SQL_AUTOCOMMIT_OFF, 0);
if (!SQL_SUCCEEDED(sr))
throw IOException("ODBC StorageService failed to disable auto-commit mode.");
conn.autoCommit = false;
SQLHSTMT stmt = getHSTMT(conn);
// First, fetch the current version for later, which also ensures the record still exists.
char timebuf[32];
timestampFromTime(time(nullptr), timebuf);
SQLString scontext(context);
SQLString skey(key);
string q("SELECT version FROM ");
q = q + table + " WHERE context='" + scontext.tostr() + "' AND id='" + skey.tostr() + "' AND expires > " + timebuf;
m_log.debug("SQL: %s", q.c_str());
sr = SQLExecDirect(stmt, (SQLCHAR*)q.c_str(), SQL_NTS);
if (!SQL_SUCCEEDED(sr)) {
m_log.error("error searching for (t=%s, c=%s, k=%s)", table, context, key);
log_error(stmt, SQL_HANDLE_STMT);
throw IOException("ODBC StorageService search failed.");
}
SQLSMALLINT ver;
SQLINTEGER widever;
if (m_wideVersion)
SQLBindCol(stmt, 1, SQL_C_SLONG, &widever, 0, nullptr);
else
SQLBindCol(stmt, 1, SQL_C_SSHORT, &ver, 0, nullptr);
if ((sr = SQLFetch(stmt)) == SQL_NO_DATA) {
return 0;
}
// Check version?
if (version > 0 && version != (m_wideVersion ? widever : ver)) {
return -1;
}
else if ((m_wideVersion && widever == INT_MAX) || (!m_wideVersion && ver == 32767)) {
m_log.error("record version overflow (t=%s, c=%s, k=%s)", table, context, key);
throw IOException("Version overflow, record in ODBC StorageService could not be updated.");
}
SQLFreeHandle(SQL_HANDLE_STMT, stmt);
stmt = getHSTMT(conn);
// Prepare and exectute update statement.
q = string("UPDATE ") + table + " SET ";
if (value)
q = q + "value=?, version=version+1";
if (expiration) {
timestampFromTime(expiration, timebuf);
if (value)
q += ',';
q = q + "expires = " + timebuf;
}
q = q + " WHERE context='" + scontext.tostr() + "' AND id='" + skey.tostr() + "'";
sr = SQLPrepare(stmt, (SQLCHAR*)q.c_str(), SQL_NTS);
if (!SQL_SUCCEEDED(sr)) {
m_log.error("update of record failed (t=%s, c=%s, k=%s", table, context, key);
log_error(stmt, SQL_HANDLE_STMT);
throw IOException("ODBC StorageService failed to update record.");
}
m_log.debug("SQLPrepare succeeded. SQL: %s", q.c_str());
SQLLEN b_ind = SQL_NTS;
if (value) {
if (strcmp(table, TEXT_TABLE)==0)
sr = SQLBindParam(stmt, 1, SQL_C_CHAR, SQL_LONGVARCHAR, strlen(value), 0, const_cast<char*>(value), &b_ind);
else
sr = SQLBindParam(stmt, 1, SQL_C_CHAR, SQL_VARCHAR, 255, 0, const_cast<char*>(value), &b_ind);
if (!SQL_SUCCEEDED(sr)) {
m_log.error("SQLBindParam failed (value = %s)", value);
log_error(stmt, SQL_HANDLE_STMT);
throw IOException("ODBC StorageService failed to update record.");
}
m_log.debug("SQLBindParam succeeded (value = %s)", value);
}
int attempts = 3;
pair<bool,bool> logres;
do {
logres = make_pair(false,false);
attempts--;
sr = SQLExecute(stmt);
if (sr == SQL_NO_DATA)
return 0; // went missing?
else if (SQL_SUCCEEDED(sr)) {
m_log.debug("SQLExecute of update succeeded");
return (m_wideVersion ? widever : ver) + 1;
}
m_log.error("update of record failed (t=%s, c=%s, k=%s)", table, context, key);
logres = log_error(stmt, SQL_HANDLE_STMT);
} while (attempts && logres.first);
throw IOException("ODBC StorageService failed to update record.");
}
bool ODBCStorageService::deleteRow(const char *table, const char *context, const char* key)
{
#ifdef _DEBUG
xmltooling::NDC ndc("deleteRow");
#endif
// Get statement handle.
ODBCConn conn(getHDBC());
SQLHSTMT stmt = getHSTMT(conn);
// Prepare and execute delete statement.
SQLString scontext(context);
SQLString skey(key);
string q = string("DELETE FROM ") + table + " WHERE context='" + scontext.tostr() + "' AND id='" + skey.tostr() + "'";
m_log.debug("SQL: %s", q.c_str());
SQLRETURN sr = SQLExecDirect(stmt, (SQLCHAR*)q.c_str(), SQL_NTS);
if (sr == SQL_NO_DATA)
return false;
else if (!SQL_SUCCEEDED(sr)) {
m_log.error("error deleting record (t=%s, c=%s, k=%s)", table, context, key);
log_error(stmt, SQL_HANDLE_STMT);
throw IOException("ODBC StorageService failed to delete record.");
}
return true;
}
void ODBCStorageService::cleanup()
{
#ifdef _DEBUG
xmltooling::NDC ndc("cleanup");
#endif
scoped_ptr<Mutex> mutex(Mutex::create());
mutex->lock();
m_log.info("cleanup thread started... running every %d secs", m_cleanupInterval);
while (!shutdown) {
shutdown_wait->timedwait(mutex.get(), m_cleanupInterval);
if (shutdown)
break;
try {
reap(nullptr);
}
catch (std::exception& ex) {
m_log.error("cleanup thread swallowed exception: %s", ex.what());
}
}
m_log.info("cleanup thread exiting...");
mutex->unlock();
Thread::exit(nullptr);
}
void* ODBCStorageService::cleanup_fn(void* cache_p)
{
ODBCStorageService* cache = (ODBCStorageService*)cache_p;
#ifndef WIN32
// First, let's block all signals
Thread::mask_all_signals();
#endif
// Now run the cleanup process.
cache->cleanup();
return nullptr;
}
void ODBCStorageService::updateContext(const char *table, const char* context, time_t expiration)
{
#ifdef _DEBUG
xmltooling::NDC ndc("updateContext");
#endif
// Get statement handle.
ODBCConn conn(getHDBC());
SQLHSTMT stmt = getHSTMT(conn);
char timebuf[32];
timestampFromTime(expiration, timebuf);
char nowbuf[32];
timestampFromTime(time(nullptr), nowbuf);
SQLString scontext(context);
string q = string("UPDATE ") + table + " SET expires = " + timebuf + " WHERE context='" + scontext.tostr() + "' AND expires > " + nowbuf;
m_log.debug("SQL: %s", q.c_str());
SQLRETURN sr = SQLExecDirect(stmt, (SQLCHAR*)q.c_str(), SQL_NTS);
if ((sr != SQL_NO_DATA) && !SQL_SUCCEEDED(sr)) {
m_log.error("error updating records (t=%s, c=%s)", table, context ? context : "all");
log_error(stmt, SQL_HANDLE_STMT);
throw IOException("ODBC StorageService failed to update context expiration.");
}
}
void ODBCStorageService::reap(const char *table, const char* context)
{
#ifdef _DEBUG
xmltooling::NDC ndc("reap");
#endif
// Get statement handle.
ODBCConn conn(getHDBC());
SQLHSTMT stmt = getHSTMT(conn);
// Prepare and execute delete statement.
char nowbuf[32];
timestampFromTime(time(nullptr), nowbuf);
string q;
if (context) {
SQLString scontext(context);
q = string("DELETE FROM ") + table + " WHERE context='" + scontext.tostr() + "' AND expires <= " + nowbuf;
}
else {
q = string("DELETE FROM ") + table + " WHERE expires <= " + nowbuf;
}
m_log.debug("SQL: %s", q.c_str());
SQLRETURN sr = SQLExecDirect(stmt, (SQLCHAR*)q.c_str(), SQL_NTS);
if ((sr != SQL_NO_DATA) && !SQL_SUCCEEDED(sr)) {
m_log.error("error expiring records (t=%s, c=%s)", table, context ? context : "all");
log_error(stmt, SQL_HANDLE_STMT);
throw IOException("ODBC StorageService failed to purge expired records.");
}
}
void ODBCStorageService::deleteContext(const char *table, const char* context)
{
#ifdef _DEBUG
xmltooling::NDC ndc("deleteContext");
#endif
// Get statement handle.
ODBCConn conn(getHDBC());
SQLHSTMT stmt = getHSTMT(conn);
// Prepare and execute delete statement.
SQLString scontext(context);
string q = string("DELETE FROM ") + table + " WHERE context='" + scontext.tostr() + "'";
m_log.debug("SQL: %s", q.c_str());
SQLRETURN sr = SQLExecDirect(stmt, (SQLCHAR*)q.c_str(), SQL_NTS);
if ((sr != SQL_NO_DATA) && !SQL_SUCCEEDED(sr)) {
m_log.error("error deleting context (t=%s, c=%s)", table, context);
log_error(stmt, SQL_HANDLE_STMT);
throw IOException("ODBC StorageService failed to delete context.");
}
}
extern "C" int ODBCSTORE_EXPORTS xmltooling_extension_init(void*)
{
// Register this SS type
XMLToolingConfig::getConfig().StorageServiceManager.registerFactory("ODBC", ODBCStorageServiceFactory);
return 0;
}
extern "C" void ODBCSTORE_EXPORTS xmltooling_extension_term()
{
XMLToolingConfig::getConfig().StorageServiceManager.deregisterFactory("ODBC");
}
|