Mercurial > hg > orthanc
annotate Core/SQLite/Connection.cpp @ 137:0e97abc7b950
fix of a bug in older versions of sqlite
| author | Sebastien Jodogne <s.jodogne@gmail.com> |
|---|---|
| date | Wed, 10 Oct 2012 13:13:14 +0200 |
| parents | c996319e90bc |
| children | 2dece1526c06 |
| rev | line source |
|---|---|
| 0 | 1 /** |
| 59 | 2 * Orthanc - A Lightweight, RESTful DICOM Store |
| 0 | 3 * Copyright (C) 2012 Medical Physics Department, CHU of Liege, |
| 4 * Belgium | |
| 5 * | |
| 17 | 6 * Copyright (c) 2012 The Chromium Authors. All rights reserved. |
| 7 * | |
| 8 * Redistribution and use in source and binary forms, with or without | |
| 9 * modification, are permitted provided that the following conditions are | |
| 10 * met: | |
| 0 | 11 * |
| 17 | 12 * * Redistributions of source code must retain the above copyright |
| 13 * notice, this list of conditions and the following disclaimer. | |
| 14 * * Redistributions in binary form must reproduce the above | |
| 15 * copyright notice, this list of conditions and the following disclaimer | |
| 16 * in the documentation and/or other materials provided with the | |
| 17 * distribution. | |
| 18 * * Neither the name of Google Inc., the name of the CHU of Liege, | |
| 19 * nor the names of its contributors may be used to endorse or promote | |
| 20 * products derived from this software without specific prior written | |
| 21 * permission. | |
| 22 * | |
| 23 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS | |
| 24 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT | |
| 25 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR | |
| 26 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT | |
| 27 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, | |
| 28 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT | |
| 29 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, | |
| 30 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY | |
| 31 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT | |
| 32 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE | |
| 33 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. | |
| 0 | 34 **/ |
| 35 | |
| 36 | |
| 37 #include "Connection.h" | |
| 38 | |
| 39 #include <memory> | |
| 40 #include <cassert> | |
| 41 #include <sqlite3.h> | |
| 42 #include <string.h> | |
| 43 | |
|
137
0e97abc7b950
fix of a bug in older versions of sqlite
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
59
diff
changeset
|
44 #include <glog/logging.h> |
| 0 | 45 |
| 46 | |
| 59 | 47 namespace Orthanc |
| 0 | 48 { |
| 49 namespace SQLite | |
| 50 { | |
| 51 Connection::Connection() : | |
| 52 db_(NULL), | |
| 53 transactionNesting_(0), | |
| 54 needsRollback_(false) | |
| 55 { | |
| 56 } | |
| 57 | |
| 58 | |
| 59 Connection::~Connection() | |
| 60 { | |
| 61 Close(); | |
| 62 } | |
| 63 | |
| 64 | |
| 65 void Connection::CheckIsOpen() const | |
| 66 { | |
| 67 if (!db_) | |
| 68 { | |
| 59 | 69 throw OrthancException("SQLite: The database is not opened"); |
| 0 | 70 } |
| 71 } | |
| 72 | |
| 73 void Connection::Open(const std::string& path) | |
| 74 { | |
| 75 if (db_) | |
| 76 { | |
| 59 | 77 throw OrthancException("SQLite: Connection is already open"); |
| 0 | 78 } |
| 79 | |
| 80 int err = sqlite3_open(path.c_str(), &db_); | |
| 81 if (err != SQLITE_OK) | |
| 82 { | |
| 83 Close(); | |
| 84 db_ = NULL; | |
| 59 | 85 throw OrthancException("SQLite: Unable to open the database"); |
| 0 | 86 } |
| 87 | |
| 88 // Execute PRAGMAs at this point | |
| 89 // http://www.sqlite.org/pragma.html | |
| 90 Execute("PRAGMA FOREIGN_KEYS=ON;"); | |
| 91 | |
| 92 // Performance tuning | |
| 93 Execute("PRAGMA SYNCHRONOUS=NORMAL;"); | |
| 94 Execute("PRAGMA JOURNAL_MODE=WAL;"); | |
| 95 Execute("PRAGMA LOCKING_MODE=EXCLUSIVE;"); | |
| 96 Execute("PRAGMA WAL_AUTOCHECKPOINT=1000;"); | |
| 97 //Execute("PRAGMA TEMP_STORE=memory"); | |
| 98 } | |
| 99 | |
| 100 void Connection::OpenInMemory() | |
| 101 { | |
| 102 Open(":memory:"); | |
| 103 } | |
| 104 | |
| 105 void Connection::Close() | |
| 106 { | |
| 107 ClearCache(); | |
| 108 | |
| 109 if (db_) | |
| 110 { | |
| 111 sqlite3_close(db_); | |
| 112 db_ = NULL; | |
| 113 } | |
| 114 } | |
| 115 | |
| 116 void Connection::ClearCache() | |
| 117 { | |
| 118 for (CachedStatements::iterator | |
| 119 it = cachedStatements_.begin(); | |
| 120 it != cachedStatements_.end(); it++) | |
| 121 { | |
| 122 delete it->second; | |
| 123 } | |
| 124 | |
| 125 cachedStatements_.clear(); | |
| 126 } | |
| 127 | |
| 128 | |
| 129 StatementReference& Connection::GetCachedStatement(const StatementId& id, | |
| 130 const char* sql) | |
| 131 { | |
| 132 CachedStatements::iterator i = cachedStatements_.find(id); | |
| 133 if (i != cachedStatements_.end()) | |
| 134 { | |
| 135 if (i->second->GetReferenceCount() >= 1) | |
| 136 { | |
| 59 | 137 throw OrthancException("SQLite: This cached statement is already being referred to"); |
| 0 | 138 } |
| 139 | |
| 140 return *i->second; | |
| 141 } | |
| 142 else | |
| 143 { | |
| 144 StatementReference* statement = new StatementReference(db_, sql); | |
| 145 cachedStatements_[id] = statement; | |
| 146 return *statement; | |
| 147 } | |
| 148 } | |
| 149 | |
| 150 | |
| 151 bool Connection::Execute(const char* sql) | |
| 152 { | |
|
137
0e97abc7b950
fix of a bug in older versions of sqlite
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
59
diff
changeset
|
153 VLOG(1) << "SQLite::Connection::Execute " << sql; |
| 0 | 154 CheckIsOpen(); |
| 155 | |
| 156 int error = sqlite3_exec(db_, sql, NULL, NULL, NULL); | |
| 157 if (error == SQLITE_ERROR) | |
| 158 { | |
| 59 | 159 throw OrthancException("SQLite Execute error: " + std::string(sqlite3_errmsg(db_))); |
| 0 | 160 } |
| 161 else | |
| 162 { | |
| 163 return error == SQLITE_OK; | |
| 164 } | |
| 165 } | |
| 166 | |
| 167 int Connection::ExecuteAndReturnErrorCode(const char* sql) | |
| 168 { | |
| 169 CheckIsOpen(); | |
| 170 return sqlite3_exec(db_, sql, NULL, NULL, NULL); | |
| 171 } | |
| 172 | |
| 173 // Info querying ------------------------------------------------------------- | |
| 174 | |
| 175 bool Connection::IsSQLValid(const char* sql) | |
| 176 { | |
| 177 sqlite3_stmt* stmt = NULL; | |
| 178 if (sqlite3_prepare_v2(db_, sql, -1, &stmt, NULL) != SQLITE_OK) | |
| 179 return false; | |
| 180 | |
| 181 sqlite3_finalize(stmt); | |
| 182 return true; | |
| 183 } | |
| 184 | |
| 185 bool Connection::DoesTableOrIndexExist(const char* name, | |
| 186 const char* type) const | |
| 187 { | |
| 188 // Our SQL is non-mutating, so this cast is OK. | |
| 189 Statement statement(const_cast<Connection&>(*this), | |
| 190 "SELECT name FROM sqlite_master WHERE type=? AND name=?"); | |
| 191 statement.BindString(0, type); | |
| 192 statement.BindString(1, name); | |
| 193 return statement.Step(); // Table exists if any row was returned. | |
| 194 } | |
| 195 | |
| 196 bool Connection::DoesTableExist(const char* table_name) const | |
| 197 { | |
| 198 return DoesTableOrIndexExist(table_name, "table"); | |
| 199 } | |
| 200 | |
| 201 bool Connection::DoesIndexExist(const char* index_name) const | |
| 202 { | |
| 203 return DoesTableOrIndexExist(index_name, "index"); | |
| 204 } | |
| 205 | |
| 206 bool Connection::DoesColumnExist(const char* table_name, const char* column_name) const | |
| 207 { | |
| 208 std::string sql("PRAGMA TABLE_INFO("); | |
| 209 sql.append(table_name); | |
| 210 sql.append(")"); | |
| 211 | |
| 212 // Our SQL is non-mutating, so this cast is OK. | |
| 213 Statement statement(const_cast<Connection&>(*this), sql.c_str()); | |
| 214 | |
| 215 while (statement.Step()) { | |
| 216 if (!statement.ColumnString(1).compare(column_name)) | |
| 217 return true; | |
| 218 } | |
| 219 return false; | |
| 220 } | |
| 221 | |
| 222 int64_t Connection::GetLastInsertRowId() const | |
| 223 { | |
| 224 return sqlite3_last_insert_rowid(db_); | |
| 225 } | |
| 226 | |
| 227 int Connection::GetLastChangeCount() const | |
| 228 { | |
| 229 return sqlite3_changes(db_); | |
| 230 } | |
| 231 | |
| 232 int Connection::GetErrorCode() const | |
| 233 { | |
| 234 return sqlite3_errcode(db_); | |
| 235 } | |
| 236 | |
| 237 int Connection::GetLastErrno() const | |
| 238 { | |
| 239 int err = 0; | |
| 240 if (SQLITE_OK != sqlite3_file_control(db_, NULL, SQLITE_LAST_ERRNO, &err)) | |
| 241 return -2; | |
| 242 | |
| 243 return err; | |
| 244 } | |
| 245 | |
| 246 const char* Connection::GetErrorMessage() const | |
| 247 { | |
| 248 return sqlite3_errmsg(db_); | |
| 249 } | |
| 250 | |
| 251 | |
| 252 bool Connection::BeginTransaction() | |
| 253 { | |
| 254 if (needsRollback_) | |
| 255 { | |
| 256 assert(transactionNesting_ > 0); | |
| 257 | |
| 258 // When we're going to rollback, fail on this begin and don't actually | |
| 259 // mark us as entering the nested transaction. | |
| 260 return false; | |
| 261 } | |
| 262 | |
| 263 bool success = true; | |
| 264 if (!transactionNesting_) | |
| 265 { | |
| 266 needsRollback_ = false; | |
| 267 | |
| 268 Statement begin(*this, SQLITE_FROM_HERE, "BEGIN TRANSACTION"); | |
| 269 if (!begin.Run()) | |
| 270 return false; | |
| 271 } | |
| 272 transactionNesting_++; | |
| 273 return success; | |
| 274 } | |
| 275 | |
| 276 void Connection::RollbackTransaction() | |
| 277 { | |
| 278 if (!transactionNesting_) | |
| 279 { | |
| 59 | 280 throw OrthancException("Rolling back a nonexistent transaction"); |
| 0 | 281 } |
| 282 | |
| 283 transactionNesting_--; | |
| 284 | |
| 285 if (transactionNesting_ > 0) | |
| 286 { | |
| 287 // Mark the outermost transaction as needing rollback. | |
| 288 needsRollback_ = true; | |
| 289 return; | |
| 290 } | |
| 291 | |
| 292 DoRollback(); | |
| 293 } | |
| 294 | |
| 295 bool Connection::CommitTransaction() | |
| 296 { | |
| 297 if (!transactionNesting_) | |
| 298 { | |
| 59 | 299 throw OrthancException("Committing a nonexistent transaction"); |
| 0 | 300 } |
| 301 transactionNesting_--; | |
| 302 | |
| 303 if (transactionNesting_ > 0) | |
| 304 { | |
| 305 // Mark any nested transactions as failing after we've already got one. | |
| 306 return !needsRollback_; | |
| 307 } | |
| 308 | |
| 309 if (needsRollback_) | |
| 310 { | |
| 311 DoRollback(); | |
| 312 return false; | |
| 313 } | |
| 314 | |
| 315 Statement commit(*this, SQLITE_FROM_HERE, "COMMIT"); | |
| 316 return commit.Run(); | |
| 317 } | |
| 318 | |
| 319 void Connection::DoRollback() | |
| 320 { | |
| 321 Statement rollback(*this, SQLITE_FROM_HERE, "ROLLBACK"); | |
| 322 rollback.Run(); | |
| 323 needsRollback_ = false; | |
| 324 } | |
| 325 | |
| 326 | |
| 327 | |
| 328 | |
| 329 | |
| 330 | |
| 331 static void ScalarFunctionCaller(sqlite3_context* rawContext, | |
| 332 int argc, | |
| 333 sqlite3_value** argv) | |
| 334 { | |
| 335 FunctionContext context(rawContext, argc, argv); | |
| 336 | |
| 337 void* payload = sqlite3_user_data(rawContext); | |
| 338 assert(payload != NULL); | |
| 339 | |
| 340 IScalarFunction& func = *(IScalarFunction*) payload; | |
| 341 func.Compute(context); | |
| 342 } | |
| 343 | |
| 344 | |
| 345 static void ScalarFunctionDestroyer(void* payload) | |
| 346 { | |
| 347 assert(payload != NULL); | |
| 348 delete (IScalarFunction*) payload; | |
| 349 } | |
| 350 | |
| 351 | |
| 352 IScalarFunction* Connection::Register(IScalarFunction* func) | |
| 353 { | |
| 354 int err = sqlite3_create_function_v2(db_, | |
| 355 func->GetName(), | |
| 356 func->GetCardinality(), | |
| 357 SQLITE_UTF8, | |
| 358 func, | |
| 359 ScalarFunctionCaller, | |
| 360 NULL, | |
| 361 NULL, | |
| 362 ScalarFunctionDestroyer); | |
| 363 | |
| 364 if (err != SQLITE_OK) | |
| 365 { | |
| 366 delete func; | |
| 59 | 367 throw OrthancException("SQLite: Unable to register a function"); |
| 0 | 368 } |
| 369 | |
| 370 return func; | |
| 371 } | |
| 372 | |
| 373 } | |
| 374 } |