Mercurial > hg > orthanc-databases
annotate Framework/PostgreSQL/PostgreSQLParameters.cpp @ 432:8b7c1c423367 pg-transactions
new 'TransactionMode' config + rewrote ResourceDeletedFunc to avoid IF/THEN/ELSE pattern
| author | Alain Mazy <am@osimis.io> |
|---|---|
| date | Mon, 11 Dec 2023 14:39:27 +0100 |
| parents | dbf811b1bb43 |
| children | 2f3b0688548e |
| 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 | |
|
389
3d6886f3e5b3
upgrade to year 2023
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
359
diff
changeset
|
5 * Copyright (C) 2017-2023 Osimis S.A., Belgium |
|
3d6886f3e5b3
upgrade to year 2023
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
359
diff
changeset
|
6 * Copyright (C) 2021-2023 Sebastien Jodogne, ICTEAM UCLouvain, Belgium |
| 0 | 7 * |
| 8 * This program is free software: you can redistribute it and/or | |
| 9 * modify it under the terms of the GNU Affero General Public License | |
| 10 * as published by the Free Software Foundation, either version 3 of | |
| 11 * the License, or (at your option) any later version. | |
| 12 * | |
| 13 * This program is distributed in the hope that it will be useful, but | |
| 14 * WITHOUT ANY WARRANTY; without even the implied warranty of | |
| 15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
| 16 * Affero General Public License for more details. | |
| 17 * | |
| 18 * You should have received a copy of the GNU Affero General Public License | |
| 19 * along with this program. If not, see <http://www.gnu.org/licenses/>. | |
| 20 **/ | |
| 21 | |
| 22 | |
| 23 #include "PostgreSQLParameters.h" | |
| 24 | |
| 152 | 25 #include <Logging.h> |
| 26 #include <OrthancException.h> | |
| 0 | 27 |
| 28 #include <boost/lexical_cast.hpp> | |
| 29 | |
| 30 | |
| 31 namespace OrthancDatabases | |
| 32 { | |
| 33 void PostgreSQLParameters::Reset() | |
| 34 { | |
| 35 host_ = "localhost"; | |
| 36 port_ = 5432; | |
| 37 username_ = ""; | |
| 38 password_ = ""; | |
| 39 database_.clear(); | |
| 40 uri_.clear(); | |
|
80
16df1a6ea452
Fix issue 105 (Unable to connect to PostgreSQL database using SSL)
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
67
diff
changeset
|
41 ssl_ = false; |
| 0 | 42 lock_ = true; |
|
141
0b3e9ee53c46
Added 'MaximumConnectionRetries' & 'ConnectionRetryInterval' to configure the retries when connecting to the DB at startup
Alain Mazy <alain@mazy.be>
parents:
140
diff
changeset
|
43 maxConnectionRetries_ = 10; |
|
0b3e9ee53c46
Added 'MaximumConnectionRetries' & 'ConnectionRetryInterval' to configure the retries when connecting to the DB at startup
Alain Mazy <alain@mazy.be>
parents:
140
diff
changeset
|
44 connectionRetryInterval_ = 5; |
|
429
dbf811b1bb43
new configuration 'EnableVerboseLogs' to log SQL statements being executed
Alain Mazy <am@osimis.io>
parents:
417
diff
changeset
|
45 isVerboseEnabled_ = false; |
| 0 | 46 } |
| 47 | |
| 48 | |
| 49 PostgreSQLParameters::PostgreSQLParameters() | |
| 50 { | |
| 51 Reset(); | |
| 52 } | |
| 53 | |
| 54 | |
| 55 PostgreSQLParameters::PostgreSQLParameters(const OrthancPlugins::OrthancConfiguration& configuration) | |
| 56 { | |
| 57 Reset(); | |
| 58 | |
| 59 std::string s; | |
| 60 | |
| 61 if (configuration.LookupStringValue(s, "ConnectionUri")) | |
| 62 { | |
| 63 SetConnectionUri(s); | |
| 64 } | |
| 65 else | |
| 66 { | |
| 67 if (configuration.LookupStringValue(s, "Host")) | |
| 68 { | |
| 69 SetHost(s); | |
| 70 } | |
| 71 | |
| 72 unsigned int port; | |
| 73 if (configuration.LookupUnsignedIntegerValue(port, "Port")) | |
| 74 { | |
| 75 SetPortNumber(port); | |
| 76 } | |
| 77 | |
| 78 if (configuration.LookupStringValue(s, "Database")) | |
| 79 { | |
| 80 SetDatabase(s); | |
| 81 } | |
| 82 | |
| 83 if (configuration.LookupStringValue(s, "Username")) | |
| 84 { | |
| 85 SetUsername(s); | |
| 86 } | |
| 87 | |
| 88 if (configuration.LookupStringValue(s, "Password")) | |
| 89 { | |
| 90 SetPassword(s); | |
| 91 } | |
|
80
16df1a6ea452
Fix issue 105 (Unable to connect to PostgreSQL database using SSL)
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
67
diff
changeset
|
92 |
|
16df1a6ea452
Fix issue 105 (Unable to connect to PostgreSQL database using SSL)
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
67
diff
changeset
|
93 ssl_ = configuration.GetBooleanValue("EnableSsl", false); |
| 0 | 94 } |
| 95 | |
| 96 lock_ = configuration.GetBooleanValue("Lock", true); // Use locking by default | |
|
141
0b3e9ee53c46
Added 'MaximumConnectionRetries' & 'ConnectionRetryInterval' to configure the retries when connecting to the DB at startup
Alain Mazy <alain@mazy.be>
parents:
140
diff
changeset
|
97 |
|
429
dbf811b1bb43
new configuration 'EnableVerboseLogs' to log SQL statements being executed
Alain Mazy <am@osimis.io>
parents:
417
diff
changeset
|
98 isVerboseEnabled_ = configuration.GetBooleanValue("EnableVerboseLogs", false); |
|
dbf811b1bb43
new configuration 'EnableVerboseLogs' to log SQL statements being executed
Alain Mazy <am@osimis.io>
parents:
417
diff
changeset
|
99 |
|
141
0b3e9ee53c46
Added 'MaximumConnectionRetries' & 'ConnectionRetryInterval' to configure the retries when connecting to the DB at startup
Alain Mazy <alain@mazy.be>
parents:
140
diff
changeset
|
100 maxConnectionRetries_ = configuration.GetUnsignedIntegerValue("MaximumConnectionRetries", 10); |
|
0b3e9ee53c46
Added 'MaximumConnectionRetries' & 'ConnectionRetryInterval' to configure the retries when connecting to the DB at startup
Alain Mazy <alain@mazy.be>
parents:
140
diff
changeset
|
101 connectionRetryInterval_ = configuration.GetUnsignedIntegerValue("ConnectionRetryInterval", 5); |
|
370
d2b5d9c92214
PG: test feature: configurable transaction isolation level
Alain Mazy <am@osimis.io>
parents:
359
diff
changeset
|
102 |
|
432
8b7c1c423367
new 'TransactionMode' config + rewrote ResourceDeletedFunc to avoid IF/THEN/ELSE pattern
Alain Mazy <am@osimis.io>
parents:
429
diff
changeset
|
103 std::string transactionMode = configuration.GetStringValue("TransactionMode", "SERIALIZABLE"); |
|
8b7c1c423367
new 'TransactionMode' config + rewrote ResourceDeletedFunc to avoid IF/THEN/ELSE pattern
Alain Mazy <am@osimis.io>
parents:
429
diff
changeset
|
104 if (transactionMode == "DEFAULT") |
|
370
d2b5d9c92214
PG: test feature: configurable transaction isolation level
Alain Mazy <am@osimis.io>
parents:
359
diff
changeset
|
105 { |
|
432
8b7c1c423367
new 'TransactionMode' config + rewrote ResourceDeletedFunc to avoid IF/THEN/ELSE pattern
Alain Mazy <am@osimis.io>
parents:
429
diff
changeset
|
106 SetIsolationMode(IsolationMode_DbDefault); |
|
8b7c1c423367
new 'TransactionMode' config + rewrote ResourceDeletedFunc to avoid IF/THEN/ELSE pattern
Alain Mazy <am@osimis.io>
parents:
429
diff
changeset
|
107 } |
|
8b7c1c423367
new 'TransactionMode' config + rewrote ResourceDeletedFunc to avoid IF/THEN/ELSE pattern
Alain Mazy <am@osimis.io>
parents:
429
diff
changeset
|
108 else if (transactionMode == "READ COMMITTED") |
|
8b7c1c423367
new 'TransactionMode' config + rewrote ResourceDeletedFunc to avoid IF/THEN/ELSE pattern
Alain Mazy <am@osimis.io>
parents:
429
diff
changeset
|
109 { |
|
8b7c1c423367
new 'TransactionMode' config + rewrote ResourceDeletedFunc to avoid IF/THEN/ELSE pattern
Alain Mazy <am@osimis.io>
parents:
429
diff
changeset
|
110 SetIsolationMode(IsolationMode_ReadCommited); |
|
370
d2b5d9c92214
PG: test feature: configurable transaction isolation level
Alain Mazy <am@osimis.io>
parents:
359
diff
changeset
|
111 } |
|
432
8b7c1c423367
new 'TransactionMode' config + rewrote ResourceDeletedFunc to avoid IF/THEN/ELSE pattern
Alain Mazy <am@osimis.io>
parents:
429
diff
changeset
|
112 else if (transactionMode == "SERIALIZABLE") |
|
370
d2b5d9c92214
PG: test feature: configurable transaction isolation level
Alain Mazy <am@osimis.io>
parents:
359
diff
changeset
|
113 { |
|
432
8b7c1c423367
new 'TransactionMode' config + rewrote ResourceDeletedFunc to avoid IF/THEN/ELSE pattern
Alain Mazy <am@osimis.io>
parents:
429
diff
changeset
|
114 SetIsolationMode(IsolationMode_Serializable); |
|
370
d2b5d9c92214
PG: test feature: configurable transaction isolation level
Alain Mazy <am@osimis.io>
parents:
359
diff
changeset
|
115 } |
|
432
8b7c1c423367
new 'TransactionMode' config + rewrote ResourceDeletedFunc to avoid IF/THEN/ELSE pattern
Alain Mazy <am@osimis.io>
parents:
429
diff
changeset
|
116 else |
|
8b7c1c423367
new 'TransactionMode' config + rewrote ResourceDeletedFunc to avoid IF/THEN/ELSE pattern
Alain Mazy <am@osimis.io>
parents:
429
diff
changeset
|
117 { |
|
8b7c1c423367
new 'TransactionMode' config + rewrote ResourceDeletedFunc to avoid IF/THEN/ELSE pattern
Alain Mazy <am@osimis.io>
parents:
429
diff
changeset
|
118 throw Orthanc::OrthancException(Orthanc::ErrorCode_BadParameterType, std::string("Invalid value for 'TransactionMode': ") + transactionMode); |
|
8b7c1c423367
new 'TransactionMode' config + rewrote ResourceDeletedFunc to avoid IF/THEN/ELSE pattern
Alain Mazy <am@osimis.io>
parents:
429
diff
changeset
|
119 } |
| 0 | 120 } |
| 121 | |
| 122 | |
| 123 void PostgreSQLParameters::SetConnectionUri(const std::string& uri) | |
| 124 { | |
| 125 uri_ = uri; | |
| 126 } | |
| 127 | |
| 128 | |
| 129 std::string PostgreSQLParameters::GetConnectionUri() const | |
| 130 { | |
| 131 if (uri_.empty()) | |
| 132 { | |
| 133 std::string actualUri = "postgresql://"; | |
| 134 | |
| 135 if (!username_.empty()) | |
| 136 { | |
| 137 actualUri += username_; | |
| 138 | |
| 139 if (!password_.empty()) | |
| 140 { | |
| 141 actualUri += ":" + password_; | |
| 142 } | |
| 143 | |
| 144 actualUri += "@" + host_; | |
| 145 } | |
| 146 else | |
| 147 { | |
| 148 actualUri += host_; | |
| 149 } | |
| 150 | |
| 151 if (port_ > 0) | |
| 152 { | |
| 153 actualUri += ":" + boost::lexical_cast<std::string>(port_); | |
| 154 } | |
| 155 | |
| 156 actualUri += "/" + database_; | |
| 157 | |
| 158 return actualUri; | |
| 159 } | |
| 160 else | |
| 161 { | |
| 162 return uri_; | |
| 163 } | |
| 164 } | |
| 165 | |
| 166 | |
| 167 void PostgreSQLParameters::SetHost(const std::string& host) | |
| 168 { | |
| 169 uri_.clear(); | |
| 170 host_ = host; | |
| 171 } | |
| 172 | |
| 173 void PostgreSQLParameters::SetPortNumber(unsigned int port) | |
| 174 { | |
| 252 | 175 if (port == 0 || |
| 0 | 176 port >= 65535) |
| 177 { | |
| 178 throw Orthanc::OrthancException(Orthanc::ErrorCode_ParameterOutOfRange); | |
| 179 } | |
| 180 | |
| 181 uri_.clear(); | |
| 182 port_ = port; | |
| 183 } | |
| 184 | |
| 185 void PostgreSQLParameters::SetUsername(const std::string& username) | |
| 186 { | |
| 187 uri_.clear(); | |
| 188 username_ = username; | |
| 189 } | |
| 190 | |
| 191 void PostgreSQLParameters::SetPassword(const std::string& password) | |
| 192 { | |
| 193 uri_.clear(); | |
| 194 password_ = password; | |
| 195 } | |
| 196 | |
| 197 void PostgreSQLParameters::SetDatabase(const std::string& database) | |
| 198 { | |
| 199 uri_.clear(); | |
| 200 database_ = database; | |
| 201 } | |
| 202 | |
| 203 void PostgreSQLParameters::Format(std::string& target) const | |
| 204 { | |
| 205 if (uri_.empty()) | |
| 206 { | |
|
80
16df1a6ea452
Fix issue 105 (Unable to connect to PostgreSQL database using SSL)
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
67
diff
changeset
|
207 // Note about SSL: "require" means that "I want my data to be |
|
16df1a6ea452
Fix issue 105 (Unable to connect to PostgreSQL database using SSL)
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
67
diff
changeset
|
208 // encrypted, and I accept the overhead. I trust that the |
|
16df1a6ea452
Fix issue 105 (Unable to connect to PostgreSQL database using SSL)
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
67
diff
changeset
|
209 // network will make sure I always connect to the server I want." |
|
16df1a6ea452
Fix issue 105 (Unable to connect to PostgreSQL database using SSL)
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
67
diff
changeset
|
210 // https://www.postgresql.org/docs/current/libpq-ssl.html |
|
16df1a6ea452
Fix issue 105 (Unable to connect to PostgreSQL database using SSL)
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
67
diff
changeset
|
211 target = std::string(ssl_ ? "sslmode=require" : "sslmode=disable") + |
| 0 | 212 " user=" + username_ + |
| 213 " host=" + host_ + | |
| 214 " port=" + boost::lexical_cast<std::string>(port_); | |
| 215 | |
|
10
3686ba3f9cdb
don't include password in connection string if it is empty; it's seems its not supported by some pg drivers
am@osimis.io
parents:
0
diff
changeset
|
216 if (!password_.empty()) |
|
3686ba3f9cdb
don't include password in connection string if it is empty; it's seems its not supported by some pg drivers
am@osimis.io
parents:
0
diff
changeset
|
217 { |
|
3686ba3f9cdb
don't include password in connection string if it is empty; it's seems its not supported by some pg drivers
am@osimis.io
parents:
0
diff
changeset
|
218 target += " password=" + password_; |
|
3686ba3f9cdb
don't include password in connection string if it is empty; it's seems its not supported by some pg drivers
am@osimis.io
parents:
0
diff
changeset
|
219 } |
|
3686ba3f9cdb
don't include password in connection string if it is empty; it's seems its not supported by some pg drivers
am@osimis.io
parents:
0
diff
changeset
|
220 |
| 0 | 221 if (database_.size() > 0) |
| 222 { | |
| 223 target += " dbname=" + database_; | |
| 224 } | |
| 225 } | |
| 226 else | |
| 227 { | |
| 228 target = uri_; | |
| 229 } | |
| 230 } | |
| 231 } |