1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
|
/**
* Orthanc - A Lightweight, RESTful DICOM Store
* Copyright (C) 2012-2016 Sebastien Jodogne, Medical Physics
* Department, University Hospital of Liege, Belgium
* Copyright (C) 2017-2023 Osimis S.A., Belgium
* Copyright (C) 2021-2023 Sebastien Jodogne, ICTEAM UCLouvain, Belgium
*
* This program is free software: you can redistribute it and/or
* modify it under the terms of the GNU Affero General Public License
* as published by the Free Software Foundation, either version 3 of
* the License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful, but
* WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
**/
#pragma once
#include "../../Resources/Orthanc/Databases/ISqlLookupFormatter.h"
#include "../Common/DatabaseManager.h"
#include "../Common/DatabasesEnumerations.h"
#include "IDatabaseBackendOutput.h"
#include "IdentifierTag.h"
#include <list>
namespace OrthancDatabases
{
class IDatabaseBackend : public boost::noncopyable
{
public:
virtual ~IDatabaseBackend()
{
}
virtual OrthancPluginContext* GetContext() = 0;
virtual IDatabaseFactory* CreateDatabaseFactory() = 0;
/**
* This function is invoked once, even if multiple connections are
* open. It is notably used to update the schema of the database.
**/
virtual void ConfigureDatabase(DatabaseManager& database,
bool hasIdentifierTags,
const std::list<IdentifierTag>& identifierTags) = 0;
virtual void SetOutputFactory(IDatabaseBackendOutput::IFactory* factory) = 0;
virtual IDatabaseBackendOutput* CreateOutput() = 0;
virtual bool HasRevisionsSupport() const = 0;
virtual void AddAttachment(DatabaseManager& manager,
int64_t id,
const OrthancPluginAttachment& attachment,
int64_t revision) = 0;
virtual void AttachChild(DatabaseManager& manager,
int64_t parent,
int64_t child) = 0;
virtual void ClearChanges(DatabaseManager& manager) = 0;
virtual void ClearExportedResources(DatabaseManager& manager) = 0;
virtual int64_t CreateResource(DatabaseManager& manager,
const char* publicId,
OrthancPluginResourceType type) = 0;
virtual void DeleteAttachment(IDatabaseBackendOutput& output,
DatabaseManager& manager,
int64_t id,
int32_t attachment) = 0;
virtual void DeleteMetadata(DatabaseManager& manager,
int64_t id,
int32_t metadataType) = 0;
virtual void DeleteResource(IDatabaseBackendOutput& output,
DatabaseManager& manager,
int64_t id) = 0;
virtual void GetAllInternalIds(std::list<int64_t>& target,
DatabaseManager& manager,
OrthancPluginResourceType resourceType) = 0;
virtual void GetAllPublicIds(std::list<std::string>& target,
DatabaseManager& manager,
OrthancPluginResourceType resourceType) = 0;
virtual void GetAllPublicIds(std::list<std::string>& target,
DatabaseManager& manager,
OrthancPluginResourceType resourceType,
int64_t since,
uint32_t limit) = 0;
/* Use GetOutput().AnswerChange() */
virtual void GetChanges(IDatabaseBackendOutput& output,
bool& done /*out*/,
DatabaseManager& manager,
int64_t since,
uint32_t limit) = 0;
virtual void GetChildrenInternalId(std::list<int64_t>& target /*out*/,
DatabaseManager& manager,
int64_t id) = 0;
virtual void GetChildrenPublicId(std::list<std::string>& target /*out*/,
DatabaseManager& manager,
int64_t id) = 0;
/* Use GetOutput().AnswerExportedResource() */
virtual void GetExportedResources(IDatabaseBackendOutput& output,
bool& done /*out*/,
DatabaseManager& manager,
int64_t since,
uint32_t limit) = 0;
/* Use GetOutput().AnswerChange() */
virtual void GetLastChange(IDatabaseBackendOutput& output,
DatabaseManager& manager) = 0;
/* Use GetOutput().AnswerExportedResource() */
virtual void GetLastExportedResource(IDatabaseBackendOutput& output,
DatabaseManager& manager) = 0;
/* Use GetOutput().AnswerDicomTag() */
virtual void GetMainDicomTags(IDatabaseBackendOutput& output,
DatabaseManager& manager,
int64_t id) = 0;
virtual std::string GetPublicId(DatabaseManager& manager,
int64_t resourceId) = 0;
virtual uint64_t GetResourcesCount(DatabaseManager& manager,
OrthancPluginResourceType resourceType) = 0;
virtual OrthancPluginResourceType GetResourceType(DatabaseManager& manager,
int64_t resourceId) = 0;
virtual uint64_t GetTotalCompressedSize(DatabaseManager& manager) = 0;
virtual uint64_t GetTotalUncompressedSize(DatabaseManager& manager) = 0;
virtual bool IsExistingResource(DatabaseManager& manager,
int64_t internalId) = 0;
virtual bool IsProtectedPatient(DatabaseManager& manager,
int64_t internalId) = 0;
virtual void ListAvailableMetadata(std::list<int32_t>& target /*out*/,
DatabaseManager& manager,
int64_t id) = 0;
virtual void ListAvailableAttachments(std::list<int32_t>& target /*out*/,
DatabaseManager& manager,
int64_t id) = 0;
virtual void LogChange(DatabaseManager& manager,
int32_t changeType,
int64_t resourceId,
OrthancPluginResourceType resourceType,
const char* date) = 0;
virtual void LogExportedResource(DatabaseManager& manager,
OrthancPluginResourceType resourceType,
const char* publicId,
const char* modality,
const char* date,
const char* patientId,
const char* studyInstanceUid,
const char* seriesInstanceUid,
const char* sopInstanceUid) = 0;
/* Use GetOutput().AnswerAttachment() */
virtual bool LookupAttachment(IDatabaseBackendOutput& output,
int64_t& revision /*out*/,
DatabaseManager& manager,
int64_t id,
int32_t contentType) = 0;
virtual bool LookupGlobalProperty(std::string& target /*out*/,
DatabaseManager& manager,
const char* serverIdentifier,
int32_t property) = 0;
virtual void LookupIdentifier(std::list<int64_t>& target /*out*/,
DatabaseManager& manager,
OrthancPluginResourceType resourceType,
uint16_t group,
uint16_t element,
OrthancPluginIdentifierConstraint constraint,
const char* value) = 0;
virtual void LookupIdentifierRange(std::list<int64_t>& target /*out*/,
DatabaseManager& manager,
OrthancPluginResourceType resourceType,
uint16_t group,
uint16_t element,
const char* start,
const char* end) = 0;
virtual bool LookupMetadata(std::string& target /*out*/,
int64_t& revision /*out*/,
DatabaseManager& manager,
int64_t id,
int32_t metadataType) = 0;
virtual bool LookupParent(int64_t& parentId /*out*/,
DatabaseManager& manager,
int64_t resourceId) = 0;
virtual bool LookupResource(int64_t& id /*out*/,
OrthancPluginResourceType& type /*out*/,
DatabaseManager& manager,
const char* publicId) = 0;
virtual bool SelectPatientToRecycle(int64_t& internalId /*out*/,
DatabaseManager& manager) = 0;
virtual bool SelectPatientToRecycle(int64_t& internalId /*out*/,
DatabaseManager& manager,
int64_t patientIdToAvoid) = 0;
virtual void SetGlobalProperty(DatabaseManager& manager,
const char* serverIdentifier,
int32_t property,
const char* utf8) = 0;
virtual void SetMainDicomTag(DatabaseManager& manager,
int64_t id,
uint16_t group,
uint16_t element,
const char* value) = 0;
virtual void SetIdentifierTag(DatabaseManager& manager,
int64_t id,
uint16_t group,
uint16_t element,
const char* value) = 0;
virtual void SetMetadata(DatabaseManager& manager,
int64_t id,
int32_t metadataType,
const char* value,
int64_t revision) = 0;
virtual void SetProtectedPatient(DatabaseManager& manager,
int64_t internalId,
bool isProtected) = 0;
virtual uint32_t GetDatabaseVersion(DatabaseManager& manager) = 0;
/**
* Upgrade the database to the specified version of the database
* schema. The upgrade script is allowed to make calls to
* OrthancPluginReconstructMainDicomTags().
**/
virtual void UpgradeDatabase(DatabaseManager& manager,
uint32_t targetVersion,
OrthancPluginStorageArea* storageArea) = 0;
virtual void ClearMainDicomTags(DatabaseManager& manager,
int64_t internalId) = 0;
virtual bool HasCreateInstance() const = 0;
#if ORTHANC_PLUGINS_HAS_DATABASE_CONSTRAINT == 1
virtual void LookupResources(IDatabaseBackendOutput& output,
DatabaseManager& manager,
const std::vector<Orthanc::DatabaseConstraint>& lookup,
OrthancPluginResourceType queryLevel,
const std::set<std::string>& labels, // New in Orthanc 1.12.0
Orthanc::LabelsConstraint labelsConstraint, // New in Orthanc 1.12.0
uint32_t limit,
bool requestSomeInstance) = 0;
#endif
#if ORTHANC_PLUGINS_HAS_DATABASE_CONSTRAINT == 1
virtual void CreateInstance(OrthancPluginCreateInstanceResult& result,
DatabaseManager& manager,
const char* hashPatient,
const char* hashStudy,
const char* hashSeries,
const char* hashInstance) = 0;
#endif
#if ORTHANC_PLUGINS_HAS_DATABASE_CONSTRAINT == 1
virtual void SetResourcesContent(
DatabaseManager& manager,
uint32_t countIdentifierTags,
const OrthancPluginResourcesContentTags* identifierTags,
uint32_t countMainDicomTags,
const OrthancPluginResourcesContentTags* mainDicomTags,
uint32_t countMetadata,
const OrthancPluginResourcesContentMetadata* metadata) = 0;
#endif
virtual void GetChildrenMetadata(std::list<std::string>& target,
DatabaseManager& manager,
int64_t resourceId,
int32_t metadata) = 0;
virtual int64_t GetLastChangeIndex(DatabaseManager& manager) = 0;
virtual void TagMostRecentPatient(DatabaseManager& manager,
int64_t patientId) = 0;
// NB: "parentPublicId" must be cleared if the resource has no parent
virtual bool LookupResourceAndParent(int64_t& id,
OrthancPluginResourceType& type,
std::string& parentPublicId,
DatabaseManager& manager,
const char* publicId) = 0;
virtual void GetAllMetadata(std::map<int32_t, std::string>& result,
DatabaseManager& manager,
int64_t id) = 0;
// New in Orthanc 1.12.0
virtual bool HasLabelsSupport() const = 0;
// New in Orthanc 1.12.0
virtual void AddLabel(DatabaseManager& manager,
int64_t resource,
const std::string& label) = 0;
// New in Orthanc 1.12.0
virtual void RemoveLabel(DatabaseManager& manager,
int64_t resource,
const std::string& label) = 0;
// New in Orthanc 1.12.0
virtual void ListLabels(std::list<std::string>& target,
DatabaseManager& manager,
int64_t resource) = 0;
// New in Orthanc 1.12.0
virtual void ListAllLabels(std::list<std::string>& target,
DatabaseManager& manager) = 0;
};
}
|
