Mercurial > hg > orthanc-databases
annotate Framework/PostgreSQL/PostgreSQLParameters.cpp @ 474:b363f94084c0 OrthancPostgreSQL-6.1
6.1
author | Alain Mazy <am@osimis.io> |
---|---|
date | Wed, 14 Feb 2024 15:06:44 +0100 |
parents | ff84104f7842 |
children | 4a76aca03774 |
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 | |
459
ecd0b719cff5
update year to 2024
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
389
diff
changeset
|
5 * Copyright (C) 2017-2024 Osimis S.A., Belgium |
ecd0b719cff5
update year to 2024
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
389
diff
changeset
|
6 * Copyright (C) 2021-2024 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 |
467
ff84104f7842
renamed v6.2 to REV2 + removed 'default' TransactionMode + renamed 'READ COMMITTED' into 'ReadCommitted'
Alain Mazy <am@osimis.io>
parents:
460
diff
changeset
|
103 std::string transactionMode = configuration.GetStringValue("TransactionMode", "Serializable"); |
ff84104f7842
renamed v6.2 to REV2 + removed 'default' TransactionMode + renamed 'READ COMMITTED' into 'ReadCommitted'
Alain Mazy <am@osimis.io>
parents:
460
diff
changeset
|
104 if (transactionMode == "ReadCommitted") |
432
8b7c1c423367
new 'TransactionMode' config + rewrote ResourceDeletedFunc to avoid IF/THEN/ELSE pattern
Alain Mazy <am@osimis.io>
parents:
429
diff
changeset
|
105 { |
457 | 106 LOG(WARNING) << "PostgreSQL: using READ COMMITTED transaction mode"; |
432
8b7c1c423367
new 'TransactionMode' config + rewrote ResourceDeletedFunc to avoid IF/THEN/ELSE pattern
Alain Mazy <am@osimis.io>
parents:
429
diff
changeset
|
107 SetIsolationMode(IsolationMode_ReadCommited); |
370
d2b5d9c92214
PG: test feature: configurable transaction isolation level
Alain Mazy <am@osimis.io>
parents:
359
diff
changeset
|
108 } |
467
ff84104f7842
renamed v6.2 to REV2 + removed 'default' TransactionMode + renamed 'READ COMMITTED' into 'ReadCommitted'
Alain Mazy <am@osimis.io>
parents:
460
diff
changeset
|
109 else if (transactionMode == "Serializable") |
370
d2b5d9c92214
PG: test feature: configurable transaction isolation level
Alain Mazy <am@osimis.io>
parents:
359
diff
changeset
|
110 { |
457 | 111 LOG(WARNING) << "PostgreSQL: using SERIALIZABLE transaction mode"; |
432
8b7c1c423367
new 'TransactionMode' config + rewrote ResourceDeletedFunc to avoid IF/THEN/ELSE pattern
Alain Mazy <am@osimis.io>
parents:
429
diff
changeset
|
112 SetIsolationMode(IsolationMode_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 else |
8b7c1c423367
new 'TransactionMode' config + rewrote ResourceDeletedFunc to avoid IF/THEN/ELSE pattern
Alain Mazy <am@osimis.io>
parents:
429
diff
changeset
|
115 { |
8b7c1c423367
new 'TransactionMode' config + rewrote ResourceDeletedFunc to avoid IF/THEN/ELSE pattern
Alain Mazy <am@osimis.io>
parents:
429
diff
changeset
|
116 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
|
117 } |
0 | 118 } |
119 | |
120 | |
121 void PostgreSQLParameters::SetConnectionUri(const std::string& uri) | |
122 { | |
123 uri_ = uri; | |
124 } | |
125 | |
126 | |
127 std::string PostgreSQLParameters::GetConnectionUri() const | |
128 { | |
129 if (uri_.empty()) | |
130 { | |
131 std::string actualUri = "postgresql://"; | |
132 | |
133 if (!username_.empty()) | |
134 { | |
135 actualUri += username_; | |
136 | |
137 if (!password_.empty()) | |
138 { | |
139 actualUri += ":" + password_; | |
140 } | |
141 | |
142 actualUri += "@" + host_; | |
143 } | |
144 else | |
145 { | |
146 actualUri += host_; | |
147 } | |
148 | |
149 if (port_ > 0) | |
150 { | |
151 actualUri += ":" + boost::lexical_cast<std::string>(port_); | |
152 } | |
153 | |
154 actualUri += "/" + database_; | |
155 | |
156 return actualUri; | |
157 } | |
158 else | |
159 { | |
160 return uri_; | |
161 } | |
162 } | |
163 | |
164 | |
165 void PostgreSQLParameters::SetHost(const std::string& host) | |
166 { | |
167 uri_.clear(); | |
168 host_ = host; | |
169 } | |
170 | |
171 void PostgreSQLParameters::SetPortNumber(unsigned int port) | |
172 { | |
252 | 173 if (port == 0 || |
0 | 174 port >= 65535) |
175 { | |
176 throw Orthanc::OrthancException(Orthanc::ErrorCode_ParameterOutOfRange); | |
177 } | |
178 | |
179 uri_.clear(); | |
180 port_ = port; | |
181 } | |
182 | |
183 void PostgreSQLParameters::SetUsername(const std::string& username) | |
184 { | |
185 uri_.clear(); | |
186 username_ = username; | |
187 } | |
188 | |
189 void PostgreSQLParameters::SetPassword(const std::string& password) | |
190 { | |
191 uri_.clear(); | |
192 password_ = password; | |
193 } | |
194 | |
195 void PostgreSQLParameters::SetDatabase(const std::string& database) | |
196 { | |
197 uri_.clear(); | |
198 database_ = database; | |
199 } | |
200 | |
201 void PostgreSQLParameters::Format(std::string& target) const | |
202 { | |
203 if (uri_.empty()) | |
204 { | |
80
16df1a6ea452
Fix issue 105 (Unable to connect to PostgreSQL database using SSL)
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
67
diff
changeset
|
205 // 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
|
206 // 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
|
207 // 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
|
208 // 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
|
209 target = std::string(ssl_ ? "sslmode=require" : "sslmode=disable") + |
0 | 210 " user=" + username_ + |
211 " host=" + host_ + | |
212 " port=" + boost::lexical_cast<std::string>(port_); | |
213 | |
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
|
214 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
|
215 { |
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 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
|
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 |
0 | 219 if (database_.size() > 0) |
220 { | |
221 target += " dbname=" + database_; | |
222 } | |
223 } | |
224 else | |
225 { | |
226 target = uri_; | |
227 } | |
228 } | |
229 } |