Mercurial > hg > orthanc-stone

comparison StoneWebViewer/Resources/Orthanc/Plugins/OrthancPluginCppWrapper.cpp @ 1508:dd1d1cc0575d

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