Mercurial > hg > orthanc-databases
annotate Framework/PostgreSQL/PostgreSQLStatement.cpp @ 59:318c1ccb787c
fix build with postgresql-11
| author | s.jodogne@gmail.com |
|---|---|
| date | Sun, 28 Oct 2018 12:29:22 +0100 |
| parents | 6a574d810b98 |
| children | 714c5d2bee76 |
| rev | line source |
|---|---|
| 0 | 1 /** |
| 2 * Orthanc - A Lightweight, RESTful DICOM Store | |
| 3 * Copyright (C) 2012-2016 Sebastien Jodogne, Medical Physics | |
| 4 * Department, University Hospital of Liege, Belgium | |
| 5 * Copyright (C) 2017-2018 Osimis S.A., Belgium | |
| 6 * | |
| 7 * This program is free software: you can redistribute it and/or | |
| 8 * modify it under the terms of the GNU Affero General Public License | |
| 9 * as published by the Free Software Foundation, either version 3 of | |
| 10 * the License, or (at your option) any later version. | |
| 11 * | |
| 12 * This program is distributed in the hope that it will be useful, but | |
| 13 * WITHOUT ANY WARRANTY; without even the implied warranty of | |
| 14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
| 15 * Affero General Public License for more details. | |
| 16 * | |
| 17 * You should have received a copy of the GNU Affero General Public License | |
| 18 * along with this program. If not, see <http://www.gnu.org/licenses/>. | |
| 19 **/ | |
| 20 | |
| 21 | |
| 22 #include "PostgreSQLStatement.h" | |
| 23 | |
| 24 #include "../Common/BinaryStringValue.h" | |
| 25 #include "../Common/FileValue.h" | |
| 26 #include "../Common/Integer64Value.h" | |
| 27 #include "../Common/NullValue.h" | |
| 28 #include "../Common/ResultBase.h" | |
| 29 #include "../Common/Utf8StringValue.h" | |
| 30 #include "PostgreSQLResult.h" | |
| 31 | |
| 59 | 32 #include <pg_config.h> |
| 33 | |
| 34 #if PG_VERSION_NUM >= 110000 | |
| 35 # include <postgres.h> | |
| 36 # undef LOG // This one comes from <postgres.h>, and conflicts with <Core/Logging.h> | |
| 37 #endif | |
| 38 | |
| 0 | 39 #include <Core/Logging.h> |
| 40 #include <Core/OrthancException.h> | |
| 41 #include <Core/Toolbox.h> | |
| 42 | |
| 43 #include <cassert> | |
| 44 | |
| 45 // PostgreSQL includes | |
| 46 #include <libpq-fe.h> | |
| 47 #include <c.h> | |
| 48 #include <catalog/pg_type.h> | |
| 49 | |
| 50 #include <Core/Endianness.h> | |
| 51 | |
| 52 | |
| 53 namespace OrthancDatabases | |
| 54 { | |
| 55 class PostgreSQLStatement::Inputs : public boost::noncopyable | |
| 56 { | |
| 57 private: | |
| 58 std::vector<char*> values_; | |
| 59 std::vector<int> sizes_; | |
| 60 | |
| 61 static char* Allocate(const void* source, int size) | |
| 62 { | |
| 63 if (size == 0) | |
| 64 { | |
| 65 return NULL; | |
| 66 } | |
| 67 else | |
| 68 { | |
| 69 char* ptr = reinterpret_cast<char*>(malloc(size)); | |
| 70 | |
| 71 if (source != NULL) | |
| 72 { | |
| 73 memcpy(ptr, source, size); | |
| 74 } | |
| 75 | |
| 76 return ptr; | |
| 77 } | |
| 78 } | |
| 79 | |
| 80 void Resize(size_t size) | |
| 81 { | |
| 82 // Shrinking of the vector | |
| 83 for (size_t i = size; i < values_.size(); i++) | |
| 84 { | |
| 85 if (values_[i] != NULL) | |
| 86 free(values_[i]); | |
| 87 } | |
| 88 | |
| 89 values_.resize(size, NULL); | |
| 90 sizes_.resize(size, 0); | |
| 91 } | |
| 92 | |
| 93 void EnlargeForIndex(size_t index) | |
| 94 { | |
| 95 if (index >= values_.size()) | |
| 96 { | |
| 97 // The vector is too small | |
| 98 Resize(index + 1); | |
| 99 } | |
| 100 } | |
| 101 | |
| 102 public: | |
| 103 Inputs() | |
| 104 { | |
| 105 } | |
| 106 | |
| 107 ~Inputs() | |
| 108 { | |
| 109 Resize(0); | |
| 110 } | |
| 111 | |
| 112 void SetItem(size_t pos, const void* source, int size) | |
| 113 { | |
| 114 EnlargeForIndex(pos); | |
| 115 | |
| 116 if (sizes_[pos] == size) | |
| 117 { | |
| 118 if (source && size != 0) | |
| 119 { | |
| 120 memcpy(values_[pos], source, size); | |
| 121 } | |
| 122 } | |
| 123 else | |
| 124 { | |
| 125 if (values_[pos] != NULL) | |
| 126 { | |
| 127 free(values_[pos]); | |
| 128 } | |
| 129 | |
| 130 values_[pos] = Allocate(source, size); | |
| 131 sizes_[pos] = size; | |
| 132 } | |
| 133 } | |
| 134 | |
| 135 void SetItem(size_t pos, int size) | |
| 136 { | |
| 137 SetItem(pos, NULL, size); | |
| 138 } | |
| 139 | |
| 140 void* GetItem(size_t pos) const | |
| 141 { | |
| 142 if (pos >= values_.size()) | |
| 143 { | |
| 144 throw Orthanc::OrthancException(Orthanc::ErrorCode_ParameterOutOfRange); | |
| 145 } | |
| 146 | |
| 147 return values_[pos]; | |
| 148 } | |
| 149 | |
| 150 const std::vector<char*>& GetValues() const | |
| 151 { | |
| 152 return values_; | |
| 153 } | |
| 154 | |
| 155 const std::vector<int>& GetSizes() const | |
| 156 { | |
| 157 return sizes_; | |
| 158 } | |
| 159 }; | |
| 160 | |
| 161 | |
| 162 void PostgreSQLStatement::Prepare() | |
| 163 { | |
| 164 if (id_.size() > 0) | |
| 165 { | |
| 166 // Already prepared | |
| 167 return; | |
| 168 } | |
| 169 | |
| 170 for (size_t i = 0; i < oids_.size(); i++) | |
| 171 { | |
| 172 if (oids_[i] == 0) | |
| 173 { | |
| 174 // The type of an input parameter was not set | |
| 175 throw Orthanc::OrthancException(Orthanc::ErrorCode_BadSequenceOfCalls); | |
| 176 } | |
| 177 } | |
| 178 | |
| 179 id_ = Orthanc::Toolbox::GenerateUuid(); | |
| 180 | |
| 181 const unsigned int* tmp = oids_.size() ? &oids_[0] : NULL; | |
| 182 | |
| 183 PGresult* result = PQprepare(reinterpret_cast<PGconn*>(database_.pg_), | |
| 184 id_.c_str(), sql_.c_str(), oids_.size(), tmp); | |
| 185 | |
| 186 if (result == NULL) | |
| 187 { | |
| 188 id_.clear(); | |
| 189 database_.ThrowException(true); | |
| 190 } | |
| 191 | |
| 192 bool ok = (PQresultStatus(result) == PGRES_COMMAND_OK); | |
| 193 if (ok) | |
| 194 { | |
| 195 PQclear(result); | |
| 196 } | |
| 197 else | |
| 198 { | |
| 199 std::string message = PQresultErrorMessage(result); | |
| 200 PQclear(result); | |
| 201 id_.clear(); | |
| 202 LOG(ERROR) << "PostgreSQL error: " << message; | |
| 203 database_.ThrowException(false); | |
| 204 } | |
| 205 } | |
| 206 | |
| 207 | |
| 208 void PostgreSQLStatement::Unprepare() | |
| 209 { | |
| 210 if (id_.size() > 0) | |
| 211 { | |
| 212 // "Although there is no libpq function for deleting a | |
| 213 // prepared statement, the SQL DEALLOCATE statement can be | |
| 214 // used for that purpose." | |
| 215 //database_.Execute("DEALLOCATE " + id_); | |
| 216 } | |
| 217 | |
| 218 id_.clear(); | |
| 219 } | |
| 220 | |
| 221 | |
| 222 void PostgreSQLStatement::DeclareInputInternal(unsigned int param, | |
| 223 unsigned int /*Oid*/ type) | |
| 224 { | |
| 225 Unprepare(); | |
| 226 | |
| 227 if (oids_.size() <= param) | |
| 228 { | |
| 229 oids_.resize(param + 1, 0); | |
| 230 binary_.resize(param + 1); | |
| 231 } | |
| 232 | |
| 233 oids_[param] = type; | |
| 234 binary_[param] = (type == TEXTOID || type == BYTEAOID || type == OIDOID) ? 0 : 1; | |
| 235 } | |
| 236 | |
| 237 | |
| 238 void PostgreSQLStatement::DeclareInputInteger(unsigned int param) | |
| 239 { | |
| 240 DeclareInputInternal(param, INT4OID); | |
| 241 } | |
| 242 | |
| 243 | |
| 244 void PostgreSQLStatement::DeclareInputInteger64(unsigned int param) | |
| 245 { | |
| 246 DeclareInputInternal(param, INT8OID); | |
| 247 } | |
| 248 | |
| 249 | |
| 250 void PostgreSQLStatement::DeclareInputString(unsigned int param) | |
| 251 { | |
| 252 DeclareInputInternal(param, TEXTOID); | |
| 253 } | |
| 254 | |
| 255 | |
| 256 void PostgreSQLStatement::DeclareInputBinary(unsigned int param) | |
| 257 { | |
| 258 DeclareInputInternal(param, BYTEAOID); | |
| 259 } | |
| 260 | |
| 261 | |
| 262 void PostgreSQLStatement::DeclareInputLargeObject(unsigned int param) | |
| 263 { | |
| 264 DeclareInputInternal(param, OIDOID); | |
| 265 } | |
| 266 | |
| 267 | |
| 268 void* /* PGresult* */ PostgreSQLStatement::Execute() | |
| 269 { | |
| 270 Prepare(); | |
| 271 | |
| 272 PGresult* result; | |
| 273 | |
| 274 if (oids_.size() == 0) | |
| 275 { | |
| 276 // No parameter | |
| 277 result = PQexecPrepared(reinterpret_cast<PGconn*>(database_.pg_), | |
| 278 id_.c_str(), 0, NULL, NULL, NULL, 1); | |
| 279 } | |
| 280 else | |
| 281 { | |
| 282 // At least 1 parameter | |
| 283 result = PQexecPrepared(reinterpret_cast<PGconn*>(database_.pg_), | |
| 284 id_.c_str(), | |
| 285 oids_.size(), | |
| 286 &inputs_->GetValues()[0], | |
| 287 &inputs_->GetSizes()[0], | |
| 288 &binary_[0], | |
| 289 1); | |
| 290 } | |
| 291 | |
| 292 if (result == NULL) | |
| 293 { | |
| 294 database_.ThrowException(true); | |
| 295 } | |
| 296 | |
| 297 return result; | |
| 298 } | |
| 299 | |
| 300 | |
| 301 PostgreSQLStatement::PostgreSQLStatement(PostgreSQLDatabase& database, | |
| 302 const std::string& sql, | |
| 303 bool readOnly) : | |
| 304 database_(database), | |
| 305 readOnly_(readOnly), | |
| 306 sql_(sql), | |
| 307 inputs_(new Inputs), | |
| 308 formatter_(Dialect_PostgreSQL) | |
| 309 { | |
| 310 LOG(TRACE) << "PostgreSQL: " << sql; | |
| 311 } | |
| 312 | |
| 313 | |
| 314 PostgreSQLStatement::PostgreSQLStatement(PostgreSQLDatabase& database, | |
| 315 const Query& query) : | |
| 316 database_(database), | |
| 317 readOnly_(query.IsReadOnly()), | |
| 318 inputs_(new Inputs), | |
| 319 formatter_(Dialect_PostgreSQL) | |
| 320 { | |
| 321 query.Format(sql_, formatter_); | |
| 322 LOG(TRACE) << "PostgreSQL: " << sql_; | |
| 323 | |
| 324 for (size_t i = 0; i < formatter_.GetParametersCount(); i++) | |
| 325 { | |
| 326 switch (formatter_.GetParameterType(i)) | |
| 327 { | |
| 328 case ValueType_Integer64: | |
| 329 DeclareInputInteger64(i); | |
| 330 break; | |
| 331 | |
| 332 case ValueType_Utf8String: | |
| 333 DeclareInputString(i); | |
| 334 break; | |
| 335 | |
| 336 case ValueType_BinaryString: | |
| 337 DeclareInputBinary(i); | |
| 338 break; | |
| 339 | |
| 340 case ValueType_File: | |
| 341 DeclareInputLargeObject(i); | |
| 342 break; | |
| 343 | |
| 344 case ValueType_Null: | |
| 345 default: | |
| 346 throw Orthanc::OrthancException(Orthanc::ErrorCode_NotImplemented); | |
| 347 } | |
| 348 } | |
| 349 } | |
| 350 | |
| 351 | |
|
46
6a574d810b98
Compatibility with MySQL 8.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
23
diff
changeset
|
352 PostgreSQLStatement::~PostgreSQLStatement() |
|
6a574d810b98
Compatibility with MySQL 8.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
23
diff
changeset
|
353 { |
|
6a574d810b98
Compatibility with MySQL 8.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
23
diff
changeset
|
354 try |
|
6a574d810b98
Compatibility with MySQL 8.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
23
diff
changeset
|
355 { |
|
6a574d810b98
Compatibility with MySQL 8.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
23
diff
changeset
|
356 Unprepare(); |
|
6a574d810b98
Compatibility with MySQL 8.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
23
diff
changeset
|
357 } |
|
6a574d810b98
Compatibility with MySQL 8.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
23
diff
changeset
|
358 catch (Orthanc::OrthancException&) |
|
6a574d810b98
Compatibility with MySQL 8.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
23
diff
changeset
|
359 { |
|
6a574d810b98
Compatibility with MySQL 8.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
23
diff
changeset
|
360 // Ignore possible exceptions due to connection loss |
|
6a574d810b98
Compatibility with MySQL 8.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
23
diff
changeset
|
361 } |
|
6a574d810b98
Compatibility with MySQL 8.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
23
diff
changeset
|
362 } |
|
6a574d810b98
Compatibility with MySQL 8.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
23
diff
changeset
|
363 |
|
6a574d810b98
Compatibility with MySQL 8.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
23
diff
changeset
|
364 |
| 0 | 365 void PostgreSQLStatement::Run() |
| 366 { | |
| 367 PGresult* result = reinterpret_cast<PGresult*>(Execute()); | |
| 368 assert(result != NULL); // An exception would have been thrown otherwise | |
| 369 | |
| 370 bool ok = (PQresultStatus(result) == PGRES_COMMAND_OK || | |
| 371 PQresultStatus(result) == PGRES_TUPLES_OK); | |
| 372 if (ok) | |
| 373 { | |
| 374 PQclear(result); | |
| 375 } | |
| 376 else | |
| 377 { | |
| 378 std::string error = PQresultErrorMessage(result); | |
| 379 PQclear(result); | |
| 380 LOG(ERROR) << "PostgreSQL error: " << error; | |
| 381 database_.ThrowException(false); | |
| 382 } | |
| 383 } | |
| 384 | |
| 385 | |
| 386 void PostgreSQLStatement::BindNull(unsigned int param) | |
| 387 { | |
| 388 if (param >= oids_.size()) | |
| 389 { | |
| 390 throw Orthanc::OrthancException(Orthanc::ErrorCode_ParameterOutOfRange); | |
| 391 } | |
| 392 | |
| 393 inputs_->SetItem(param, 0); | |
| 394 } | |
| 395 | |
| 396 | |
| 397 void PostgreSQLStatement::BindInteger(unsigned int param, | |
| 398 int value) | |
| 399 { | |
| 400 if (param >= oids_.size()) | |
| 401 { | |
| 402 throw Orthanc::OrthancException(Orthanc::ErrorCode_ParameterOutOfRange); | |
| 403 } | |
| 404 | |
| 405 if (oids_[param] != INT4OID) | |
| 406 { | |
| 407 throw Orthanc::OrthancException(Orthanc::ErrorCode_BadParameterType); | |
| 408 } | |
| 409 | |
| 410 assert(sizeof(int32_t) == 4); | |
| 411 int32_t v = htobe32(static_cast<int32_t>(value)); | |
| 412 inputs_->SetItem(param, &v, sizeof(int32_t)); | |
| 413 } | |
| 414 | |
| 415 | |
| 416 void PostgreSQLStatement::BindInteger64(unsigned int param, | |
| 417 int64_t value) | |
| 418 { | |
| 419 if (param >= oids_.size()) | |
| 420 { | |
| 421 throw Orthanc::OrthancException(Orthanc::ErrorCode_ParameterOutOfRange); | |
| 422 } | |
| 423 | |
| 424 if (oids_[param] != INT8OID) | |
| 425 { | |
| 426 throw Orthanc::OrthancException(Orthanc::ErrorCode_BadParameterType); | |
| 427 } | |
| 428 | |
| 429 assert(sizeof(int64_t) == 8); | |
| 430 int64_t v = htobe64(value); | |
| 431 inputs_->SetItem(param, &v, sizeof(int64_t)); | |
| 432 } | |
| 433 | |
| 434 | |
| 435 void PostgreSQLStatement::BindString(unsigned int param, | |
| 436 const std::string& value) | |
| 437 { | |
| 438 if (param >= oids_.size()) | |
| 439 { | |
| 440 throw Orthanc::OrthancException(Orthanc::ErrorCode_ParameterOutOfRange); | |
| 441 } | |
| 442 | |
| 443 if (oids_[param] != TEXTOID && oids_[param] != BYTEAOID) | |
| 444 { | |
| 445 throw Orthanc::OrthancException(Orthanc::ErrorCode_BadParameterType); | |
| 446 } | |
| 447 | |
| 448 if (value.size() == 0) | |
| 449 { | |
| 450 inputs_->SetItem(param, "", 1 /* end-of-string character */); | |
| 451 } | |
| 452 else | |
| 453 { | |
| 454 inputs_->SetItem(param, value.c_str(), | |
| 455 value.size() + 1); // "+1" for end-of-string character | |
| 456 } | |
| 457 } | |
| 458 | |
| 459 | |
| 460 void PostgreSQLStatement::BindLargeObject(unsigned int param, | |
| 461 const PostgreSQLLargeObject& value) | |
| 462 { | |
| 463 if (param >= oids_.size()) | |
| 464 { | |
| 465 throw Orthanc::OrthancException(Orthanc::ErrorCode_ParameterOutOfRange); | |
| 466 } | |
| 467 | |
| 468 if (oids_[param] != OIDOID) | |
| 469 { | |
| 470 throw Orthanc::OrthancException(Orthanc::ErrorCode_BadParameterType); | |
| 471 } | |
| 472 | |
| 473 inputs_->SetItem(param, value.GetOid().c_str(), | |
| 474 value.GetOid().size() + 1); // "+1" for end-of-string character | |
| 475 } | |
| 476 | |
| 477 | |
| 478 class PostgreSQLStatement::ResultWrapper : public ResultBase | |
| 479 { | |
| 480 private: | |
| 481 std::auto_ptr<PostgreSQLResult> result_; | |
| 482 | |
| 483 protected: | |
| 484 virtual IValue* FetchField(size_t index) | |
| 485 { | |
| 486 return result_->GetValue(index); | |
| 487 } | |
| 488 | |
| 489 public: | |
| 490 ResultWrapper(PostgreSQLStatement& statement) : | |
| 491 result_(new PostgreSQLResult(statement)) | |
| 492 { | |
| 493 SetFieldsCount(result_->GetColumnsCount()); | |
| 494 FetchFields(); | |
| 495 } | |
| 496 | |
| 497 virtual void Next() | |
| 498 { | |
| 499 result_->Next(); | |
| 500 FetchFields(); | |
| 501 } | |
| 502 | |
| 503 virtual bool IsDone() const | |
| 504 { | |
| 505 return result_->IsDone(); | |
| 506 } | |
| 507 }; | |
| 508 | |
| 509 | |
|
23
b2ff1cd2907a
handling of implicit transactions in DatabaseManager
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
510 IResult* PostgreSQLStatement::Execute(ITransaction& transaction, |
| 0 | 511 const Dictionary& parameters) |
| 512 { | |
| 513 for (size_t i = 0; i < formatter_.GetParametersCount(); i++) | |
| 514 { | |
| 515 const std::string& name = formatter_.GetParameterName(i); | |
| 516 | |
| 517 switch (formatter_.GetParameterType(i)) | |
| 518 { | |
| 519 case ValueType_Integer64: | |
| 520 BindInteger64(i, dynamic_cast<const Integer64Value&>(parameters.GetValue(name)).GetValue()); | |
| 521 break; | |
| 522 | |
| 523 case ValueType_Null: | |
| 524 BindNull(i); | |
| 525 break; | |
| 526 | |
| 527 case ValueType_Utf8String: | |
| 528 BindString(i, dynamic_cast<const Utf8StringValue&> | |
| 529 (parameters.GetValue(name)).GetContent()); | |
| 530 break; | |
| 531 | |
| 532 case ValueType_BinaryString: | |
| 533 BindString(i, dynamic_cast<const BinaryStringValue&> | |
| 534 (parameters.GetValue(name)).GetContent()); | |
| 535 break; | |
| 536 | |
| 537 case ValueType_File: | |
| 538 { | |
| 539 const FileValue& blob = | |
| 540 dynamic_cast<const FileValue&>(parameters.GetValue(name)); | |
| 541 | |
| 542 PostgreSQLLargeObject largeObject(database_, blob.GetContent()); | |
| 543 BindLargeObject(i, largeObject); | |
| 544 break; | |
| 545 } | |
| 546 | |
| 547 default: | |
| 548 throw Orthanc::OrthancException(Orthanc::ErrorCode_InternalError); | |
| 549 } | |
| 550 } | |
| 551 | |
| 552 return new ResultWrapper(*this); | |
| 553 } | |
| 554 | |
| 555 | |
|
23
b2ff1cd2907a
handling of implicit transactions in DatabaseManager
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
556 void PostgreSQLStatement::ExecuteWithoutResult(ITransaction& transaction, |
| 0 | 557 const Dictionary& parameters) |
| 558 { | |
| 559 std::auto_ptr<IResult> dummy(Execute(transaction, parameters)); | |
| 560 } | |
| 561 } |