Mercurial > hg > orthanc-databases
annotate Framework/PostgreSQL/PostgreSQLParameters.cpp @ 429:dbf811b1bb43 pg-transactions
new configuration 'EnableVerboseLogs' to log SQL statements being executed
author | Alain Mazy <am@osimis.io> |
---|---|
date | Thu, 30 Nov 2023 14:47:23 +0100 |
parents | 15bfd9a76f8d |
children | 8b7c1c423367 |
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; |
370
d2b5d9c92214
PG: test feature: configurable transaction isolation level
Alain Mazy <am@osimis.io>
parents:
359
diff
changeset
|
45 readWriteTransactionStatement_ = "SET TRANSACTION ISOLATION LEVEL SERIALIZABLE READ WRITE"; |
d2b5d9c92214
PG: test feature: configurable transaction isolation level
Alain Mazy <am@osimis.io>
parents:
359
diff
changeset
|
46 readOnlyTransactionStatement_ = "SET TRANSACTION ISOLATION LEVEL SERIALIZABLE READ ONLY"; |
429
dbf811b1bb43
new configuration 'EnableVerboseLogs' to log SQL statements being executed
Alain Mazy <am@osimis.io>
parents:
417
diff
changeset
|
47 isVerboseEnabled_ = false; |
0 | 48 } |
49 | |
50 | |
51 PostgreSQLParameters::PostgreSQLParameters() | |
52 { | |
53 Reset(); | |
54 } | |
55 | |
56 | |
57 PostgreSQLParameters::PostgreSQLParameters(const OrthancPlugins::OrthancConfiguration& configuration) | |
58 { | |
59 Reset(); | |
60 | |
61 std::string s; | |
62 | |
63 if (configuration.LookupStringValue(s, "ConnectionUri")) | |
64 { | |
65 SetConnectionUri(s); | |
66 } | |
67 else | |
68 { | |
69 if (configuration.LookupStringValue(s, "Host")) | |
70 { | |
71 SetHost(s); | |
72 } | |
73 | |
74 unsigned int port; | |
75 if (configuration.LookupUnsignedIntegerValue(port, "Port")) | |
76 { | |
77 SetPortNumber(port); | |
78 } | |
79 | |
80 if (configuration.LookupStringValue(s, "Database")) | |
81 { | |
82 SetDatabase(s); | |
83 } | |
84 | |
85 if (configuration.LookupStringValue(s, "Username")) | |
86 { | |
87 SetUsername(s); | |
88 } | |
89 | |
90 if (configuration.LookupStringValue(s, "Password")) | |
91 { | |
92 SetPassword(s); | |
93 } | |
80
16df1a6ea452
Fix issue 105 (Unable to connect to PostgreSQL database using SSL)
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
67
diff
changeset
|
94 |
16df1a6ea452
Fix issue 105 (Unable to connect to PostgreSQL database using SSL)
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
67
diff
changeset
|
95 ssl_ = configuration.GetBooleanValue("EnableSsl", false); |
0 | 96 } |
97 | |
98 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
|
99 |
429
dbf811b1bb43
new configuration 'EnableVerboseLogs' to log SQL statements being executed
Alain Mazy <am@osimis.io>
parents:
417
diff
changeset
|
100 isVerboseEnabled_ = configuration.GetBooleanValue("EnableVerboseLogs", false); |
dbf811b1bb43
new configuration 'EnableVerboseLogs' to log SQL statements being executed
Alain Mazy <am@osimis.io>
parents:
417
diff
changeset
|
101 |
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
|
102 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
|
103 connectionRetryInterval_ = configuration.GetUnsignedIntegerValue("ConnectionRetryInterval", 5); |
370
d2b5d9c92214
PG: test feature: configurable transaction isolation level
Alain Mazy <am@osimis.io>
parents:
359
diff
changeset
|
104 |
d2b5d9c92214
PG: test feature: configurable transaction isolation level
Alain Mazy <am@osimis.io>
parents:
359
diff
changeset
|
105 if (configuration.LookupStringValue(s, "ReadWriteTransactionStatement")) |
d2b5d9c92214
PG: test feature: configurable transaction isolation level
Alain Mazy <am@osimis.io>
parents:
359
diff
changeset
|
106 { |
d2b5d9c92214
PG: test feature: configurable transaction isolation level
Alain Mazy <am@osimis.io>
parents:
359
diff
changeset
|
107 SetReadWriteTransactionStatement(s); |
d2b5d9c92214
PG: test feature: configurable transaction isolation level
Alain Mazy <am@osimis.io>
parents:
359
diff
changeset
|
108 } |
d2b5d9c92214
PG: test feature: configurable transaction isolation level
Alain Mazy <am@osimis.io>
parents:
359
diff
changeset
|
109 |
d2b5d9c92214
PG: test feature: configurable transaction isolation level
Alain Mazy <am@osimis.io>
parents:
359
diff
changeset
|
110 if (configuration.LookupStringValue(s, "ReadOnlyTransactionStatement")) |
d2b5d9c92214
PG: test feature: configurable transaction isolation level
Alain Mazy <am@osimis.io>
parents:
359
diff
changeset
|
111 { |
d2b5d9c92214
PG: test feature: configurable transaction isolation level
Alain Mazy <am@osimis.io>
parents:
359
diff
changeset
|
112 SetReadOnlyTransactionStatement(s); |
d2b5d9c92214
PG: test feature: configurable transaction isolation level
Alain Mazy <am@osimis.io>
parents:
359
diff
changeset
|
113 } |
d2b5d9c92214
PG: test feature: configurable transaction isolation level
Alain Mazy <am@osimis.io>
parents:
359
diff
changeset
|
114 |
0 | 115 } |
116 | |
117 | |
118 void PostgreSQLParameters::SetConnectionUri(const std::string& uri) | |
119 { | |
120 uri_ = uri; | |
121 } | |
122 | |
123 | |
124 std::string PostgreSQLParameters::GetConnectionUri() const | |
125 { | |
126 if (uri_.empty()) | |
127 { | |
128 std::string actualUri = "postgresql://"; | |
129 | |
130 if (!username_.empty()) | |
131 { | |
132 actualUri += username_; | |
133 | |
134 if (!password_.empty()) | |
135 { | |
136 actualUri += ":" + password_; | |
137 } | |
138 | |
139 actualUri += "@" + host_; | |
140 } | |
141 else | |
142 { | |
143 actualUri += host_; | |
144 } | |
145 | |
146 if (port_ > 0) | |
147 { | |
148 actualUri += ":" + boost::lexical_cast<std::string>(port_); | |
149 } | |
150 | |
151 actualUri += "/" + database_; | |
152 | |
153 return actualUri; | |
154 } | |
155 else | |
156 { | |
157 return uri_; | |
158 } | |
159 } | |
160 | |
161 | |
162 void PostgreSQLParameters::SetHost(const std::string& host) | |
163 { | |
164 uri_.clear(); | |
165 host_ = host; | |
166 } | |
167 | |
168 void PostgreSQLParameters::SetPortNumber(unsigned int port) | |
169 { | |
252 | 170 if (port == 0 || |
0 | 171 port >= 65535) |
172 { | |
173 throw Orthanc::OrthancException(Orthanc::ErrorCode_ParameterOutOfRange); | |
174 } | |
175 | |
176 uri_.clear(); | |
177 port_ = port; | |
178 } | |
179 | |
180 void PostgreSQLParameters::SetUsername(const std::string& username) | |
181 { | |
182 uri_.clear(); | |
183 username_ = username; | |
184 } | |
185 | |
186 void PostgreSQLParameters::SetPassword(const std::string& password) | |
187 { | |
188 uri_.clear(); | |
189 password_ = password; | |
190 } | |
191 | |
192 void PostgreSQLParameters::SetDatabase(const std::string& database) | |
193 { | |
194 uri_.clear(); | |
195 database_ = database; | |
196 } | |
197 | |
198 void PostgreSQLParameters::Format(std::string& target) const | |
199 { | |
200 if (uri_.empty()) | |
201 { | |
80
16df1a6ea452
Fix issue 105 (Unable to connect to PostgreSQL database using SSL)
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
67
diff
changeset
|
202 // 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
|
203 // 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
|
204 // 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
|
205 // 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
|
206 target = std::string(ssl_ ? "sslmode=require" : "sslmode=disable") + |
0 | 207 " user=" + username_ + |
208 " host=" + host_ + | |
209 " port=" + boost::lexical_cast<std::string>(port_); | |
210 | |
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
|
211 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
|
212 { |
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
|
213 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
|
214 } |
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 |
0 | 216 if (database_.size() > 0) |
217 { | |
218 target += " dbname=" + database_; | |
219 } | |
220 } | |
221 else | |
222 { | |
223 target = uri_; | |
224 } | |
225 } | |
226 } |