Mercurial > hg > orthanc-databases
annotate Framework/MySQL/MySQLParameters.cpp @ 333:fad7c6156923
fix pragma warning for msvc
| author | Sebastien Jodogne <s.jodogne@gmail.com> |
|---|---|
| date | Wed, 11 Aug 2021 08:00:46 +0200 |
| parents | 3236894320d6 |
| children | 16aac0287485 |
| 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 | |
|
193
3236894320d6
upgrade to year 2021
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
186
diff
changeset
|
5 * Copyright (C) 2017-2021 Osimis S.A., Belgium |
| 0 | 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 "MySQLParameters.h" | |
| 23 | |
| 61 | 24 #include "MySQLDatabase.h" |
| 25 | |
| 152 | 26 #include <Logging.h> |
| 27 #include <OrthancException.h> | |
| 0 | 28 |
| 29 namespace OrthancDatabases | |
| 30 { | |
| 31 void MySQLParameters::Reset() | |
| 32 { | |
| 33 host_ = "localhost"; | |
| 34 username_.clear(); | |
| 35 password_.clear(); | |
| 36 database_.clear(); | |
| 37 port_ = 3306; | |
|
46
6a574d810b98
Compatibility with MySQL 8.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
23
diff
changeset
|
38 |
|
6a574d810b98
Compatibility with MySQL 8.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
23
diff
changeset
|
39 #if defined(_WIN32) |
|
6a574d810b98
Compatibility with MySQL 8.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
23
diff
changeset
|
40 unixSocket_.clear(); |
|
6a574d810b98
Compatibility with MySQL 8.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
23
diff
changeset
|
41 #else |
| 0 | 42 unixSocket_ = "/var/run/mysqld/mysqld.sock"; |
|
46
6a574d810b98
Compatibility with MySQL 8.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
23
diff
changeset
|
43 #endif |
|
6a574d810b98
Compatibility with MySQL 8.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
23
diff
changeset
|
44 |
| 0 | 45 lock_ = true; |
| 46 } | |
| 47 | |
| 48 | |
| 186 | 49 MySQLParameters::MySQLParameters() : |
| 50 ssl_(false), | |
| 51 verifySslServerCertificates_(true), | |
| 52 maxConnectionRetries_(10), | |
| 53 connectionRetryInterval_(5) | |
| 0 | 54 { |
| 55 Reset(); | |
| 56 } | |
| 57 | |
| 58 | |
| 186 | 59 MySQLParameters::MySQLParameters(const OrthancPlugins::OrthancConfiguration& pluginConfiguration, |
| 60 const OrthancPlugins::OrthancConfiguration& orthancConfiguration) | |
| 0 | 61 { |
| 62 Reset(); | |
| 63 | |
| 64 std::string s; | |
|
163
4d32c9c8d6c0
Added support for TLS connections
Alain Mazy <alain@mazy.be>
parents:
152
diff
changeset
|
65 if (pluginConfiguration.LookupStringValue(s, "Host")) |
| 0 | 66 { |
| 67 SetHost(s); | |
| 68 } | |
| 69 | |
|
163
4d32c9c8d6c0
Added support for TLS connections
Alain Mazy <alain@mazy.be>
parents:
152
diff
changeset
|
70 if (pluginConfiguration.LookupStringValue(s, "Username")) |
| 0 | 71 { |
| 72 SetUsername(s); | |
| 73 } | |
| 74 | |
|
163
4d32c9c8d6c0
Added support for TLS connections
Alain Mazy <alain@mazy.be>
parents:
152
diff
changeset
|
75 if (pluginConfiguration.LookupStringValue(s, "Password")) |
| 0 | 76 { |
| 77 SetPassword(s); | |
| 78 } | |
| 79 | |
|
163
4d32c9c8d6c0
Added support for TLS connections
Alain Mazy <alain@mazy.be>
parents:
152
diff
changeset
|
80 if (pluginConfiguration.LookupStringValue(s, "Database")) |
| 0 | 81 { |
| 82 SetDatabase(s); | |
| 83 } | |
| 84 | |
| 85 unsigned int port; | |
|
163
4d32c9c8d6c0
Added support for TLS connections
Alain Mazy <alain@mazy.be>
parents:
152
diff
changeset
|
86 if (pluginConfiguration.LookupUnsignedIntegerValue(port, "Port")) |
| 0 | 87 { |
| 88 SetPort(port); | |
| 89 } | |
| 90 | |
|
163
4d32c9c8d6c0
Added support for TLS connections
Alain Mazy <alain@mazy.be>
parents:
152
diff
changeset
|
91 if (pluginConfiguration.LookupStringValue(s, "UnixSocket")) |
| 0 | 92 { |
| 93 SetUnixSocket(s); | |
| 94 } | |
| 95 | |
|
163
4d32c9c8d6c0
Added support for TLS connections
Alain Mazy <alain@mazy.be>
parents:
152
diff
changeset
|
96 lock_ = pluginConfiguration.GetBooleanValue("Lock", true); // Use locking by default |
|
4d32c9c8d6c0
Added support for TLS connections
Alain Mazy <alain@mazy.be>
parents:
152
diff
changeset
|
97 |
|
4d32c9c8d6c0
Added support for TLS connections
Alain Mazy <alain@mazy.be>
parents:
152
diff
changeset
|
98 ssl_ = pluginConfiguration.GetBooleanValue("EnableSsl", false); |
|
4d32c9c8d6c0
Added support for TLS connections
Alain Mazy <alain@mazy.be>
parents:
152
diff
changeset
|
99 verifySslServerCertificates_ = pluginConfiguration.GetBooleanValue("SslVerifyServerCertificates", true); |
|
4d32c9c8d6c0
Added support for TLS connections
Alain Mazy <alain@mazy.be>
parents:
152
diff
changeset
|
100 |
|
4d32c9c8d6c0
Added support for TLS connections
Alain Mazy <alain@mazy.be>
parents:
152
diff
changeset
|
101 const std::string defaultCaCertificates = orthancConfiguration.GetStringValue("HttpsCACertificates", ""); |
|
4d32c9c8d6c0
Added support for TLS connections
Alain Mazy <alain@mazy.be>
parents:
152
diff
changeset
|
102 sslCaCertificates_ = pluginConfiguration.GetStringValue("SslCACertificates", defaultCaCertificates); |
|
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
|
103 |
|
163
4d32c9c8d6c0
Added support for TLS connections
Alain Mazy <alain@mazy.be>
parents:
152
diff
changeset
|
104 if (ssl_ && verifySslServerCertificates_ && sslCaCertificates_.empty()) |
|
4d32c9c8d6c0
Added support for TLS connections
Alain Mazy <alain@mazy.be>
parents:
152
diff
changeset
|
105 { |
|
4d32c9c8d6c0
Added support for TLS connections
Alain Mazy <alain@mazy.be>
parents:
152
diff
changeset
|
106 LOG(ERROR) << "MySQL: No SslCACertificates defined, unable to check SSL Server certificates"; |
|
4d32c9c8d6c0
Added support for TLS connections
Alain Mazy <alain@mazy.be>
parents:
152
diff
changeset
|
107 throw Orthanc::OrthancException(Orthanc::ErrorCode_ParameterOutOfRange); |
|
4d32c9c8d6c0
Added support for TLS connections
Alain Mazy <alain@mazy.be>
parents:
152
diff
changeset
|
108 } |
|
4d32c9c8d6c0
Added support for TLS connections
Alain Mazy <alain@mazy.be>
parents:
152
diff
changeset
|
109 |
|
4d32c9c8d6c0
Added support for TLS connections
Alain Mazy <alain@mazy.be>
parents:
152
diff
changeset
|
110 maxConnectionRetries_ = pluginConfiguration.GetUnsignedIntegerValue("MaximumConnectionRetries", 10); |
|
4d32c9c8d6c0
Added support for TLS connections
Alain Mazy <alain@mazy.be>
parents:
152
diff
changeset
|
111 connectionRetryInterval_ = pluginConfiguration.GetUnsignedIntegerValue("ConnectionRetryInterval", 5); |
| 0 | 112 } |
| 113 | |
| 114 | |
| 115 void MySQLParameters::SetHost(const std::string& host) | |
| 116 { | |
| 117 host_ = host; | |
| 118 } | |
| 119 | |
| 120 | |
| 121 void MySQLParameters::SetUsername(const std::string& username) | |
| 122 { | |
| 123 username_ = username; | |
| 124 } | |
| 125 | |
| 126 | |
| 127 void MySQLParameters::SetPassword(const std::string& password) | |
| 128 { | |
| 129 password_ = password; | |
| 130 } | |
| 131 | |
| 132 | |
| 133 void MySQLParameters::SetDatabase(const std::string& database) | |
| 134 { | |
|
23
b2ff1cd2907a
handling of implicit transactions in DatabaseManager
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
22
diff
changeset
|
135 if (database.empty()) |
|
b2ff1cd2907a
handling of implicit transactions in DatabaseManager
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
22
diff
changeset
|
136 { |
|
46
6a574d810b98
Compatibility with MySQL 8.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
23
diff
changeset
|
137 LOG(ERROR) << "MySQL: Empty database name"; |
|
23
b2ff1cd2907a
handling of implicit transactions in DatabaseManager
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
22
diff
changeset
|
138 throw Orthanc::OrthancException(Orthanc::ErrorCode_ParameterOutOfRange); |
|
b2ff1cd2907a
handling of implicit transactions in DatabaseManager
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
22
diff
changeset
|
139 } |
|
b2ff1cd2907a
handling of implicit transactions in DatabaseManager
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
22
diff
changeset
|
140 |
| 61 | 141 if (!MySQLDatabase::IsValidDatabaseIdentifier(database)) |
|
23
b2ff1cd2907a
handling of implicit transactions in DatabaseManager
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
22
diff
changeset
|
142 { |
| 61 | 143 LOG(ERROR) << "MySQL: Only alphanumeric characters are allowed in a " |
| 144 << "database name: \"" << database << "\""; | |
| 145 throw Orthanc::OrthancException(Orthanc::ErrorCode_ParameterOutOfRange); | |
|
23
b2ff1cd2907a
handling of implicit transactions in DatabaseManager
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
22
diff
changeset
|
146 } |
|
b2ff1cd2907a
handling of implicit transactions in DatabaseManager
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
22
diff
changeset
|
147 |
| 0 | 148 database_ = database; |
| 149 } | |
| 150 | |
| 151 | |
| 152 void MySQLParameters::SetPort(unsigned int port) | |
| 153 { | |
| 154 if (port >= 65535) | |
| 155 { | |
| 156 throw Orthanc::OrthancException(Orthanc::ErrorCode_ParameterOutOfRange); | |
| 157 } | |
| 158 else | |
| 159 { | |
| 160 port_ = port; | |
| 161 } | |
| 162 } | |
| 163 | |
| 164 | |
| 165 void MySQLParameters::SetUnixSocket(const std::string& socket) | |
| 166 { | |
|
46
6a574d810b98
Compatibility with MySQL 8.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
23
diff
changeset
|
167 #if defined(_WIN32) |
|
6a574d810b98
Compatibility with MySQL 8.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
23
diff
changeset
|
168 if (!socket.empty()) |
|
6a574d810b98
Compatibility with MySQL 8.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
23
diff
changeset
|
169 { |
|
6a574d810b98
Compatibility with MySQL 8.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
23
diff
changeset
|
170 LOG(WARNING) << "MySQL: Setting an UNIX socket on Windows has no effect"; |
|
6a574d810b98
Compatibility with MySQL 8.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
23
diff
changeset
|
171 } |
|
6a574d810b98
Compatibility with MySQL 8.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
23
diff
changeset
|
172 #endif |
|
6a574d810b98
Compatibility with MySQL 8.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
23
diff
changeset
|
173 |
| 0 | 174 unixSocket_ = socket; |
| 175 } | |
|
22
1e9bad493475
prevent running unit tests on a non-existing db
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
176 |
|
1e9bad493475
prevent running unit tests on a non-existing db
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
177 |
|
1e9bad493475
prevent running unit tests on a non-existing db
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
178 void MySQLParameters::Format(Json::Value& target) const |
|
1e9bad493475
prevent running unit tests on a non-existing db
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
179 { |
|
1e9bad493475
prevent running unit tests on a non-existing db
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
180 target = Json::objectValue; |
|
1e9bad493475
prevent running unit tests on a non-existing db
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
181 target["Host"] = host_; |
|
1e9bad493475
prevent running unit tests on a non-existing db
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
182 target["Username"] = username_; |
|
1e9bad493475
prevent running unit tests on a non-existing db
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
183 target["Password"] = password_; |
|
1e9bad493475
prevent running unit tests on a non-existing db
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
184 target["Database"] = database_; |
|
1e9bad493475
prevent running unit tests on a non-existing db
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
185 target["Port"] = port_; |
|
1e9bad493475
prevent running unit tests on a non-existing db
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
186 target["UnixSocket"] = unixSocket_; |
|
1e9bad493475
prevent running unit tests on a non-existing db
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
187 target["Lock"] = lock_; |
|
1e9bad493475
prevent running unit tests on a non-existing db
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
188 } |
| 0 | 189 } |