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