Mercurial > hg > orthanc-databases
annotate Framework/Plugins/GlobalProperties.cpp @ 221:73cc85f3d9c1
implementation of the "serverIdentifier" information for global properties
| author | Sebastien Jodogne <s.jodogne@gmail.com> |
|---|---|
| date | Tue, 30 Mar 2021 10:40:34 +0200 |
| parents | 3236894320d6 |
| children |
| 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:
157
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 "GlobalProperties.h" | |
| 23 | |
| 24 #include "../Common/Utf8StringValue.h" | |
| 25 | |
|
157
275e14f57f1e
replacing deprecated std::auto_ptr by std::unique_ptr
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
152
diff
changeset
|
26 #include <Compatibility.h> // For std::unique_ptr<> |
| 152 | 27 #include <Logging.h> |
| 28 #include <OrthancException.h> | |
| 0 | 29 |
| 30 #include <boost/lexical_cast.hpp> | |
| 31 | |
| 32 namespace OrthancDatabases | |
| 33 { | |
| 34 bool LookupGlobalProperty(std::string& target, | |
| 35 IDatabase& db, | |
| 36 ITransaction& transaction, | |
|
221
73cc85f3d9c1
implementation of the "serverIdentifier" information for global properties
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
193
diff
changeset
|
37 const std::string& serverIdentifier, |
| 0 | 38 Orthanc::GlobalProperty property) |
| 39 { | |
| 40 Query query("SELECT value FROM GlobalProperties WHERE property=${property}", true); | |
| 41 query.SetType("property", ValueType_Integer64); | |
| 42 | |
|
157
275e14f57f1e
replacing deprecated std::auto_ptr by std::unique_ptr
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
152
diff
changeset
|
43 std::unique_ptr<IPrecompiledStatement> statement(db.Compile(query)); |
| 0 | 44 |
| 45 Dictionary args; | |
| 46 args.SetIntegerValue("property", property); | |
| 47 | |
|
157
275e14f57f1e
replacing deprecated std::auto_ptr by std::unique_ptr
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
152
diff
changeset
|
48 std::unique_ptr<IResult> result(transaction.Execute(*statement, args)); |
| 0 | 49 |
| 50 if (result->IsDone()) | |
| 51 { | |
| 52 return false; | |
| 53 } | |
| 54 | |
| 55 result->SetExpectedType(0, ValueType_Utf8String); | |
| 56 | |
| 57 ValueType type = result->GetField(0).GetType(); | |
| 58 | |
| 59 if (type == ValueType_Null) | |
| 60 { | |
| 61 return false; | |
| 62 } | |
| 63 else if (type != ValueType_Utf8String) | |
| 64 { | |
| 65 throw Orthanc::OrthancException(Orthanc::ErrorCode_Database); | |
| 66 } | |
| 67 else | |
| 68 { | |
| 69 target = dynamic_cast<const Utf8StringValue&>(result->GetField(0)).GetContent(); | |
| 70 return true; | |
| 71 } | |
| 72 } | |
| 73 | |
| 74 | |
| 75 bool LookupGlobalProperty(std::string& target /* out */, | |
| 76 DatabaseManager& manager, | |
|
221
73cc85f3d9c1
implementation of the "serverIdentifier" information for global properties
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
193
diff
changeset
|
77 const std::string& serverIdentifier, |
| 0 | 78 Orthanc::GlobalProperty property) |
| 79 { | |
| 80 DatabaseManager::CachedStatement statement( | |
| 81 STATEMENT_FROM_HERE, manager, | |
| 82 "SELECT value FROM GlobalProperties WHERE property=${property}"); | |
| 83 | |
| 84 statement.SetReadOnly(true); | |
| 85 statement.SetParameterType("property", ValueType_Integer64); | |
| 86 | |
| 87 Dictionary args; | |
| 88 args.SetIntegerValue("property", property); | |
| 89 | |
| 90 statement.Execute(args); | |
| 91 statement.SetResultFieldType(0, ValueType_Utf8String); | |
| 92 | |
| 93 if (statement.IsDone()) | |
| 94 { | |
| 95 return false; | |
| 96 } | |
| 97 | |
| 98 ValueType type = statement.GetResultField(0).GetType(); | |
| 99 | |
| 100 if (type == ValueType_Null) | |
| 101 { | |
| 102 return false; | |
| 103 } | |
| 104 else if (type != ValueType_Utf8String) | |
| 105 { | |
| 106 throw Orthanc::OrthancException(Orthanc::ErrorCode_Database); | |
| 107 } | |
| 108 else | |
| 109 { | |
| 110 target = dynamic_cast<const Utf8StringValue&>(statement.GetResultField(0)).GetContent(); | |
| 111 return true; | |
| 112 } | |
| 113 } | |
| 114 | |
| 115 | |
| 116 void SetGlobalProperty(IDatabase& db, | |
| 117 ITransaction& transaction, | |
|
221
73cc85f3d9c1
implementation of the "serverIdentifier" information for global properties
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
193
diff
changeset
|
118 const std::string& serverIdentifier, |
| 0 | 119 Orthanc::GlobalProperty property, |
| 120 const std::string& utf8) | |
| 121 { | |
|
132
5c69c2a14c97
OrthancPostgreSQL-3.2
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
67
diff
changeset
|
122 // This version of "SetGlobalProperty()" (with an explicit |
|
5c69c2a14c97
OrthancPostgreSQL-3.2
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
67
diff
changeset
|
123 // transaction) is called internally by the plugin to set a global |
|
5c69c2a14c97
OrthancPostgreSQL-3.2
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
67
diff
changeset
|
124 // property during the initialization of the database. (TODO: |
|
5c69c2a14c97
OrthancPostgreSQL-3.2
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
67
diff
changeset
|
125 // Could be replaced by the version with an implicit transaction |
|
5c69c2a14c97
OrthancPostgreSQL-3.2
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
67
diff
changeset
|
126 // to avoid code redundancy). |
|
5c69c2a14c97
OrthancPostgreSQL-3.2
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
67
diff
changeset
|
127 |
| 0 | 128 if (db.GetDialect() == Dialect_SQLite) |
| 129 { | |
| 130 Query query("INSERT OR REPLACE INTO GlobalProperties VALUES (${property}, ${value})", false); | |
| 131 query.SetType("property", ValueType_Integer64); | |
| 132 query.SetType("value", ValueType_Utf8String); | |
| 133 | |
|
157
275e14f57f1e
replacing deprecated std::auto_ptr by std::unique_ptr
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
152
diff
changeset
|
134 std::unique_ptr<IPrecompiledStatement> statement(db.Compile(query)); |
| 0 | 135 |
| 136 Dictionary args; | |
| 137 args.SetIntegerValue("property", static_cast<int>(property)); | |
| 138 args.SetUtf8Value("value", utf8); | |
| 139 | |
| 140 transaction.ExecuteWithoutResult(*statement, args); | |
| 141 } | |
| 142 else | |
| 143 { | |
| 144 { | |
| 145 Query query("DELETE FROM GlobalProperties WHERE property=${property}", false); | |
| 146 query.SetType("property", ValueType_Integer64); | |
| 147 | |
|
157
275e14f57f1e
replacing deprecated std::auto_ptr by std::unique_ptr
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
152
diff
changeset
|
148 std::unique_ptr<IPrecompiledStatement> statement(db.Compile(query)); |
| 0 | 149 |
| 150 Dictionary args; | |
| 151 args.SetIntegerValue("property", static_cast<int>(property)); | |
| 152 | |
| 153 transaction.ExecuteWithoutResult(*statement, args); | |
| 154 } | |
| 155 | |
| 156 { | |
| 157 Query query("INSERT INTO GlobalProperties VALUES (${property}, ${value})", false); | |
| 158 query.SetType("property", ValueType_Integer64); | |
| 159 query.SetType("value", ValueType_Utf8String); | |
| 160 | |
|
157
275e14f57f1e
replacing deprecated std::auto_ptr by std::unique_ptr
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
152
diff
changeset
|
161 std::unique_ptr<IPrecompiledStatement> statement(db.Compile(query)); |
| 0 | 162 |
| 163 Dictionary args; | |
| 164 args.SetIntegerValue("property", static_cast<int>(property)); | |
| 165 args.SetUtf8Value("value", utf8); | |
| 166 | |
| 167 transaction.ExecuteWithoutResult(*statement, args); | |
| 168 } | |
| 169 } | |
| 170 } | |
| 171 | |
| 172 | |
| 173 void SetGlobalProperty(DatabaseManager& manager, | |
|
221
73cc85f3d9c1
implementation of the "serverIdentifier" information for global properties
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
193
diff
changeset
|
174 const std::string& serverIdentifier, |
| 0 | 175 Orthanc::GlobalProperty property, |
| 176 const std::string& utf8) | |
| 177 { | |
|
132
5c69c2a14c97
OrthancPostgreSQL-3.2
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
67
diff
changeset
|
178 // This version of "SetGlobalProperty()" (without an explicit |
|
5c69c2a14c97
OrthancPostgreSQL-3.2
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
67
diff
changeset
|
179 // transaction) is called by Orthanc during its execution. Orthanc |
|
5c69c2a14c97
OrthancPostgreSQL-3.2
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
67
diff
changeset
|
180 // manages the transaction at a higher level, but this transaction |
|
5c69c2a14c97
OrthancPostgreSQL-3.2
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
67
diff
changeset
|
181 // is always present. |
|
5c69c2a14c97
OrthancPostgreSQL-3.2
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
67
diff
changeset
|
182 |
| 0 | 183 if (manager.GetDialect() == Dialect_SQLite) |
| 184 { | |
| 185 DatabaseManager::CachedStatement statement( | |
| 186 STATEMENT_FROM_HERE, manager, | |
| 187 "INSERT OR REPLACE INTO GlobalProperties VALUES (${property}, ${value})"); | |
| 188 | |
| 189 statement.SetParameterType("property", ValueType_Integer64); | |
| 190 statement.SetParameterType("value", ValueType_Utf8String); | |
| 191 | |
| 192 Dictionary args; | |
| 193 args.SetIntegerValue("property", static_cast<int>(property)); | |
| 194 args.SetUtf8Value("value", utf8); | |
| 195 | |
| 196 statement.Execute(args); | |
| 197 } | |
| 198 else | |
| 199 { | |
| 200 { | |
| 201 DatabaseManager::CachedStatement statement( | |
| 202 STATEMENT_FROM_HERE, manager, | |
| 203 "DELETE FROM GlobalProperties WHERE property=${property}"); | |
| 204 | |
| 205 statement.SetParameterType("property", ValueType_Integer64); | |
| 206 | |
| 207 Dictionary args; | |
| 208 args.SetIntegerValue("property", property); | |
| 209 | |
| 210 statement.Execute(args); | |
| 211 } | |
| 212 | |
| 213 { | |
| 214 DatabaseManager::CachedStatement statement( | |
| 215 STATEMENT_FROM_HERE, manager, | |
| 216 "INSERT INTO GlobalProperties VALUES (${property}, ${value})"); | |
| 217 | |
| 218 statement.SetParameterType("property", ValueType_Integer64); | |
| 219 statement.SetParameterType("value", ValueType_Utf8String); | |
| 220 | |
| 221 Dictionary args; | |
| 222 args.SetIntegerValue("property", static_cast<int>(property)); | |
| 223 args.SetUtf8Value("value", utf8); | |
| 224 | |
| 225 statement.Execute(args); | |
| 226 } | |
| 227 } | |
| 228 } | |
| 229 | |
| 230 | |
| 231 bool LookupGlobalIntegerProperty(int& target, | |
| 232 IDatabase& db, | |
| 233 ITransaction& transaction, | |
|
221
73cc85f3d9c1
implementation of the "serverIdentifier" information for global properties
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
193
diff
changeset
|
234 const std::string& serverIdentifier, |
| 0 | 235 Orthanc::GlobalProperty property) |
| 236 { | |
| 237 std::string value; | |
| 238 | |
|
221
73cc85f3d9c1
implementation of the "serverIdentifier" information for global properties
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
193
diff
changeset
|
239 if (LookupGlobalProperty(value, db, transaction, serverIdentifier, property)) |
| 0 | 240 { |
| 241 try | |
| 242 { | |
| 243 target = boost::lexical_cast<int>(value); | |
| 244 return true; | |
| 245 } | |
| 246 catch (boost::bad_lexical_cast&) | |
| 247 { | |
| 248 LOG(ERROR) << "Corrupted PostgreSQL database"; | |
| 249 throw Orthanc::OrthancException(Orthanc::ErrorCode_Database); | |
| 250 } | |
| 251 } | |
| 252 else | |
| 253 { | |
| 254 return false; | |
| 255 } | |
| 256 } | |
| 257 | |
| 258 | |
| 259 void SetGlobalIntegerProperty(IDatabase& db, | |
| 260 ITransaction& transaction, | |
|
221
73cc85f3d9c1
implementation of the "serverIdentifier" information for global properties
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
193
diff
changeset
|
261 const std::string& serverIdentifier, |
| 0 | 262 Orthanc::GlobalProperty property, |
| 263 int value) | |
| 264 { | |
|
221
73cc85f3d9c1
implementation of the "serverIdentifier" information for global properties
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
193
diff
changeset
|
265 SetGlobalProperty(db, transaction, serverIdentifier, property, boost::lexical_cast<std::string>(value)); |
| 0 | 266 } |
| 267 } |