Mercurial > hg > orthanc
annotate OrthancServer/Resources/Graveyard/DatabasePluginSample/Database.h @ 4831:7053502fbf97
added copyright UCLouvain
| author | Sebastien Jodogne <s.jodogne@gmail.com> |
|---|---|
| date | Thu, 25 Nov 2021 19:01:11 +0100 |
| parents | d9473bd5ed43 |
| children | 2e71a08eea15 43e613a7756b |
| rev | line source |
|---|---|
| 1671 | 1 /** |
| 2 * Orthanc - A Lightweight, RESTful DICOM Store | |
| 1900 | 3 * Copyright (C) 2012-2016 Sebastien Jodogne, Medical Physics |
| 1671 | 4 * Department, University Hospital of Liege, Belgium |
|
4437
d9473bd5ed43
upgrade to year 2021
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4050
diff
changeset
|
5 * Copyright (C) 2017-2021 Osimis S.A., Belgium |
|
4831
7053502fbf97
added copyright UCLouvain
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4437
diff
changeset
|
6 * Copyright (C) 2021-2021 Sebastien Jodogne, ICTEAM UCLouvain, Belgium |
| 1671 | 7 * |
| 8 * This program is free software: you can redistribute it and/or | |
| 9 * modify it under the terms of the GNU General Public License as | |
| 10 * published by the Free Software Foundation, either version 3 of the | |
| 11 * License, or (at your option) any later version. | |
| 12 * | |
| 13 * In addition, as a special exception, the copyright holders of this | |
| 14 * program give permission to link the code of its release with the | |
| 15 * OpenSSL project's "OpenSSL" library (or with modified versions of it | |
| 16 * that use the same license as the "OpenSSL" library), and distribute | |
| 17 * the linked executables. You must obey the GNU General Public License | |
| 18 * in all respects for all of the code used other than "OpenSSL". If you | |
| 19 * modify file(s) with this exception, you may extend this exception to | |
| 20 * your version of the file(s), but you are not obligated to do so. If | |
| 21 * you do not wish to do so, delete this exception statement from your | |
| 22 * version. If you delete this exception statement from all source files | |
| 23 * in the program, then also delete it here. | |
| 24 * | |
| 25 * This program is distributed in the hope that it will be useful, but | |
| 26 * WITHOUT ANY WARRANTY; without even the implied warranty of | |
| 27 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
| 28 * General Public License for more details. | |
| 29 * | |
| 30 * You should have received a copy of the GNU General Public License | |
| 31 * along with this program. If not, see <http://www.gnu.org/licenses/>. | |
| 32 **/ | |
| 33 | |
| 34 | |
| 35 #pragma once | |
| 36 | |
| 4050 | 37 #include "OrthancCppDatabasePlugin.h" |
| 1671 | 38 |
| 4050 | 39 #include "../../../../OrthancFramework/Sources/SQLite/Connection.h" |
| 40 #include "../../../../OrthancFramework/Sources/SQLite/Transaction.h" | |
| 41 #include "../../../Plugins/Engine/PluginsEnumerations.h" | |
| 42 #include "DatabaseWrapperBase.h" | |
| 1671 | 43 |
| 44 #include <memory> | |
| 45 | |
| 46 class Database : public OrthancPlugins::IDatabaseBackend | |
| 47 { | |
| 48 private: | |
| 49 class SignalRemainingAncestor; | |
| 50 | |
| 51 std::string path_; | |
| 52 Orthanc::SQLite::Connection db_; | |
| 53 Orthanc::DatabaseWrapperBase base_; | |
| 54 SignalRemainingAncestor* signalRemainingAncestor_; | |
| 55 | |
| 56 std::auto_ptr<Orthanc::SQLite::Transaction> transaction_; | |
| 57 | |
| 58 public: | |
| 59 Database(const std::string& path); | |
| 60 | |
| 61 virtual void Open(); | |
| 62 | |
| 63 virtual void Close(); | |
| 64 | |
| 65 virtual void AddAttachment(int64_t id, | |
| 66 const OrthancPluginAttachment& attachment); | |
| 67 | |
| 68 virtual void AttachChild(int64_t parent, | |
| 69 int64_t child) | |
| 70 { | |
| 71 base_.AttachChild(parent, child); | |
| 72 } | |
| 73 | |
| 74 virtual void ClearChanges() | |
| 75 { | |
| 76 db_.Execute("DELETE FROM Changes"); | |
| 77 } | |
| 78 | |
| 79 virtual void ClearExportedResources() | |
| 80 { | |
| 81 db_.Execute("DELETE FROM ExportedResources"); | |
| 82 } | |
| 83 | |
| 84 virtual int64_t CreateResource(const char* publicId, | |
| 85 OrthancPluginResourceType type) | |
| 86 { | |
| 87 return base_.CreateResource(publicId, Orthanc::Plugins::Convert(type)); | |
| 88 } | |
| 89 | |
| 90 virtual void DeleteAttachment(int64_t id, | |
| 91 int32_t attachment) | |
| 92 { | |
| 93 base_.DeleteAttachment(id, static_cast<Orthanc::FileContentType>(attachment)); | |
| 94 } | |
| 95 | |
| 96 virtual void DeleteMetadata(int64_t id, | |
| 97 int32_t metadataType) | |
| 98 { | |
| 99 base_.DeleteMetadata(id, static_cast<Orthanc::MetadataType>(metadataType)); | |
| 100 } | |
| 101 | |
| 102 virtual void DeleteResource(int64_t id); | |
| 103 | |
|
1761
f4286d99ee0a
fix sample database plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1728
diff
changeset
|
104 virtual void GetAllInternalIds(std::list<int64_t>& target, |
|
f4286d99ee0a
fix sample database plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1728
diff
changeset
|
105 OrthancPluginResourceType resourceType) |
|
f4286d99ee0a
fix sample database plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1728
diff
changeset
|
106 { |
|
f4286d99ee0a
fix sample database plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1728
diff
changeset
|
107 base_.GetAllInternalIds(target, Orthanc::Plugins::Convert(resourceType)); |
|
f4286d99ee0a
fix sample database plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1728
diff
changeset
|
108 } |
|
f4286d99ee0a
fix sample database plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1728
diff
changeset
|
109 |
| 1671 | 110 virtual void GetAllPublicIds(std::list<std::string>& target, |
| 111 OrthancPluginResourceType resourceType) | |
| 112 { | |
| 113 base_.GetAllPublicIds(target, Orthanc::Plugins::Convert(resourceType)); | |
| 114 } | |
| 115 | |
| 116 virtual void GetAllPublicIds(std::list<std::string>& target, | |
| 117 OrthancPluginResourceType resourceType, | |
| 118 uint64_t since, | |
| 119 uint64_t limit) | |
| 120 { | |
| 121 base_.GetAllPublicIds(target, Orthanc::Plugins::Convert(resourceType), since, limit); | |
| 122 } | |
| 123 | |
| 124 virtual void GetChanges(bool& done /*out*/, | |
| 125 int64_t since, | |
| 126 uint32_t maxResults); | |
| 127 | |
| 128 virtual void GetChildrenInternalId(std::list<int64_t>& target /*out*/, | |
| 129 int64_t id) | |
| 130 { | |
| 131 base_.GetChildrenInternalId(target, id); | |
| 132 } | |
| 133 | |
| 134 virtual void GetChildrenPublicId(std::list<std::string>& target /*out*/, | |
| 135 int64_t id) | |
| 136 { | |
| 137 base_.GetChildrenPublicId(target, id); | |
| 138 } | |
| 139 | |
| 140 virtual void GetExportedResources(bool& done /*out*/, | |
| 141 int64_t since, | |
| 142 uint32_t maxResults); | |
| 143 | |
| 144 virtual void GetLastChange(); | |
| 145 | |
| 146 virtual void GetLastExportedResource(); | |
| 147 | |
| 148 virtual void GetMainDicomTags(int64_t id); | |
| 149 | |
| 150 virtual std::string GetPublicId(int64_t resourceId); | |
| 151 | |
| 152 virtual uint64_t GetResourceCount(OrthancPluginResourceType resourceType) | |
| 153 { | |
| 154 return base_.GetResourceCount(Orthanc::Plugins::Convert(resourceType)); | |
| 155 } | |
| 156 | |
| 157 virtual OrthancPluginResourceType GetResourceType(int64_t resourceId); | |
| 158 | |
| 159 virtual uint64_t GetTotalCompressedSize() | |
| 160 { | |
| 161 return base_.GetTotalCompressedSize(); | |
| 162 } | |
| 163 | |
| 164 virtual uint64_t GetTotalUncompressedSize() | |
| 165 { | |
| 166 return base_.GetTotalUncompressedSize(); | |
| 167 } | |
| 168 | |
| 169 virtual bool IsExistingResource(int64_t internalId) | |
| 170 { | |
| 171 return base_.IsExistingResource(internalId); | |
| 172 } | |
| 173 | |
| 174 virtual bool IsProtectedPatient(int64_t internalId) | |
| 175 { | |
| 176 return base_.IsProtectedPatient(internalId); | |
| 177 } | |
| 178 | |
| 179 virtual void ListAvailableMetadata(std::list<int32_t>& target /*out*/, | |
| 180 int64_t id); | |
| 181 | |
| 182 virtual void ListAvailableAttachments(std::list<int32_t>& target /*out*/, | |
| 183 int64_t id); | |
| 184 | |
| 185 virtual void LogChange(const OrthancPluginChange& change); | |
| 186 | |
| 187 virtual void LogExportedResource(const OrthancPluginExportedResource& resource); | |
| 188 | |
| 189 virtual bool LookupAttachment(int64_t id, | |
| 190 int32_t contentType); | |
| 191 | |
| 192 virtual bool LookupGlobalProperty(std::string& target /*out*/, | |
| 193 int32_t property) | |
| 194 { | |
| 195 return base_.LookupGlobalProperty(target, static_cast<Orthanc::GlobalProperty>(property)); | |
| 196 } | |
| 197 | |
|
1761
f4286d99ee0a
fix sample database plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1728
diff
changeset
|
198 virtual void LookupIdentifier(std::list<int64_t>& target /*out*/, |
|
f4286d99ee0a
fix sample database plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1728
diff
changeset
|
199 OrthancPluginResourceType level, |
|
f4286d99ee0a
fix sample database plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1728
diff
changeset
|
200 uint16_t group, |
|
f4286d99ee0a
fix sample database plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1728
diff
changeset
|
201 uint16_t element, |
|
f4286d99ee0a
fix sample database plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1728
diff
changeset
|
202 OrthancPluginIdentifierConstraint constraint, |
|
f4286d99ee0a
fix sample database plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1728
diff
changeset
|
203 const char* value) |
| 1671 | 204 { |
|
1761
f4286d99ee0a
fix sample database plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1728
diff
changeset
|
205 base_.LookupIdentifier(target, Orthanc::Plugins::Convert(level), |
|
f4286d99ee0a
fix sample database plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1728
diff
changeset
|
206 Orthanc::DicomTag(group, element), |
|
f4286d99ee0a
fix sample database plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1728
diff
changeset
|
207 Orthanc::Plugins::Convert(constraint), value); |
| 1671 | 208 } |
| 209 | |
| 210 virtual bool LookupMetadata(std::string& target /*out*/, | |
| 211 int64_t id, | |
| 212 int32_t metadataType) | |
| 213 { | |
| 214 return base_.LookupMetadata(target, id, static_cast<Orthanc::MetadataType>(metadataType)); | |
| 215 } | |
| 216 | |
| 217 virtual bool LookupParent(int64_t& parentId /*out*/, | |
| 218 int64_t resourceId); | |
| 219 | |
| 220 virtual bool LookupResource(int64_t& id /*out*/, | |
| 221 OrthancPluginResourceType& type /*out*/, | |
| 222 const char* publicId); | |
| 223 | |
| 224 virtual bool SelectPatientToRecycle(int64_t& internalId /*out*/) | |
| 225 { | |
| 226 return base_.SelectPatientToRecycle(internalId); | |
| 227 } | |
| 228 | |
| 229 virtual bool SelectPatientToRecycle(int64_t& internalId /*out*/, | |
| 230 int64_t patientIdToAvoid) | |
| 231 { | |
| 232 return base_.SelectPatientToRecycle(internalId, patientIdToAvoid); | |
| 233 } | |
| 234 | |
| 235 | |
| 236 virtual void SetGlobalProperty(int32_t property, | |
| 237 const char* value) | |
| 238 { | |
| 239 base_.SetGlobalProperty(static_cast<Orthanc::GlobalProperty>(property), value); | |
| 240 } | |
| 241 | |
| 242 virtual void SetMainDicomTag(int64_t id, | |
| 243 uint16_t group, | |
| 244 uint16_t element, | |
| 245 const char* value) | |
| 246 { | |
| 247 base_.SetMainDicomTag(id, Orthanc::DicomTag(group, element), value); | |
| 248 } | |
| 249 | |
| 250 virtual void SetIdentifierTag(int64_t id, | |
| 251 uint16_t group, | |
| 252 uint16_t element, | |
| 253 const char* value) | |
| 254 { | |
| 1714 | 255 base_.SetIdentifierTag(id, Orthanc::DicomTag(group, element), value); |
| 1671 | 256 } |
| 257 | |
| 258 virtual void SetMetadata(int64_t id, | |
| 259 int32_t metadataType, | |
| 260 const char* value) | |
| 261 { | |
| 262 base_.SetMetadata(id, static_cast<Orthanc::MetadataType>(metadataType), value); | |
| 263 } | |
| 264 | |
| 265 virtual void SetProtectedPatient(int64_t internalId, | |
| 266 bool isProtected) | |
| 267 { | |
| 268 base_.SetProtectedPatient(internalId, isProtected); | |
| 269 } | |
| 270 | |
| 271 virtual void StartTransaction(); | |
| 272 | |
| 273 virtual void RollbackTransaction(); | |
| 274 | |
| 275 virtual void CommitTransaction(); | |
| 276 | |
| 277 virtual uint32_t GetDatabaseVersion(); | |
| 278 | |
| 279 virtual void UpgradeDatabase(uint32_t targetVersion, | |
| 280 OrthancPluginStorageArea* storageArea); | |
| 281 | |
| 282 virtual void ClearMainDicomTags(int64_t internalId) | |
| 283 { | |
| 284 base_.ClearMainDicomTags(internalId); | |
| 285 } | |
| 286 }; |