Mercurial > hg > orthanc
annotate OrthancServer/Plugins/Samples/DelayedDeletion/LargeDeleteJob.cpp @ 5839:7aef730c0859 default tip
cont
author | Sebastien Jodogne <s.jodogne@gmail.com> |
---|---|
date | Wed, 16 Oct 2024 19:34:42 +0200 |
parents | f7adfb22e20e |
children |
rev | line source |
---|---|
5264
99751c5a7cfe
added missing copyrights
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5024
diff
changeset
|
1 /** |
99751c5a7cfe
added missing copyrights
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5024
diff
changeset
|
2 * Orthanc - A Lightweight, RESTful DICOM Store |
99751c5a7cfe
added missing copyrights
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5024
diff
changeset
|
3 * Copyright (C) 2012-2016 Sebastien Jodogne, Medical Physics |
99751c5a7cfe
added missing copyrights
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5024
diff
changeset
|
4 * Department, University Hospital of Liege, Belgium |
5640
f7adfb22e20e
updated copyright, as Orthanc Team now replaces Osimis
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5485
diff
changeset
|
5 * Copyright (C) 2017-2023 Osimis S.A., Belgium |
f7adfb22e20e
updated copyright, as Orthanc Team now replaces Osimis
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5485
diff
changeset
|
6 * Copyright (C) 2024-2024 Orthanc Team SRL, Belgium |
5485
48b8dae6dc77
upgrade to year 2024
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5280
diff
changeset
|
7 * Copyright (C) 2021-2024 Sebastien Jodogne, ICTEAM UCLouvain, Belgium |
5264
99751c5a7cfe
added missing copyrights
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5024
diff
changeset
|
8 * |
99751c5a7cfe
added missing copyrights
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5024
diff
changeset
|
9 * This program is free software: you can redistribute it and/or |
99751c5a7cfe
added missing copyrights
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5024
diff
changeset
|
10 * modify it under the terms of the GNU General Public License as |
99751c5a7cfe
added missing copyrights
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5024
diff
changeset
|
11 * published by the Free Software Foundation, either version 3 of the |
99751c5a7cfe
added missing copyrights
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5024
diff
changeset
|
12 * License, or (at your option) any later version. |
99751c5a7cfe
added missing copyrights
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5024
diff
changeset
|
13 * |
99751c5a7cfe
added missing copyrights
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5024
diff
changeset
|
14 * This program is distributed in the hope that it will be useful, but |
99751c5a7cfe
added missing copyrights
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5024
diff
changeset
|
15 * WITHOUT ANY WARRANTY; without even the implied warranty of |
99751c5a7cfe
added missing copyrights
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5024
diff
changeset
|
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU |
99751c5a7cfe
added missing copyrights
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5024
diff
changeset
|
17 * General Public License for more details. |
99751c5a7cfe
added missing copyrights
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5024
diff
changeset
|
18 * |
99751c5a7cfe
added missing copyrights
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5024
diff
changeset
|
19 * You should have received a copy of the GNU General Public License |
99751c5a7cfe
added missing copyrights
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5024
diff
changeset
|
20 * along with this program. If not, see <http://www.gnu.org/licenses/>. |
99751c5a7cfe
added missing copyrights
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5024
diff
changeset
|
21 **/ |
99751c5a7cfe
added missing copyrights
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5024
diff
changeset
|
22 |
99751c5a7cfe
added missing copyrights
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5024
diff
changeset
|
23 |
5024 | 24 #include "LargeDeleteJob.h" |
25 | |
26 #include "../../../../OrthancFramework/Sources/Logging.h" | |
27 #include "../../../../OrthancFramework/Sources/OrthancException.h" | |
28 | |
29 #include <json/reader.h> | |
30 | |
31 void LargeDeleteJob::UpdateDeleteProgress() | |
32 { | |
33 size_t total = 2 * resources_.size() + instances_.size() + series_.size(); | |
34 | |
35 float progress; | |
36 if (total == 0) | |
37 { | |
38 progress = 1; | |
39 } | |
40 else | |
41 { | |
42 progress = (static_cast<float>(posResources_ + posInstances_ + posSeries_ + posDelete_) / | |
43 static_cast<float>(total)); | |
44 } | |
45 | |
46 UpdateProgress(progress); | |
47 } | |
48 | |
49 | |
50 void LargeDeleteJob::ScheduleChildrenResources(std::vector<std::string>& target, | |
51 const std::string& uri) | |
52 { | |
53 Json::Value items; | |
54 if (OrthancPlugins::RestApiGet(items, uri, false)) | |
55 { | |
56 if (items.type() != Json::arrayValue) | |
57 { | |
58 throw Orthanc::OrthancException(Orthanc::ErrorCode_InternalError); | |
59 } | |
60 | |
61 for (Json::Value::ArrayIndex i = 0; i < items.size(); i++) | |
62 { | |
63 if (items[i].type() != Json::objectValue || | |
64 !items[i].isMember("ID") || | |
65 items[i]["ID"].type() != Json::stringValue) | |
66 { | |
67 throw Orthanc::OrthancException(Orthanc::ErrorCode_InternalError); | |
68 } | |
69 else | |
70 { | |
71 target.push_back(items[i]["ID"].asString()); | |
72 } | |
73 } | |
74 } | |
75 } | |
76 | |
77 | |
78 void LargeDeleteJob::ScheduleResource(Orthanc::ResourceType level, | |
79 const std::string& id) | |
80 { | |
81 #if 0 | |
82 // Instance-level granularity => very slow! | |
83 switch (level) | |
84 { | |
85 case Orthanc::ResourceType_Patient: | |
86 ScheduleChildrenResources(instances_, "/patients/" + id + "/instances"); | |
87 break; | |
88 | |
89 case Orthanc::ResourceType_Study: | |
90 ScheduleChildrenResources(instances_, "/studies/" + id + "/instances"); | |
91 break; | |
92 | |
93 case Orthanc::ResourceType_Series: | |
94 ScheduleChildrenResources(instances_, "/series/" + id + "/instances"); | |
95 break; | |
96 | |
97 case Orthanc::ResourceType_Instance: | |
98 instances_.push_back(id); | |
99 break; | |
100 | |
101 default: | |
102 throw Orthanc::OrthancException(Orthanc::ErrorCode_InternalError); | |
103 } | |
104 #else | |
105 /** | |
106 * Series-level granularity => looks like a good compromise between | |
107 * having the Orthanc mutex locked during all the study, and very | |
108 * slow instance-level granularity. | |
109 **/ | |
110 switch (level) | |
111 { | |
112 case Orthanc::ResourceType_Patient: | |
113 ScheduleChildrenResources(series_, "/patients/" + id + "/series"); | |
114 break; | |
115 | |
116 case Orthanc::ResourceType_Study: | |
117 ScheduleChildrenResources(series_, "/studies/" + id + "/series"); | |
118 break; | |
119 | |
120 case Orthanc::ResourceType_Series: | |
121 series_.push_back(id); | |
122 break; | |
123 | |
124 case Orthanc::ResourceType_Instance: | |
125 instances_.push_back(id); | |
126 break; | |
127 | |
128 default: | |
129 throw Orthanc::OrthancException(Orthanc::ErrorCode_InternalError); | |
130 } | |
131 #endif | |
132 } | |
133 | |
134 | |
135 void LargeDeleteJob::DeleteResource(Orthanc::ResourceType level, | |
136 const std::string& id) | |
137 { | |
138 std::string uri; | |
139 switch (level) | |
140 { | |
141 case Orthanc::ResourceType_Patient: | |
142 uri = "/patients/" + id; | |
143 break; | |
144 | |
145 case Orthanc::ResourceType_Study: | |
146 uri = "/studies/" + id; | |
147 break; | |
148 | |
149 case Orthanc::ResourceType_Series: | |
150 uri = "/series/" + id; | |
151 break; | |
152 | |
153 case Orthanc::ResourceType_Instance: | |
154 uri = "/instances/" + id; | |
155 break; | |
156 | |
157 default: | |
158 throw Orthanc::OrthancException(Orthanc::ErrorCode_InternalError); | |
159 } | |
160 | |
161 OrthancPlugins::RestApiDelete(uri, false); | |
162 } | |
163 | |
164 | |
165 LargeDeleteJob::LargeDeleteJob(const std::vector<std::string>& resources, | |
166 const std::vector<Orthanc::ResourceType>& levels) : | |
167 OrthancJob("LargeDelete"), | |
168 resources_(resources), | |
169 levels_(levels), | |
170 posResources_(0), | |
171 posInstances_(0), | |
5280 | 172 posSeries_(0), |
5024 | 173 posDelete_(0) |
174 { | |
175 if (resources.size() != levels.size()) | |
176 { | |
177 throw Orthanc::OrthancException(Orthanc::ErrorCode_ParameterOutOfRange); | |
178 } | |
179 } | |
180 | |
181 | |
182 OrthancPluginJobStepStatus LargeDeleteJob::Step() | |
183 { | |
184 if (posResources_ == 0) | |
185 { | |
186 if (resources_.size() == 1) | |
187 { | |
188 // LOG(WARNING) << "LargeDeleteJob has started on resource: " << resources_[0]; | |
189 } | |
190 else | |
191 { | |
192 // LOG(WARNING) << "LargeDeleteJob has started"; | |
193 } | |
194 } | |
195 | |
196 if (posResources_ < resources_.size()) | |
197 { | |
198 // First step: Discovering all the instances of the resources | |
199 | |
200 ScheduleResource(levels_[posResources_], resources_[posResources_]); | |
201 | |
202 posResources_ += 1; | |
203 UpdateDeleteProgress(); | |
204 return OrthancPluginJobStepStatus_Continue; | |
205 } | |
206 else if (posInstances_ < instances_.size()) | |
207 { | |
208 // Second step: Deleting the instances one by one | |
209 | |
210 DeleteResource(Orthanc::ResourceType_Instance, instances_[posInstances_]); | |
211 | |
212 posInstances_ += 1; | |
213 UpdateDeleteProgress(); | |
214 return OrthancPluginJobStepStatus_Continue; | |
215 } | |
216 else if (posSeries_ < series_.size()) | |
217 { | |
218 // Third step: Deleting the series one by one | |
219 | |
220 DeleteResource(Orthanc::ResourceType_Series, series_[posSeries_]); | |
221 | |
222 posSeries_ += 1; | |
223 UpdateDeleteProgress(); | |
224 return OrthancPluginJobStepStatus_Continue; | |
225 } | |
226 else if (posDelete_ < resources_.size()) | |
227 { | |
228 // Fourth step: Make sure the resources where fully deleted | |
229 // (instances might have been received since the beginning of | |
230 // the job) | |
231 | |
232 DeleteResource(levels_[posDelete_], resources_[posDelete_]); | |
233 | |
234 posDelete_ += 1; | |
235 UpdateDeleteProgress(); | |
236 return OrthancPluginJobStepStatus_Continue; | |
237 } | |
238 else | |
239 { | |
240 if (resources_.size() == 1) | |
241 { | |
242 // LOG(WARNING) << "LargeDeleteJob has completed on resource: " << resources_[0]; | |
243 } | |
244 else | |
245 { | |
246 // LOG(WARNING) << "LargeDeleteJob has completed"; | |
247 } | |
248 | |
249 UpdateProgress(1); | |
250 return OrthancPluginJobStepStatus_Success; | |
251 } | |
252 } | |
253 | |
254 | |
255 void LargeDeleteJob::Reset() | |
256 { | |
257 posResources_ = 0; | |
258 posInstances_ = 0; | |
259 posDelete_ = 0; | |
260 instances_.clear(); | |
261 } | |
262 | |
263 | |
264 void LargeDeleteJob::RestHandler(OrthancPluginRestOutput* output, | |
265 const char* url, | |
266 const OrthancPluginHttpRequest* request) | |
267 { | |
268 static const char* KEY_RESOURCES = "Resources"; | |
269 | |
270 if (request->method != OrthancPluginHttpMethod_Post) | |
271 { | |
272 OrthancPluginSendMethodNotAllowed(OrthancPlugins::GetGlobalContext(), output, "POST"); | |
273 return; | |
274 } | |
275 | |
276 Json::Value body; | |
277 Json::Reader reader; | |
278 if (!reader.parse(reinterpret_cast<const char*>(request->body), | |
279 reinterpret_cast<const char*>(request->body) + request->bodySize, body)) | |
280 { | |
281 throw Orthanc::OrthancException(Orthanc::ErrorCode_BadFileFormat, "JSON body is expected"); | |
282 } | |
283 | |
284 if (body.type() != Json::objectValue) | |
285 { | |
286 throw Orthanc::OrthancException(Orthanc::ErrorCode_BadFileFormat, | |
287 "Expected a JSON object in the body"); | |
288 } | |
289 | |
290 if (!body.isMember(KEY_RESOURCES) || | |
291 body[KEY_RESOURCES].type() != Json::arrayValue) | |
292 { | |
293 throw Orthanc::OrthancException(Orthanc::ErrorCode_BadFileFormat, | |
294 "The JSON object must contain an array in \"" + | |
295 std::string(KEY_RESOURCES) + "\""); | |
296 } | |
297 | |
298 std::vector<std::string> resources; | |
299 std::vector<Orthanc::ResourceType> levels; | |
300 | |
301 resources.reserve(body.size()); | |
302 levels.reserve(body.size()); | |
303 | |
304 const Json::Value& arr = body[KEY_RESOURCES]; | |
305 for (Json::Value::ArrayIndex i = 0; i < arr.size(); i++) | |
306 { | |
307 if (arr[i].type() != Json::arrayValue || | |
308 arr[i].size() != 2u || | |
309 arr[i][0].type() != Json::stringValue || | |
310 arr[i][1].type() != Json::stringValue) | |
311 { | |
312 throw Orthanc::OrthancException(Orthanc::ErrorCode_BadFileFormat, | |
313 "Each entry must be an array containing 2 strings, " | |
314 "the resource level and its ID"); | |
315 } | |
316 else | |
317 { | |
318 levels.push_back(Orthanc::StringToResourceType(arr[i][0].asCString())); | |
319 resources.push_back(arr[i][1].asString()); | |
320 } | |
321 } | |
322 | |
323 OrthancPlugins::OrthancJob::SubmitFromRestApiPost( | |
324 output, body, new LargeDeleteJob(resources, levels)); | |
325 } |