Mercurial > hg > orthanc-stone
comparison Applications/Resources/Orthanc/Plugins/OrthancPluginCppWrapper.cpp @ 1538:d1806b4e4839
moving OrthancStone/Samples/ as Applications/Samples/
author | Sebastien Jodogne <s.jodogne@gmail.com> |
---|---|
date | Tue, 11 Aug 2020 13:24:38 +0200 |
parents | |
children | 4fb8fdf03314 |
comparison
equal
deleted
inserted
replaced
1537:de8cf5859e84 | 1538:d1806b4e4839 |
---|---|
1 /** | |
2 * Orthanc - A Lightweight, RESTful DICOM Store | |
3 * Copyright (C) 2012-2016 Sebastien Jodogne, Medical Physics | |
4 * Department, University Hospital of Liege, Belgium | |
5 * Copyright (C) 2017-2020 Osimis S.A., Belgium | |
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. | |
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 * 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 #include "OrthancPluginCppWrapper.h" | |
23 | |
24 #include <boost/algorithm/string/predicate.hpp> | |
25 #include <boost/move/unique_ptr.hpp> | |
26 #include <boost/thread.hpp> | |
27 #include <json/reader.h> | |
28 #include <json/writer.h> | |
29 | |
30 | |
31 #if !ORTHANC_PLUGINS_VERSION_IS_ABOVE(1, 2, 0) | |
32 static const OrthancPluginErrorCode OrthancPluginErrorCode_NullPointer = OrthancPluginErrorCode_Plugin; | |
33 #endif | |
34 | |
35 | |
36 namespace OrthancPlugins | |
37 { | |
38 static OrthancPluginContext* globalContext_ = NULL; | |
39 | |
40 | |
41 void SetGlobalContext(OrthancPluginContext* context) | |
42 { | |
43 if (context == NULL) | |
44 { | |
45 ORTHANC_PLUGINS_THROW_EXCEPTION(NullPointer); | |
46 } | |
47 else if (globalContext_ == NULL) | |
48 { | |
49 globalContext_ = context; | |
50 } | |
51 else | |
52 { | |
53 ORTHANC_PLUGINS_THROW_EXCEPTION(BadSequenceOfCalls); | |
54 } | |
55 } | |
56 | |
57 | |
58 bool HasGlobalContext() | |
59 { | |
60 return globalContext_ != NULL; | |
61 } | |
62 | |
63 | |
64 OrthancPluginContext* GetGlobalContext() | |
65 { | |
66 if (globalContext_ == NULL) | |
67 { | |
68 ORTHANC_PLUGINS_THROW_EXCEPTION(BadSequenceOfCalls); | |
69 } | |
70 else | |
71 { | |
72 return globalContext_; | |
73 } | |
74 } | |
75 | |
76 | |
77 void MemoryBuffer::Check(OrthancPluginErrorCode code) | |
78 { | |
79 if (code != OrthancPluginErrorCode_Success) | |
80 { | |
81 // Prevent using garbage information | |
82 buffer_.data = NULL; | |
83 buffer_.size = 0; | |
84 ORTHANC_PLUGINS_THROW_PLUGIN_ERROR_CODE(code); | |
85 } | |
86 } | |
87 | |
88 | |
89 bool MemoryBuffer::CheckHttp(OrthancPluginErrorCode code) | |
90 { | |
91 if (code != OrthancPluginErrorCode_Success) | |
92 { | |
93 // Prevent using garbage information | |
94 buffer_.data = NULL; | |
95 buffer_.size = 0; | |
96 } | |
97 | |
98 if (code == OrthancPluginErrorCode_Success) | |
99 { | |
100 return true; | |
101 } | |
102 else if (code == OrthancPluginErrorCode_UnknownResource || | |
103 code == OrthancPluginErrorCode_InexistentItem) | |
104 { | |
105 return false; | |
106 } | |
107 else | |
108 { | |
109 ORTHANC_PLUGINS_THROW_PLUGIN_ERROR_CODE(code); | |
110 } | |
111 } | |
112 | |
113 | |
114 MemoryBuffer::MemoryBuffer() | |
115 { | |
116 buffer_.data = NULL; | |
117 buffer_.size = 0; | |
118 } | |
119 | |
120 | |
121 #if ORTHANC_PLUGINS_VERSION_IS_ABOVE(1, 7, 0) | |
122 MemoryBuffer::MemoryBuffer(const void* buffer, | |
123 size_t size) | |
124 { | |
125 uint32_t s = static_cast<uint32_t>(size); | |
126 if (static_cast<size_t>(s) != size) | |
127 { | |
128 ORTHANC_PLUGINS_THROW_EXCEPTION(NotEnoughMemory); | |
129 } | |
130 else if (OrthancPluginCreateMemoryBuffer(GetGlobalContext(), &buffer_, s) != | |
131 OrthancPluginErrorCode_Success) | |
132 { | |
133 ORTHANC_PLUGINS_THROW_EXCEPTION(NotEnoughMemory); | |
134 } | |
135 else | |
136 { | |
137 memcpy(buffer_.data, buffer, size); | |
138 } | |
139 } | |
140 #endif | |
141 | |
142 | |
143 void MemoryBuffer::Clear() | |
144 { | |
145 if (buffer_.data != NULL) | |
146 { | |
147 OrthancPluginFreeMemoryBuffer(GetGlobalContext(), &buffer_); | |
148 buffer_.data = NULL; | |
149 buffer_.size = 0; | |
150 } | |
151 } | |
152 | |
153 | |
154 void MemoryBuffer::Assign(OrthancPluginMemoryBuffer& other) | |
155 { | |
156 Clear(); | |
157 | |
158 buffer_.data = other.data; | |
159 buffer_.size = other.size; | |
160 | |
161 other.data = NULL; | |
162 other.size = 0; | |
163 } | |
164 | |
165 | |
166 void MemoryBuffer::Swap(MemoryBuffer& other) | |
167 { | |
168 std::swap(buffer_.data, other.buffer_.data); | |
169 std::swap(buffer_.size, other.buffer_.size); | |
170 } | |
171 | |
172 | |
173 OrthancPluginMemoryBuffer MemoryBuffer::Release() | |
174 { | |
175 OrthancPluginMemoryBuffer result = buffer_; | |
176 | |
177 buffer_.data = NULL; | |
178 buffer_.size = 0; | |
179 | |
180 return result; | |
181 } | |
182 | |
183 | |
184 void MemoryBuffer::ToString(std::string& target) const | |
185 { | |
186 if (buffer_.size == 0) | |
187 { | |
188 target.clear(); | |
189 } | |
190 else | |
191 { | |
192 target.assign(reinterpret_cast<const char*>(buffer_.data), buffer_.size); | |
193 } | |
194 } | |
195 | |
196 | |
197 void MemoryBuffer::ToJson(Json::Value& target) const | |
198 { | |
199 if (buffer_.data == NULL || | |
200 buffer_.size == 0) | |
201 { | |
202 ORTHANC_PLUGINS_THROW_EXCEPTION(InternalError); | |
203 } | |
204 | |
205 const char* tmp = reinterpret_cast<const char*>(buffer_.data); | |
206 | |
207 Json::Reader reader; | |
208 if (!reader.parse(tmp, tmp + buffer_.size, target)) | |
209 { | |
210 LogError("Cannot convert some memory buffer to JSON"); | |
211 ORTHANC_PLUGINS_THROW_EXCEPTION(BadFileFormat); | |
212 } | |
213 } | |
214 | |
215 | |
216 bool MemoryBuffer::RestApiGet(const std::string& uri, | |
217 bool applyPlugins) | |
218 { | |
219 Clear(); | |
220 | |
221 if (applyPlugins) | |
222 { | |
223 return CheckHttp(OrthancPluginRestApiGetAfterPlugins(GetGlobalContext(), &buffer_, uri.c_str())); | |
224 } | |
225 else | |
226 { | |
227 return CheckHttp(OrthancPluginRestApiGet(GetGlobalContext(), &buffer_, uri.c_str())); | |
228 } | |
229 } | |
230 | |
231 bool MemoryBuffer::RestApiGet(const std::string& uri, | |
232 const std::map<std::string, std::string>& httpHeaders, | |
233 bool applyPlugins) | |
234 { | |
235 Clear(); | |
236 | |
237 std::vector<const char*> headersKeys; | |
238 std::vector<const char*> headersValues; | |
239 | |
240 for (std::map<std::string, std::string>::const_iterator | |
241 it = httpHeaders.begin(); it != httpHeaders.end(); it++) | |
242 { | |
243 headersKeys.push_back(it->first.c_str()); | |
244 headersValues.push_back(it->second.c_str()); | |
245 } | |
246 | |
247 return CheckHttp(OrthancPluginRestApiGet2( | |
248 GetGlobalContext(), &buffer_, uri.c_str(), httpHeaders.size(), | |
249 (headersKeys.empty() ? NULL : &headersKeys[0]), | |
250 (headersValues.empty() ? NULL : &headersValues[0]), applyPlugins)); | |
251 } | |
252 | |
253 bool MemoryBuffer::RestApiPost(const std::string& uri, | |
254 const void* body, | |
255 size_t bodySize, | |
256 bool applyPlugins) | |
257 { | |
258 Clear(); | |
259 | |
260 // Cast for compatibility with Orthanc SDK <= 1.5.6 | |
261 const char* b = reinterpret_cast<const char*>(body); | |
262 | |
263 if (applyPlugins) | |
264 { | |
265 return CheckHttp(OrthancPluginRestApiPostAfterPlugins(GetGlobalContext(), &buffer_, uri.c_str(), b, bodySize)); | |
266 } | |
267 else | |
268 { | |
269 return CheckHttp(OrthancPluginRestApiPost(GetGlobalContext(), &buffer_, uri.c_str(), b, bodySize)); | |
270 } | |
271 } | |
272 | |
273 | |
274 bool MemoryBuffer::RestApiPut(const std::string& uri, | |
275 const void* body, | |
276 size_t bodySize, | |
277 bool applyPlugins) | |
278 { | |
279 Clear(); | |
280 | |
281 // Cast for compatibility with Orthanc SDK <= 1.5.6 | |
282 const char* b = reinterpret_cast<const char*>(body); | |
283 | |
284 if (applyPlugins) | |
285 { | |
286 return CheckHttp(OrthancPluginRestApiPutAfterPlugins(GetGlobalContext(), &buffer_, uri.c_str(), b, bodySize)); | |
287 } | |
288 else | |
289 { | |
290 return CheckHttp(OrthancPluginRestApiPut(GetGlobalContext(), &buffer_, uri.c_str(), b, bodySize)); | |
291 } | |
292 } | |
293 | |
294 | |
295 bool MemoryBuffer::RestApiPost(const std::string& uri, | |
296 const Json::Value& body, | |
297 bool applyPlugins) | |
298 { | |
299 Json::FastWriter writer; | |
300 return RestApiPost(uri, writer.write(body), applyPlugins); | |
301 } | |
302 | |
303 | |
304 bool MemoryBuffer::RestApiPut(const std::string& uri, | |
305 const Json::Value& body, | |
306 bool applyPlugins) | |
307 { | |
308 Json::FastWriter writer; | |
309 return RestApiPut(uri, writer.write(body), applyPlugins); | |
310 } | |
311 | |
312 | |
313 void MemoryBuffer::CreateDicom(const Json::Value& tags, | |
314 OrthancPluginCreateDicomFlags flags) | |
315 { | |
316 Clear(); | |
317 | |
318 Json::FastWriter writer; | |
319 std::string s = writer.write(tags); | |
320 | |
321 Check(OrthancPluginCreateDicom(GetGlobalContext(), &buffer_, s.c_str(), NULL, flags)); | |
322 } | |
323 | |
324 void MemoryBuffer::CreateDicom(const Json::Value& tags, | |
325 const OrthancImage& pixelData, | |
326 OrthancPluginCreateDicomFlags flags) | |
327 { | |
328 Clear(); | |
329 | |
330 Json::FastWriter writer; | |
331 std::string s = writer.write(tags); | |
332 | |
333 Check(OrthancPluginCreateDicom(GetGlobalContext(), &buffer_, s.c_str(), pixelData.GetObject(), flags)); | |
334 } | |
335 | |
336 | |
337 void MemoryBuffer::ReadFile(const std::string& path) | |
338 { | |
339 Clear(); | |
340 Check(OrthancPluginReadFile(GetGlobalContext(), &buffer_, path.c_str())); | |
341 } | |
342 | |
343 | |
344 void MemoryBuffer::GetDicomQuery(const OrthancPluginWorklistQuery* query) | |
345 { | |
346 Clear(); | |
347 Check(OrthancPluginWorklistGetDicomQuery(GetGlobalContext(), &buffer_, query)); | |
348 } | |
349 | |
350 | |
351 void OrthancString::Assign(char* str) | |
352 { | |
353 Clear(); | |
354 | |
355 if (str != NULL) | |
356 { | |
357 str_ = str; | |
358 } | |
359 } | |
360 | |
361 | |
362 void OrthancString::Clear() | |
363 { | |
364 if (str_ != NULL) | |
365 { | |
366 OrthancPluginFreeString(GetGlobalContext(), str_); | |
367 str_ = NULL; | |
368 } | |
369 } | |
370 | |
371 | |
372 void OrthancString::ToString(std::string& target) const | |
373 { | |
374 if (str_ == NULL) | |
375 { | |
376 target.clear(); | |
377 } | |
378 else | |
379 { | |
380 target.assign(str_); | |
381 } | |
382 } | |
383 | |
384 | |
385 void OrthancString::ToJson(Json::Value& target) const | |
386 { | |
387 if (str_ == NULL) | |
388 { | |
389 LogError("Cannot convert an empty memory buffer to JSON"); | |
390 ORTHANC_PLUGINS_THROW_EXCEPTION(InternalError); | |
391 } | |
392 | |
393 Json::Reader reader; | |
394 if (!reader.parse(str_, target)) | |
395 { | |
396 LogError("Cannot convert some memory buffer to JSON"); | |
397 ORTHANC_PLUGINS_THROW_EXCEPTION(BadFileFormat); | |
398 } | |
399 } | |
400 | |
401 | |
402 void MemoryBuffer::DicomToJson(Json::Value& target, | |
403 OrthancPluginDicomToJsonFormat format, | |
404 OrthancPluginDicomToJsonFlags flags, | |
405 uint32_t maxStringLength) | |
406 { | |
407 OrthancString str; | |
408 str.Assign(OrthancPluginDicomBufferToJson | |
409 (GetGlobalContext(), GetData(), GetSize(), format, flags, maxStringLength)); | |
410 str.ToJson(target); | |
411 } | |
412 | |
413 | |
414 bool MemoryBuffer::HttpGet(const std::string& url, | |
415 const std::string& username, | |
416 const std::string& password) | |
417 { | |
418 Clear(); | |
419 return CheckHttp(OrthancPluginHttpGet(GetGlobalContext(), &buffer_, url.c_str(), | |
420 username.empty() ? NULL : username.c_str(), | |
421 password.empty() ? NULL : password.c_str())); | |
422 } | |
423 | |
424 | |
425 bool MemoryBuffer::HttpPost(const std::string& url, | |
426 const std::string& body, | |
427 const std::string& username, | |
428 const std::string& password) | |
429 { | |
430 Clear(); | |
431 return CheckHttp(OrthancPluginHttpPost(GetGlobalContext(), &buffer_, url.c_str(), | |
432 body.c_str(), body.size(), | |
433 username.empty() ? NULL : username.c_str(), | |
434 password.empty() ? NULL : password.c_str())); | |
435 } | |
436 | |
437 | |
438 bool MemoryBuffer::HttpPut(const std::string& url, | |
439 const std::string& body, | |
440 const std::string& username, | |
441 const std::string& password) | |
442 { | |
443 Clear(); | |
444 return CheckHttp(OrthancPluginHttpPut(GetGlobalContext(), &buffer_, url.c_str(), | |
445 body.empty() ? NULL : body.c_str(), | |
446 body.size(), | |
447 username.empty() ? NULL : username.c_str(), | |
448 password.empty() ? NULL : password.c_str())); | |
449 } | |
450 | |
451 | |
452 void MemoryBuffer::GetDicomInstance(const std::string& instanceId) | |
453 { | |
454 Clear(); | |
455 Check(OrthancPluginGetDicomForInstance(GetGlobalContext(), &buffer_, instanceId.c_str())); | |
456 } | |
457 | |
458 | |
459 bool HttpDelete(const std::string& url, | |
460 const std::string& username, | |
461 const std::string& password) | |
462 { | |
463 OrthancPluginErrorCode error = OrthancPluginHttpDelete | |
464 (GetGlobalContext(), url.c_str(), | |
465 username.empty() ? NULL : username.c_str(), | |
466 password.empty() ? NULL : password.c_str()); | |
467 | |
468 if (error == OrthancPluginErrorCode_Success) | |
469 { | |
470 return true; | |
471 } | |
472 else if (error == OrthancPluginErrorCode_UnknownResource || | |
473 error == OrthancPluginErrorCode_InexistentItem) | |
474 { | |
475 return false; | |
476 } | |
477 else | |
478 { | |
479 ORTHANC_PLUGINS_THROW_PLUGIN_ERROR_CODE(error); | |
480 } | |
481 } | |
482 | |
483 | |
484 void LogError(const std::string& message) | |
485 { | |
486 if (HasGlobalContext()) | |
487 { | |
488 OrthancPluginLogError(GetGlobalContext(), message.c_str()); | |
489 } | |
490 } | |
491 | |
492 | |
493 void LogWarning(const std::string& message) | |
494 { | |
495 if (HasGlobalContext()) | |
496 { | |
497 OrthancPluginLogWarning(GetGlobalContext(), message.c_str()); | |
498 } | |
499 } | |
500 | |
501 | |
502 void LogInfo(const std::string& message) | |
503 { | |
504 if (HasGlobalContext()) | |
505 { | |
506 OrthancPluginLogInfo(GetGlobalContext(), message.c_str()); | |
507 } | |
508 } | |
509 | |
510 | |
511 void OrthancConfiguration::LoadConfiguration() | |
512 { | |
513 OrthancString str; | |
514 str.Assign(OrthancPluginGetConfiguration(GetGlobalContext())); | |
515 | |
516 if (str.GetContent() == NULL) | |
517 { | |
518 LogError("Cannot access the Orthanc configuration"); | |
519 ORTHANC_PLUGINS_THROW_EXCEPTION(InternalError); | |
520 } | |
521 | |
522 str.ToJson(configuration_); | |
523 | |
524 if (configuration_.type() != Json::objectValue) | |
525 { | |
526 LogError("Unable to read the Orthanc configuration"); | |
527 ORTHANC_PLUGINS_THROW_EXCEPTION(InternalError); | |
528 } | |
529 } | |
530 | |
531 | |
532 OrthancConfiguration::OrthancConfiguration() | |
533 { | |
534 LoadConfiguration(); | |
535 } | |
536 | |
537 | |
538 OrthancConfiguration::OrthancConfiguration(bool loadConfiguration) | |
539 { | |
540 if (loadConfiguration) | |
541 { | |
542 LoadConfiguration(); | |
543 } | |
544 else | |
545 { | |
546 configuration_ = Json::objectValue; | |
547 } | |
548 } | |
549 | |
550 | |
551 std::string OrthancConfiguration::GetPath(const std::string& key) const | |
552 { | |
553 if (path_.empty()) | |
554 { | |
555 return key; | |
556 } | |
557 else | |
558 { | |
559 return path_ + "." + key; | |
560 } | |
561 } | |
562 | |
563 | |
564 bool OrthancConfiguration::IsSection(const std::string& key) const | |
565 { | |
566 assert(configuration_.type() == Json::objectValue); | |
567 | |
568 return (configuration_.isMember(key) && | |
569 configuration_[key].type() == Json::objectValue); | |
570 } | |
571 | |
572 | |
573 void OrthancConfiguration::GetSection(OrthancConfiguration& target, | |
574 const std::string& key) const | |
575 { | |
576 assert(configuration_.type() == Json::objectValue); | |
577 | |
578 target.path_ = GetPath(key); | |
579 | |
580 if (!configuration_.isMember(key)) | |
581 { | |
582 target.configuration_ = Json::objectValue; | |
583 } | |
584 else | |
585 { | |
586 if (configuration_[key].type() != Json::objectValue) | |
587 { | |
588 LogError("The configuration section \"" + target.path_ + | |
589 "\" is not an associative array as expected"); | |
590 | |
591 ORTHANC_PLUGINS_THROW_EXCEPTION(BadFileFormat); | |
592 } | |
593 | |
594 target.configuration_ = configuration_[key]; | |
595 } | |
596 } | |
597 | |
598 | |
599 bool OrthancConfiguration::LookupStringValue(std::string& target, | |
600 const std::string& key) const | |
601 { | |
602 assert(configuration_.type() == Json::objectValue); | |
603 | |
604 if (!configuration_.isMember(key)) | |
605 { | |
606 return false; | |
607 } | |
608 | |
609 if (configuration_[key].type() != Json::stringValue) | |
610 { | |
611 LogError("The configuration option \"" + GetPath(key) + | |
612 "\" is not a string as expected"); | |
613 | |
614 ORTHANC_PLUGINS_THROW_EXCEPTION(BadFileFormat); | |
615 } | |
616 | |
617 target = configuration_[key].asString(); | |
618 return true; | |
619 } | |
620 | |
621 | |
622 bool OrthancConfiguration::LookupIntegerValue(int& target, | |
623 const std::string& key) const | |
624 { | |
625 assert(configuration_.type() == Json::objectValue); | |
626 | |
627 if (!configuration_.isMember(key)) | |
628 { | |
629 return false; | |
630 } | |
631 | |
632 switch (configuration_[key].type()) | |
633 { | |
634 case Json::intValue: | |
635 target = configuration_[key].asInt(); | |
636 return true; | |
637 | |
638 case Json::uintValue: | |
639 target = configuration_[key].asUInt(); | |
640 return true; | |
641 | |
642 default: | |
643 LogError("The configuration option \"" + GetPath(key) + | |
644 "\" is not an integer as expected"); | |
645 | |
646 ORTHANC_PLUGINS_THROW_EXCEPTION(BadFileFormat); | |
647 } | |
648 } | |
649 | |
650 | |
651 bool OrthancConfiguration::LookupUnsignedIntegerValue(unsigned int& target, | |
652 const std::string& key) const | |
653 { | |
654 int tmp; | |
655 if (!LookupIntegerValue(tmp, key)) | |
656 { | |
657 return false; | |
658 } | |
659 | |
660 if (tmp < 0) | |
661 { | |
662 LogError("The configuration option \"" + GetPath(key) + | |
663 "\" is not a positive integer as expected"); | |
664 | |
665 ORTHANC_PLUGINS_THROW_EXCEPTION(BadFileFormat); | |
666 } | |
667 else | |
668 { | |
669 target = static_cast<unsigned int>(tmp); | |
670 return true; | |
671 } | |
672 } | |
673 | |
674 | |
675 bool OrthancConfiguration::LookupBooleanValue(bool& target, | |
676 const std::string& key) const | |
677 { | |
678 assert(configuration_.type() == Json::objectValue); | |
679 | |
680 if (!configuration_.isMember(key)) | |
681 { | |
682 return false; | |
683 } | |
684 | |
685 if (configuration_[key].type() != Json::booleanValue) | |
686 { | |
687 LogError("The configuration option \"" + GetPath(key) + | |
688 "\" is not a Boolean as expected"); | |
689 | |
690 ORTHANC_PLUGINS_THROW_EXCEPTION(BadFileFormat); | |
691 } | |
692 | |
693 target = configuration_[key].asBool(); | |
694 return true; | |
695 } | |
696 | |
697 | |
698 bool OrthancConfiguration::LookupFloatValue(float& target, | |
699 const std::string& key) const | |
700 { | |
701 assert(configuration_.type() == Json::objectValue); | |
702 | |
703 if (!configuration_.isMember(key)) | |
704 { | |
705 return false; | |
706 } | |
707 | |
708 switch (configuration_[key].type()) | |
709 { | |
710 case Json::realValue: | |
711 target = configuration_[key].asFloat(); | |
712 return true; | |
713 | |
714 case Json::intValue: | |
715 target = static_cast<float>(configuration_[key].asInt()); | |
716 return true; | |
717 | |
718 case Json::uintValue: | |
719 target = static_cast<float>(configuration_[key].asUInt()); | |
720 return true; | |
721 | |
722 default: | |
723 LogError("The configuration option \"" + GetPath(key) + | |
724 "\" is not an integer as expected"); | |
725 | |
726 ORTHANC_PLUGINS_THROW_EXCEPTION(BadFileFormat); | |
727 } | |
728 } | |
729 | |
730 | |
731 bool OrthancConfiguration::LookupListOfStrings(std::list<std::string>& target, | |
732 const std::string& key, | |
733 bool allowSingleString) const | |
734 { | |
735 assert(configuration_.type() == Json::objectValue); | |
736 | |
737 target.clear(); | |
738 | |
739 if (!configuration_.isMember(key)) | |
740 { | |
741 return false; | |
742 } | |
743 | |
744 switch (configuration_[key].type()) | |
745 { | |
746 case Json::arrayValue: | |
747 { | |
748 bool ok = true; | |
749 | |
750 for (Json::Value::ArrayIndex i = 0; ok && i < configuration_[key].size(); i++) | |
751 { | |
752 if (configuration_[key][i].type() == Json::stringValue) | |
753 { | |
754 target.push_back(configuration_[key][i].asString()); | |
755 } | |
756 else | |
757 { | |
758 ok = false; | |
759 } | |
760 } | |
761 | |
762 if (ok) | |
763 { | |
764 return true; | |
765 } | |
766 | |
767 break; | |
768 } | |
769 | |
770 case Json::stringValue: | |
771 if (allowSingleString) | |
772 { | |
773 target.push_back(configuration_[key].asString()); | |
774 return true; | |
775 } | |
776 | |
777 break; | |
778 | |
779 default: | |
780 break; | |
781 } | |
782 | |
783 LogError("The configuration option \"" + GetPath(key) + | |
784 "\" is not a list of strings as expected"); | |
785 | |
786 ORTHANC_PLUGINS_THROW_EXCEPTION(BadFileFormat); | |
787 } | |
788 | |
789 | |
790 bool OrthancConfiguration::LookupSetOfStrings(std::set<std::string>& target, | |
791 const std::string& key, | |
792 bool allowSingleString) const | |
793 { | |
794 std::list<std::string> lst; | |
795 | |
796 if (LookupListOfStrings(lst, key, allowSingleString)) | |
797 { | |
798 target.clear(); | |
799 | |
800 for (std::list<std::string>::const_iterator | |
801 it = lst.begin(); it != lst.end(); ++it) | |
802 { | |
803 target.insert(*it); | |
804 } | |
805 | |
806 return true; | |
807 } | |
808 else | |
809 { | |
810 return false; | |
811 } | |
812 } | |
813 | |
814 | |
815 std::string OrthancConfiguration::GetStringValue(const std::string& key, | |
816 const std::string& defaultValue) const | |
817 { | |
818 std::string tmp; | |
819 if (LookupStringValue(tmp, key)) | |
820 { | |
821 return tmp; | |
822 } | |
823 else | |
824 { | |
825 return defaultValue; | |
826 } | |
827 } | |
828 | |
829 | |
830 int OrthancConfiguration::GetIntegerValue(const std::string& key, | |
831 int defaultValue) const | |
832 { | |
833 int tmp; | |
834 if (LookupIntegerValue(tmp, key)) | |
835 { | |
836 return tmp; | |
837 } | |
838 else | |
839 { | |
840 return defaultValue; | |
841 } | |
842 } | |
843 | |
844 | |
845 unsigned int OrthancConfiguration::GetUnsignedIntegerValue(const std::string& key, | |
846 unsigned int defaultValue) const | |
847 { | |
848 unsigned int tmp; | |
849 if (LookupUnsignedIntegerValue(tmp, key)) | |
850 { | |
851 return tmp; | |
852 } | |
853 else | |
854 { | |
855 return defaultValue; | |
856 } | |
857 } | |
858 | |
859 | |
860 bool OrthancConfiguration::GetBooleanValue(const std::string& key, | |
861 bool defaultValue) const | |
862 { | |
863 bool tmp; | |
864 if (LookupBooleanValue(tmp, key)) | |
865 { | |
866 return tmp; | |
867 } | |
868 else | |
869 { | |
870 return defaultValue; | |
871 } | |
872 } | |
873 | |
874 | |
875 float OrthancConfiguration::GetFloatValue(const std::string& key, | |
876 float defaultValue) const | |
877 { | |
878 float tmp; | |
879 if (LookupFloatValue(tmp, key)) | |
880 { | |
881 return tmp; | |
882 } | |
883 else | |
884 { | |
885 return defaultValue; | |
886 } | |
887 } | |
888 | |
889 | |
890 void OrthancConfiguration::GetDictionary(std::map<std::string, std::string>& target, | |
891 const std::string& key) const | |
892 { | |
893 assert(configuration_.type() == Json::objectValue); | |
894 | |
895 target.clear(); | |
896 | |
897 if (!configuration_.isMember(key)) | |
898 { | |
899 return; | |
900 } | |
901 | |
902 if (configuration_[key].type() != Json::objectValue) | |
903 { | |
904 LogError("The configuration option \"" + GetPath(key) + | |
905 "\" is not a string as expected"); | |
906 | |
907 ORTHANC_PLUGINS_THROW_EXCEPTION(BadFileFormat); | |
908 } | |
909 | |
910 Json::Value::Members members = configuration_[key].getMemberNames(); | |
911 | |
912 for (size_t i = 0; i < members.size(); i++) | |
913 { | |
914 const Json::Value& value = configuration_[key][members[i]]; | |
915 | |
916 if (value.type() == Json::stringValue) | |
917 { | |
918 target[members[i]] = value.asString(); | |
919 } | |
920 else | |
921 { | |
922 LogError("The configuration option \"" + GetPath(key) + | |
923 "\" is not a dictionary mapping strings to strings"); | |
924 | |
925 ORTHANC_PLUGINS_THROW_EXCEPTION(BadFileFormat); | |
926 } | |
927 } | |
928 } | |
929 | |
930 | |
931 void OrthancImage::Clear() | |
932 { | |
933 if (image_ != NULL) | |
934 { | |
935 OrthancPluginFreeImage(GetGlobalContext(), image_); | |
936 image_ = NULL; | |
937 } | |
938 } | |
939 | |
940 | |
941 void OrthancImage::CheckImageAvailable() const | |
942 { | |
943 if (image_ == NULL) | |
944 { | |
945 LogError("Trying to access a NULL image"); | |
946 ORTHANC_PLUGINS_THROW_EXCEPTION(ParameterOutOfRange); | |
947 } | |
948 } | |
949 | |
950 | |
951 OrthancImage::OrthancImage() : | |
952 image_(NULL) | |
953 { | |
954 } | |
955 | |
956 | |
957 OrthancImage::OrthancImage(OrthancPluginImage* image) : | |
958 image_(image) | |
959 { | |
960 } | |
961 | |
962 | |
963 OrthancImage::OrthancImage(OrthancPluginPixelFormat format, | |
964 uint32_t width, | |
965 uint32_t height) | |
966 { | |
967 image_ = OrthancPluginCreateImage(GetGlobalContext(), format, width, height); | |
968 | |
969 if (image_ == NULL) | |
970 { | |
971 LogError("Cannot create an image"); | |
972 ORTHANC_PLUGINS_THROW_EXCEPTION(InternalError); | |
973 } | |
974 } | |
975 | |
976 | |
977 OrthancImage::OrthancImage(OrthancPluginPixelFormat format, | |
978 uint32_t width, | |
979 uint32_t height, | |
980 uint32_t pitch, | |
981 void* buffer) | |
982 { | |
983 image_ = OrthancPluginCreateImageAccessor | |
984 (GetGlobalContext(), format, width, height, pitch, buffer); | |
985 | |
986 if (image_ == NULL) | |
987 { | |
988 LogError("Cannot create an image accessor"); | |
989 ORTHANC_PLUGINS_THROW_EXCEPTION(InternalError); | |
990 } | |
991 } | |
992 | |
993 void OrthancImage::UncompressPngImage(const void* data, | |
994 size_t size) | |
995 { | |
996 Clear(); | |
997 | |
998 image_ = OrthancPluginUncompressImage(GetGlobalContext(), data, size, OrthancPluginImageFormat_Png); | |
999 | |
1000 if (image_ == NULL) | |
1001 { | |
1002 LogError("Cannot uncompress a PNG image"); | |
1003 ORTHANC_PLUGINS_THROW_EXCEPTION(ParameterOutOfRange); | |
1004 } | |
1005 } | |
1006 | |
1007 | |
1008 void OrthancImage::UncompressJpegImage(const void* data, | |
1009 size_t size) | |
1010 { | |
1011 Clear(); | |
1012 image_ = OrthancPluginUncompressImage(GetGlobalContext(), data, size, OrthancPluginImageFormat_Jpeg); | |
1013 if (image_ == NULL) | |
1014 { | |
1015 LogError("Cannot uncompress a JPEG image"); | |
1016 ORTHANC_PLUGINS_THROW_EXCEPTION(ParameterOutOfRange); | |
1017 } | |
1018 } | |
1019 | |
1020 | |
1021 void OrthancImage::DecodeDicomImage(const void* data, | |
1022 size_t size, | |
1023 unsigned int frame) | |
1024 { | |
1025 Clear(); | |
1026 image_ = OrthancPluginDecodeDicomImage(GetGlobalContext(), data, size, frame); | |
1027 if (image_ == NULL) | |
1028 { | |
1029 LogError("Cannot uncompress a DICOM image"); | |
1030 ORTHANC_PLUGINS_THROW_EXCEPTION(ParameterOutOfRange); | |
1031 } | |
1032 } | |
1033 | |
1034 | |
1035 OrthancPluginPixelFormat OrthancImage::GetPixelFormat() const | |
1036 { | |
1037 CheckImageAvailable(); | |
1038 return OrthancPluginGetImagePixelFormat(GetGlobalContext(), image_); | |
1039 } | |
1040 | |
1041 | |
1042 unsigned int OrthancImage::GetWidth() const | |
1043 { | |
1044 CheckImageAvailable(); | |
1045 return OrthancPluginGetImageWidth(GetGlobalContext(), image_); | |
1046 } | |
1047 | |
1048 | |
1049 unsigned int OrthancImage::GetHeight() const | |
1050 { | |
1051 CheckImageAvailable(); | |
1052 return OrthancPluginGetImageHeight(GetGlobalContext(), image_); | |
1053 } | |
1054 | |
1055 | |
1056 unsigned int OrthancImage::GetPitch() const | |
1057 { | |
1058 CheckImageAvailable(); | |
1059 return OrthancPluginGetImagePitch(GetGlobalContext(), image_); | |
1060 } | |
1061 | |
1062 | |
1063 void* OrthancImage::GetBuffer() const | |
1064 { | |
1065 CheckImageAvailable(); | |
1066 return OrthancPluginGetImageBuffer(GetGlobalContext(), image_); | |
1067 } | |
1068 | |
1069 | |
1070 void OrthancImage::CompressPngImage(MemoryBuffer& target) const | |
1071 { | |
1072 CheckImageAvailable(); | |
1073 | |
1074 OrthancPlugins::MemoryBuffer answer; | |
1075 OrthancPluginCompressPngImage(GetGlobalContext(), *answer, GetPixelFormat(), | |
1076 GetWidth(), GetHeight(), GetPitch(), GetBuffer()); | |
1077 | |
1078 target.Swap(answer); | |
1079 } | |
1080 | |
1081 | |
1082 void OrthancImage::CompressJpegImage(MemoryBuffer& target, | |
1083 uint8_t quality) const | |
1084 { | |
1085 CheckImageAvailable(); | |
1086 | |
1087 OrthancPlugins::MemoryBuffer answer; | |
1088 OrthancPluginCompressJpegImage(GetGlobalContext(), *answer, GetPixelFormat(), | |
1089 GetWidth(), GetHeight(), GetPitch(), GetBuffer(), quality); | |
1090 | |
1091 target.Swap(answer); | |
1092 } | |
1093 | |
1094 | |
1095 void OrthancImage::AnswerPngImage(OrthancPluginRestOutput* output) const | |
1096 { | |
1097 CheckImageAvailable(); | |
1098 OrthancPluginCompressAndAnswerPngImage(GetGlobalContext(), output, GetPixelFormat(), | |
1099 GetWidth(), GetHeight(), GetPitch(), GetBuffer()); | |
1100 } | |
1101 | |
1102 | |
1103 void OrthancImage::AnswerJpegImage(OrthancPluginRestOutput* output, | |
1104 uint8_t quality) const | |
1105 { | |
1106 CheckImageAvailable(); | |
1107 OrthancPluginCompressAndAnswerJpegImage(GetGlobalContext(), output, GetPixelFormat(), | |
1108 GetWidth(), GetHeight(), GetPitch(), GetBuffer(), quality); | |
1109 } | |
1110 | |
1111 | |
1112 OrthancPluginImage* OrthancImage::Release() | |
1113 { | |
1114 CheckImageAvailable(); | |
1115 OrthancPluginImage* tmp = image_; | |
1116 image_ = NULL; | |
1117 return tmp; | |
1118 } | |
1119 | |
1120 | |
1121 #if HAS_ORTHANC_PLUGIN_FIND_MATCHER == 1 | |
1122 FindMatcher::FindMatcher(const OrthancPluginWorklistQuery* worklist) : | |
1123 matcher_(NULL), | |
1124 worklist_(worklist) | |
1125 { | |
1126 if (worklist_ == NULL) | |
1127 { | |
1128 ORTHANC_PLUGINS_THROW_EXCEPTION(ParameterOutOfRange); | |
1129 } | |
1130 } | |
1131 | |
1132 | |
1133 void FindMatcher::SetupDicom(const void* query, | |
1134 uint32_t size) | |
1135 { | |
1136 worklist_ = NULL; | |
1137 | |
1138 matcher_ = OrthancPluginCreateFindMatcher(GetGlobalContext(), query, size); | |
1139 if (matcher_ == NULL) | |
1140 { | |
1141 ORTHANC_PLUGINS_THROW_EXCEPTION(InternalError); | |
1142 } | |
1143 } | |
1144 | |
1145 | |
1146 FindMatcher::~FindMatcher() | |
1147 { | |
1148 // The "worklist_" field | |
1149 | |
1150 if (matcher_ != NULL) | |
1151 { | |
1152 OrthancPluginFreeFindMatcher(GetGlobalContext(), matcher_); | |
1153 } | |
1154 } | |
1155 | |
1156 | |
1157 | |
1158 bool FindMatcher::IsMatch(const void* dicom, | |
1159 uint32_t size) const | |
1160 { | |
1161 int32_t result; | |
1162 | |
1163 if (matcher_ != NULL) | |
1164 { | |
1165 result = OrthancPluginFindMatcherIsMatch(GetGlobalContext(), matcher_, dicom, size); | |
1166 } | |
1167 else if (worklist_ != NULL) | |
1168 { | |
1169 result = OrthancPluginWorklistIsMatch(GetGlobalContext(), worklist_, dicom, size); | |
1170 } | |
1171 else | |
1172 { | |
1173 ORTHANC_PLUGINS_THROW_EXCEPTION(InternalError); | |
1174 } | |
1175 | |
1176 if (result == 0) | |
1177 { | |
1178 return false; | |
1179 } | |
1180 else if (result == 1) | |
1181 { | |
1182 return true; | |
1183 } | |
1184 else | |
1185 { | |
1186 ORTHANC_PLUGINS_THROW_EXCEPTION(InternalError); | |
1187 } | |
1188 } | |
1189 | |
1190 #endif /* HAS_ORTHANC_PLUGIN_FIND_MATCHER == 1 */ | |
1191 | |
1192 void AnswerJson(const Json::Value& value, | |
1193 OrthancPluginRestOutput* output | |
1194 ) | |
1195 { | |
1196 Json::StyledWriter writer; | |
1197 std::string bodyString = writer.write(value); | |
1198 | |
1199 OrthancPluginAnswerBuffer(GetGlobalContext(), output, bodyString.c_str(), bodyString.size(), "application/json"); | |
1200 } | |
1201 | |
1202 void AnswerString(const std::string& answer, | |
1203 const char* mimeType, | |
1204 OrthancPluginRestOutput* output | |
1205 ) | |
1206 { | |
1207 OrthancPluginAnswerBuffer(GetGlobalContext(), output, answer.c_str(), answer.size(), mimeType); | |
1208 } | |
1209 | |
1210 void AnswerHttpError(uint16_t httpError, OrthancPluginRestOutput *output) | |
1211 { | |
1212 OrthancPluginSendHttpStatusCode(GetGlobalContext(), output, httpError); | |
1213 } | |
1214 | |
1215 void AnswerMethodNotAllowed(OrthancPluginRestOutput *output, const char* allowedMethods) | |
1216 { | |
1217 OrthancPluginSendMethodNotAllowed(GetGlobalContext(), output, allowedMethods); | |
1218 } | |
1219 | |
1220 bool RestApiGetString(std::string& result, | |
1221 const std::string& uri, | |
1222 bool applyPlugins) | |
1223 { | |
1224 MemoryBuffer answer; | |
1225 if (!answer.RestApiGet(uri, applyPlugins)) | |
1226 { | |
1227 return false; | |
1228 } | |
1229 else | |
1230 { | |
1231 answer.ToString(result); | |
1232 return true; | |
1233 } | |
1234 } | |
1235 | |
1236 bool RestApiGetString(std::string& result, | |
1237 const std::string& uri, | |
1238 const std::map<std::string, std::string>& httpHeaders, | |
1239 bool applyPlugins) | |
1240 { | |
1241 MemoryBuffer answer; | |
1242 if (!answer.RestApiGet(uri, httpHeaders, applyPlugins)) | |
1243 { | |
1244 return false; | |
1245 } | |
1246 else | |
1247 { | |
1248 answer.ToString(result); | |
1249 return true; | |
1250 } | |
1251 } | |
1252 | |
1253 | |
1254 | |
1255 bool RestApiGet(Json::Value& result, | |
1256 const std::string& uri, | |
1257 bool applyPlugins) | |
1258 { | |
1259 MemoryBuffer answer; | |
1260 | |
1261 if (!answer.RestApiGet(uri, applyPlugins)) | |
1262 { | |
1263 return false; | |
1264 } | |
1265 else | |
1266 { | |
1267 if (!answer.IsEmpty()) | |
1268 { | |
1269 answer.ToJson(result); | |
1270 } | |
1271 return true; | |
1272 } | |
1273 } | |
1274 | |
1275 | |
1276 bool RestApiPost(std::string& result, | |
1277 const std::string& uri, | |
1278 const void* body, | |
1279 size_t bodySize, | |
1280 bool applyPlugins) | |
1281 { | |
1282 MemoryBuffer answer; | |
1283 | |
1284 if (!answer.RestApiPost(uri, body, bodySize, applyPlugins)) | |
1285 { | |
1286 return false; | |
1287 } | |
1288 else | |
1289 { | |
1290 if (!answer.IsEmpty()) | |
1291 { | |
1292 result.assign(answer.GetData(), answer.GetSize()); | |
1293 } | |
1294 return true; | |
1295 } | |
1296 } | |
1297 | |
1298 | |
1299 bool RestApiPost(Json::Value& result, | |
1300 const std::string& uri, | |
1301 const void* body, | |
1302 size_t bodySize, | |
1303 bool applyPlugins) | |
1304 { | |
1305 MemoryBuffer answer; | |
1306 | |
1307 if (!answer.RestApiPost(uri, body, bodySize, applyPlugins)) | |
1308 { | |
1309 return false; | |
1310 } | |
1311 else | |
1312 { | |
1313 if (!answer.IsEmpty()) | |
1314 { | |
1315 answer.ToJson(result); | |
1316 } | |
1317 return true; | |
1318 } | |
1319 } | |
1320 | |
1321 | |
1322 bool RestApiPost(Json::Value& result, | |
1323 const std::string& uri, | |
1324 const Json::Value& body, | |
1325 bool applyPlugins) | |
1326 { | |
1327 Json::FastWriter writer; | |
1328 return RestApiPost(result, uri, writer.write(body), applyPlugins); | |
1329 } | |
1330 | |
1331 | |
1332 bool RestApiPut(Json::Value& result, | |
1333 const std::string& uri, | |
1334 const void* body, | |
1335 size_t bodySize, | |
1336 bool applyPlugins) | |
1337 { | |
1338 MemoryBuffer answer; | |
1339 | |
1340 if (!answer.RestApiPut(uri, body, bodySize, applyPlugins)) | |
1341 { | |
1342 return false; | |
1343 } | |
1344 else | |
1345 { | |
1346 if (!answer.IsEmpty()) // i.e, on a PUT to metadata/..., orthanc returns an empty response | |
1347 { | |
1348 answer.ToJson(result); | |
1349 } | |
1350 return true; | |
1351 } | |
1352 } | |
1353 | |
1354 | |
1355 bool RestApiPut(Json::Value& result, | |
1356 const std::string& uri, | |
1357 const Json::Value& body, | |
1358 bool applyPlugins) | |
1359 { | |
1360 Json::FastWriter writer; | |
1361 return RestApiPut(result, uri, writer.write(body), applyPlugins); | |
1362 } | |
1363 | |
1364 | |
1365 bool RestApiDelete(const std::string& uri, | |
1366 bool applyPlugins) | |
1367 { | |
1368 OrthancPluginErrorCode error; | |
1369 | |
1370 if (applyPlugins) | |
1371 { | |
1372 error = OrthancPluginRestApiDeleteAfterPlugins(GetGlobalContext(), uri.c_str()); | |
1373 } | |
1374 else | |
1375 { | |
1376 error = OrthancPluginRestApiDelete(GetGlobalContext(), uri.c_str()); | |
1377 } | |
1378 | |
1379 if (error == OrthancPluginErrorCode_Success) | |
1380 { | |
1381 return true; | |
1382 } | |
1383 else if (error == OrthancPluginErrorCode_UnknownResource || | |
1384 error == OrthancPluginErrorCode_InexistentItem) | |
1385 { | |
1386 return false; | |
1387 } | |
1388 else | |
1389 { | |
1390 ORTHANC_PLUGINS_THROW_PLUGIN_ERROR_CODE(error); | |
1391 } | |
1392 } | |
1393 | |
1394 | |
1395 void ReportMinimalOrthancVersion(unsigned int major, | |
1396 unsigned int minor, | |
1397 unsigned int revision) | |
1398 { | |
1399 LogError("Your version of the Orthanc core (" + | |
1400 std::string(GetGlobalContext()->orthancVersion) + | |
1401 ") is too old to run this plugin (version " + | |
1402 boost::lexical_cast<std::string>(major) + "." + | |
1403 boost::lexical_cast<std::string>(minor) + "." + | |
1404 boost::lexical_cast<std::string>(revision) + | |
1405 " is required)"); | |
1406 } | |
1407 | |
1408 | |
1409 bool CheckMinimalOrthancVersion(unsigned int major, | |
1410 unsigned int minor, | |
1411 unsigned int revision) | |
1412 { | |
1413 if (!HasGlobalContext()) | |
1414 { | |
1415 LogError("Bad Orthanc context in the plugin"); | |
1416 return false; | |
1417 } | |
1418 | |
1419 if (!strcmp(GetGlobalContext()->orthancVersion, "mainline")) | |
1420 { | |
1421 // Assume compatibility with the mainline | |
1422 return true; | |
1423 } | |
1424 | |
1425 // Parse the version of the Orthanc core | |
1426 int aa, bb, cc; | |
1427 if ( | |
1428 #ifdef _MSC_VER | |
1429 sscanf_s | |
1430 #else | |
1431 sscanf | |
1432 #endif | |
1433 (GetGlobalContext()->orthancVersion, "%4d.%4d.%4d", &aa, &bb, &cc) != 3 || | |
1434 aa < 0 || | |
1435 bb < 0 || | |
1436 cc < 0) | |
1437 { | |
1438 return false; | |
1439 } | |
1440 | |
1441 unsigned int a = static_cast<unsigned int>(aa); | |
1442 unsigned int b = static_cast<unsigned int>(bb); | |
1443 unsigned int c = static_cast<unsigned int>(cc); | |
1444 | |
1445 // Check the major version number | |
1446 | |
1447 if (a > major) | |
1448 { | |
1449 return true; | |
1450 } | |
1451 | |
1452 if (a < major) | |
1453 { | |
1454 return false; | |
1455 } | |
1456 | |
1457 | |
1458 // Check the minor version number | |
1459 assert(a == major); | |
1460 | |
1461 if (b > minor) | |
1462 { | |
1463 return true; | |
1464 } | |
1465 | |
1466 if (b < minor) | |
1467 { | |
1468 return false; | |
1469 } | |
1470 | |
1471 // Check the patch level version number | |
1472 assert(a == major && b == minor); | |
1473 | |
1474 if (c >= revision) | |
1475 { | |
1476 return true; | |
1477 } | |
1478 else | |
1479 { | |
1480 return false; | |
1481 } | |
1482 } | |
1483 | |
1484 | |
1485 #if ORTHANC_PLUGINS_VERSION_IS_ABOVE(1, 5, 0) | |
1486 const char* AutodetectMimeType(const std::string& path) | |
1487 { | |
1488 const char* mime = OrthancPluginAutodetectMimeType(GetGlobalContext(), path.c_str()); | |
1489 | |
1490 if (mime == NULL) | |
1491 { | |
1492 // Should never happen, just for safety | |
1493 return "application/octet-stream"; | |
1494 } | |
1495 else | |
1496 { | |
1497 return mime; | |
1498 } | |
1499 } | |
1500 #endif | |
1501 | |
1502 | |
1503 #if HAS_ORTHANC_PLUGIN_PEERS == 1 | |
1504 size_t OrthancPeers::GetPeerIndex(const std::string& name) const | |
1505 { | |
1506 size_t index; | |
1507 if (LookupName(index, name)) | |
1508 { | |
1509 return index; | |
1510 } | |
1511 else | |
1512 { | |
1513 LogError("Inexistent peer: " + name); | |
1514 ORTHANC_PLUGINS_THROW_EXCEPTION(UnknownResource); | |
1515 } | |
1516 } | |
1517 | |
1518 | |
1519 OrthancPeers::OrthancPeers() : | |
1520 peers_(NULL), | |
1521 timeout_(0) | |
1522 { | |
1523 peers_ = OrthancPluginGetPeers(GetGlobalContext()); | |
1524 | |
1525 if (peers_ == NULL) | |
1526 { | |
1527 ORTHANC_PLUGINS_THROW_PLUGIN_ERROR_CODE(OrthancPluginErrorCode_Plugin); | |
1528 } | |
1529 | |
1530 uint32_t count = OrthancPluginGetPeersCount(GetGlobalContext(), peers_); | |
1531 | |
1532 for (uint32_t i = 0; i < count; i++) | |
1533 { | |
1534 const char* name = OrthancPluginGetPeerName(GetGlobalContext(), peers_, i); | |
1535 if (name == NULL) | |
1536 { | |
1537 OrthancPluginFreePeers(GetGlobalContext(), peers_); | |
1538 ORTHANC_PLUGINS_THROW_PLUGIN_ERROR_CODE(OrthancPluginErrorCode_Plugin); | |
1539 } | |
1540 | |
1541 index_[name] = i; | |
1542 } | |
1543 } | |
1544 | |
1545 | |
1546 OrthancPeers::~OrthancPeers() | |
1547 { | |
1548 if (peers_ != NULL) | |
1549 { | |
1550 OrthancPluginFreePeers(GetGlobalContext(), peers_); | |
1551 } | |
1552 } | |
1553 | |
1554 | |
1555 bool OrthancPeers::LookupName(size_t& target, | |
1556 const std::string& name) const | |
1557 { | |
1558 Index::const_iterator found = index_.find(name); | |
1559 | |
1560 if (found == index_.end()) | |
1561 { | |
1562 return false; | |
1563 } | |
1564 else | |
1565 { | |
1566 target = found->second; | |
1567 return true; | |
1568 } | |
1569 } | |
1570 | |
1571 | |
1572 std::string OrthancPeers::GetPeerName(size_t index) const | |
1573 { | |
1574 if (index >= index_.size()) | |
1575 { | |
1576 ORTHANC_PLUGINS_THROW_PLUGIN_ERROR_CODE(OrthancPluginErrorCode_ParameterOutOfRange); | |
1577 } | |
1578 else | |
1579 { | |
1580 const char* s = OrthancPluginGetPeerName(GetGlobalContext(), peers_, static_cast<uint32_t>(index)); | |
1581 if (s == NULL) | |
1582 { | |
1583 ORTHANC_PLUGINS_THROW_PLUGIN_ERROR_CODE(OrthancPluginErrorCode_Plugin); | |
1584 } | |
1585 else | |
1586 { | |
1587 return s; | |
1588 } | |
1589 } | |
1590 } | |
1591 | |
1592 | |
1593 std::string OrthancPeers::GetPeerUrl(size_t index) const | |
1594 { | |
1595 if (index >= index_.size()) | |
1596 { | |
1597 ORTHANC_PLUGINS_THROW_PLUGIN_ERROR_CODE(OrthancPluginErrorCode_ParameterOutOfRange); | |
1598 } | |
1599 else | |
1600 { | |
1601 const char* s = OrthancPluginGetPeerUrl(GetGlobalContext(), peers_, static_cast<uint32_t>(index)); | |
1602 if (s == NULL) | |
1603 { | |
1604 ORTHANC_PLUGINS_THROW_PLUGIN_ERROR_CODE(OrthancPluginErrorCode_Plugin); | |
1605 } | |
1606 else | |
1607 { | |
1608 return s; | |
1609 } | |
1610 } | |
1611 } | |
1612 | |
1613 | |
1614 std::string OrthancPeers::GetPeerUrl(const std::string& name) const | |
1615 { | |
1616 return GetPeerUrl(GetPeerIndex(name)); | |
1617 } | |
1618 | |
1619 | |
1620 bool OrthancPeers::LookupUserProperty(std::string& value, | |
1621 size_t index, | |
1622 const std::string& key) const | |
1623 { | |
1624 if (index >= index_.size()) | |
1625 { | |
1626 ORTHANC_PLUGINS_THROW_PLUGIN_ERROR_CODE(OrthancPluginErrorCode_ParameterOutOfRange); | |
1627 } | |
1628 else | |
1629 { | |
1630 const char* s = OrthancPluginGetPeerUserProperty(GetGlobalContext(), peers_, static_cast<uint32_t>(index), key.c_str()); | |
1631 if (s == NULL) | |
1632 { | |
1633 return false; | |
1634 } | |
1635 else | |
1636 { | |
1637 value.assign(s); | |
1638 return true; | |
1639 } | |
1640 } | |
1641 } | |
1642 | |
1643 | |
1644 bool OrthancPeers::LookupUserProperty(std::string& value, | |
1645 const std::string& peer, | |
1646 const std::string& key) const | |
1647 { | |
1648 return LookupUserProperty(value, GetPeerIndex(peer), key); | |
1649 } | |
1650 | |
1651 | |
1652 bool OrthancPeers::DoGet(MemoryBuffer& target, | |
1653 size_t index, | |
1654 const std::string& uri) const | |
1655 { | |
1656 if (index >= index_.size()) | |
1657 { | |
1658 ORTHANC_PLUGINS_THROW_PLUGIN_ERROR_CODE(OrthancPluginErrorCode_ParameterOutOfRange); | |
1659 } | |
1660 | |
1661 OrthancPlugins::MemoryBuffer answer; | |
1662 uint16_t status; | |
1663 OrthancPluginErrorCode code = OrthancPluginCallPeerApi | |
1664 (GetGlobalContext(), *answer, NULL, &status, peers_, | |
1665 static_cast<uint32_t>(index), OrthancPluginHttpMethod_Get, uri.c_str(), | |
1666 0, NULL, NULL, NULL, 0, timeout_); | |
1667 | |
1668 if (code == OrthancPluginErrorCode_Success) | |
1669 { | |
1670 target.Swap(answer); | |
1671 return (status == 200); | |
1672 } | |
1673 else | |
1674 { | |
1675 return false; | |
1676 } | |
1677 } | |
1678 | |
1679 | |
1680 bool OrthancPeers::DoGet(MemoryBuffer& target, | |
1681 const std::string& name, | |
1682 const std::string& uri) const | |
1683 { | |
1684 size_t index; | |
1685 return (LookupName(index, name) && | |
1686 DoGet(target, index, uri)); | |
1687 } | |
1688 | |
1689 | |
1690 bool OrthancPeers::DoGet(Json::Value& target, | |
1691 size_t index, | |
1692 const std::string& uri) const | |
1693 { | |
1694 MemoryBuffer buffer; | |
1695 | |
1696 if (DoGet(buffer, index, uri)) | |
1697 { | |
1698 buffer.ToJson(target); | |
1699 return true; | |
1700 } | |
1701 else | |
1702 { | |
1703 return false; | |
1704 } | |
1705 } | |
1706 | |
1707 | |
1708 bool OrthancPeers::DoGet(Json::Value& target, | |
1709 const std::string& name, | |
1710 const std::string& uri) const | |
1711 { | |
1712 MemoryBuffer buffer; | |
1713 | |
1714 if (DoGet(buffer, name, uri)) | |
1715 { | |
1716 buffer.ToJson(target); | |
1717 return true; | |
1718 } | |
1719 else | |
1720 { | |
1721 return false; | |
1722 } | |
1723 } | |
1724 | |
1725 | |
1726 bool OrthancPeers::DoPost(MemoryBuffer& target, | |
1727 const std::string& name, | |
1728 const std::string& uri, | |
1729 const std::string& body) const | |
1730 { | |
1731 size_t index; | |
1732 return (LookupName(index, name) && | |
1733 DoPost(target, index, uri, body)); | |
1734 } | |
1735 | |
1736 | |
1737 bool OrthancPeers::DoPost(Json::Value& target, | |
1738 size_t index, | |
1739 const std::string& uri, | |
1740 const std::string& body) const | |
1741 { | |
1742 MemoryBuffer buffer; | |
1743 | |
1744 if (DoPost(buffer, index, uri, body)) | |
1745 { | |
1746 buffer.ToJson(target); | |
1747 return true; | |
1748 } | |
1749 else | |
1750 { | |
1751 return false; | |
1752 } | |
1753 } | |
1754 | |
1755 | |
1756 bool OrthancPeers::DoPost(Json::Value& target, | |
1757 const std::string& name, | |
1758 const std::string& uri, | |
1759 const std::string& body) const | |
1760 { | |
1761 MemoryBuffer buffer; | |
1762 | |
1763 if (DoPost(buffer, name, uri, body)) | |
1764 { | |
1765 buffer.ToJson(target); | |
1766 return true; | |
1767 } | |
1768 else | |
1769 { | |
1770 return false; | |
1771 } | |
1772 } | |
1773 | |
1774 | |
1775 bool OrthancPeers::DoPost(MemoryBuffer& target, | |
1776 size_t index, | |
1777 const std::string& uri, | |
1778 const std::string& body) const | |
1779 { | |
1780 if (index >= index_.size()) | |
1781 { | |
1782 ORTHANC_PLUGINS_THROW_PLUGIN_ERROR_CODE(OrthancPluginErrorCode_ParameterOutOfRange); | |
1783 } | |
1784 | |
1785 OrthancPlugins::MemoryBuffer answer; | |
1786 uint16_t status; | |
1787 OrthancPluginErrorCode code = OrthancPluginCallPeerApi | |
1788 (GetGlobalContext(), *answer, NULL, &status, peers_, | |
1789 static_cast<uint32_t>(index), OrthancPluginHttpMethod_Post, uri.c_str(), | |
1790 0, NULL, NULL, body.empty() ? NULL : body.c_str(), body.size(), timeout_); | |
1791 | |
1792 if (code == OrthancPluginErrorCode_Success) | |
1793 { | |
1794 target.Swap(answer); | |
1795 return (status == 200); | |
1796 } | |
1797 else | |
1798 { | |
1799 return false; | |
1800 } | |
1801 } | |
1802 | |
1803 | |
1804 bool OrthancPeers::DoPut(size_t index, | |
1805 const std::string& uri, | |
1806 const std::string& body) const | |
1807 { | |
1808 if (index >= index_.size()) | |
1809 { | |
1810 ORTHANC_PLUGINS_THROW_PLUGIN_ERROR_CODE(OrthancPluginErrorCode_ParameterOutOfRange); | |
1811 } | |
1812 | |
1813 OrthancPlugins::MemoryBuffer answer; | |
1814 uint16_t status; | |
1815 OrthancPluginErrorCode code = OrthancPluginCallPeerApi | |
1816 (GetGlobalContext(), *answer, NULL, &status, peers_, | |
1817 static_cast<uint32_t>(index), OrthancPluginHttpMethod_Put, uri.c_str(), | |
1818 0, NULL, NULL, body.empty() ? NULL : body.c_str(), body.size(), timeout_); | |
1819 | |
1820 if (code == OrthancPluginErrorCode_Success) | |
1821 { | |
1822 return (status == 200); | |
1823 } | |
1824 else | |
1825 { | |
1826 return false; | |
1827 } | |
1828 } | |
1829 | |
1830 | |
1831 bool OrthancPeers::DoPut(const std::string& name, | |
1832 const std::string& uri, | |
1833 const std::string& body) const | |
1834 { | |
1835 size_t index; | |
1836 return (LookupName(index, name) && | |
1837 DoPut(index, uri, body)); | |
1838 } | |
1839 | |
1840 | |
1841 bool OrthancPeers::DoDelete(size_t index, | |
1842 const std::string& uri) const | |
1843 { | |
1844 if (index >= index_.size()) | |
1845 { | |
1846 ORTHANC_PLUGINS_THROW_PLUGIN_ERROR_CODE(OrthancPluginErrorCode_ParameterOutOfRange); | |
1847 } | |
1848 | |
1849 OrthancPlugins::MemoryBuffer answer; | |
1850 uint16_t status; | |
1851 OrthancPluginErrorCode code = OrthancPluginCallPeerApi | |
1852 (GetGlobalContext(), *answer, NULL, &status, peers_, | |
1853 static_cast<uint32_t>(index), OrthancPluginHttpMethod_Delete, uri.c_str(), | |
1854 0, NULL, NULL, NULL, 0, timeout_); | |
1855 | |
1856 if (code == OrthancPluginErrorCode_Success) | |
1857 { | |
1858 return (status == 200); | |
1859 } | |
1860 else | |
1861 { | |
1862 return false; | |
1863 } | |
1864 } | |
1865 | |
1866 | |
1867 bool OrthancPeers::DoDelete(const std::string& name, | |
1868 const std::string& uri) const | |
1869 { | |
1870 size_t index; | |
1871 return (LookupName(index, name) && | |
1872 DoDelete(index, uri)); | |
1873 } | |
1874 #endif | |
1875 | |
1876 | |
1877 | |
1878 | |
1879 | |
1880 /****************************************************************** | |
1881 ** JOBS | |
1882 ******************************************************************/ | |
1883 | |
1884 #if HAS_ORTHANC_PLUGIN_JOB == 1 | |
1885 void OrthancJob::CallbackFinalize(void* job) | |
1886 { | |
1887 if (job != NULL) | |
1888 { | |
1889 delete reinterpret_cast<OrthancJob*>(job); | |
1890 } | |
1891 } | |
1892 | |
1893 | |
1894 float OrthancJob::CallbackGetProgress(void* job) | |
1895 { | |
1896 assert(job != NULL); | |
1897 | |
1898 try | |
1899 { | |
1900 return reinterpret_cast<OrthancJob*>(job)->progress_; | |
1901 } | |
1902 catch (...) | |
1903 { | |
1904 return 0; | |
1905 } | |
1906 } | |
1907 | |
1908 | |
1909 const char* OrthancJob::CallbackGetContent(void* job) | |
1910 { | |
1911 assert(job != NULL); | |
1912 | |
1913 try | |
1914 { | |
1915 return reinterpret_cast<OrthancJob*>(job)->content_.c_str(); | |
1916 } | |
1917 catch (...) | |
1918 { | |
1919 return 0; | |
1920 } | |
1921 } | |
1922 | |
1923 | |
1924 const char* OrthancJob::CallbackGetSerialized(void* job) | |
1925 { | |
1926 assert(job != NULL); | |
1927 | |
1928 try | |
1929 { | |
1930 const OrthancJob& tmp = *reinterpret_cast<OrthancJob*>(job); | |
1931 | |
1932 if (tmp.hasSerialized_) | |
1933 { | |
1934 return tmp.serialized_.c_str(); | |
1935 } | |
1936 else | |
1937 { | |
1938 return NULL; | |
1939 } | |
1940 } | |
1941 catch (...) | |
1942 { | |
1943 return 0; | |
1944 } | |
1945 } | |
1946 | |
1947 | |
1948 OrthancPluginJobStepStatus OrthancJob::CallbackStep(void* job) | |
1949 { | |
1950 assert(job != NULL); | |
1951 | |
1952 try | |
1953 { | |
1954 return reinterpret_cast<OrthancJob*>(job)->Step(); | |
1955 } | |
1956 catch (ORTHANC_PLUGINS_EXCEPTION_CLASS&) | |
1957 { | |
1958 return OrthancPluginJobStepStatus_Failure; | |
1959 } | |
1960 catch (...) | |
1961 { | |
1962 return OrthancPluginJobStepStatus_Failure; | |
1963 } | |
1964 } | |
1965 | |
1966 | |
1967 OrthancPluginErrorCode OrthancJob::CallbackStop(void* job, | |
1968 OrthancPluginJobStopReason reason) | |
1969 { | |
1970 assert(job != NULL); | |
1971 | |
1972 try | |
1973 { | |
1974 reinterpret_cast<OrthancJob*>(job)->Stop(reason); | |
1975 return OrthancPluginErrorCode_Success; | |
1976 } | |
1977 catch (ORTHANC_PLUGINS_EXCEPTION_CLASS& e) | |
1978 { | |
1979 return static_cast<OrthancPluginErrorCode>(e.GetErrorCode()); | |
1980 } | |
1981 catch (...) | |
1982 { | |
1983 return OrthancPluginErrorCode_Plugin; | |
1984 } | |
1985 } | |
1986 | |
1987 | |
1988 OrthancPluginErrorCode OrthancJob::CallbackReset(void* job) | |
1989 { | |
1990 assert(job != NULL); | |
1991 | |
1992 try | |
1993 { | |
1994 reinterpret_cast<OrthancJob*>(job)->Reset(); | |
1995 return OrthancPluginErrorCode_Success; | |
1996 } | |
1997 catch (ORTHANC_PLUGINS_EXCEPTION_CLASS& e) | |
1998 { | |
1999 return static_cast<OrthancPluginErrorCode>(e.GetErrorCode()); | |
2000 } | |
2001 catch (...) | |
2002 { | |
2003 return OrthancPluginErrorCode_Plugin; | |
2004 } | |
2005 } | |
2006 | |
2007 | |
2008 void OrthancJob::ClearContent() | |
2009 { | |
2010 Json::Value empty = Json::objectValue; | |
2011 UpdateContent(empty); | |
2012 } | |
2013 | |
2014 | |
2015 void OrthancJob::UpdateContent(const Json::Value& content) | |
2016 { | |
2017 if (content.type() != Json::objectValue) | |
2018 { | |
2019 ORTHANC_PLUGINS_THROW_PLUGIN_ERROR_CODE(OrthancPluginErrorCode_BadFileFormat); | |
2020 } | |
2021 else | |
2022 { | |
2023 Json::FastWriter writer; | |
2024 content_ = writer.write(content); | |
2025 } | |
2026 } | |
2027 | |
2028 | |
2029 void OrthancJob::ClearSerialized() | |
2030 { | |
2031 hasSerialized_ = false; | |
2032 serialized_.clear(); | |
2033 } | |
2034 | |
2035 | |
2036 void OrthancJob::UpdateSerialized(const Json::Value& serialized) | |
2037 { | |
2038 if (serialized.type() != Json::objectValue) | |
2039 { | |
2040 ORTHANC_PLUGINS_THROW_PLUGIN_ERROR_CODE(OrthancPluginErrorCode_BadFileFormat); | |
2041 } | |
2042 else | |
2043 { | |
2044 Json::FastWriter writer; | |
2045 serialized_ = writer.write(serialized); | |
2046 hasSerialized_ = true; | |
2047 } | |
2048 } | |
2049 | |
2050 | |
2051 void OrthancJob::UpdateProgress(float progress) | |
2052 { | |
2053 if (progress < 0 || | |
2054 progress > 1) | |
2055 { | |
2056 ORTHANC_PLUGINS_THROW_PLUGIN_ERROR_CODE(OrthancPluginErrorCode_ParameterOutOfRange); | |
2057 } | |
2058 | |
2059 progress_ = progress; | |
2060 } | |
2061 | |
2062 | |
2063 OrthancJob::OrthancJob(const std::string& jobType) : | |
2064 jobType_(jobType), | |
2065 progress_(0) | |
2066 { | |
2067 ClearContent(); | |
2068 ClearSerialized(); | |
2069 } | |
2070 | |
2071 | |
2072 OrthancPluginJob* OrthancJob::Create(OrthancJob* job) | |
2073 { | |
2074 if (job == NULL) | |
2075 { | |
2076 ORTHANC_PLUGINS_THROW_PLUGIN_ERROR_CODE(OrthancPluginErrorCode_NullPointer); | |
2077 } | |
2078 | |
2079 OrthancPluginJob* orthanc = OrthancPluginCreateJob( | |
2080 GetGlobalContext(), job, CallbackFinalize, job->jobType_.c_str(), | |
2081 CallbackGetProgress, CallbackGetContent, CallbackGetSerialized, | |
2082 CallbackStep, CallbackStop, CallbackReset); | |
2083 | |
2084 if (orthanc == NULL) | |
2085 { | |
2086 ORTHANC_PLUGINS_THROW_PLUGIN_ERROR_CODE(OrthancPluginErrorCode_Plugin); | |
2087 } | |
2088 else | |
2089 { | |
2090 return orthanc; | |
2091 } | |
2092 } | |
2093 | |
2094 | |
2095 std::string OrthancJob::Submit(OrthancJob* job, | |
2096 int priority) | |
2097 { | |
2098 if (job == NULL) | |
2099 { | |
2100 ORTHANC_PLUGINS_THROW_PLUGIN_ERROR_CODE(OrthancPluginErrorCode_NullPointer); | |
2101 } | |
2102 | |
2103 OrthancPluginJob* orthanc = Create(job); | |
2104 | |
2105 char* id = OrthancPluginSubmitJob(GetGlobalContext(), orthanc, priority); | |
2106 | |
2107 if (id == NULL) | |
2108 { | |
2109 LogError("Plugin cannot submit job"); | |
2110 OrthancPluginFreeJob(GetGlobalContext(), orthanc); | |
2111 ORTHANC_PLUGINS_THROW_PLUGIN_ERROR_CODE(OrthancPluginErrorCode_Plugin); | |
2112 } | |
2113 else | |
2114 { | |
2115 std::string tmp(id); | |
2116 tmp.assign(id); | |
2117 OrthancPluginFreeString(GetGlobalContext(), id); | |
2118 | |
2119 return tmp; | |
2120 } | |
2121 } | |
2122 | |
2123 | |
2124 void OrthancJob::SubmitAndWait(Json::Value& result, | |
2125 OrthancJob* job /* takes ownership */, | |
2126 int priority) | |
2127 { | |
2128 std::string id = Submit(job, priority); | |
2129 | |
2130 for (;;) | |
2131 { | |
2132 boost::this_thread::sleep(boost::posix_time::milliseconds(100)); | |
2133 | |
2134 Json::Value status; | |
2135 if (!RestApiGet(status, "/jobs/" + id, false) || | |
2136 !status.isMember("State") || | |
2137 status["State"].type() != Json::stringValue) | |
2138 { | |
2139 ORTHANC_PLUGINS_THROW_PLUGIN_ERROR_CODE(OrthancPluginErrorCode_InexistentItem); | |
2140 } | |
2141 | |
2142 const std::string state = status["State"].asString(); | |
2143 if (state == "Success") | |
2144 { | |
2145 if (status.isMember("Content")) | |
2146 { | |
2147 result = status["Content"]; | |
2148 } | |
2149 else | |
2150 { | |
2151 result = Json::objectValue; | |
2152 } | |
2153 | |
2154 return; | |
2155 } | |
2156 else if (state == "Running") | |
2157 { | |
2158 continue; | |
2159 } | |
2160 else if (!status.isMember("ErrorCode") || | |
2161 status["ErrorCode"].type() != Json::intValue) | |
2162 { | |
2163 ORTHANC_PLUGINS_THROW_PLUGIN_ERROR_CODE(OrthancPluginErrorCode_InternalError); | |
2164 } | |
2165 else | |
2166 { | |
2167 if (!status.isMember("ErrorDescription") || | |
2168 status["ErrorDescription"].type() != Json::stringValue) | |
2169 { | |
2170 ORTHANC_PLUGINS_THROW_PLUGIN_ERROR_CODE(status["ErrorCode"].asInt()); | |
2171 } | |
2172 else | |
2173 { | |
2174 #if HAS_ORTHANC_EXCEPTION == 1 | |
2175 throw Orthanc::OrthancException(static_cast<Orthanc::ErrorCode>(status["ErrorCode"].asInt()), | |
2176 status["ErrorDescription"].asString()); | |
2177 #else | |
2178 LogError("Exception while executing the job: " + status["ErrorDescription"].asString()); | |
2179 ORTHANC_PLUGINS_THROW_PLUGIN_ERROR_CODE(status["ErrorCode"].asInt()); | |
2180 #endif | |
2181 } | |
2182 } | |
2183 } | |
2184 } | |
2185 | |
2186 | |
2187 void OrthancJob::SubmitFromRestApiPost(OrthancPluginRestOutput* output, | |
2188 const Json::Value& body, | |
2189 OrthancJob* job) | |
2190 { | |
2191 static const char* KEY_SYNCHRONOUS = "Synchronous"; | |
2192 static const char* KEY_ASYNCHRONOUS = "Asynchronous"; | |
2193 static const char* KEY_PRIORITY = "Priority"; | |
2194 | |
2195 boost::movelib::unique_ptr<OrthancJob> protection(job); | |
2196 | |
2197 if (body.type() != Json::objectValue) | |
2198 { | |
2199 #if HAS_ORTHANC_EXCEPTION == 1 | |
2200 throw Orthanc::OrthancException(Orthanc::ErrorCode_BadFileFormat, | |
2201 "Expected a JSON object in the body"); | |
2202 #else | |
2203 LogError("Expected a JSON object in the body"); | |
2204 ORTHANC_PLUGINS_THROW_EXCEPTION(BadFileFormat); | |
2205 #endif | |
2206 } | |
2207 | |
2208 bool synchronous = true; | |
2209 | |
2210 if (body.isMember(KEY_SYNCHRONOUS)) | |
2211 { | |
2212 if (body[KEY_SYNCHRONOUS].type() != Json::booleanValue) | |
2213 { | |
2214 #if HAS_ORTHANC_EXCEPTION == 1 | |
2215 throw Orthanc::OrthancException(Orthanc::ErrorCode_BadFileFormat, | |
2216 "Option \"" + std::string(KEY_SYNCHRONOUS) + | |
2217 "\" must be Boolean"); | |
2218 #else | |
2219 LogError("Option \"" + std::string(KEY_SYNCHRONOUS) + "\" must be Boolean"); | |
2220 ORTHANC_PLUGINS_THROW_EXCEPTION(BadFileFormat); | |
2221 #endif | |
2222 } | |
2223 else | |
2224 { | |
2225 synchronous = body[KEY_SYNCHRONOUS].asBool(); | |
2226 } | |
2227 } | |
2228 | |
2229 if (body.isMember(KEY_ASYNCHRONOUS)) | |
2230 { | |
2231 if (body[KEY_ASYNCHRONOUS].type() != Json::booleanValue) | |
2232 { | |
2233 #if HAS_ORTHANC_EXCEPTION == 1 | |
2234 throw Orthanc::OrthancException(Orthanc::ErrorCode_BadFileFormat, | |
2235 "Option \"" + std::string(KEY_ASYNCHRONOUS) + | |
2236 "\" must be Boolean"); | |
2237 #else | |
2238 LogError("Option \"" + std::string(KEY_ASYNCHRONOUS) + "\" must be Boolean"); | |
2239 ORTHANC_PLUGINS_THROW_EXCEPTION(BadFileFormat); | |
2240 #endif | |
2241 } | |
2242 else | |
2243 { | |
2244 synchronous = !body[KEY_ASYNCHRONOUS].asBool(); | |
2245 } | |
2246 } | |
2247 | |
2248 int priority = 0; | |
2249 | |
2250 if (body.isMember(KEY_PRIORITY)) | |
2251 { | |
2252 if (body[KEY_PRIORITY].type() != Json::booleanValue) | |
2253 { | |
2254 #if HAS_ORTHANC_EXCEPTION == 1 | |
2255 throw Orthanc::OrthancException(Orthanc::ErrorCode_BadFileFormat, | |
2256 "Option \"" + std::string(KEY_PRIORITY) + | |
2257 "\" must be an integer"); | |
2258 #else | |
2259 LogError("Option \"" + std::string(KEY_PRIORITY) + "\" must be an integer"); | |
2260 ORTHANC_PLUGINS_THROW_EXCEPTION(BadFileFormat); | |
2261 #endif | |
2262 } | |
2263 else | |
2264 { | |
2265 priority = !body[KEY_PRIORITY].asInt(); | |
2266 } | |
2267 } | |
2268 | |
2269 Json::Value result; | |
2270 | |
2271 if (synchronous) | |
2272 { | |
2273 OrthancPlugins::OrthancJob::SubmitAndWait(result, protection.release(), priority); | |
2274 } | |
2275 else | |
2276 { | |
2277 std::string id = OrthancPlugins::OrthancJob::Submit(protection.release(), priority); | |
2278 | |
2279 result = Json::objectValue; | |
2280 result["ID"] = id; | |
2281 result["Path"] = "/jobs/" + id; | |
2282 } | |
2283 | |
2284 std::string s = result.toStyledString(); | |
2285 OrthancPluginAnswerBuffer(OrthancPlugins::GetGlobalContext(), output, s.c_str(), | |
2286 s.size(), "application/json"); | |
2287 } | |
2288 | |
2289 #endif | |
2290 | |
2291 | |
2292 | |
2293 | |
2294 /****************************************************************** | |
2295 ** METRICS | |
2296 ******************************************************************/ | |
2297 | |
2298 #if HAS_ORTHANC_PLUGIN_METRICS == 1 | |
2299 MetricsTimer::MetricsTimer(const char* name) : | |
2300 name_(name) | |
2301 { | |
2302 start_ = boost::posix_time::microsec_clock::universal_time(); | |
2303 } | |
2304 | |
2305 MetricsTimer::~MetricsTimer() | |
2306 { | |
2307 const boost::posix_time::ptime stop = boost::posix_time::microsec_clock::universal_time(); | |
2308 const boost::posix_time::time_duration diff = stop - start_; | |
2309 OrthancPluginSetMetricsValue(GetGlobalContext(), name_.c_str(), static_cast<float>(diff.total_milliseconds()), | |
2310 OrthancPluginMetricsType_Timer); | |
2311 } | |
2312 #endif | |
2313 | |
2314 | |
2315 | |
2316 | |
2317 /****************************************************************** | |
2318 ** HTTP CLIENT | |
2319 ******************************************************************/ | |
2320 | |
2321 #if HAS_ORTHANC_PLUGIN_HTTP_CLIENT == 1 | |
2322 class HttpClient::RequestBodyWrapper : public boost::noncopyable | |
2323 { | |
2324 private: | |
2325 static RequestBodyWrapper& GetObject(void* body) | |
2326 { | |
2327 assert(body != NULL); | |
2328 return *reinterpret_cast<RequestBodyWrapper*>(body); | |
2329 } | |
2330 | |
2331 IRequestBody& body_; | |
2332 bool done_; | |
2333 std::string chunk_; | |
2334 | |
2335 public: | |
2336 RequestBodyWrapper(IRequestBody& body) : | |
2337 body_(body), | |
2338 done_(false) | |
2339 { | |
2340 } | |
2341 | |
2342 static uint8_t IsDone(void* body) | |
2343 { | |
2344 return GetObject(body).done_; | |
2345 } | |
2346 | |
2347 static const void* GetChunkData(void* body) | |
2348 { | |
2349 return GetObject(body).chunk_.c_str(); | |
2350 } | |
2351 | |
2352 static uint32_t GetChunkSize(void* body) | |
2353 { | |
2354 return static_cast<uint32_t>(GetObject(body).chunk_.size()); | |
2355 } | |
2356 | |
2357 static OrthancPluginErrorCode Next(void* body) | |
2358 { | |
2359 RequestBodyWrapper& that = GetObject(body); | |
2360 | |
2361 if (that.done_) | |
2362 { | |
2363 return OrthancPluginErrorCode_BadSequenceOfCalls; | |
2364 } | |
2365 else | |
2366 { | |
2367 try | |
2368 { | |
2369 that.done_ = !that.body_.ReadNextChunk(that.chunk_); | |
2370 return OrthancPluginErrorCode_Success; | |
2371 } | |
2372 catch (ORTHANC_PLUGINS_EXCEPTION_CLASS& e) | |
2373 { | |
2374 return static_cast<OrthancPluginErrorCode>(e.GetErrorCode()); | |
2375 } | |
2376 catch (...) | |
2377 { | |
2378 return OrthancPluginErrorCode_InternalError; | |
2379 } | |
2380 } | |
2381 } | |
2382 }; | |
2383 | |
2384 | |
2385 #if HAS_ORTHANC_PLUGIN_CHUNKED_HTTP_CLIENT == 1 | |
2386 static OrthancPluginErrorCode AnswerAddHeaderCallback(void* answer, | |
2387 const char* key, | |
2388 const char* value) | |
2389 { | |
2390 assert(answer != NULL && key != NULL && value != NULL); | |
2391 | |
2392 try | |
2393 { | |
2394 reinterpret_cast<HttpClient::IAnswer*>(answer)->AddHeader(key, value); | |
2395 return OrthancPluginErrorCode_Success; | |
2396 } | |
2397 catch (ORTHANC_PLUGINS_EXCEPTION_CLASS& e) | |
2398 { | |
2399 return static_cast<OrthancPluginErrorCode>(e.GetErrorCode()); | |
2400 } | |
2401 catch (...) | |
2402 { | |
2403 return OrthancPluginErrorCode_Plugin; | |
2404 } | |
2405 } | |
2406 #endif | |
2407 | |
2408 | |
2409 #if HAS_ORTHANC_PLUGIN_CHUNKED_HTTP_CLIENT == 1 | |
2410 static OrthancPluginErrorCode AnswerAddChunkCallback(void* answer, | |
2411 const void* data, | |
2412 uint32_t size) | |
2413 { | |
2414 assert(answer != NULL); | |
2415 | |
2416 try | |
2417 { | |
2418 reinterpret_cast<HttpClient::IAnswer*>(answer)->AddChunk(data, size); | |
2419 return OrthancPluginErrorCode_Success; | |
2420 } | |
2421 catch (ORTHANC_PLUGINS_EXCEPTION_CLASS& e) | |
2422 { | |
2423 return static_cast<OrthancPluginErrorCode>(e.GetErrorCode()); | |
2424 } | |
2425 catch (...) | |
2426 { | |
2427 return OrthancPluginErrorCode_Plugin; | |
2428 } | |
2429 } | |
2430 #endif | |
2431 | |
2432 | |
2433 HttpClient::HttpClient() : | |
2434 httpStatus_(0), | |
2435 method_(OrthancPluginHttpMethod_Get), | |
2436 timeout_(0), | |
2437 pkcs11_(false), | |
2438 chunkedBody_(NULL), | |
2439 allowChunkedTransfers_(true) | |
2440 { | |
2441 } | |
2442 | |
2443 | |
2444 void HttpClient::AddHeaders(const HttpHeaders& headers) | |
2445 { | |
2446 for (HttpHeaders::const_iterator it = headers.begin(); | |
2447 it != headers.end(); ++it) | |
2448 { | |
2449 headers_[it->first] = it->second; | |
2450 } | |
2451 } | |
2452 | |
2453 | |
2454 void HttpClient::SetCredentials(const std::string& username, | |
2455 const std::string& password) | |
2456 { | |
2457 username_ = username; | |
2458 password_ = password; | |
2459 } | |
2460 | |
2461 | |
2462 void HttpClient::ClearCredentials() | |
2463 { | |
2464 username_.empty(); | |
2465 password_.empty(); | |
2466 } | |
2467 | |
2468 | |
2469 void HttpClient::SetCertificate(const std::string& certificateFile, | |
2470 const std::string& keyFile, | |
2471 const std::string& keyPassword) | |
2472 { | |
2473 certificateFile_ = certificateFile; | |
2474 certificateKeyFile_ = keyFile; | |
2475 certificateKeyPassword_ = keyPassword; | |
2476 } | |
2477 | |
2478 | |
2479 void HttpClient::ClearCertificate() | |
2480 { | |
2481 certificateFile_.clear(); | |
2482 certificateKeyFile_.clear(); | |
2483 certificateKeyPassword_.clear(); | |
2484 } | |
2485 | |
2486 | |
2487 void HttpClient::ClearBody() | |
2488 { | |
2489 fullBody_.clear(); | |
2490 chunkedBody_ = NULL; | |
2491 } | |
2492 | |
2493 | |
2494 void HttpClient::SwapBody(std::string& body) | |
2495 { | |
2496 fullBody_.swap(body); | |
2497 chunkedBody_ = NULL; | |
2498 } | |
2499 | |
2500 | |
2501 void HttpClient::SetBody(const std::string& body) | |
2502 { | |
2503 fullBody_ = body; | |
2504 chunkedBody_ = NULL; | |
2505 } | |
2506 | |
2507 | |
2508 void HttpClient::SetBody(IRequestBody& body) | |
2509 { | |
2510 fullBody_.clear(); | |
2511 chunkedBody_ = &body; | |
2512 } | |
2513 | |
2514 | |
2515 namespace | |
2516 { | |
2517 class HeadersWrapper : public boost::noncopyable | |
2518 { | |
2519 private: | |
2520 std::vector<const char*> headersKeys_; | |
2521 std::vector<const char*> headersValues_; | |
2522 | |
2523 public: | |
2524 HeadersWrapper(const HttpClient::HttpHeaders& headers) | |
2525 { | |
2526 headersKeys_.reserve(headers.size()); | |
2527 headersValues_.reserve(headers.size()); | |
2528 | |
2529 for (HttpClient::HttpHeaders::const_iterator it = headers.begin(); it != headers.end(); ++it) | |
2530 { | |
2531 headersKeys_.push_back(it->first.c_str()); | |
2532 headersValues_.push_back(it->second.c_str()); | |
2533 } | |
2534 } | |
2535 | |
2536 void AddStaticString(const char* key, | |
2537 const char* value) | |
2538 { | |
2539 headersKeys_.push_back(key); | |
2540 headersValues_.push_back(value); | |
2541 } | |
2542 | |
2543 uint32_t GetCount() const | |
2544 { | |
2545 return headersKeys_.size(); | |
2546 } | |
2547 | |
2548 const char* const* GetKeys() const | |
2549 { | |
2550 return headersKeys_.empty() ? NULL : &headersKeys_[0]; | |
2551 } | |
2552 | |
2553 const char* const* GetValues() const | |
2554 { | |
2555 return headersValues_.empty() ? NULL : &headersValues_[0]; | |
2556 } | |
2557 }; | |
2558 | |
2559 | |
2560 class MemoryRequestBody : public HttpClient::IRequestBody | |
2561 { | |
2562 private: | |
2563 std::string body_; | |
2564 bool done_; | |
2565 | |
2566 public: | |
2567 MemoryRequestBody(const std::string& body) : | |
2568 body_(body), | |
2569 done_(false) | |
2570 { | |
2571 if (body_.empty()) | |
2572 { | |
2573 done_ = true; | |
2574 } | |
2575 } | |
2576 | |
2577 virtual bool ReadNextChunk(std::string& chunk) | |
2578 { | |
2579 if (done_) | |
2580 { | |
2581 return false; | |
2582 } | |
2583 else | |
2584 { | |
2585 chunk.swap(body_); | |
2586 done_ = true; | |
2587 return true; | |
2588 } | |
2589 } | |
2590 }; | |
2591 | |
2592 | |
2593 // This class mimics Orthanc::ChunkedBuffer | |
2594 class ChunkedBuffer : public boost::noncopyable | |
2595 { | |
2596 private: | |
2597 typedef std::list<std::string*> Content; | |
2598 | |
2599 Content content_; | |
2600 size_t size_; | |
2601 | |
2602 public: | |
2603 ChunkedBuffer() : | |
2604 size_(0) | |
2605 { | |
2606 } | |
2607 | |
2608 ~ChunkedBuffer() | |
2609 { | |
2610 Clear(); | |
2611 } | |
2612 | |
2613 void Clear() | |
2614 { | |
2615 for (Content::iterator it = content_.begin(); it != content_.end(); ++it) | |
2616 { | |
2617 assert(*it != NULL); | |
2618 delete *it; | |
2619 } | |
2620 | |
2621 content_.clear(); | |
2622 } | |
2623 | |
2624 void Flatten(std::string& target) const | |
2625 { | |
2626 target.resize(size_); | |
2627 | |
2628 size_t pos = 0; | |
2629 | |
2630 for (Content::const_iterator it = content_.begin(); it != content_.end(); ++it) | |
2631 { | |
2632 assert(*it != NULL); | |
2633 size_t s = (*it)->size(); | |
2634 | |
2635 if (s != 0) | |
2636 { | |
2637 memcpy(&target[pos], (*it)->c_str(), s); | |
2638 pos += s; | |
2639 } | |
2640 } | |
2641 | |
2642 assert(size_ == 0 || | |
2643 pos == target.size()); | |
2644 } | |
2645 | |
2646 void AddChunk(const void* data, | |
2647 size_t size) | |
2648 { | |
2649 content_.push_back(new std::string(reinterpret_cast<const char*>(data), size)); | |
2650 size_ += size; | |
2651 } | |
2652 | |
2653 void AddChunk(const std::string& chunk) | |
2654 { | |
2655 content_.push_back(new std::string(chunk)); | |
2656 size_ += chunk.size(); | |
2657 } | |
2658 }; | |
2659 | |
2660 | |
2661 #if HAS_ORTHANC_PLUGIN_CHUNKED_HTTP_CLIENT == 1 | |
2662 class MemoryAnswer : public HttpClient::IAnswer | |
2663 { | |
2664 private: | |
2665 HttpClient::HttpHeaders headers_; | |
2666 ChunkedBuffer body_; | |
2667 | |
2668 public: | |
2669 const HttpClient::HttpHeaders& GetHeaders() const | |
2670 { | |
2671 return headers_; | |
2672 } | |
2673 | |
2674 const ChunkedBuffer& GetBody() const | |
2675 { | |
2676 return body_; | |
2677 } | |
2678 | |
2679 virtual void AddHeader(const std::string& key, | |
2680 const std::string& value) | |
2681 { | |
2682 headers_[key] = value; | |
2683 } | |
2684 | |
2685 virtual void AddChunk(const void* data, | |
2686 size_t size) | |
2687 { | |
2688 body_.AddChunk(data, size); | |
2689 } | |
2690 }; | |
2691 #endif | |
2692 } | |
2693 | |
2694 | |
2695 #if HAS_ORTHANC_PLUGIN_CHUNKED_HTTP_CLIENT == 1 | |
2696 void HttpClient::ExecuteWithStream(uint16_t& httpStatus, | |
2697 IAnswer& answer, | |
2698 IRequestBody& body) const | |
2699 { | |
2700 HeadersWrapper h(headers_); | |
2701 | |
2702 if (method_ == OrthancPluginHttpMethod_Post || | |
2703 method_ == OrthancPluginHttpMethod_Put) | |
2704 { | |
2705 // Automatically set the "Transfer-Encoding" header if absent | |
2706 bool found = false; | |
2707 | |
2708 for (HttpHeaders::const_iterator it = headers_.begin(); it != headers_.end(); ++it) | |
2709 { | |
2710 if (boost::iequals(it->first, "Transfer-Encoding")) | |
2711 { | |
2712 found = true; | |
2713 break; | |
2714 } | |
2715 } | |
2716 | |
2717 if (!found) | |
2718 { | |
2719 h.AddStaticString("Transfer-Encoding", "chunked"); | |
2720 } | |
2721 } | |
2722 | |
2723 RequestBodyWrapper request(body); | |
2724 | |
2725 OrthancPluginErrorCode error = OrthancPluginChunkedHttpClient( | |
2726 GetGlobalContext(), | |
2727 &answer, | |
2728 AnswerAddChunkCallback, | |
2729 AnswerAddHeaderCallback, | |
2730 &httpStatus, | |
2731 method_, | |
2732 url_.c_str(), | |
2733 h.GetCount(), | |
2734 h.GetKeys(), | |
2735 h.GetValues(), | |
2736 &request, | |
2737 RequestBodyWrapper::IsDone, | |
2738 RequestBodyWrapper::GetChunkData, | |
2739 RequestBodyWrapper::GetChunkSize, | |
2740 RequestBodyWrapper::Next, | |
2741 username_.empty() ? NULL : username_.c_str(), | |
2742 password_.empty() ? NULL : password_.c_str(), | |
2743 timeout_, | |
2744 certificateFile_.empty() ? NULL : certificateFile_.c_str(), | |
2745 certificateFile_.empty() ? NULL : certificateKeyFile_.c_str(), | |
2746 certificateFile_.empty() ? NULL : certificateKeyPassword_.c_str(), | |
2747 pkcs11_ ? 1 : 0); | |
2748 | |
2749 if (error != OrthancPluginErrorCode_Success) | |
2750 { | |
2751 ORTHANC_PLUGINS_THROW_PLUGIN_ERROR_CODE(error); | |
2752 } | |
2753 } | |
2754 #endif | |
2755 | |
2756 | |
2757 void HttpClient::ExecuteWithoutStream(uint16_t& httpStatus, | |
2758 HttpHeaders& answerHeaders, | |
2759 std::string& answerBody, | |
2760 const std::string& body) const | |
2761 { | |
2762 HeadersWrapper headers(headers_); | |
2763 | |
2764 MemoryBuffer answerBodyBuffer, answerHeadersBuffer; | |
2765 | |
2766 OrthancPluginErrorCode error = OrthancPluginHttpClient( | |
2767 GetGlobalContext(), | |
2768 *answerBodyBuffer, | |
2769 *answerHeadersBuffer, | |
2770 &httpStatus, | |
2771 method_, | |
2772 url_.c_str(), | |
2773 headers.GetCount(), | |
2774 headers.GetKeys(), | |
2775 headers.GetValues(), | |
2776 body.empty() ? NULL : body.c_str(), | |
2777 body.size(), | |
2778 username_.empty() ? NULL : username_.c_str(), | |
2779 password_.empty() ? NULL : password_.c_str(), | |
2780 timeout_, | |
2781 certificateFile_.empty() ? NULL : certificateFile_.c_str(), | |
2782 certificateFile_.empty() ? NULL : certificateKeyFile_.c_str(), | |
2783 certificateFile_.empty() ? NULL : certificateKeyPassword_.c_str(), | |
2784 pkcs11_ ? 1 : 0); | |
2785 | |
2786 if (error != OrthancPluginErrorCode_Success) | |
2787 { | |
2788 ORTHANC_PLUGINS_THROW_PLUGIN_ERROR_CODE(error); | |
2789 } | |
2790 | |
2791 Json::Value v; | |
2792 answerHeadersBuffer.ToJson(v); | |
2793 | |
2794 if (v.type() != Json::objectValue) | |
2795 { | |
2796 ORTHANC_PLUGINS_THROW_EXCEPTION(InternalError); | |
2797 } | |
2798 | |
2799 Json::Value::Members members = v.getMemberNames(); | |
2800 answerHeaders.clear(); | |
2801 | |
2802 for (size_t i = 0; i < members.size(); i++) | |
2803 { | |
2804 const Json::Value& h = v[members[i]]; | |
2805 if (h.type() != Json::stringValue) | |
2806 { | |
2807 ORTHANC_PLUGINS_THROW_EXCEPTION(InternalError); | |
2808 } | |
2809 else | |
2810 { | |
2811 answerHeaders[members[i]] = h.asString(); | |
2812 } | |
2813 } | |
2814 | |
2815 answerBodyBuffer.ToString(answerBody); | |
2816 } | |
2817 | |
2818 | |
2819 void HttpClient::Execute(IAnswer& answer) | |
2820 { | |
2821 #if HAS_ORTHANC_PLUGIN_CHUNKED_HTTP_CLIENT == 1 | |
2822 if (allowChunkedTransfers_) | |
2823 { | |
2824 if (chunkedBody_ != NULL) | |
2825 { | |
2826 ExecuteWithStream(httpStatus_, answer, *chunkedBody_); | |
2827 } | |
2828 else | |
2829 { | |
2830 MemoryRequestBody wrapper(fullBody_); | |
2831 ExecuteWithStream(httpStatus_, answer, wrapper); | |
2832 } | |
2833 | |
2834 return; | |
2835 } | |
2836 #endif | |
2837 | |
2838 // Compatibility mode for Orthanc SDK <= 1.5.6 or if chunked | |
2839 // transfers are disabled. This results in higher memory usage | |
2840 // (all chunks from the answer body are sent at once) | |
2841 | |
2842 HttpHeaders answerHeaders; | |
2843 std::string answerBody; | |
2844 Execute(answerHeaders, answerBody); | |
2845 | |
2846 for (HttpHeaders::const_iterator it = answerHeaders.begin(); | |
2847 it != answerHeaders.end(); ++it) | |
2848 { | |
2849 answer.AddHeader(it->first, it->second); | |
2850 } | |
2851 | |
2852 if (!answerBody.empty()) | |
2853 { | |
2854 answer.AddChunk(answerBody.c_str(), answerBody.size()); | |
2855 } | |
2856 } | |
2857 | |
2858 | |
2859 void HttpClient::Execute(HttpHeaders& answerHeaders /* out */, | |
2860 std::string& answerBody /* out */) | |
2861 { | |
2862 #if HAS_ORTHANC_PLUGIN_CHUNKED_HTTP_CLIENT == 1 | |
2863 if (allowChunkedTransfers_) | |
2864 { | |
2865 MemoryAnswer answer; | |
2866 Execute(answer); | |
2867 answerHeaders = answer.GetHeaders(); | |
2868 answer.GetBody().Flatten(answerBody); | |
2869 return; | |
2870 } | |
2871 #endif | |
2872 | |
2873 // Compatibility mode for Orthanc SDK <= 1.5.6 or if chunked | |
2874 // transfers are disabled. This results in higher memory usage | |
2875 // (all chunks from the request body are sent at once) | |
2876 | |
2877 if (chunkedBody_ != NULL) | |
2878 { | |
2879 ChunkedBuffer buffer; | |
2880 | |
2881 std::string chunk; | |
2882 while (chunkedBody_->ReadNextChunk(chunk)) | |
2883 { | |
2884 buffer.AddChunk(chunk); | |
2885 } | |
2886 | |
2887 std::string body; | |
2888 buffer.Flatten(body); | |
2889 | |
2890 ExecuteWithoutStream(httpStatus_, answerHeaders, answerBody, body); | |
2891 } | |
2892 else | |
2893 { | |
2894 ExecuteWithoutStream(httpStatus_, answerHeaders, answerBody, fullBody_); | |
2895 } | |
2896 } | |
2897 | |
2898 | |
2899 void HttpClient::Execute(HttpHeaders& answerHeaders /* out */, | |
2900 Json::Value& answerBody /* out */) | |
2901 { | |
2902 std::string body; | |
2903 Execute(answerHeaders, body); | |
2904 | |
2905 Json::Reader reader; | |
2906 if (!reader.parse(body, answerBody)) | |
2907 { | |
2908 LogError("Cannot convert HTTP answer body to JSON"); | |
2909 ORTHANC_PLUGINS_THROW_EXCEPTION(BadFileFormat); | |
2910 } | |
2911 } | |
2912 | |
2913 | |
2914 void HttpClient::Execute() | |
2915 { | |
2916 HttpHeaders answerHeaders; | |
2917 std::string body; | |
2918 Execute(answerHeaders, body); | |
2919 } | |
2920 | |
2921 #endif /* HAS_ORTHANC_PLUGIN_HTTP_CLIENT == 1 */ | |
2922 | |
2923 | |
2924 | |
2925 | |
2926 | |
2927 /****************************************************************** | |
2928 ** CHUNKED HTTP SERVER | |
2929 ******************************************************************/ | |
2930 | |
2931 namespace Internals | |
2932 { | |
2933 void NullRestCallback(OrthancPluginRestOutput* output, | |
2934 const char* url, | |
2935 const OrthancPluginHttpRequest* request) | |
2936 { | |
2937 } | |
2938 | |
2939 IChunkedRequestReader *NullChunkedRestCallback(const char* url, | |
2940 const OrthancPluginHttpRequest* request) | |
2941 { | |
2942 return NULL; | |
2943 } | |
2944 | |
2945 | |
2946 #if HAS_ORTHANC_PLUGIN_CHUNKED_HTTP_SERVER == 1 | |
2947 | |
2948 OrthancPluginErrorCode ChunkedRequestReaderAddChunk( | |
2949 OrthancPluginServerChunkedRequestReader* reader, | |
2950 const void* data, | |
2951 uint32_t size) | |
2952 { | |
2953 try | |
2954 { | |
2955 if (reader == NULL) | |
2956 { | |
2957 return OrthancPluginErrorCode_InternalError; | |
2958 } | |
2959 | |
2960 reinterpret_cast<IChunkedRequestReader*>(reader)->AddChunk(data, size); | |
2961 return OrthancPluginErrorCode_Success; | |
2962 } | |
2963 catch (ORTHANC_PLUGINS_EXCEPTION_CLASS& e) | |
2964 { | |
2965 return static_cast<OrthancPluginErrorCode>(e.GetErrorCode()); | |
2966 } | |
2967 catch (boost::bad_lexical_cast&) | |
2968 { | |
2969 return OrthancPluginErrorCode_BadFileFormat; | |
2970 } | |
2971 catch (...) | |
2972 { | |
2973 return OrthancPluginErrorCode_Plugin; | |
2974 } | |
2975 } | |
2976 | |
2977 | |
2978 OrthancPluginErrorCode ChunkedRequestReaderExecute( | |
2979 OrthancPluginServerChunkedRequestReader* reader, | |
2980 OrthancPluginRestOutput* output) | |
2981 { | |
2982 try | |
2983 { | |
2984 if (reader == NULL) | |
2985 { | |
2986 return OrthancPluginErrorCode_InternalError; | |
2987 } | |
2988 | |
2989 reinterpret_cast<IChunkedRequestReader*>(reader)->Execute(output); | |
2990 return OrthancPluginErrorCode_Success; | |
2991 } | |
2992 catch (ORTHANC_PLUGINS_EXCEPTION_CLASS& e) | |
2993 { | |
2994 return static_cast<OrthancPluginErrorCode>(e.GetErrorCode()); | |
2995 } | |
2996 catch (boost::bad_lexical_cast&) | |
2997 { | |
2998 return OrthancPluginErrorCode_BadFileFormat; | |
2999 } | |
3000 catch (...) | |
3001 { | |
3002 return OrthancPluginErrorCode_Plugin; | |
3003 } | |
3004 } | |
3005 | |
3006 | |
3007 void ChunkedRequestReaderFinalize( | |
3008 OrthancPluginServerChunkedRequestReader* reader) | |
3009 { | |
3010 if (reader != NULL) | |
3011 { | |
3012 delete reinterpret_cast<IChunkedRequestReader*>(reader); | |
3013 } | |
3014 } | |
3015 | |
3016 #else | |
3017 | |
3018 OrthancPluginErrorCode ChunkedRestCompatibility(OrthancPluginRestOutput* output, | |
3019 const char* url, | |
3020 const OrthancPluginHttpRequest* request, | |
3021 RestCallback GetHandler, | |
3022 ChunkedRestCallback PostHandler, | |
3023 RestCallback DeleteHandler, | |
3024 ChunkedRestCallback PutHandler) | |
3025 { | |
3026 try | |
3027 { | |
3028 std::string allowed; | |
3029 | |
3030 if (GetHandler != Internals::NullRestCallback) | |
3031 { | |
3032 allowed += "GET"; | |
3033 } | |
3034 | |
3035 if (PostHandler != Internals::NullChunkedRestCallback) | |
3036 { | |
3037 if (!allowed.empty()) | |
3038 { | |
3039 allowed += ","; | |
3040 } | |
3041 | |
3042 allowed += "POST"; | |
3043 } | |
3044 | |
3045 if (DeleteHandler != Internals::NullRestCallback) | |
3046 { | |
3047 if (!allowed.empty()) | |
3048 { | |
3049 allowed += ","; | |
3050 } | |
3051 | |
3052 allowed += "DELETE"; | |
3053 } | |
3054 | |
3055 if (PutHandler != Internals::NullChunkedRestCallback) | |
3056 { | |
3057 if (!allowed.empty()) | |
3058 { | |
3059 allowed += ","; | |
3060 } | |
3061 | |
3062 allowed += "PUT"; | |
3063 } | |
3064 | |
3065 switch (request->method) | |
3066 { | |
3067 case OrthancPluginHttpMethod_Get: | |
3068 if (GetHandler == Internals::NullRestCallback) | |
3069 { | |
3070 OrthancPluginSendMethodNotAllowed(GetGlobalContext(), output, allowed.c_str()); | |
3071 } | |
3072 else | |
3073 { | |
3074 GetHandler(output, url, request); | |
3075 } | |
3076 | |
3077 break; | |
3078 | |
3079 case OrthancPluginHttpMethod_Post: | |
3080 if (PostHandler == Internals::NullChunkedRestCallback) | |
3081 { | |
3082 OrthancPluginSendMethodNotAllowed(GetGlobalContext(), output, allowed.c_str()); | |
3083 } | |
3084 else | |
3085 { | |
3086 boost::movelib::unique_ptr<IChunkedRequestReader> reader(PostHandler(url, request)); | |
3087 if (reader.get() == NULL) | |
3088 { | |
3089 ORTHANC_PLUGINS_THROW_EXCEPTION(Plugin); | |
3090 } | |
3091 else | |
3092 { | |
3093 reader->AddChunk(request->body, request->bodySize); | |
3094 reader->Execute(output); | |
3095 } | |
3096 } | |
3097 | |
3098 break; | |
3099 | |
3100 case OrthancPluginHttpMethod_Delete: | |
3101 if (DeleteHandler == Internals::NullRestCallback) | |
3102 { | |
3103 OrthancPluginSendMethodNotAllowed(GetGlobalContext(), output, allowed.c_str()); | |
3104 } | |
3105 else | |
3106 { | |
3107 DeleteHandler(output, url, request); | |
3108 } | |
3109 | |
3110 break; | |
3111 | |
3112 case OrthancPluginHttpMethod_Put: | |
3113 if (PutHandler == Internals::NullChunkedRestCallback) | |
3114 { | |
3115 OrthancPluginSendMethodNotAllowed(GetGlobalContext(), output, allowed.c_str()); | |
3116 } | |
3117 else | |
3118 { | |
3119 boost::movelib::unique_ptr<IChunkedRequestReader> reader(PutHandler(url, request)); | |
3120 if (reader.get() == NULL) | |
3121 { | |
3122 ORTHANC_PLUGINS_THROW_EXCEPTION(Plugin); | |
3123 } | |
3124 else | |
3125 { | |
3126 reader->AddChunk(request->body, request->bodySize); | |
3127 reader->Execute(output); | |
3128 } | |
3129 } | |
3130 | |
3131 break; | |
3132 | |
3133 default: | |
3134 ORTHANC_PLUGINS_THROW_EXCEPTION(InternalError); | |
3135 } | |
3136 | |
3137 return OrthancPluginErrorCode_Success; | |
3138 } | |
3139 catch (ORTHANC_PLUGINS_EXCEPTION_CLASS& e) | |
3140 { | |
3141 #if HAS_ORTHANC_EXCEPTION == 1 && HAS_ORTHANC_PLUGIN_EXCEPTION_DETAILS == 1 | |
3142 if (HasGlobalContext() && | |
3143 e.HasDetails()) | |
3144 { | |
3145 // The "false" instructs Orthanc not to log the detailed | |
3146 // error message. This is to avoid duplicating the details, | |
3147 // because "OrthancException" already does it on construction. | |
3148 OrthancPluginSetHttpErrorDetails | |
3149 (GetGlobalContext(), output, e.GetDetails(), false); | |
3150 } | |
3151 #endif | |
3152 | |
3153 return static_cast<OrthancPluginErrorCode>(e.GetErrorCode()); | |
3154 } | |
3155 catch (boost::bad_lexical_cast&) | |
3156 { | |
3157 return OrthancPluginErrorCode_BadFileFormat; | |
3158 } | |
3159 catch (...) | |
3160 { | |
3161 return OrthancPluginErrorCode_Plugin; | |
3162 } | |
3163 } | |
3164 #endif | |
3165 } | |
3166 | |
3167 | |
3168 #if HAS_ORTHANC_PLUGIN_STORAGE_COMMITMENT_SCP == 1 | |
3169 OrthancPluginErrorCode IStorageCommitmentScpHandler::Lookup( | |
3170 OrthancPluginStorageCommitmentFailureReason* target, | |
3171 void* rawHandler, | |
3172 const char* sopClassUid, | |
3173 const char* sopInstanceUid) | |
3174 { | |
3175 assert(target != NULL && | |
3176 rawHandler != NULL); | |
3177 | |
3178 try | |
3179 { | |
3180 IStorageCommitmentScpHandler& handler = *reinterpret_cast<IStorageCommitmentScpHandler*>(rawHandler); | |
3181 *target = handler.Lookup(sopClassUid, sopInstanceUid); | |
3182 return OrthancPluginErrorCode_Success; | |
3183 } | |
3184 catch (ORTHANC_PLUGINS_EXCEPTION_CLASS& e) | |
3185 { | |
3186 return static_cast<OrthancPluginErrorCode>(e.GetErrorCode()); | |
3187 } | |
3188 catch (...) | |
3189 { | |
3190 return OrthancPluginErrorCode_Plugin; | |
3191 } | |
3192 } | |
3193 #endif | |
3194 | |
3195 | |
3196 #if HAS_ORTHANC_PLUGIN_STORAGE_COMMITMENT_SCP == 1 | |
3197 void IStorageCommitmentScpHandler::Destructor(void* rawHandler) | |
3198 { | |
3199 assert(rawHandler != NULL); | |
3200 delete reinterpret_cast<IStorageCommitmentScpHandler*>(rawHandler); | |
3201 } | |
3202 #endif | |
3203 | |
3204 | |
3205 #if ORTHANC_PLUGINS_VERSION_IS_ABOVE(1, 6, 1) | |
3206 DicomInstance::DicomInstance(const OrthancPluginDicomInstance* instance) : | |
3207 toFree_(false), | |
3208 instance_(instance) | |
3209 { | |
3210 } | |
3211 #else | |
3212 DicomInstance::DicomInstance(OrthancPluginDicomInstance* instance) : | |
3213 toFree_(false), | |
3214 instance_(instance) | |
3215 { | |
3216 } | |
3217 #endif | |
3218 | |
3219 | |
3220 #if ORTHANC_PLUGINS_VERSION_IS_ABOVE(1, 7, 0) | |
3221 DicomInstance::DicomInstance(const void* buffer, | |
3222 size_t size) : | |
3223 toFree_(true), | |
3224 instance_(OrthancPluginCreateDicomInstance(GetGlobalContext(), buffer, size)) | |
3225 { | |
3226 if (instance_ == NULL) | |
3227 { | |
3228 ORTHANC_PLUGINS_THROW_EXCEPTION(NullPointer); | |
3229 } | |
3230 } | |
3231 #endif | |
3232 | |
3233 | |
3234 DicomInstance::~DicomInstance() | |
3235 { | |
3236 #if ORTHANC_PLUGINS_VERSION_IS_ABOVE(1, 7, 0) | |
3237 if (toFree_ && | |
3238 instance_ != NULL) | |
3239 { | |
3240 OrthancPluginFreeDicomInstance( | |
3241 GetGlobalContext(), const_cast<OrthancPluginDicomInstance*>(instance_)); | |
3242 } | |
3243 #endif | |
3244 } | |
3245 | |
3246 | |
3247 std::string DicomInstance::GetRemoteAet() const | |
3248 { | |
3249 const char* s = OrthancPluginGetInstanceRemoteAet(GetGlobalContext(), instance_); | |
3250 if (s == NULL) | |
3251 { | |
3252 ORTHANC_PLUGINS_THROW_EXCEPTION(Plugin); | |
3253 } | |
3254 else | |
3255 { | |
3256 return std::string(s); | |
3257 } | |
3258 } | |
3259 | |
3260 | |
3261 void DicomInstance::GetJson(Json::Value& target) const | |
3262 { | |
3263 OrthancString s; | |
3264 s.Assign(OrthancPluginGetInstanceJson(GetGlobalContext(), instance_)); | |
3265 s.ToJson(target); | |
3266 } | |
3267 | |
3268 | |
3269 void DicomInstance::GetSimplifiedJson(Json::Value& target) const | |
3270 { | |
3271 OrthancString s; | |
3272 s.Assign(OrthancPluginGetInstanceSimplifiedJson(GetGlobalContext(), instance_)); | |
3273 s.ToJson(target); | |
3274 } | |
3275 | |
3276 | |
3277 #if ORTHANC_PLUGINS_VERSION_IS_ABOVE(1, 6, 1) | |
3278 std::string DicomInstance::GetTransferSyntaxUid() const | |
3279 { | |
3280 OrthancString s; | |
3281 s.Assign(OrthancPluginGetInstanceTransferSyntaxUid(GetGlobalContext(), instance_)); | |
3282 | |
3283 std::string result; | |
3284 s.ToString(result); | |
3285 return result; | |
3286 } | |
3287 #endif | |
3288 | |
3289 | |
3290 #if ORTHANC_PLUGINS_VERSION_IS_ABOVE(1, 6, 1) | |
3291 bool DicomInstance::HasPixelData() const | |
3292 { | |
3293 int32_t result = OrthancPluginHasInstancePixelData(GetGlobalContext(), instance_); | |
3294 if (result < 0) | |
3295 { | |
3296 ORTHANC_PLUGINS_THROW_EXCEPTION(Plugin); | |
3297 } | |
3298 else | |
3299 { | |
3300 return (result != 0); | |
3301 } | |
3302 } | |
3303 #endif | |
3304 | |
3305 | |
3306 #if ORTHANC_PLUGINS_VERSION_IS_ABOVE(1, 7, 0) | |
3307 void DicomInstance::GetRawFrame(std::string& target, | |
3308 unsigned int frameIndex) const | |
3309 { | |
3310 MemoryBuffer buffer; | |
3311 OrthancPluginErrorCode code = OrthancPluginGetInstanceRawFrame( | |
3312 GetGlobalContext(), *buffer, instance_, frameIndex); | |
3313 | |
3314 if (code == OrthancPluginErrorCode_Success) | |
3315 { | |
3316 buffer.ToString(target); | |
3317 } | |
3318 else | |
3319 { | |
3320 ORTHANC_PLUGINS_THROW_PLUGIN_ERROR_CODE(code); | |
3321 } | |
3322 } | |
3323 #endif | |
3324 | |
3325 | |
3326 #if ORTHANC_PLUGINS_VERSION_IS_ABOVE(1, 7, 0) | |
3327 OrthancImage* DicomInstance::GetDecodedFrame(unsigned int frameIndex) const | |
3328 { | |
3329 OrthancPluginImage* image = OrthancPluginGetInstanceDecodedFrame( | |
3330 GetGlobalContext(), instance_, frameIndex); | |
3331 | |
3332 if (image == NULL) | |
3333 { | |
3334 ORTHANC_PLUGINS_THROW_EXCEPTION(Plugin); | |
3335 } | |
3336 else | |
3337 { | |
3338 return new OrthancImage(image); | |
3339 } | |
3340 } | |
3341 #endif | |
3342 | |
3343 | |
3344 #if ORTHANC_PLUGINS_VERSION_IS_ABOVE(1, 7, 0) | |
3345 void DicomInstance::Serialize(std::string& target) const | |
3346 { | |
3347 MemoryBuffer buffer; | |
3348 OrthancPluginErrorCode code = OrthancPluginSerializeDicomInstance( | |
3349 GetGlobalContext(), *buffer, instance_); | |
3350 | |
3351 if (code == OrthancPluginErrorCode_Success) | |
3352 { | |
3353 buffer.ToString(target); | |
3354 } | |
3355 else | |
3356 { | |
3357 ORTHANC_PLUGINS_THROW_PLUGIN_ERROR_CODE(code); | |
3358 } | |
3359 } | |
3360 #endif | |
3361 | |
3362 | |
3363 #if ORTHANC_PLUGINS_VERSION_IS_ABOVE(1, 7, 0) | |
3364 DicomInstance* DicomInstance::Transcode(const void* buffer, | |
3365 size_t size, | |
3366 const std::string& transferSyntax) | |
3367 { | |
3368 OrthancPluginDicomInstance* instance = OrthancPluginTranscodeDicomInstance( | |
3369 GetGlobalContext(), buffer, size, transferSyntax.c_str()); | |
3370 | |
3371 if (instance == NULL) | |
3372 { | |
3373 ORTHANC_PLUGINS_THROW_EXCEPTION(Plugin); | |
3374 } | |
3375 else | |
3376 { | |
3377 boost::movelib::unique_ptr<DicomInstance> result(new DicomInstance(instance)); | |
3378 result->toFree_ = true; | |
3379 return result.release(); | |
3380 } | |
3381 } | |
3382 #endif | |
3383 } |