Mercurial > hg > orthanc-databases
annotate Resources/Orthanc/Plugins/OrthancPluginCppWrapper.h @ 241:a063bbf10a3e
simplification of class DatabaseManager::Transaction
author | Sebastien Jodogne <s.jodogne@gmail.com> |
---|---|
date | Tue, 13 Apr 2021 12:07:30 +0200 |
parents | 3236894320d6 |
children | c7dc70a0a477 |
rev | line source |
---|---|
152 | 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:
170
diff
changeset
|
5 * Copyright (C) 2017-2021 Osimis S.A., Belgium |
152 | 6 * |
7 * This program is free software: you can redistribute it and/or | |
8 * modify it under the terms of the GNU General Public License as | |
9 * published by the Free Software Foundation, either version 3 of the | |
10 * License, or (at your option) any later version. | |
160 | 11 * |
152 | 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 * General Public License for more details. | |
16 * | |
17 * You should have received a copy of the GNU General Public License | |
18 * along with this program. If not, see <http://www.gnu.org/licenses/>. | |
19 **/ | |
20 | |
21 | |
22 #pragma once | |
23 | |
24 #include "OrthancPluginException.h" | |
25 | |
26 #include <orthanc/OrthancCPlugin.h> | |
27 #include <boost/noncopyable.hpp> | |
28 #include <boost/lexical_cast.hpp> | |
29 #include <boost/date_time/posix_time/posix_time.hpp> | |
30 #include <json/value.h> | |
31 #include <vector> | |
32 #include <list> | |
33 #include <set> | |
34 #include <map> | |
35 | |
36 | |
37 | |
38 /** | |
39 * The definition of ORTHANC_PLUGINS_VERSION_IS_ABOVE below is for | |
40 * backward compatibility with Orthanc SDK <= 1.3.0. | |
41 * | |
42 * $ hg diff -r Orthanc-1.3.0:Orthanc-1.3.1 ../../../Plugins/Include/orthanc/OrthancCPlugin.h | |
43 * | |
44 **/ | |
45 #if !defined(ORTHANC_PLUGINS_VERSION_IS_ABOVE) | |
46 #define ORTHANC_PLUGINS_VERSION_IS_ABOVE(major, minor, revision) \ | |
47 (ORTHANC_PLUGINS_MINIMAL_MAJOR_NUMBER > major || \ | |
48 (ORTHANC_PLUGINS_MINIMAL_MAJOR_NUMBER == major && \ | |
49 (ORTHANC_PLUGINS_MINIMAL_MINOR_NUMBER > minor || \ | |
50 (ORTHANC_PLUGINS_MINIMAL_MINOR_NUMBER == minor && \ | |
51 ORTHANC_PLUGINS_MINIMAL_REVISION_NUMBER >= revision)))) | |
52 #endif | |
53 | |
54 | |
55 #if !defined(ORTHANC_FRAMEWORK_VERSION_IS_ABOVE) | |
56 #define ORTHANC_FRAMEWORK_VERSION_IS_ABOVE(major, minor, revision) \ | |
57 (ORTHANC_VERSION_MAJOR > major || \ | |
58 (ORTHANC_VERSION_MAJOR == major && \ | |
59 (ORTHANC_VERSION_MINOR > minor || \ | |
60 (ORTHANC_VERSION_MINOR == minor && \ | |
61 ORTHANC_VERSION_REVISION >= revision)))) | |
62 #endif | |
63 | |
64 | |
65 #if ORTHANC_PLUGINS_VERSION_IS_ABOVE(1, 2, 0) | |
66 // The "OrthancPluginFindMatcher()" primitive was introduced in Orthanc 1.2.0 | |
67 # define HAS_ORTHANC_PLUGIN_FIND_MATCHER 1 | |
68 #else | |
69 # define HAS_ORTHANC_PLUGIN_FIND_MATCHER 0 | |
70 #endif | |
71 | |
72 | |
73 #if ORTHANC_PLUGINS_VERSION_IS_ABOVE(1, 4, 2) | |
74 # define HAS_ORTHANC_PLUGIN_PEERS 1 | |
75 # define HAS_ORTHANC_PLUGIN_JOB 1 | |
76 #else | |
77 # define HAS_ORTHANC_PLUGIN_PEERS 0 | |
78 # define HAS_ORTHANC_PLUGIN_JOB 0 | |
79 #endif | |
80 | |
81 #if ORTHANC_PLUGINS_VERSION_IS_ABOVE(1, 5, 0) | |
82 # define HAS_ORTHANC_PLUGIN_EXCEPTION_DETAILS 1 | |
83 #else | |
84 # define HAS_ORTHANC_PLUGIN_EXCEPTION_DETAILS 0 | |
85 #endif | |
86 | |
87 #if ORTHANC_PLUGINS_VERSION_IS_ABOVE(1, 5, 4) | |
88 # define HAS_ORTHANC_PLUGIN_METRICS 1 | |
89 #else | |
90 # define HAS_ORTHANC_PLUGIN_METRICS 0 | |
91 #endif | |
92 | |
93 #if ORTHANC_PLUGINS_VERSION_IS_ABOVE(1, 1, 0) | |
94 # define HAS_ORTHANC_PLUGIN_HTTP_CLIENT 1 | |
95 #else | |
96 # define HAS_ORTHANC_PLUGIN_HTTP_CLIENT 0 | |
97 #endif | |
98 | |
99 #if ORTHANC_PLUGINS_VERSION_IS_ABOVE(1, 5, 7) | |
100 # define HAS_ORTHANC_PLUGIN_CHUNKED_HTTP_CLIENT 1 | |
101 #else | |
102 # define HAS_ORTHANC_PLUGIN_CHUNKED_HTTP_CLIENT 0 | |
103 #endif | |
104 | |
105 #if ORTHANC_PLUGINS_VERSION_IS_ABOVE(1, 5, 7) | |
106 # define HAS_ORTHANC_PLUGIN_CHUNKED_HTTP_SERVER 1 | |
107 #else | |
108 # define HAS_ORTHANC_PLUGIN_CHUNKED_HTTP_SERVER 0 | |
109 #endif | |
110 | |
111 #if ORTHANC_PLUGINS_VERSION_IS_ABOVE(1, 6, 0) | |
112 # define HAS_ORTHANC_PLUGIN_STORAGE_COMMITMENT_SCP 1 | |
113 #else | |
114 # define HAS_ORTHANC_PLUGIN_STORAGE_COMMITMENT_SCP 0 | |
115 #endif | |
116 | |
117 | |
118 | |
119 namespace OrthancPlugins | |
120 { | |
121 typedef void (*RestCallback) (OrthancPluginRestOutput* output, | |
122 const char* url, | |
123 const OrthancPluginHttpRequest* request); | |
124 | |
125 void SetGlobalContext(OrthancPluginContext* context); | |
126 | |
127 bool HasGlobalContext(); | |
128 | |
129 OrthancPluginContext* GetGlobalContext(); | |
130 | |
131 | |
132 class OrthancImage; | |
133 | |
134 | |
135 class MemoryBuffer : public boost::noncopyable | |
136 { | |
137 private: | |
138 OrthancPluginMemoryBuffer buffer_; | |
139 | |
140 void Check(OrthancPluginErrorCode code); | |
141 | |
142 bool CheckHttp(OrthancPluginErrorCode code); | |
143 | |
144 public: | |
145 MemoryBuffer(); | |
146 | |
147 #if ORTHANC_PLUGINS_VERSION_IS_ABOVE(1, 7, 0) | |
148 // This constructor makes a copy of the given buffer in the memory | |
149 // handled by the Orthanc core | |
150 MemoryBuffer(const void* buffer, | |
151 size_t size); | |
152 #endif | |
153 | |
154 ~MemoryBuffer() | |
155 { | |
156 Clear(); | |
157 } | |
158 | |
159 OrthancPluginMemoryBuffer* operator*() | |
160 { | |
161 return &buffer_; | |
162 } | |
163 | |
164 // This transfers ownership from "other" to "this" | |
165 void Assign(OrthancPluginMemoryBuffer& other); | |
166 | |
167 void Swap(MemoryBuffer& other); | |
168 | |
169 OrthancPluginMemoryBuffer Release(); | |
170 | |
171 const char* GetData() const | |
172 { | |
173 if (buffer_.size > 0) | |
174 { | |
175 return reinterpret_cast<const char*>(buffer_.data); | |
176 } | |
177 else | |
178 { | |
179 return NULL; | |
180 } | |
181 } | |
182 | |
183 size_t GetSize() const | |
184 { | |
185 return buffer_.size; | |
186 } | |
187 | |
188 bool IsEmpty() const | |
189 { | |
190 return GetSize() == 0 || GetData() == NULL; | |
191 } | |
192 | |
193 void Clear(); | |
194 | |
195 void ToString(std::string& target) const; | |
196 | |
197 void ToJson(Json::Value& target) const; | |
198 | |
199 bool RestApiGet(const std::string& uri, | |
200 bool applyPlugins); | |
201 | |
202 bool RestApiGet(const std::string& uri, | |
203 const std::map<std::string, std::string>& httpHeaders, | |
204 bool applyPlugins); | |
205 | |
206 bool RestApiPost(const std::string& uri, | |
207 const void* body, | |
208 size_t bodySize, | |
209 bool applyPlugins); | |
210 | |
211 bool RestApiPut(const std::string& uri, | |
212 const void* body, | |
213 size_t bodySize, | |
214 bool applyPlugins); | |
215 | |
216 bool RestApiPost(const std::string& uri, | |
217 const Json::Value& body, | |
218 bool applyPlugins); | |
219 | |
220 bool RestApiPut(const std::string& uri, | |
221 const Json::Value& body, | |
222 bool applyPlugins); | |
223 | |
224 bool RestApiPost(const std::string& uri, | |
225 const std::string& body, | |
226 bool applyPlugins) | |
227 { | |
228 return RestApiPost(uri, body.empty() ? NULL : body.c_str(), body.size(), applyPlugins); | |
229 } | |
230 | |
231 bool RestApiPut(const std::string& uri, | |
232 const std::string& body, | |
233 bool applyPlugins) | |
234 { | |
235 return RestApiPut(uri, body.empty() ? NULL : body.c_str(), body.size(), applyPlugins); | |
236 } | |
237 | |
238 void CreateDicom(const Json::Value& tags, | |
239 OrthancPluginCreateDicomFlags flags); | |
240 | |
241 void CreateDicom(const Json::Value& tags, | |
242 const OrthancImage& pixelData, | |
243 OrthancPluginCreateDicomFlags flags); | |
244 | |
245 void ReadFile(const std::string& path); | |
246 | |
247 void GetDicomQuery(const OrthancPluginWorklistQuery* query); | |
248 | |
249 void DicomToJson(Json::Value& target, | |
250 OrthancPluginDicomToJsonFormat format, | |
251 OrthancPluginDicomToJsonFlags flags, | |
252 uint32_t maxStringLength); | |
253 | |
254 bool HttpGet(const std::string& url, | |
255 const std::string& username, | |
256 const std::string& password); | |
257 | |
258 bool HttpPost(const std::string& url, | |
259 const std::string& body, | |
260 const std::string& username, | |
261 const std::string& password); | |
262 | |
263 bool HttpPut(const std::string& url, | |
264 const std::string& body, | |
265 const std::string& username, | |
266 const std::string& password); | |
267 | |
268 void GetDicomInstance(const std::string& instanceId); | |
269 }; | |
270 | |
271 | |
272 class OrthancString : public boost::noncopyable | |
273 { | |
274 private: | |
275 char* str_; | |
276 | |
277 void Clear(); | |
278 | |
279 public: | |
280 OrthancString() : | |
281 str_(NULL) | |
282 { | |
283 } | |
284 | |
285 ~OrthancString() | |
286 { | |
287 Clear(); | |
288 } | |
289 | |
290 // This transfers ownership, warning: The string must have been | |
291 // allocated by the Orthanc core | |
292 void Assign(char* str); | |
293 | |
294 const char* GetContent() const | |
295 { | |
296 return str_; | |
297 } | |
298 | |
299 void ToString(std::string& target) const; | |
300 | |
301 void ToJson(Json::Value& target) const; | |
302 }; | |
303 | |
304 | |
305 class OrthancConfiguration : public boost::noncopyable | |
306 { | |
307 private: | |
308 Json::Value configuration_; // Necessarily a Json::objectValue | |
309 std::string path_; | |
310 | |
311 std::string GetPath(const std::string& key) const; | |
312 | |
313 void LoadConfiguration(); | |
314 | |
315 public: | |
316 OrthancConfiguration(); | |
317 | |
318 explicit OrthancConfiguration(bool load); | |
319 | |
320 const Json::Value& GetJson() const | |
321 { | |
322 return configuration_; | |
323 } | |
324 | |
325 bool IsSection(const std::string& key) const; | |
326 | |
327 void GetSection(OrthancConfiguration& target, | |
328 const std::string& key) const; | |
329 | |
330 bool LookupStringValue(std::string& target, | |
331 const std::string& key) const; | |
332 | |
333 bool LookupIntegerValue(int& target, | |
334 const std::string& key) const; | |
335 | |
336 bool LookupUnsignedIntegerValue(unsigned int& target, | |
337 const std::string& key) const; | |
338 | |
339 bool LookupBooleanValue(bool& target, | |
340 const std::string& key) const; | |
341 | |
342 bool LookupFloatValue(float& target, | |
343 const std::string& key) const; | |
344 | |
345 bool LookupListOfStrings(std::list<std::string>& target, | |
346 const std::string& key, | |
347 bool allowSingleString) const; | |
348 | |
349 bool LookupSetOfStrings(std::set<std::string>& target, | |
350 const std::string& key, | |
351 bool allowSingleString) const; | |
352 | |
353 std::string GetStringValue(const std::string& key, | |
354 const std::string& defaultValue) const; | |
355 | |
356 int GetIntegerValue(const std::string& key, | |
357 int defaultValue) const; | |
358 | |
359 unsigned int GetUnsignedIntegerValue(const std::string& key, | |
360 unsigned int defaultValue) const; | |
361 | |
362 bool GetBooleanValue(const std::string& key, | |
363 bool defaultValue) const; | |
364 | |
365 float GetFloatValue(const std::string& key, | |
366 float defaultValue) const; | |
367 | |
368 void GetDictionary(std::map<std::string, std::string>& target, | |
369 const std::string& key) const; | |
370 }; | |
371 | |
372 class OrthancImage : public boost::noncopyable | |
373 { | |
374 private: | |
375 OrthancPluginImage* image_; | |
376 | |
377 void Clear(); | |
378 | |
379 void CheckImageAvailable() const; | |
380 | |
381 public: | |
382 OrthancImage(); | |
383 | |
384 explicit OrthancImage(OrthancPluginImage* image); | |
385 | |
386 OrthancImage(OrthancPluginPixelFormat format, | |
387 uint32_t width, | |
388 uint32_t height); | |
389 | |
390 OrthancImage(OrthancPluginPixelFormat format, | |
391 uint32_t width, | |
392 uint32_t height, | |
393 uint32_t pitch, | |
394 void* buffer); | |
395 | |
396 ~OrthancImage() | |
397 { | |
398 Clear(); | |
399 } | |
400 | |
401 void UncompressPngImage(const void* data, | |
402 size_t size); | |
403 | |
404 void UncompressJpegImage(const void* data, | |
405 size_t size); | |
406 | |
407 void DecodeDicomImage(const void* data, | |
408 size_t size, | |
409 unsigned int frame); | |
410 | |
411 OrthancPluginPixelFormat GetPixelFormat() const; | |
412 | |
413 unsigned int GetWidth() const; | |
414 | |
415 unsigned int GetHeight() const; | |
416 | |
417 unsigned int GetPitch() const; | |
418 | |
419 void* GetBuffer() const; | |
420 | |
421 const OrthancPluginImage* GetObject() const | |
422 { | |
423 return image_; | |
424 } | |
425 | |
426 void CompressPngImage(MemoryBuffer& target) const; | |
427 | |
428 void CompressJpegImage(MemoryBuffer& target, | |
429 uint8_t quality) const; | |
430 | |
431 void AnswerPngImage(OrthancPluginRestOutput* output) const; | |
432 | |
433 void AnswerJpegImage(OrthancPluginRestOutput* output, | |
434 uint8_t quality) const; | |
435 | |
436 void* GetWriteableBuffer(); | |
437 | |
438 OrthancPluginImage* Release(); | |
439 }; | |
440 | |
441 | |
442 #if HAS_ORTHANC_PLUGIN_FIND_MATCHER == 1 | |
443 class FindMatcher : public boost::noncopyable | |
444 { | |
445 private: | |
446 OrthancPluginFindMatcher* matcher_; | |
447 const OrthancPluginWorklistQuery* worklist_; | |
448 | |
449 void SetupDicom(const void* query, | |
450 uint32_t size); | |
451 | |
452 public: | |
453 explicit FindMatcher(const OrthancPluginWorklistQuery* worklist); | |
454 | |
455 FindMatcher(const void* query, | |
456 uint32_t size) | |
457 { | |
458 SetupDicom(query, size); | |
459 } | |
460 | |
461 explicit FindMatcher(const MemoryBuffer& dicom) | |
462 { | |
463 SetupDicom(dicom.GetData(), dicom.GetSize()); | |
464 } | |
465 | |
466 ~FindMatcher(); | |
467 | |
468 bool IsMatch(const void* dicom, | |
469 uint32_t size) const; | |
470 | |
471 bool IsMatch(const MemoryBuffer& dicom) const | |
472 { | |
473 return IsMatch(dicom.GetData(), dicom.GetSize()); | |
474 } | |
475 }; | |
476 #endif | |
477 | |
478 | |
193
3236894320d6
upgrade to year 2021
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
170
diff
changeset
|
479 bool ReadJson(Json::Value& target, |
3236894320d6
upgrade to year 2021
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
170
diff
changeset
|
480 const std::string& source); |
3236894320d6
upgrade to year 2021
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
170
diff
changeset
|
481 |
3236894320d6
upgrade to year 2021
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
170
diff
changeset
|
482 bool ReadJson(Json::Value& target, |
3236894320d6
upgrade to year 2021
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
170
diff
changeset
|
483 const void* buffer, |
3236894320d6
upgrade to year 2021
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
170
diff
changeset
|
484 size_t size); |
3236894320d6
upgrade to year 2021
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
170
diff
changeset
|
485 |
3236894320d6
upgrade to year 2021
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
170
diff
changeset
|
486 void WriteFastJson(std::string& target, |
3236894320d6
upgrade to year 2021
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
170
diff
changeset
|
487 const Json::Value& source); |
3236894320d6
upgrade to year 2021
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
170
diff
changeset
|
488 |
3236894320d6
upgrade to year 2021
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
170
diff
changeset
|
489 void WriteStyledJson(std::string& target, |
3236894320d6
upgrade to year 2021
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
170
diff
changeset
|
490 const Json::Value& source); |
3236894320d6
upgrade to year 2021
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
170
diff
changeset
|
491 |
152 | 492 bool RestApiGet(Json::Value& result, |
493 const std::string& uri, | |
494 bool applyPlugins); | |
495 | |
496 bool RestApiGetString(std::string& result, | |
497 const std::string& uri, | |
498 bool applyPlugins); | |
499 | |
500 bool RestApiGetString(std::string& result, | |
501 const std::string& uri, | |
502 const std::map<std::string, std::string>& httpHeaders, | |
503 bool applyPlugins); | |
504 | |
505 bool RestApiPost(std::string& result, | |
506 const std::string& uri, | |
507 const void* body, | |
508 size_t bodySize, | |
509 bool applyPlugins); | |
510 | |
511 bool RestApiPost(Json::Value& result, | |
512 const std::string& uri, | |
513 const void* body, | |
514 size_t bodySize, | |
515 bool applyPlugins); | |
516 | |
517 bool RestApiPost(Json::Value& result, | |
518 const std::string& uri, | |
519 const Json::Value& body, | |
520 bool applyPlugins); | |
521 | |
522 inline bool RestApiPost(Json::Value& result, | |
523 const std::string& uri, | |
524 const std::string& body, | |
525 bool applyPlugins) | |
526 { | |
527 return RestApiPost(result, uri, body.empty() ? NULL : body.c_str(), | |
528 body.size(), applyPlugins); | |
529 } | |
530 | |
531 inline bool RestApiPost(Json::Value& result, | |
532 const std::string& uri, | |
533 const MemoryBuffer& body, | |
534 bool applyPlugins) | |
535 { | |
536 return RestApiPost(result, uri, body.GetData(), | |
537 body.GetSize(), applyPlugins); | |
538 } | |
539 | |
540 bool RestApiPut(Json::Value& result, | |
541 const std::string& uri, | |
542 const void* body, | |
543 size_t bodySize, | |
544 bool applyPlugins); | |
545 | |
546 bool RestApiPut(Json::Value& result, | |
547 const std::string& uri, | |
548 const Json::Value& body, | |
549 bool applyPlugins); | |
550 | |
551 inline bool RestApiPut(Json::Value& result, | |
552 const std::string& uri, | |
553 const std::string& body, | |
554 bool applyPlugins) | |
555 { | |
556 return RestApiPut(result, uri, body.empty() ? NULL : body.c_str(), | |
557 body.size(), applyPlugins); | |
558 } | |
559 | |
560 bool RestApiDelete(const std::string& uri, | |
561 bool applyPlugins); | |
562 | |
563 bool HttpDelete(const std::string& url, | |
564 const std::string& username, | |
565 const std::string& password); | |
566 | |
567 void AnswerJson(const Json::Value& value, | |
568 OrthancPluginRestOutput* output); | |
569 | |
570 void AnswerString(const std::string& answer, | |
571 const char* mimeType, | |
572 OrthancPluginRestOutput* output); | |
573 | |
574 void AnswerHttpError(uint16_t httpError, | |
575 OrthancPluginRestOutput* output); | |
576 | |
577 void AnswerMethodNotAllowed(OrthancPluginRestOutput* output, const char* allowedMethods); | |
578 | |
579 #if ORTHANC_PLUGINS_VERSION_IS_ABOVE(1, 5, 0) | |
580 const char* AutodetectMimeType(const std::string& path); | |
581 #endif | |
582 | |
583 void LogError(const std::string& message); | |
584 | |
585 void LogWarning(const std::string& message); | |
586 | |
587 void LogInfo(const std::string& message); | |
588 | |
589 void ReportMinimalOrthancVersion(unsigned int major, | |
590 unsigned int minor, | |
591 unsigned int revision); | |
592 | |
593 bool CheckMinimalOrthancVersion(unsigned int major, | |
594 unsigned int minor, | |
595 unsigned int revision); | |
596 | |
597 | |
598 namespace Internals | |
599 { | |
600 template <RestCallback Callback> | |
601 static OrthancPluginErrorCode Protect(OrthancPluginRestOutput* output, | |
602 const char* url, | |
603 const OrthancPluginHttpRequest* request) | |
604 { | |
605 try | |
606 { | |
607 Callback(output, url, request); | |
608 return OrthancPluginErrorCode_Success; | |
609 } | |
610 catch (ORTHANC_PLUGINS_EXCEPTION_CLASS& e) | |
611 { | |
612 #if HAS_ORTHANC_EXCEPTION == 1 && HAS_ORTHANC_PLUGIN_EXCEPTION_DETAILS == 1 | |
613 if (HasGlobalContext() && | |
614 e.HasDetails()) | |
615 { | |
616 // The "false" instructs Orthanc not to log the detailed | |
617 // error message. This is to avoid duplicating the details, | |
618 // because "OrthancException" already does it on construction. | |
619 OrthancPluginSetHttpErrorDetails | |
620 (GetGlobalContext(), output, e.GetDetails(), false); | |
621 } | |
622 #endif | |
623 | |
624 return static_cast<OrthancPluginErrorCode>(e.GetErrorCode()); | |
625 } | |
626 catch (boost::bad_lexical_cast&) | |
627 { | |
628 return OrthancPluginErrorCode_BadFileFormat; | |
629 } | |
630 catch (...) | |
631 { | |
632 return OrthancPluginErrorCode_Plugin; | |
633 } | |
634 } | |
635 } | |
636 | |
637 | |
638 template <RestCallback Callback> | |
639 void RegisterRestCallback(const std::string& uri, | |
640 bool isThreadSafe) | |
641 { | |
642 if (isThreadSafe) | |
643 { | |
644 OrthancPluginRegisterRestCallbackNoLock | |
645 (GetGlobalContext(), uri.c_str(), Internals::Protect<Callback>); | |
646 } | |
647 else | |
648 { | |
649 OrthancPluginRegisterRestCallback | |
650 (GetGlobalContext(), uri.c_str(), Internals::Protect<Callback>); | |
651 } | |
652 } | |
653 | |
654 | |
655 #if HAS_ORTHANC_PLUGIN_PEERS == 1 | |
656 class OrthancPeers : public boost::noncopyable | |
657 { | |
658 private: | |
659 typedef std::map<std::string, uint32_t> Index; | |
660 | |
661 OrthancPluginPeers *peers_; | |
662 Index index_; | |
663 uint32_t timeout_; | |
664 | |
665 size_t GetPeerIndex(const std::string& name) const; | |
666 | |
667 public: | |
668 OrthancPeers(); | |
669 | |
670 ~OrthancPeers(); | |
671 | |
672 uint32_t GetTimeout() const | |
673 { | |
674 return timeout_; | |
675 } | |
676 | |
677 void SetTimeout(uint32_t timeout) | |
678 { | |
679 timeout_ = timeout; | |
680 } | |
681 | |
682 bool LookupName(size_t& target, | |
683 const std::string& name) const; | |
684 | |
685 std::string GetPeerName(size_t index) const; | |
686 | |
687 std::string GetPeerUrl(size_t index) const; | |
688 | |
689 std::string GetPeerUrl(const std::string& name) const; | |
690 | |
691 size_t GetPeersCount() const | |
692 { | |
693 return index_.size(); | |
694 } | |
695 | |
696 bool LookupUserProperty(std::string& value, | |
697 size_t index, | |
698 const std::string& key) const; | |
699 | |
700 bool LookupUserProperty(std::string& value, | |
701 const std::string& peer, | |
702 const std::string& key) const; | |
703 | |
704 bool DoGet(MemoryBuffer& target, | |
705 size_t index, | |
706 const std::string& uri) const; | |
707 | |
708 bool DoGet(MemoryBuffer& target, | |
709 const std::string& name, | |
710 const std::string& uri) const; | |
711 | |
712 bool DoGet(Json::Value& target, | |
713 size_t index, | |
714 const std::string& uri) const; | |
715 | |
716 bool DoGet(Json::Value& target, | |
717 const std::string& name, | |
718 const std::string& uri) const; | |
719 | |
720 bool DoPost(MemoryBuffer& target, | |
721 size_t index, | |
722 const std::string& uri, | |
723 const std::string& body) const; | |
724 | |
725 bool DoPost(MemoryBuffer& target, | |
726 const std::string& name, | |
727 const std::string& uri, | |
728 const std::string& body) const; | |
729 | |
730 bool DoPost(Json::Value& target, | |
731 size_t index, | |
732 const std::string& uri, | |
733 const std::string& body) const; | |
734 | |
735 bool DoPost(Json::Value& target, | |
736 const std::string& name, | |
737 const std::string& uri, | |
738 const std::string& body) const; | |
739 | |
740 bool DoPut(size_t index, | |
741 const std::string& uri, | |
742 const std::string& body) const; | |
743 | |
744 bool DoPut(const std::string& name, | |
745 const std::string& uri, | |
746 const std::string& body) const; | |
747 | |
748 bool DoDelete(size_t index, | |
749 const std::string& uri) const; | |
750 | |
751 bool DoDelete(const std::string& name, | |
752 const std::string& uri) const; | |
753 }; | |
754 #endif | |
755 | |
756 | |
757 | |
758 #if HAS_ORTHANC_PLUGIN_JOB == 1 | |
759 class OrthancJob : public boost::noncopyable | |
760 { | |
761 private: | |
762 std::string jobType_; | |
763 std::string content_; | |
764 bool hasSerialized_; | |
765 std::string serialized_; | |
766 float progress_; | |
767 | |
768 static void CallbackFinalize(void* job); | |
769 | |
770 static float CallbackGetProgress(void* job); | |
771 | |
772 static const char* CallbackGetContent(void* job); | |
773 | |
774 static const char* CallbackGetSerialized(void* job); | |
775 | |
776 static OrthancPluginJobStepStatus CallbackStep(void* job); | |
777 | |
778 static OrthancPluginErrorCode CallbackStop(void* job, | |
779 OrthancPluginJobStopReason reason); | |
780 | |
781 static OrthancPluginErrorCode CallbackReset(void* job); | |
782 | |
783 protected: | |
784 void ClearContent(); | |
785 | |
786 void UpdateContent(const Json::Value& content); | |
787 | |
788 void ClearSerialized(); | |
789 | |
790 void UpdateSerialized(const Json::Value& serialized); | |
791 | |
792 void UpdateProgress(float progress); | |
793 | |
794 public: | |
170 | 795 explicit OrthancJob(const std::string& jobType); |
152 | 796 |
797 virtual ~OrthancJob() | |
798 { | |
799 } | |
800 | |
801 virtual OrthancPluginJobStepStatus Step() = 0; | |
802 | |
803 virtual void Stop(OrthancPluginJobStopReason reason) = 0; | |
804 | |
805 virtual void Reset() = 0; | |
806 | |
807 static OrthancPluginJob* Create(OrthancJob* job /* takes ownership */); | |
808 | |
809 static std::string Submit(OrthancJob* job /* takes ownership */, | |
810 int priority); | |
811 | |
812 static void SubmitAndWait(Json::Value& result, | |
813 OrthancJob* job /* takes ownership */, | |
814 int priority); | |
815 | |
816 // Submit a job from a POST on the REST API with the same | |
817 // conventions as in the Orthanc core (according to the | |
818 // "Synchronous" and "Priority" options) | |
819 static void SubmitFromRestApiPost(OrthancPluginRestOutput* output, | |
820 const Json::Value& body, | |
821 OrthancJob* job); | |
822 }; | |
823 #endif | |
824 | |
825 | |
826 #if HAS_ORTHANC_PLUGIN_METRICS == 1 | |
827 inline void SetMetricsValue(char* name, | |
828 float value) | |
829 { | |
830 OrthancPluginSetMetricsValue(GetGlobalContext(), name, | |
831 value, OrthancPluginMetricsType_Default); | |
832 } | |
833 | |
834 class MetricsTimer : public boost::noncopyable | |
835 { | |
836 private: | |
837 std::string name_; | |
838 boost::posix_time::ptime start_; | |
839 | |
840 public: | |
841 explicit MetricsTimer(const char* name); | |
842 | |
843 ~MetricsTimer(); | |
844 }; | |
845 #endif | |
846 | |
847 | |
848 #if HAS_ORTHANC_PLUGIN_HTTP_CLIENT == 1 | |
849 class HttpClient : public boost::noncopyable | |
850 { | |
851 public: | |
852 typedef std::map<std::string, std::string> HttpHeaders; | |
853 | |
854 class IRequestBody : public boost::noncopyable | |
855 { | |
856 public: | |
857 virtual ~IRequestBody() | |
858 { | |
859 } | |
860 | |
861 virtual bool ReadNextChunk(std::string& chunk) = 0; | |
862 }; | |
863 | |
864 | |
865 class IAnswer : public boost::noncopyable | |
866 { | |
867 public: | |
868 virtual ~IAnswer() | |
869 { | |
870 } | |
871 | |
872 virtual void AddHeader(const std::string& key, | |
873 const std::string& value) = 0; | |
874 | |
875 virtual void AddChunk(const void* data, | |
876 size_t size) = 0; | |
877 }; | |
878 | |
879 | |
880 private: | |
881 class RequestBodyWrapper; | |
882 | |
883 uint16_t httpStatus_; | |
884 OrthancPluginHttpMethod method_; | |
885 std::string url_; | |
886 HttpHeaders headers_; | |
887 std::string username_; | |
888 std::string password_; | |
889 uint32_t timeout_; | |
890 std::string certificateFile_; | |
891 std::string certificateKeyFile_; | |
892 std::string certificateKeyPassword_; | |
893 bool pkcs11_; | |
894 std::string fullBody_; | |
895 IRequestBody* chunkedBody_; | |
896 bool allowChunkedTransfers_; | |
897 | |
898 #if HAS_ORTHANC_PLUGIN_CHUNKED_HTTP_CLIENT == 1 | |
899 void ExecuteWithStream(uint16_t& httpStatus, // out | |
900 IAnswer& answer, // out | |
901 IRequestBody& body) const; | |
902 #endif | |
903 | |
904 void ExecuteWithoutStream(uint16_t& httpStatus, // out | |
905 HttpHeaders& answerHeaders, // out | |
906 std::string& answerBody, // out | |
907 const std::string& body) const; | |
908 | |
909 public: | |
910 HttpClient(); | |
911 | |
912 uint16_t GetHttpStatus() const | |
913 { | |
914 return httpStatus_; | |
915 } | |
916 | |
917 void SetMethod(OrthancPluginHttpMethod method) | |
918 { | |
919 method_ = method; | |
920 } | |
921 | |
922 const std::string& GetUrl() const | |
923 { | |
924 return url_; | |
925 } | |
926 | |
927 void SetUrl(const std::string& url) | |
928 { | |
929 url_ = url; | |
930 } | |
931 | |
932 void SetHeaders(const HttpHeaders& headers) | |
933 { | |
934 headers_ = headers; | |
935 } | |
936 | |
937 void AddHeader(const std::string& key, | |
938 const std::string& value) | |
939 { | |
940 headers_[key] = value; | |
941 } | |
942 | |
943 void AddHeaders(const HttpHeaders& headers); | |
944 | |
945 void SetCredentials(const std::string& username, | |
946 const std::string& password); | |
947 | |
948 void ClearCredentials(); | |
949 | |
950 void SetTimeout(unsigned int timeout) // 0 for default timeout | |
951 { | |
952 timeout_ = timeout; | |
953 } | |
954 | |
955 void SetCertificate(const std::string& certificateFile, | |
956 const std::string& keyFile, | |
957 const std::string& keyPassword); | |
958 | |
959 void ClearCertificate(); | |
960 | |
961 void SetPkcs11(bool pkcs11) | |
962 { | |
963 pkcs11_ = pkcs11; | |
964 } | |
965 | |
966 void ClearBody(); | |
967 | |
968 void SwapBody(std::string& body); | |
969 | |
970 void SetBody(const std::string& body); | |
971 | |
972 void SetBody(IRequestBody& body); | |
973 | |
974 // This function can be used to disable chunked transfers if the | |
975 // remote server is Orthanc with a version <= 1.5.6. | |
976 void SetChunkedTransfersAllowed(bool allow) | |
977 { | |
978 allowChunkedTransfers_ = allow; | |
979 } | |
980 | |
981 bool IsChunkedTransfersAllowed() const | |
982 { | |
983 return allowChunkedTransfers_; | |
984 } | |
985 | |
986 void Execute(IAnswer& answer); | |
987 | |
988 void Execute(HttpHeaders& answerHeaders /* out */, | |
989 std::string& answerBody /* out */); | |
990 | |
991 void Execute(HttpHeaders& answerHeaders /* out */, | |
992 Json::Value& answerBody /* out */); | |
993 | |
994 void Execute(); | |
995 }; | |
996 #endif | |
997 | |
998 | |
999 | |
1000 class IChunkedRequestReader : public boost::noncopyable | |
1001 { | |
1002 public: | |
1003 virtual ~IChunkedRequestReader() | |
1004 { | |
1005 } | |
1006 | |
1007 virtual void AddChunk(const void* data, | |
1008 size_t size) = 0; | |
1009 | |
1010 virtual void Execute(OrthancPluginRestOutput* output) = 0; | |
1011 }; | |
1012 | |
1013 | |
1014 typedef IChunkedRequestReader* (*ChunkedRestCallback) (const char* url, | |
1015 const OrthancPluginHttpRequest* request); | |
1016 | |
1017 | |
1018 namespace Internals | |
1019 { | |
1020 void NullRestCallback(OrthancPluginRestOutput* output, | |
1021 const char* url, | |
1022 const OrthancPluginHttpRequest* request); | |
1023 | |
1024 IChunkedRequestReader *NullChunkedRestCallback(const char* url, | |
1025 const OrthancPluginHttpRequest* request); | |
1026 | |
1027 | |
1028 #if HAS_ORTHANC_PLUGIN_CHUNKED_HTTP_SERVER == 1 | |
1029 template <ChunkedRestCallback Callback> | |
1030 static OrthancPluginErrorCode ChunkedProtect(OrthancPluginServerChunkedRequestReader** reader, | |
1031 const char* url, | |
1032 const OrthancPluginHttpRequest* request) | |
1033 { | |
1034 try | |
1035 { | |
1036 if (reader == NULL) | |
1037 { | |
1038 return OrthancPluginErrorCode_InternalError; | |
1039 } | |
1040 else | |
1041 { | |
1042 *reader = reinterpret_cast<OrthancPluginServerChunkedRequestReader*>(Callback(url, request)); | |
1043 if (*reader == NULL) | |
1044 { | |
1045 return OrthancPluginErrorCode_Plugin; | |
1046 } | |
1047 else | |
1048 { | |
1049 return OrthancPluginErrorCode_Success; | |
1050 } | |
1051 } | |
1052 } | |
1053 catch (ORTHANC_PLUGINS_EXCEPTION_CLASS& e) | |
1054 { | |
1055 return static_cast<OrthancPluginErrorCode>(e.GetErrorCode()); | |
1056 } | |
1057 catch (boost::bad_lexical_cast&) | |
1058 { | |
1059 return OrthancPluginErrorCode_BadFileFormat; | |
1060 } | |
1061 catch (...) | |
1062 { | |
1063 return OrthancPluginErrorCode_Plugin; | |
1064 } | |
1065 } | |
1066 | |
1067 OrthancPluginErrorCode ChunkedRequestReaderAddChunk( | |
1068 OrthancPluginServerChunkedRequestReader* reader, | |
1069 const void* data, | |
1070 uint32_t size); | |
1071 | |
1072 OrthancPluginErrorCode ChunkedRequestReaderExecute( | |
1073 OrthancPluginServerChunkedRequestReader* reader, | |
1074 OrthancPluginRestOutput* output); | |
1075 | |
1076 void ChunkedRequestReaderFinalize( | |
1077 OrthancPluginServerChunkedRequestReader* reader); | |
1078 | |
1079 #else | |
1080 | |
1081 OrthancPluginErrorCode ChunkedRestCompatibility(OrthancPluginRestOutput* output, | |
1082 const char* url, | |
1083 const OrthancPluginHttpRequest* request, | |
1084 RestCallback GetHandler, | |
1085 ChunkedRestCallback PostHandler, | |
1086 RestCallback DeleteHandler, | |
1087 ChunkedRestCallback PutHandler); | |
1088 | |
1089 template< | |
1090 RestCallback GetHandler, | |
1091 ChunkedRestCallback PostHandler, | |
1092 RestCallback DeleteHandler, | |
1093 ChunkedRestCallback PutHandler | |
1094 > | |
1095 inline OrthancPluginErrorCode ChunkedRestCompatibility(OrthancPluginRestOutput* output, | |
1096 const char* url, | |
1097 const OrthancPluginHttpRequest* request) | |
1098 { | |
1099 return ChunkedRestCompatibility(output, url, request, GetHandler, | |
1100 PostHandler, DeleteHandler, PutHandler); | |
1101 } | |
1102 #endif | |
1103 } | |
1104 | |
1105 | |
1106 | |
1107 // NB: We use a templated class instead of a templated function, because | |
1108 // default values are only available in functions since C++11 | |
1109 template< | |
1110 RestCallback GetHandler = Internals::NullRestCallback, | |
1111 ChunkedRestCallback PostHandler = Internals::NullChunkedRestCallback, | |
1112 RestCallback DeleteHandler = Internals::NullRestCallback, | |
1113 ChunkedRestCallback PutHandler = Internals::NullChunkedRestCallback | |
1114 > | |
1115 class ChunkedRestRegistration : public boost::noncopyable | |
1116 { | |
1117 public: | |
1118 static void Apply(const std::string& uri) | |
1119 { | |
1120 #if HAS_ORTHANC_PLUGIN_CHUNKED_HTTP_SERVER == 1 | |
1121 OrthancPluginRegisterChunkedRestCallback( | |
1122 GetGlobalContext(), uri.c_str(), | |
1123 GetHandler == Internals::NullRestCallback ? NULL : Internals::Protect<GetHandler>, | |
1124 PostHandler == Internals::NullChunkedRestCallback ? NULL : Internals::ChunkedProtect<PostHandler>, | |
1125 DeleteHandler == Internals::NullRestCallback ? NULL : Internals::Protect<DeleteHandler>, | |
1126 PutHandler == Internals::NullChunkedRestCallback ? NULL : Internals::ChunkedProtect<PutHandler>, | |
1127 Internals::ChunkedRequestReaderAddChunk, | |
1128 Internals::ChunkedRequestReaderExecute, | |
1129 Internals::ChunkedRequestReaderFinalize); | |
1130 #else | |
1131 OrthancPluginRegisterRestCallbackNoLock( | |
1132 GetGlobalContext(), uri.c_str(), | |
1133 Internals::ChunkedRestCompatibility<GetHandler, PostHandler, DeleteHandler, PutHandler>); | |
1134 #endif | |
1135 } | |
1136 }; | |
1137 | |
1138 | |
1139 | |
1140 #if HAS_ORTHANC_PLUGIN_STORAGE_COMMITMENT_SCP == 1 | |
1141 class IStorageCommitmentScpHandler : public boost::noncopyable | |
1142 { | |
1143 public: | |
1144 virtual ~IStorageCommitmentScpHandler() | |
1145 { | |
1146 } | |
1147 | |
1148 virtual OrthancPluginStorageCommitmentFailureReason Lookup(const std::string& sopClassUid, | |
1149 const std::string& sopInstanceUid) = 0; | |
1150 | |
1151 static OrthancPluginErrorCode Lookup(OrthancPluginStorageCommitmentFailureReason* target, | |
1152 void* rawHandler, | |
1153 const char* sopClassUid, | |
1154 const char* sopInstanceUid); | |
1155 | |
1156 static void Destructor(void* rawHandler); | |
1157 }; | |
1158 #endif | |
1159 | |
1160 | |
1161 class DicomInstance : public boost::noncopyable | |
1162 { | |
1163 private: | |
1164 bool toFree_; | |
1165 | |
1166 #if ORTHANC_PLUGINS_VERSION_IS_ABOVE(1, 6, 1) | |
1167 const OrthancPluginDicomInstance* instance_; | |
1168 #else | |
1169 OrthancPluginDicomInstance* instance_; | |
1170 #endif | |
1171 | |
1172 public: | |
1173 #if ORTHANC_PLUGINS_VERSION_IS_ABOVE(1, 6, 1) | |
167 | 1174 explicit DicomInstance(const OrthancPluginDicomInstance* instance); |
152 | 1175 #else |
167 | 1176 explicit DicomInstance(OrthancPluginDicomInstance* instance); |
152 | 1177 #endif |
1178 | |
1179 #if ORTHANC_PLUGINS_VERSION_IS_ABOVE(1, 7, 0) | |
1180 DicomInstance(const void* buffer, | |
1181 size_t size); | |
1182 #endif | |
1183 | |
1184 ~DicomInstance(); | |
1185 | |
1186 std::string GetRemoteAet() const; | |
1187 | |
1188 const void* GetBuffer() const | |
1189 { | |
1190 return OrthancPluginGetInstanceData(GetGlobalContext(), instance_); | |
1191 } | |
1192 | |
1193 size_t GetSize() const | |
1194 { | |
1195 return static_cast<size_t>(OrthancPluginGetInstanceSize(GetGlobalContext(), instance_)); | |
1196 } | |
1197 | |
1198 void GetJson(Json::Value& target) const; | |
1199 | |
1200 void GetSimplifiedJson(Json::Value& target) const; | |
1201 | |
1202 OrthancPluginInstanceOrigin GetOrigin() const | |
1203 { | |
1204 return OrthancPluginGetInstanceOrigin(GetGlobalContext(), instance_); | |
1205 } | |
1206 | |
1207 #if ORTHANC_PLUGINS_VERSION_IS_ABOVE(1, 6, 1) | |
1208 std::string GetTransferSyntaxUid() const; | |
1209 #endif | |
1210 | |
1211 #if ORTHANC_PLUGINS_VERSION_IS_ABOVE(1, 6, 1) | |
1212 bool HasPixelData() const; | |
1213 #endif | |
1214 | |
1215 #if ORTHANC_PLUGINS_VERSION_IS_ABOVE(1, 7, 0) | |
1216 unsigned int GetFramesCount() const | |
1217 { | |
1218 return OrthancPluginGetInstanceFramesCount(GetGlobalContext(), instance_); | |
1219 } | |
1220 #endif | |
1221 | |
1222 #if ORTHANC_PLUGINS_VERSION_IS_ABOVE(1, 7, 0) | |
1223 void GetRawFrame(std::string& target, | |
1224 unsigned int frameIndex) const; | |
1225 #endif | |
1226 | |
1227 #if ORTHANC_PLUGINS_VERSION_IS_ABOVE(1, 7, 0) | |
1228 OrthancImage* GetDecodedFrame(unsigned int frameIndex) const; | |
1229 #endif | |
1230 | |
1231 #if ORTHANC_PLUGINS_VERSION_IS_ABOVE(1, 7, 0) | |
1232 void Serialize(std::string& target) const; | |
1233 #endif | |
1234 | |
1235 #if ORTHANC_PLUGINS_VERSION_IS_ABOVE(1, 7, 0) | |
1236 static DicomInstance* Transcode(const void* buffer, | |
1237 size_t size, | |
1238 const std::string& transferSyntax); | |
1239 #endif | |
1240 }; | |
1241 } |